Rails 3.1：エンジンとマウント可能なアプリ

Rails EngineとMountableアプリの違いを理解するのを手伝ってくれる人はいますか？Rails 3.1では、「rails new plugin _ __」コマンドを使用していずれかを作成できます。

rails plugin new forum --full        # Engine
rails plugin new forum --mountable   # Mountable App

どちらを使いたいですか？Engineをgemとしてパッケージ化できることは知っています。マウント可能なアプリの場合はそうではありませんか？他にどんな違いがありますか？

私は次のことに気づきました：

フルエンジン

完全なエンジンでは、親アプリケーションはエンジンからルートを継承します。で何も指定する必要はありませんparent_app/config/routes.rb。Gemfileでgemを指定するだけで、親アプリがモデルやルートなどを継承できます。エンジンルートは次のように指定されます。

# my_engine/config/routes.rb 
Rails.application.routes.draw do 
  # whatever 
end 

モデル、コントローラーなどの名前空間はありません。これらは、親アプリケーションからすぐにアクセスできます。

搭載可能なエンジン

エンジンの名前空間はデフォルトで分離されています。

# my_engine/lib/my_engine/engine.rb
module MyEngine 
  class Engine < Rails::Engine 
    isolate_namespace MyEngine 
  end 
end

マウント可能なエンジンを使用すると、ルートに名前空間が付けられ、親アプリはこの機能を単一のルートにバンドルできます。

# my_engine/config/routes.rb 
MyEngine::Engine.routes.draw do 
  #whatever 
end 

# parent_app/config/routes.rb 
ParentApp::Application.routes.draw do 
    mount MyEngine::Engine => "/engine", :as => "namespaced" 
end 

モデル、コントローラーなどは親アプリケーションから分離されていますが、ヘルパーは簡単に共有できます。

これらは私が見つけた主な違いです。おそらく他にありますか？私はここに尋ねましたが、返答はまだありません。

私の印象は、完全なエンジンはそれ自体を親アプリケーションから分離しないので、親アプリケーションに隣接するスタンドアロンアプリケーションとして最適に使用されるということです。名前の衝突が発生する可能性があると思います。

マウント可能なエンジンは、名前の競合を回避し、親アプリケーションの特定のルートの下にエンジンをバンドルする場合に使用できます。たとえば、顧客サービス用に設計された最初のエンジンの構築に取り組んでいます。親アプリケーションは、次のような単一のルートで機能をバンドルできます。

mount Cornerstone::Engine => "/cornerstone", :as => "help" 

私が想定から外れている場合は、誰かに知らせてください。この応答を修正します。私はここで主題についての小さな記事を作りました 乾杯！

どちらのオプションでもエンジンが生成されます。違いは--mountable、分離された名前空間に--fullエンジンを作成するのに対し、メインアプリの名前空間を共有するエンジンを作成することです。

違いは3つの方法で明らかになります。

1）エンジンクラスファイルは以下を呼び出しますisolate_namespace。

lib / my_full_engine / engine.rb：

module MyFullEngine
  class Engine < Rails::Engine
  end
end

lib / my_mountable_engine / engine.rb：

module MyMountableEngine
  class Engine < Rails::Engine
    isolate_namespace MyMountableEngine # --mountable option inserted this line
  end
end

2）エンジンのconfig/routes.rbファイルには名前空間が付けられます。

フルエンジン：

Rails.application.routes.draw do
end

搭載エンジン：

MyMountableEngine::Engine.routes.draw do
end

3）コントローラー、ヘルパー、ビュー、およびアセットのファイル構造には名前空間が付けられます。

create app / controllers / my_mountable_engine /application_controller.rb
create app / helpers / my_mountable_engine /application_helper.rb
create app / mailers create app / models
create app / views / layouts / my_mountable_engine /application.html.erb
create app / assets / images / my_mountable_engine
create app / assets / stylesheets / my_mountable_engine /application.css
create app / assets / javascripts / my_mountable_engine /application.js
create config / routes.rb create lib / my_mountable_engine.rb
create lib / tasks / my_mountable_engine.rake
create lib / my_mountable_engine / version .rb
lib / my_mountable_engine / engine.rbを作成します。

説明

--fullオプションのユースケースは非常に限られているようです。個人的には、名前空間も分離せずにコードをエンジンに分離したい理由は考えられません-基本的に、同じファイル構造とすべての競合とコード漏洩を共有する2つの密結合アプリケーションを提供するだけです。それが必要です。

私が見たすべてのドキュメンテーションは--mountableオプションを示しており、実際、現在のエッジガイドは含めることを強く推奨していますisolate namespace-これはuse --mountableover と言うのと同じ--fullです。

最後に、用語の混乱があります。残念ながらrails plugin -h、次の説明が表示されます。

[--full]＃テスト用にRailsアプリケーションがバンドルされたRails エンジンを生成します
[--mountable]＃マウント可能な分離アプリケーションを生成します

これにより、--full「エンジン」--mountableを作成し、「マウント可能なアプリケーション」と呼ばれる何かを作成するために使用するような印象を与えます。エンジンの作成を検討しているユーザー--fullは、これがより適切なオプションであると想定する可能性が高いため、混乱を招く可能性があります。

結論

• rails plugin new something --full=アプリの名前空間のエンジン。（なぜあなたは？）
• rails plugin new something --mountable=独自の名前空間を持つエンジン。（驚くばかり）

参考文献

• http://edgeguides.rubyonrails.org/engines.html
• http://api.rubyonrails.org/classes/Rails/Engine.html
• http://railscasts.com/episodes/277-mountable-engines
• https://github.com/rails/rails/pull/6499

