Rails/プラグイン/チュートリアル の履歴(No.2)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• Rails/プラグイン/チュートリアル へ行く。
  • 1 (2017-03-13 (月) 01:29:51)
  • 2 (2017-03-13 (月) 04:53:45)
  • 3 (2017-03-13 (月) 06:38:59)
  • 4 (2017-03-13 (月) 10:24:43)
  • 5 (2017-03-13 (月) 15:09:50)

---

Tag: Rails/プラグイン/チュートリアル

目次†

関連ページ†

• Rails/プラグイン

参考情報†

• https://railsguides.jp/engines.html

エンジンプロジェクトの作成†

• 以下のコマンドを実行する(rails-factoryディレクトリで実行)。

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

• "~/work/blorgh"ディレクトリに移動。
• blorgh.gemspecを編集してTODOを削除。
• bundle installを実行

  bundle install --path=vendor/bundle

ポイント

• "--mountable"オプションを使用すると、ApplicationControllerやApplicationHelperが名前空間化される。ところが"-full"と違う。
• ダミーのテスト用アプリケーションが test/dummyに配置される。ダミーアプリケーションのルーティングファイルは、test/dummy/config/routes.rbとなる。

エンジンの構成†

• blorgh.gemspec。エンジンのルートディレクトリに存在。利用側から以下のように使う。

  gem 'blorgh', path: "vendor/engines/blorgh"
  

• アプリケーションあらはlib/blorgh.rbが読み込まれる。ここにプラグインごとの設定を記述するのもよい。

  require "blorgh/engine"
   
  module Blorgh
  end
  

• エンジンの基本ファイルはlib/blorgh/engine.rbのなかにある。

  module Blorgh
    class Engine < ::Rails::Engine
      isolate_namespace Blorgh
    end
  end
  

• これによってエンジンがRailsアプリにマウントされる。
• isolate_namespaceは名前空間の分離に重要。
• appディレクトリは通常のRailsアプリと同じ構成。
• testディレクトリはエンジンのテストを行うための場所。
• test/dummyにテスト用のRailsアプリが存在。このアプリはtest/dummy/config/routes.rbで以下のようにマウントしている。

  Rails.application.routes.draw do
    mount Blorgh::Engine => "/blorgh"
  end
  

• test/integrationに統合テスト。test/modelsを作成しても良い。

エンジン機能を提供する†

Articleリソースの作成†

• scaffoldを実行。ネームスペース"blorgh"が追加されていることに注意。

  $ bundle exec rails generate scaffold article title:string text:text
        invoke  active_record
        create    db/migrate/20170313042107_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
  

• config/routes.rbが以下のように変更となる。

  Blorgh::Engine.routes.draw do
    resources :articles
  end
  

• コントローラー、ビュー、ヘルパーなども名前空間に分離されている。
• scaffoldで作成されたリソースファイルは、エンジンに適用されない。
• マイグレーション実行(Webサイトのようにbin/rails ではなくrakeでは？)

  bundle exec rake db:migrate

• test/dummyディレクトリでrailsアプリが起動できるようになる。

  bundle exec rails s

• 次のURLにアクセス。http://localhost:3000/blorgh/articles

  -エンジンルート/config/routes.rbに以下を追加
  root to: "articles#index"

• すると http://localhost:3000/blorgh/ でアクセスできる。

commentsリソースを作成する†

モデルの作成†

• エンジンのルートディレクトリでモデルのジェネレータを実行する。

  $ bundle exec bin/rails generate model Comment article_id:integer text:text
        invoke  active_record
        create    db/migrate/20170313044114_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
  

• マイグレーション実行。

  bundle exec rake db:migrate

• ビューの変更。app/views/blorgh/articles/show.html.erbを編集。Editリンクの前に以下を追加。

  <h3>Comments</h3>
  <%= render @article.comments %>
  

• app/models/blorgh/article.rbに追加。

  has_many :comments
  

• 記事を作成するためのフォームを作成。app/views/blorgh/articles/show.html.erbのrender @article.comments呼び出しの直後に以下の行を追加。

  <%= render "blorgh/comments/form" %>
  

• app/views/blorgh/commentsディレクトリに_form.html.erbを作成。

  <h3>New comment</h3>
  <%= form_for [@article, @article.comments.build] do |f| %>
    <p>
      <%= f.label :text %><br>
      <%= f.text_area :text %>
    </p>
    <%= f.submit %>
  <% end %>
  

• コメント用のルーティングを追加。config/routes.rbを編集。

  resources :articles do
    resources :comments
  end
  

コントローラーの作成†

• scaffoldの実行。

  $ bundle exec rails g controller comments
  Expected string default value for '--helper'; got true (boolean)
  Expected string default value for '--assets'; got true (boolean)
        create  app/controllers/blorgh/comments_controller.rb
        invoke  erb
         exist    app/views/blorgh/comments
        invoke  test_unit
        create    test/controllers/blorgh/comments_controller_test.rb
        invoke  helper
        create    app/helpers/blorgh/comments_helper.rb
        invoke    test_unit
        invoke  assets
        invoke    js
        create      app/assets/javascripts/blorgh/comments.js
        invoke    css
        create      app/assets/stylesheets/blorgh/comments.css
  

• app/controllers/blorgh/comments_controller.rbを編集

  require_dependency "blorgh/application_controller"
  
  module Blorgh
    class CommentsController < ApplicationController
      def create
        @article = Article.find(params[:article_id])
        @comment = @article.comments.create(comment_params)
        flash[:notice] = "Comment has been created!"
        redirect_to articles_path
      end
  
      private
      def comment_params
        params.require(:comment).permit(:text)
      end
    end
  end
  

• app/views/blorgh/comments/_comment.html.erbを作成。

  <%= comment_counter + 1 %>. <%= comment.text %>
  

作成†

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にコメント一覧とコメント追加用のフォームを追加する。