railties @ ruby mastersconf - 2011.02.26

Carlos Antonio @cantoniodasilvablog.plataformatec.com.br

RAILTIESOU

COMO DESENVOLVER PLUGINS/GEMS PARA RAILS

Sunday, November 6, 11

http://blog.plataformatec.com



$ WHOAMI





CARLOS ANTONIO DA SILVA

@cantoniodasilva





COMECEI COM DESENVOLVIMENTO EM 2003

E COM RUBY E RAILS EM 2007





TRABALHO NA





DEVISE





SIMPLE_FORM





RESPONDERS





THE ROAD SO FAR

RAILS 2.3





RAILS 2.3

Já possuía a estrutura de Rails Engine.





RAILS 2.3


Mas...





RAILS 2.3


Mas... podemos dizer que era uma boa “gambiarra”.





RAILS 2.3

http://thereifixedit.files.wordpress.com/2011/02/white-trash-repairs-traveling-for-kludgers.jpg




https://github.com/rails/rails/blob/2-3-stable/railties/lib/rails/plugin.rb



RAILS 2.3

module Rails class Plugin

# Engines are plugins with an app/ directory. def engine? has_app_directory? end private

def has_app_directory? File.directory?(File.join(directory, 'app')) end endend








RAILS 2.3

Diretórios como app/[models|controllers|helpers] e as rotas eram automaticamente carregados.





RAILS 2.3

Diretórios como app/[models|controllers|helpers] e as rotas eram automaticamente carregados.

Mas eram fixos, não existia a possibilidade de nenhuma configuração de paths.





RAILS 2.3module Rails class Plugin

def view_path File.join(directory, 'app', 'views') end

def controller_path File.join(directory, 'app', 'controllers') end

def routing_file File.join(directory, 'config', 'routes.rb') end

private def app_paths [ File.join(directory, 'app', 'models'), File.join(directory, 'app', 'helpers'), controller_path, metal_path ] end endend








RAILS 2.3

Tínhamos ORMs diferentes “integradas” ao Rails, como o Datamapper e o MongoMapper...





RAILS 2.3

Tínhamos ORMs diferentes “integradas” ao Rails, como o Datamapper e o MongoMapper...

Que poderiam quebrar a cada novo patch release do Rails.





RAILS 2.3

Não existia uma API pública definida para outros frameworks se integrarem.





RAILS 2.3

Não existia uma API pública definida para outros frameworks se integrarem.

A solução: alias method chain / monkey patch.





RAILS 2.3

http://thereifixedit.files.wordpress.com/2011/02/white-trash-repairs-you-spoiled-your-sweet-ride.jpg







RAILS 2.3

O Rails sabia da existência do ActiveRecord...





RAILS 2.3

O Rails sabia da existência do ActiveRecord...

Pois era ele o responsável por inicializar o ActiveRecord e os demais frameworks.





RAILS 2.3

Isso quer dizer que, por mais que você estivesse utilizando o DataMapper ou MongoMapper, por

exemplo, o ActiveRecord sempre estaria lá.





RAILS 2.3module Rails class Initializer # Requires all frameworks specified by the Configuration#frameworks # list. By default, all frameworks (Active Record, Active Support, # Action Pack, Action Mailer, and Active Resource) are loaded. def require_frameworks configuration.frameworks.each { |framework| require(framework.to_s) } end

def load_observers if gems_dependencies_loaded && configuration.frameworks.include?(:active_record) ActiveRecord::Base.instantiate_observers end end

def initialize_database if configuration.frameworks.include?(:active_record) ActiveRecord::Base.configurations = configuration.database_configuration ActiveRecord::Base.establish_connection end end endend





RAILS 2.3

module Rails class Configuration

private

def default_frameworks [ :active_record, :action_controller, :action_view, :action_mailer, :active_resource ] end

endend





SINGLERESPONSIBILITY

PRINCIPLE

RAILS 2.3





RAILS 2.3





NOW

RAILS 3





RAILS 3

Modularidade.

API pública e bem definida.





RAILS 3

HOOKS!

http://www.flickr.com/photos/ooh_food/3304708302/







RAILS 3

O Rails não conhece o ActiveRecord.





RAILS 3

O Rails não conhece o ActiveRecord.

O ActiveRecord é quem conta para o Rails como ele deve ser inicializado.





RAILS 3

E isso acontece com todos os outros frameworks.





RAILS 3

E isso acontece com todos os outros frameworks.

ActiveRecord

ActionMailer

ActionController

ActionView

ActiveResource





