Rails/プラグイン の履歴(No.7)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• Rails/プラグイン へ行く。
  • 1 (2016-10-12 (水) 03:59:47)
  • 2 (2016-10-12 (水) 05:32:29)
  • 3 (2016-10-12 (水) 17:32:09)
  • 4 (2016-10-25 (火) 09:44:26)
  • 5 (2016-10-25 (火) 15:28:54)
  • 6 (2016-10-26 (水) 05:01:12)
  • 7 (2017-03-12 (日) 08:11:40)
  • 8 (2017-03-13 (月) 01:28:45)

---

Rails

Tag: Rails/プラグイン

目次†

関連ページ†

参考情報†

• Rails エンジン入門 | Rails ガイド…ここが一番わかりやすい。
• 使いやすくなった Rails 3.1 の Engine - passingloopの日記…Engine型プラグインの利点。
• Rails用のgemを作成する手順 (Rails 4.0以降) – Oh My Enter!…Engine型プラグインを作成する手順。
• Gem、Railtieプラグイン、Engine（full/mountable）の違いとそれぞれの基礎情報 - Qiita…プラグインの違い。
• rails pluginコマンドで簡単に出来るgemの作成方法。 - Qiita…mountableでcssを追加するプラグインの例。
• Rails pluginでengineを使ったgemの作り方[5]（view helper編） | joppot…シンプルな例

概要†

• プラグインの種類、下に行くほど複雑っぽいがmountable型が主流？
  • Railtie型:
  • Engine型:
  • Mountable Engine型: Devise
• cssを一個追加するようなプラグインをmountableでつくる例もあるし。

作成†

mountable型の作成†

プロジェクトの作成†

• 以下のコマンドを実行

  bundle exec rails plugin new ~/work/blorgh --mountable --skip-bundle

• blorgh.gemspecを編集してTODOを削除したあと、bundle installの実行

   bundle install --path=vendor/bundle

Articleリソースの作成†

• 以下のコマンドを実行

  bundle exec bin/rails generate scaffold article title:string text:text

• モデルやコントローラーにネームスペースが付与されていることに注意。

  $ bundle exec bin/rails generate scaffold article title:string text:text
        invoke  active_record
        create    db/migrate/20161025072006_create_blorgh_articles.rb
        create    app/models/blorgh/article.rb
        invoke    test_unit
        create      test/models/blorgh/article_test.rb
        create      test/fixtures/blorgh/articles.yml
        invoke  resource_route
         route    resources :articles
        invoke  scaffold_controller
        create    app/controllers/blorgh/articles_controller.rb
        invoke    erb
        create      app/views/blorgh/articles
        create      app/views/blorgh/articles/index.html.erb
        create      app/views/blorgh/articles/edit.html.erb
        create      app/views/blorgh/articles/show.html.erb
        create      app/views/blorgh/articles/new.html.erb
        create      app/views/blorgh/articles/_form.html.erb
        invoke    test_unit
        create      test/controllers/blorgh/articles_controller_test.rb
        invoke    helper
        create      app/helpers/blorgh/articles_helper.rb
        invoke      test_unit
        invoke  assets
        invoke    js
        create      app/assets/javascripts/blorgh/articles.js
        invoke    css
        create      app/assets/stylesheets/blorgh/articles.css
        invoke  css
        create    app/assets/stylesheets/scaffold.css
  

• miration実行

  bundle exec rake db:migrate

• test/dummyディレクトリで実行。http://localhost:3000/blorgh/articlesでアクセスできる。

  bundle exec rails s

Commentリソースの生成†

• 記事1に対して複数のコメントがつけられる。
• 以下のコマンドを実行。

  $ bundle exec bin/rails generate model Comment article_id:integer text:text
        invoke  active_record
        create    db/migrate/20161025073042_create_blorgh_comments.rb
        create    app/models/blorgh/comment.rb
        invoke    test_unit
        create      test/models/blorgh/comment_test.rb
        create      test/fixtures/blorgh/comments.yml
  

• migration実行

  bundle exec rake db:migrate

• 以下の概略。app/views/blorgh/articles/show.html.erbにコメント一覧とコメント追加用のフォームを追加する。

Tips†

engine側のApplicationHelperをアプリ側で使用する†

• Using Rails 4 engine/plugin helpers across your entire app – Carlos Roque

  class ApplicationController < ActionController::Base
    # your code
    helper Paginas::ApplicationHelper
  
    # your other code
  end
  

• アプリ側のApplicationControllerにhelperメソッドを使って追加する。こうすることでview側でだけメソッドが追加される。

開発・テストする†

• mountableエンジンの場合、test/dummyディレクトリが存在しそこでダミーのアプリケーションを作成してテストすることができる。

  cd test/dummy
  bundle exec rails s

• ただしscaffoldを実行すると、test/dummy/test以下にテストが作られてしまうがこれではだめ。作成されたテスト群はtest以下に移動する。そうしないとfixtureも読み込めなくなってしまう。

トラブルシューティング†

IntelliJ/RubyMineでプラグインのメソッドが自動補完されない†

• 単に入力しているだけだと補完されない。
• Ctrl+Spaceを押して「No Suggestions」と表示されあと、もう一回Ctrl+Spaceを押す。

Uninitialized Constantsのエラーが発生†

• なぜかdevelopment環境では発生せず、production環境で発生。
• 原因は名前空間とファイルの位置関係が一致していなかったから？
• mountableのモデルはapp/models/my_engine/article.rbのように配置して、article.rbは次のように作る

  module MyEngine
    class Article
    end
  end
  

Engineの初期化処理†

• 標準クラスを拡張したり小細工したいときはActiveSupport.on_load :action_viewなどで小細工しないといけないかもしれない。しかしそれが不要ならわざわざそこでやる必要はない。
• app以下のファイルは自動で読み込まれるし、lib以下のユーティリティは自分でEngineのメインファイルにrequireしてしまえば良い。