Rails Engines
- 1. Rails Model Engine Framework A framework for Rails applications sharing a common data model engine Rails Meetup May 20, 2014 Jonathan Kolyer [email protected]
- 2. Framework • Data Engine: Rails engine with namespaced data model • Web: Rails app for web views • API: Rails app for API only • Admin: Rails app for management • Services: Backend, asynchronous services • Env: Bash scripts for environment, deployment, etc.
- 3. Motivation • Separation of Concerns • Many > 1 • Framework for scaling the codebase • Testing & Deployment considerations
- 4. Connect the Dots • One github repo • Engine oil: bash scripts • Symlinks are your friend: database.yml, initializers, configuration • Gemfile sharing
- 5. Engine Sample Model Structure: module namespacing • payments_engine • account • media • notify • Example: PaymentsEngine::Account::User, PaymentsEngine::Media::Photo Linking Apps • /engine • app/models/payments_engine • /api • config • ../../payments_engine/config/database.yml • Gemfile • gem ‘payments_engine’, :path => ‘../payments_engine’ • eval(IO.read(“#{File.dirname(__FILE_)/../ payments_engine/Gemfile”), binding) • Run migrations in the services rails app
- 6. Environment • Bash scripts: navigation, deployment, shortcuts • Load from $HOME/.bashrc • env.bash: root script; sources other scripts • rails.bash: open console; run server; rake tasks • db.bash: db shell; run migrations • env_{development, test, production}.bash • services.bash: daemon mgmt; logging
- 7. Web / API • Standard web-view / RESTful hosted app(s) • Shares auth logic • Differing performance characteristics
- 8. Admin • Dedicated Rails app for administrative data access • ActiveAdmin gem • Internal use only
- 9. Services • Asynchronous back-end services • cron jobs • batch jobs • Data migrations • Rails or non-Rails