RAILS 3

E isso acontece com todas as demais gems/plugins que se integram com o Rails.





RAILS 3

E isso acontece com todas as demais gems/plugins que se integram com o Rails.

DataMapper

Devise

RSpec

Mongoid

outros...





EXEMPLO REAL???





WTF???

module ActiveRecord class Railtie < Rails::Railtie config.active_record = ActiveSupport::OrderedOptions.new

config.generators.orm :active_record, :migration => true, :timestamps => true

config.app_middleware.insert_after "::ActionDispatch::Callbacks", "ActiveRecord::QueryCache"

rake_tasks do load "active_record/railties/databases.rake" end

console do ActiveRecord::Base end

initializer "active_record.logger" do ActiveSupport.on_load(:active_record) { self.logger ||= ::Rails.logger } end

config.after_initialize do ActiveSupport.on_load(:active_record) do instantiate_observers # .... end end endend

https://github.com/rails/rails/tree/3-0-stable/activerecord







SINGLERESPONSIBILITY

PRINCIPLE

RAILS 3





RAILS 3

WIN!!!http://www.flickr.com/photos/simoncopping/5050597808/




http://www.flickr.com/photos/simoncopping/5050597808/

http://www.flickr.com/photos/simoncopping/5050597808/


Railties

WTF???





Railties

WTF???WTF???





RailtiesWTF???





RailtiesWTF???

Engine





RailtiesWTF???

Application Engine





RailtiesWTF???

Application

Initialization

Engine





RailtiesWTF???

Application

Initialization

Engine

Generators





RailtiesWTF???

Application

Initialization

Engine

Generators

HOOKSSunday, November 6, 11




WTF???CONFIGURAÇÃO





WTF???

CONFIGURAÇÃO

https://github.com/plataformatec/responders

module Responders class Railtie < ::Rails::Railtie

config.responders = ActiveSupport::OrderedOptions.new

# Na configuração da app (application.rb): # config.responders.flash_keys = [:notice, :failure] endend




https://github.com/mongoid/mongoid



WTF???GENERATORS





WTF???

GENERATORS

module MyGem class Railtie < ::Rails::Railtie

generators do require "my_gem/generator" end

endend





WTF???

GENERATORS

Preciso realmente adicionar na Railtie?





WTF???

GENERATORS

Preciso realmente adicionar na Railtie?

Não, se você seguir a convenção.





WTF???

GENERATORS

https://github.com/plataformatec/simple_form

simple_form lib generators simple_form install_generator.rb templates simple_form.rb

rails generate simple_form:install







WTF???

GENERATORS


simple_form lib generators simple_form install_generator.rb templates simple_form.rb

Namespace

Generator








WTF???

GENERATORS

http://guides.rubyonrails.org/generators.html

module SimpleForm module Generators class InstallGenerator < Rails::Generators::Base desc "Copy SimpleForm default files" source_root File.expand_path('../templates', __FILE__)

def copy_initializers copy_file 'simple_form.rb', 'config/initializers/simple_form.rb' end end endend








WTF???

GENERATORS

Siga as convenções.

http://www.flickr.com/photos/jasonteale/1340004498/







WTF???

GENERATORS

Siga as convenções.

E você será mais feliz =).








WTF???GENERATORS - HOOKS





WTF???

GENERATORS - ORM


module Rails module Mongoid class Railtie < Rails::Railtie

config.generators.orm :mongoid, :migration => false

end endend







WTF???

GENERATORS - TEST FRAMEWORK

https://github.com/rspec/rspec-rails

module Rails module RSpec class Railtie < Rails::Railtie

config.generators.test_framework :rspec

end endend







WTF???

GENERATORS - TEMPLATE ENGINE

https://github.com/nex3/haml

module Rails module Haml class Railtie < Rails::Railtie

config.generators.template_engine :haml

end endend







WTF???

GENERATORS - MAIS OPÇÕES?

https://github.com/rails/rails/blob/3-0-stable/railties/lib/rails/generators.rb

:helper => true,:orm => nil,:integration_tool => nil,:performance_tool => nil,:resource_controller => :controller,:scaffold_controller => :scaffold_controller,:stylesheets => true,:test_framework => nil,:template_engine => :erb







WTF???RAKE TASKS





WTF???

RAKE TASKS

module Rails module RSpec class Railtie < Rails::Railtie

rake_tasks do load "rspec/rails/tasks/rspec.rake" end

end endend





WTF???CONSOLE





WTF???

CONSOLE

module ActiveRecord class Railtie < Rails::Railtie

