Как я могу расширить ApplicationController в драгоценный камень?

Question

Я думал, что придумаю удобный способ расширить ApplicationController в геме Rails 3.x.

В моей жемчужине lib/my_namespace/my_controller.rb, Я имел:

class MyNamespace::MyController < ApplicationController

  before_filter :some_method
  after_filter :another_method

  def initialize
    # getting classname of the subclass to use for lookup of the associated model, etc.
    # and storing the model_class in an instance variable
    # ...
  end

  # define :some_method, :another_method, etc.
  # ...

private
  attr_accessor :subclass_defined_during_initialize # etc.

  # etc.
end

но когда драгоценный камень загружен, app/controllers/application_controller.rb еще не загружен, поэтому он не работает:

/path/to/rvm/gemset/gems/activesupport-3.2.6/lib/active_support/dependencies.rb:251:
in `require': cannot load such file -- my_gem_name/application_controller (LoadError)

В качестве обходного пути я определил ApplicationController в своем драгоценном камне lib/gem_namespace/application_controller.rb как:

class ApplicationController < ActionController::Base
end

Я предполагал, что хотя я определил его там, он будет переопределен в моем приложении на Rails 3 app/controllers/application_controller.rb, такой, что оба контроллера в приложении, которые были расширены ApplicationController и контроллеры, которые расширились MyNamespace::MyController будет прямо или косвенно расширять ApplicationController, определенный в app/controllers/application_controller.rb,

Тем не менее, мы заметили, что после загрузки драгоценного камня контроллеры, которые расширяются ApplicationController не удалось получить доступ к методам, определенным в app/controllers/application_controller.rb, Так же ApplicationHelper(app/helpers/application_helper.rb) модуль больше не загружался другими вспомогательными модулями.

Как я могу продлить ApplicationController в контроллере в моем драгоценном камне с целью определения before_filter а также after_filter и использовать initialize получить доступ к имени класса, чтобы определить класс связанной модели, который он мог бы затем хранить и использовать в своих методах?

Обновление 2012/10/22:

Вот что я придумал:

В lib/your_gem_name/railtie.rb:

module YourGemsModuleName
  class Railtie < Rails::Railtie
    initializer "your_gem_name.action_controller" do
    ActiveSupport.on_load(:action_controller) do
      puts "Extending #{self} with YourGemsModuleName::Controller"
      # ActionController::Base gets a method that allows controllers to include the new behavior
      include YourGemsModuleName::Controller # ActiveSupport::Concern
    end
  end
end

И в lib/your_gem_name/controller.rb:

module YourGemsModuleName
  module Controller
    extend ActiveSupport::Concern

    # note: don't specify included or ClassMethods if unused

    included do
      # anything you would want to do in every controller, for example: add a class attribute
      class_attribute :class_attribute_available_on_every_controller, instance_writer: false
    end

    module ClassMethods
      # notice: no self.method_name here, because this is being extended because ActiveSupport::Concern was extended
      def make_this_controller_fantastic
        before_filter :some_instance_method_available_on_every_controller # to be available on every controller
        after_filter :another_instance_method_available_on_every_controller # to be available on every controller
        include FantasticStuff
      end
    end

    # instance methods to go on every controller go here
    def some_instance_method_available_on_every_controller
      puts "a method available on every controller!"
    end

    def another_instance_method_available_on_every_controller
      puts "another method available on every controller!"
    end

    module FantasticStuff
      extend ActiveSupport::Concern

      # note: don't specify included or ClassMethods if unused

      included do
        class_attribute :class_attribute_only_available_on_fantastic_controllers, instance_writer: false
      end

      module ClassMethods
        # class methods available only if make_this_controller_fantastic is specified in the controller
        def some_fanastic_class_method
          put "a fantastic class method!"
        end
      end

      # instance methods available only if make_this_controller_fantastic is specified in the controller
      def some_fantastic_instance_method
        puts "a fantastic instance method!"
      end

      def another_fantastic_instance_method
        puts "another fantastic instance method!"
      end
    end
  end
end

Answer 1

Вот Gist, который показывает, как получить доступ к классу подкласса и сохранить его в переменной экземпляра и получить доступ к нему в фильтрах до и после. Он использует метод include.

Answer 2

Для этого специфического вида функциональности я бы порекомендовал создать модуль в вашем геме и включить этот модуль в свой контроллер приложений.

class ApplicationController < ActionController::Base
  include MyCoolModule
end

Чтобы добавить до фильтров и т. Д. (Добавить это в свой модуль)

def self.included(base)
  base.send(:before_filter, my_method)
end

Обновление: вы можете просто сделать base.before_filter :my_method который чище.

Answer 3

Правда намного проще и гибче.

добавить в lib/engine.rb этот: class Engine < Rails::Engine; end

А затем просто используйте:

ActionController::Base.class_eval do

  include SomethingFromMineGemModule

  # or:
  def hello_from_gem
    'Hey people!'
  end

end

Answer 4

Я смог сослаться на ApplicationController с обратным вызовом инициализатора.

Gem-код, который подклассы / ссылки ApplicationController:

class GemApplicationController < ApplicationController
  before_filter :method_to_call

  def method_to_call
    #your code here
  end
end

обратный вызов кода Gem для создания контроллера подкласса:

module GemName
  def self.load_gem_application_controller
    require "path/to/gem_application_controller"
  end
end

rails_app / конфигурации / Инициализаторы / gem_name.rb

GemName.load_gem_application_controller

Тогда есть контроллеры, которые используют эту функциональность подкласс GemApplicationController

class SpecialCaseController < GemApplicationController
  # this will inherit from the gem's controller, 
  # which inherits from the rails_app ApplicationController
end