Rails 3.1: silnik a aplikacja do montażu

Obie opcje wygenerują silnik . Różnica polega na tym, że --mountable utworzy silnik w izolowanej przestrzeni nazw, podczas gdy --full utworzy silnik, który dzieli przestrzeń nazw głównej aplikacji.

Różnice przejawiać się będą na 3 sposoby:

1) plik klasy silnika wywoła 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) Na plik config/routes.rb silnika zostanie umieszczony w przestrzeni nazw:

Pełny silnik:

Rails.application.routes.draw do
end

Zamontowany silnik:

MyMountableEngine::Engine.routes.draw do
end

3) struktura plików dla kontrolerów, helperów, widoków i zasobów będzie miała przestrzeń nazw:

Utwórz aplikację / Kontrolery / my_mountable_engine/application_controller.rb
tworzenie aplikacji / helpers / my_mountable_engine / application_helper.rb
tworzenie aplikacji / mailerów tworzenie aplikacji / modeli
Utwórz app/views/layouts / my_mountable_engine / application.html.erb
tworzenie aplikacji / aktywów / obrazy / my_mountable_engine
tworzenie aplikacji / zasobów / arkuszy stylów / my_mountable_engine /Aplikacja.css
create app/assets/javascripts/my_mountable_engine / application.js
Utwórz Config / routes.RB create lib / my_mountable_engine.rb
Utwórz lib / tasks / my_mountable_engine.grabie
Utwórz lib / my_mountable_engine / version.rb
Utwórz lib / my_mountable_engine / engine.rb

Wyjaśnienie

Przypadek użycia opcji --full wydaje się być bardzo ograniczony. Osobiście nie mogę wymyślić żadnego dobrego powodu, dla którego chciałbyś oddzielić swój kod w silnik bez izolowania przestrzeni nazw - w zasadzie dałoby to po prostu dwie ściśle powiązane aplikacje dzielące identyczne struktury plików i wszystkie konflikty i wyciek kodu, które pociągają za sobą.

Każdy kawałek dokumentacji, który widziałem pokazuje opcję --mountable i rzeczywiście obecny przewodnik Edge guide zdecydowanie zachęca do włączenia isolate namespace - co jest tym samym, co użycie --mountable nad --full.

W końcu jest zamieszanie terminologiczne: niestety rails plugin -h pokazuje następujące opisy:

[--full] # Wygeneruj silnik rails z dołączoną aplikacją Rails do testów
[--mountable] # Wygeneruj izolowaną aplikację do montowania

To daje wrażenie, że używasz --full do tworzenia "silnika" i --mountable do tworzenia czegoś innego o nazwie "aplikacja montowalna", podczas gdy w rzeczywistości są to oba silniki - jeden w przestrzeni nazw, a drugi nie. Może to prowadzić do nieporozumień, ponieważ użytkownicy chcący stworzyć silnik prawdopodobnie będą zakładać, że --full jest bardziej odpowiednią opcją.

Podsumowanie

• rails plugin new something --full = silnik w przestrzeni nazw aplikacji. (Dlaczego?)
• rails plugin new something --mountable = silnik z własną przestrzenią nazw. (Awesome)

Referencje

• 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

Zastanawiałam się nad tym samym i dlatego wylądowałam tutaj. wydaje mi się, że wcześniejsze odpowiedzi zasadniczo obejmują pytanie, ale pomyślałem, że następujące mogą również pomóc: {]}

# 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

Szczególnie interesujący (dla mnie) jest fakt, że nie ma różnicy między

rails plugin new test-plugin -T --mountable

I

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

Rozumiem różnicę, że silniki są jak wtyczki i dodają funkcjonalność do istniejących aplikacji. Podczas gdy aplikacje do montażu są zasadniczo aplikacją i mogą być samodzielne.

Więc jeśli chcesz być w stanie uruchomić go samodzielnie lub w innej aplikacji, można zrobić aplikację montowalną. Jeśli chcesz, aby był on dodatkiem do istniejących aplikacji, ale nie był uruchamiany samodzielnie, uczynisz go silnikiem.

Różnica, jak sądzę, jest taka, że aplikacje montowalne są odizolowane od aplikacji hosta, więc nie mogą udostępniać klas-modeli, helperów itp. Dzieje się tak, ponieważ aplikacja do montażu jest punktem końcowym Szafy Rack (tzn. sama aplikacja Rack).

Disclaimer: jak większość, dopiero zacząłem bawić się Rails 3.1.