私は同じことを考えていたので、ここで終わりました。以前の回答は基本的に質問をカバーしているように思えますが、次のことも役立つと思いました：

# generate plugins (NOTE: using same name each time to minimize differences)
# -----------------------------------------------------------------------------

$ rails plugin new test-plugin -T
$ mv test-plugin{,.01}

$ rails plugin new test-plugin -T --mountable
$ mv test-plugin{,.02}

$ rails plugin new test-plugin -T --full
$ mv test-plugin{,.03}

$ rails plugin new test-plugin -T --full --mountable
$ mv test-plugin{,.04}




# compare "stock" (01) with "mountable" (02)
# -----------------------------------------------------------------------------

$ diff -r test-plugin.01 test-plugin.02

Only in test-plugin.02: app
Only in test-plugin.02: config
Only in test-plugin.02/lib/test-plugin: engine.rb
diff -r test-plugin.01/lib/test-plugin.rb test-plugin.02/lib/test-plugin.rb
0a1,2
> require "test-plugin/engine"
> 
Only in test-plugin.02: script
diff -r test-plugin.01/test-plugin.gemspec test-plugin.02/test-plugin.gemspec
18a19
>   # s.add_dependency "jquery-rails"




# compare "stock" (01) with "full" (03)
# -----------------------------------------------------------------------------

$ diff -r test-plugin.01 test-plugin.03
Only in test-plugin.03: app
Only in test-plugin.03: config
Only in test-plugin.03/lib/test-plugin: engine.rb
diff -r test-plugin.01/lib/test-plugin.rb test-plugin.03/lib/test-plugin.rb
0a1,2
> require "test-plugin/engine"
> 
Only in test-plugin.03: script
diff -r test-plugin.01/test-plugin.gemspec test-plugin.03/test-plugin.gemspec
18a19
>   # s.add_dependency "jquery-rails"




# compare "mountable" (02) with "full" (03)
# -----------------------------------------------------------------------------

$ diff -r test-plugin.02 test-plugin.03

Only in test-plugin.03/app/assets/javascripts/test-plugin: .gitkeep
Only in test-plugin.02/app/assets/javascripts/test-plugin: application.js
Only in test-plugin.03/app/assets/stylesheets/test-plugin: .gitkeep
Only in test-plugin.02/app/assets/stylesheets/test-plugin: application.css
Only in test-plugin.03/app/controllers: .gitkeep
Only in test-plugin.02/app/controllers: test-plugin
Only in test-plugin.03/app/helpers: .gitkeep
Only in test-plugin.02/app/helpers: test-plugin
Only in test-plugin.03/app/mailers: .gitkeep
Only in test-plugin.03/app/models: .gitkeep
Only in test-plugin.03/app/views: .gitkeep
Only in test-plugin.02/app/views: layouts
diff -r test-plugin.02/config/routes.rb test-plugin.03/config/routes.rb
1c1
< TestPlugin::Engine.routes.draw do
---
> Rails.application.routes.draw do
diff -r test-plugin.02/lib/test-plugin/engine.rb test-plugin.03/lib/test-plugin/engine.rb
3d2
<     isolate_namespace TestPlugin




# compare "mountable" (02) with "full & mountable" (04)
# -----------------------------------------------------------------------------

$ diff -r test-plugin.02 test-plugin.04

<no difference>




# compare "full" (03) with "full & mountable" (04)
# -----------------------------------------------------------------------------

$ diff -r test-plugin.03 test-plugin.04

Only in test-plugin.03/app/assets/javascripts/test-plugin: .gitkeep
Only in test-plugin.04/app/assets/javascripts/test-plugin: application.js
Only in test-plugin.03/app/assets/stylesheets/test-plugin: .gitkeep
Only in test-plugin.04/app/assets/stylesheets/test-plugin: application.css
Only in test-plugin.03/app/controllers: .gitkeep
Only in test-plugin.04/app/controllers: test-plugin
Only in test-plugin.03/app/helpers: .gitkeep
Only in test-plugin.04/app/helpers: test-plugin
Only in test-plugin.03/app/mailers: .gitkeep
Only in test-plugin.03/app/models: .gitkeep
Only in test-plugin.03/app/views: .gitkeep
Only in test-plugin.04/app/views: layouts
diff -r test-plugin.03/config/routes.rb test-plugin.04/config/routes.rb
1c1
< Rails.application.routes.draw do
---
> TestPlugin::Engine.routes.draw do
diff -r test-plugin.03/lib/test-plugin/engine.rb test-plugin.04/lib/test-plugin/engine.rb
2a3
>     isolate_namespace TestPlugin

（私にとって）特に興味深いのは、

rails plugin new test-plugin -T --mountable

そして

rails plugin new test-plugin -T --full --mountable

違いを理解すると、エンジンはプラグインのようなものであり、既存のアプリケーションに機能を追加します。マウント可能なアプリは基本的にアプリケーションであり、スタンドアロンで使用できます。

したがって、それを単独で、または別のアプリケーション内で実行したい場合は、マウント可能なアプリを作成します。既存のアプリケーションへの追加を意図しているが、それ自体では実行しない場合は、それをエンジンにします。

違いは、マウント可能なアプリはホストアプリから分離されているため、クラス、モデル、ヘルパーなどを共有できないことです。これは、マウント可能なアプリがラックエンドポイント（つまり、独自のラックアプリ）であるためです。 ）。

免責事項：私は、ほとんどのように、Rails 3.1をいじったばかりです。