# Forçar o carregamento do # ActiveRecord com o console. console do ActiveRecord::Base end endend





WTF???

INITIALIZATION HOOKS

http://www.flickr.com/photos/mattbrett/224471090/







WTF???


module MyGem class Railtie < Rails::Railtie

config.before_configuration { # Roda após criar a classe da Aplicação, mas # antes de rodar as configurações do usuário. }

endend





WTF???



config.before_initialize { # Roda depois da configuração do usuário, mas # antes dos initializers. }

endend





WTF???



config.to_prepare { # Roda antes de cada request em development, e # antes da primeira request em production. }

endend





WTF???



config.before_eager_load { # Roda antes do Rails carregar todo o código # da aplicação. Isso só acontece com a opção # :cache_classes habilitada (production). }

endend





WTF???



config.after_initialize { # Roda após a inicialização do Rails, # configurações do usuário e initializers, e o # próprio bloco to_prepare. É executado apenas # uma única vez, antes da primeira requisição. }

endend





WTF???

Development

before_configuration=> Booting WEBrickbefore_initializeto_prepareafter_initialize[...] INFO WEBrick 1.3.1

to_prepareRequest...to_prepareRequest...to_prepare

Production (cache_classes)

before_configuration=> Booting WEBrickbefore_initializeto_preparebefore_eager_loadafter_initialize[...] INFO WEBrick 1.3.1

Request...Request...






WTF???INITIALIZERS





WTF???

INITIALIZERS

module CarrierWave class Railtie < Rails::Railtie

# Initializers “customizados” initializer "carrierwave.setup_paths" do CarrierWave.root = Rails.root.join(Rails.public_path).to_s end

endend

https://github.com/jnicklas/carrierwave







WTF???

INITIALIZERS


# Temos acesso ao objeto app para # obter as configs do usuário. initializer "my_gem.setup" do |app| # app.config end

endend





WTF???FRAMEWORK LOADING





WTF???

FRAMEWORK LOADING

# Cada módulo avisa através do ActiveSupport# quando é carregado.

ActiveSupport.run_load_hooks( :active_record, ActiveRecord::Base)





WTF???

FRAMEWORK LOADING

# E podemos executar código neste exato# momento, dentro do contexto do que está# sendo carregado.

ActiveSupport.on_load(:active_record) do include MyGem::ActiveRecordExtensionsend

ActiveSupport.on_load(:action_controller) do include MyGem::ActionControllerExtensionsend





E O QUE EU FAÇO COM ESSE NEGÓCIO DE

FRAMEWORK LOADING?





WTF???

FRAMEWORK LOADING + INITIALIZERS

module Devise class Engine < ::Rails::Engine

initializer "devise.url_helpers" do ActiveSupport.on_load(:action_controller) do include Devise::Controllers::Helpers include Devise::Controllers::UrlHelpers end end

endend

https://github.com/plataformatec/devise







WTF???

FRAMEWORK LOADING

E você pode criar o seu hook.

ActiveSupport.run_load_hooks(:my_gem, MyGem)

ActiveSupport.on_load(:my_gem) do end





WTF???COMO EU CRIO UMA

RAILS::RAILTIE???





WTF???

RAILS::RAILTIE => COMO?

module MyGem class Railtie < ::Rails::Railtie # Acabamos de criar nossa railtie.

endend





WTF???E QUANDO EU REALMENTE

PRECISO DE UMA RAILS::RAILTIE???





WTF???

RAILS::RAILTIE => QUANDO?

• Precisar carregar generators em outro diretório;

• Precisar de rake tasks disponíveis na aplicação;• Precisar executar código ao carregar o console;

• Precisar rodar código no momento de inicialização de seu plugin/gem, como um initializer do Rails;

• Precisar extender as funcionalidades de algum dos frameworks;





EXEMPLO REAL???





WTF???

module Responders class Railtie < ::Rails::Railtie config.responders = ActiveSupport::OrderedOptions.new config.generators.scaffold_controller = :responders_controller

# Add load paths straight to I18n, so engines and application can overwrite it require 'active_support/i18n' I18n.load_path << File.expand_path('../responders/locales/en.yml', __FILE__)

initializer "responders.flash_responder" do |app| if app.config.responders.flash_keys Responders::FlashResponder.flash_keys = app.config.responders.flash_keys end end endend

https://github.com/plataformatec/responders







Rails::EngineWTF???

Rails::Railtie + Paths + Autoload





WTF???

app/controllersapp/helpersapp/mailersapp/modelsapp/viewsconfig/initializers/*.rbconfig/routes.rbconfig/locales/*.{rb,yml}liblib/tasks/*.rake

RAILS::ENGINE





WTF???

Carrega automaticamente controllers, helpers, models, mailers e views dentro do

diretório app/.

O arquivo de rotas, initializers e locales são detectados e carregados quando em config/, seguindo a mesma estrutura da aplicação.

RAILS::ENGINE





WTF???

O diretório lib é adicionado ao autoload_path do Rails.

Os arquivos lib/tasks/*.rake são automaticamente carregados, basta

seguir esta convenção.

RAILS::ENGINE





WTF???

O que não é carregado automaticamente pela Engine:

migrations e assets na pasta public (javascripts, stylesheets, etc).

RAILS::ENGINE





WTF???

RAILS::ENGINE

module MyGem class Engine < ::Rails::Engine

# Você pode alterar os load_paths padrão. paths.app.controllers << "lib/controllers"

endend





WTF???COMO EU CRIO UMA

RAILS::ENGINE???





WTF???

RAILS::ENGINE => COMO?

module MyGem class Engine < ::Rails::Engine # Acabamos de criar nossa engine.

endend





WTF???E QUANDO EU PRECISO DE UMA

RAILS::ENGINE???





WTF???

RAILS::ENGINE => QUANDO?

• Suas extensões precisarem de: rotas, controllers, views ou mailers, por exemplo.





EXEMPLO REAL???





WTF???

module Devise class Engine < ::Rails::Engine config.devise = Devise

# Initialize Warden and copy its configurations. config.app_middleware.use Warden::Manager do |config| Devise.warden_config = config end

# Force routes to be loaded if we are doing any eager load. config.before_eager_load { |app| app.reload_routes! }

initializer "devise.url_helpers" do Devise.include_helpers(Devise::Controllers) end

initializer "devise.omniauth" do |app| Devise.omniauth_configs.each do |provider, config| app.middleware.use config.strategy_class, *config.args do |strategy| config.strategy = strategy end end

if Devise.omniauth_configs.any? Devise.include_helpers(Devise::OmniAuth) end end endend

https://github.com/plataformatec/devise







Rails::PluginWTF???

Rails::Engine + interno ao Rails





WTF???

Engine com alguns conhecimentos extras para carregar os plugins.

RAILS::PLUGIN





WTF???

Engine com alguns conhecimentos extras para carregar os plugins.

E você ganha de brinde a habilidade do Rails de carregar o arquivo

“init.rb” no diretório root do plugin.

RAILS::PLUGIN





WTF???

RAILS::PLUGIN

Cada plugin em vendor/plugins é carregado pelo Rails como um Rails::Plugin.





WTF???

RAILS::PLUGIN

Cada plugin em vendor/plugins é carregado pelo Rails como um Rails::Plugin.

Isto quer dizer que não é possível colocar uma Engine dentro de vendor/plugins, porque

os arquivos seriam carregados duas vezes.





WTF???COMO EU CRIO UM

RAILS::PLUGIN???





WTF???

RAILS::PLUGIN => COMO?

rails plugin installrails server





WTF???E QUANDO EU PRECISO DE UM

RAILS::PLUGIN???





WTF???

RAILS::PLUGIN => QUANDO?

Nunca. Lembre-se: é interno ao Rails.





Rails::ApplicationWTF???

Rails::Engine + App Bootstrap





WTF???

Engine com super powers e a responsabilidade de coordenar o processo de inicialização da app.

RAILS::APPLICATION





WTF???

Engine com super powers e a responsabilidade de coordenar o processo de inicialização da app.

Inicializa railties, engines e plugins.

RAILS::APPLICATION





WTF???

Possui as configurações relativas a aplicação, como o “cache_classes”.

RAILS::APPLICATION





WTF???

Possui as configurações relativas a aplicação, como o “cache_classes”.

Carrega e recarrega as rotas quando necessário, e constrói a estrutura de

middlewares da aplicação.

RAILS::APPLICATION





WTF???

Highlander!

RAILS::APPLICATION





WTF???

Highlander!

RAILS::APPLICATION

raise "You cannot have more than one Rails::Application" if Rails.application

https://github.com/rails/rails/blob/3-0-stable/railties/lib/rails/application.rb







WTF???COMO EU CRIO UMA RAILS::APPLICATION???





WTF???

RAILS::APPLICATION => COMO?

rails new my_appcd my_apprails server





RESUMO





SIMPLE_FORM





SIMPLE_FORM

Não é uma Rails::Application.





SIMPLE_FORM

Não é uma Rails::Application.Não é um Rails::Plugin.





SIMPLE_FORM


(a não ser que seja instalado como tal)





SIMPLE_FORM



Não é uma Rails::Engine.





SIMPLE_FORM



Não é uma Rails::Engine.Não é uma Rails::Railtie.





SIMPLE_FORM

Nenhum hook é necessário, podemos apenas utilizar a

estratégia de framework loading sem precisar de uma Rails::Railtie.





RESPONDERS





RESPONDERS



Não é uma Rails::Engine.





RESPONDERS



Não é uma Rails::Engine.É uma Rails::Railtie.





RESPONDERS

Permite configuração através do objeto :config;Utiliza alguns hooks de inicialização;

Sobrescreve o :scaffold_generator para utilizar o seu próprio.





DEVISE





DEVISE


(e NÃO DEVE ser instalado como tal)





DEVISE


(e NÃO DEVE ser instalado como tal)

É uma Rails::Engine e por consequência uma Rails::Railtie.





DEVISE

Permite configuração através do objeto :config;Utiliza alguns hooks de inicialização;

Adiciona middlewares;Possui funções similares a uma aplicação, com

controllers, helpers, mailers, views e rotas, mas não é capaz de rodar isoladamente.





CRIANDO UMA GEM





BUNDLER





BUNDLER

bundle gem ruby_masters





BUNDLE GEM

Cria a estrutura de diretórios basica da gem.

Cria um arquivo Rakefile carregando tarefas do próprio Bundler.

Inicializa um repositório git.





BUNDLE GEM

~/Projects [ree-1.8.7@rubymasters] $ bundle gem ruby_masters create ruby_masters/Gemfile create ruby_masters/Rakefile create ruby_masters/.gitignore create ruby_masters/ruby_masters.gemspec create ruby_masters/lib/ruby_masters.rb create ruby_masters/lib/ruby_masters/version.rbInitializating git repo in ~/Projects/ruby_masters





BUNDLE GEM

Gemfile

source "http://rubygems.org"

# Specify your gem's dependencies in ruby_masters.gemspecgemspec




http://rubygems.org

http://rubygems.org


BUNDLE GEM

Rakefile

require 'bundler'Bundler::GemHelper.install_tasks





BUNDLE GEM

# -*- encoding: utf-8 -*-$:.push File.expand_path("../lib", __FILE__)require "ruby_masters/version"

Gem::Specification.new do |s| s.name = "ruby_masters" s.version = RubyMasters::VERSION s.platform = Gem::Platform::RUBY s.authors = ["TODO: Write your name"] s.email = ["TODO: Write your email address"] s.homepage = "" s.summary = %q{TODO: Write a gem summary} s.description = %q{TODO: Write a gem description}

s.rubyforge_project = "ruby_masters" # ... continuaend

ruby_masters.gemspec





BUNDLE GEM

lib/ruby_masters.rb

module RubyMasters # Your code goes here...end





BUNDLE GEM

lib/ruby_masters/version.rb

module RubyMasters VERSION = "0.0.1"end





BUNDLE GEM

rake tasks

~/Projects/ruby_masters [ree-1.8.7@rubymasters] $ rake -Trake build # Build ruby_masters-0.0.1.gem into the pkg directoryrake install # Build and install ruby_masters-0.0.1.gem into system gemsrake release # Create tag v0.0.1 and build and push ruby_masters-0.0.1.gem to Rubygems





RAILTIE?





BUNDLE GEM + RAILTIE

lib/ruby_masters.rb

module RubyMasters class Railtie < Rails::Railtie # config.ruby_masters = ActiveSupport::OrderedOptions.new # rake_tasks {} # generators {} # console {} # config.to_prepare {} # initializer {} endend






Ou






lib/ruby_masters/railtie.rb

module RubyMasters class Railtie < Rails::Railtie # config.ruby_masters = ActiveSupport::OrderedOptions.new # rake_tasks {} # generators {} # console {} # config.to_prepare {} # initializer {} endend

lib/ruby_masters.rb

require "ruby_masters/railtie"

module RubyMasters # Your code goes here...end





BUNDLER <3





RAILS 3




@cantoniodasilva

blog.plataformatec.com.br

Obrigado!

?!


http://github.com/plataformatec

http://github.com/plataformatec

railties @ ruby mastersconf - 2011.02.26

Technology

Transcript of railties @ ruby mastersconf - 2011.02.26