Рейки 3.1: Додаток двигуна проти монтажу

Чи може хтось допомогти мені зрозуміти відмінності між Rails Engine та програмою Mountable? У Rails 3.1 ви можете створити будь-який із командою "rails new plugin _ __ ".

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

Коли ви хочете використовувати один проти іншого? Я знаю, ви можете упакувати Двигун як дорогоцінний камінь, для одного. Хіба це не так для гірських додатків? Які ще існують відмінності?

Я помітив таке:

Повний двигун

З повноцінним двигуном батьківська програма успадковує маршрути від двигуна. Не потрібно нічого вказувати parent_app/config/routes.rb. Вказання дорогоцінного каміння в Gemfile достатньо, щоб батьківське додаток успадкувало моделі, маршрути тощо. Маршрути двигуна вказані як:

# 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 створить двигун, який розділяє простір імен основного додатка.

Відмінності проявлятимуться трьома способами:

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) Структура файлів для контролерів, помічників, представлень та ресурсів буде розділена на імена:

створити додаток / контролери / my_mountable_engine /application_controller.rb
створити додаток / помічники / my_mountable_engine /application_helper.rb
створити додаток / пошти створити додаток / моделі
створити додаток / види / макети / my_mountable_engine /application.html.erb
створити додаток / активи / образи / my_mountable_gine
створити додаток / активи / таблиці стилів / my_mountable_engine /application.css
створити додаток / активи / javascripts / my_mountable_engine /application.js
створити config / routes.rb створити lib / my_mountable_engine.rb
створити lib / task / my_mountable_engine.rake
створити lib / my_mountable .rb
створити lib / my_mountable_engine / engine.rb

Пояснення

Вигляд використання --fullопції, здається, дуже обмежений. Особисто я не можу придумати жодної вагомої причини, чому ви хочете відокремити свій код в двигуні, не виділяючи простору імен. Це, по суті, просто дасть вам два щільно поєднані програми, що обмінюються однаковими файловими структурами та всі конфлікти та витоки коду. що тягне за собою.

Кожна частина документації , яку я бачив демонструє --mountableваріант, і на самому справі поточний керівництво краю настійно рекомендує вам включити isolate namespace- що те ж саме , як кажуть використання --mountableбільш --full.

Нарешті, є термінологічна плутанина: На жаль, rails plugin -hпоказано такі описи:

[--фул] # Створіть рельсовий двигун із доданим пакетом Rails для тестування
[--mountable] # Створення ізольованого додатка, що монтується

Це створює враження, що ви використовуєте --fullдля створення "двигуна" та --mountableдля створення ще чогось, що називається "монтується додаток", адже насправді вони обидва двигуна - один з просторами імен, а один - ні. Це неодмінно призведе до плутанини, оскільки користувачі, які прагнуть створити двигун, ймовірно, припускають, що --fullце більш релевантний варіант.

Висновок

• rails plugin new something --full= Двигун у просторі імен додатка. (Чому б ти?)
• rails plugin new something --mountable= Двигун із власним простором імен. (Awesome)

Список літератури

• 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

Я розумію різницю в тому, що двигуни схожі на плагіни та додають функціональність існуючим програмам. Хоча програми для монтажу по суті є додатком, і вони можуть стояти окремо.

Отже, якщо ви хочете мати можливість запустити його самостійно або в іншому додатку, ви зробите додаток, який можна встановити. Якщо ви маєте намір зробити це доповненням до існуючих додатків, але не запущеним самим, ви зробите це двигуном.

Я вважаю, що різниця полягає в тому, що додаткове програмне забезпечення є ізольованим від хост-програми, тому вони не можуть ділитися класами - моделями, помічниками тощо. Це пов’язано з тим, що додаток Mountable є кінцевою точкою Rack (тобто додатком Rack сам по собі ).

Відмова: Я, як і більшість, тільки що почав грати з Rails 3.1.