- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0 (0)
- 3.0.9 (0)
- 3.1.0 (38)
- 3.2.1 (-2)
- 3.2.8 (0)
- 3.2.13 (1)
- 4.0.2 (-1)
- 4.1.8 (0)
- 4.2.1 (0)
- 4.2.7 (0)
- 4.2.9 (0)
- 5.0.0.1 (0)
- 5.1.7 (0)
- 5.2.3 (0)
- 6.0.0 (0)
- 6.1.3.1 (5)
- 6.1.7.7 (0)
- 7.0.0 (0)
- 7.1.3.2 (0)
- 7.1.3.4 (0)
- What's this?
A typical module looks like this:
module M def self.included(base) base.extend ClassMethods base.class_eval do scope :disabled, -> { where(disabled: true) } end end module ClassMethods ... end end
By using ActiveSupport::Concern the above module could instead be written as:
require 'active_support/concern' module M extend ActiveSupport::Concern included do scope :disabled, -> { where(disabled: true) } end class_methods do ... end end
Moreover, it gracefully handles module dependencies. Given a Foo module and a Bar module which depends on the former, we would typically write the following:
module Foo def self.included(base) base.class_eval do def self.method_injected_by_foo ... end end end end module Bar def self.included(base) base.method_injected_by_foo end end class Host include Foo # We need to include this dependency for Bar include Bar # Bar is the module that Host really needs end
But why should Host care about Bar's dependencies, namely Foo? We could try to hide these from Host directly including Foo in Bar:
module Bar include Foo def self.included(base) base.method_injected_by_foo end end class Host include Bar end
Unfortunately this won’t work, since when Foo is included, its base is the Bar module, not the Host class. With ActiveSupport::Concern, module dependencies are properly resolved:
require 'active_support/concern' module Foo extend ActiveSupport::Concern included do def self.method_injected_by_foo ... end end end module Bar extend ActiveSupport::Concern include Foo included do self.method_injected_by_foo end end class Host include Bar # It works, now Bar takes care of its dependencies end
Documentation (v3.0.1)
Documentation for this module (taken from ActiveSupport 3.0.1):
# A typical module looks like this # # module M # def self.included(base) # base.send(:extend, ClassMethods) # base.send(:include, InstanceMethods) # scope :foo, :conditions => { :created_at => nil } # end # # module ClassMethods # def cm; puts 'I am a class method'; end # end # # module InstanceMethods # def im; puts 'I am an instance method'; end # end # end # # By using <tt>ActiveSupport::Concern</tt> the above module could instead be written as: # # module M # extend ActiveSupport::Concern # # included do # scope :foo, :conditions => { :created_at => nil } # end # # module ClassMethods # def cm; puts 'I am a class method'; end # end # # module InstanceMethods # def im; puts 'I am an instance method'; end # end # end