Module: ActiveSupport::Concern

Included in:: AbstractController::AssetPaths, AbstractController::Callbacks, AbstractController::Helpers, AbstractController::Layouts, AbstractController::Logger, AbstractController::Rendering, AbstractController::UrlFor, AbstractController::ViewPaths, ActionController::Caching, ActionController::Caching::Actions, ActionController::Caching::Pages, ActionController::Caching::Sweeping, ActionController::Compatibility, ActionController::ConditionalGet, ActionController::Cookies, ActionController::DataStreaming, ActionController::Flash, ActionController::ForceSSL, ActionController::Head, ActionController::Helpers, ActionController::HideActions, ActionController::HttpAuthentication::Basic::ControllerMethods, ActionController::Instrumentation, ActionController::MimeResponds, ActionController::ParamsWrapper, ActionController::RackDelegation, ActionController::Redirecting, ActionController::Renderers, ActionController::Renderers::All, ActionController::Rendering, ActionController::RequestForgeryProtection, ActionController::Rescue, ActionController::SessionManagement, ActionController::Streaming, ActionController::TemplateAssertions, ActionController::TestCase::Behavior, ActionController::Testing, ActionController::UrlFor, ActionDispatch::Assertions, ActionDispatch::Assertions::ResponseAssertions, ActionDispatch::Http::FilterParameters, ActionDispatch::Http::MimeNegotiation, ActionDispatch::Routing::UrlFor, ActionMailer::DeliveryMethods, ActionMailer::TestCase::Behavior, ActionMailer::TestHelper, ActionView::Helpers, ActionView::Helpers::AssetTagHelper::JavascriptTagHelpers, ActionView::Helpers::AssetTagHelper::StylesheetTagHelpers, ActionView::Helpers::FormHelper, ActionView::Helpers::FormTagHelper, ActionView::Helpers::SanitizeHelper, ActionView::Helpers::TagHelper, ActionView::Helpers::TextHelper, ActionView::Helpers::UrlHelper, ActionView::TestCase::Behavior, ActiveModel::AttributeMethods, ActiveModel::Conversion, ActiveModel::Dirty, ActiveModel::MassAssignmentSecurity, ActiveModel::Observing, ActiveModel::SecurePassword, ActiveModel::Serializers::JSON, ActiveModel::Serializers::Xml, ActiveModel::Validations, ActiveModel::Validations::Callbacks, ActiveRecord::Aggregations, ActiveRecord::Associations, ActiveRecord::AttributeAssignment, ActiveRecord::AttributeMethods, ActiveRecord::AttributeMethods::BeforeTypeCast, ActiveRecord::AttributeMethods::DeprecatedUnderscoreRead, ActiveRecord::AttributeMethods::Dirty, ActiveRecord::AttributeMethods::PrimaryKey, ActiveRecord::AttributeMethods::Query, ActiveRecord::AttributeMethods::Read, ActiveRecord::AttributeMethods::Serialization, ActiveRecord::AttributeMethods::TimeZoneConversion, ActiveRecord::AttributeMethods::Write, ActiveRecord::AutosaveAssociation, ActiveRecord::Callbacks, ActiveRecord::Inheritance, ActiveRecord::Locking::Optimistic, ActiveRecord::ModelSchema, ActiveRecord::NestedAttributes, ActiveRecord::Persistence, ActiveRecord::QueryMethods, ActiveRecord::Railties::ControllerRuntime, ActiveRecord::ReadonlyAttributes, ActiveRecord::Reflection, ActiveRecord::Sanitization, ActiveRecord::Scoping, ActiveRecord::Scoping::Default, ActiveRecord::Scoping::Named, ActiveRecord::Serialization, ActiveRecord::Store, ActiveRecord::TestFixtures, ActiveRecord::Timestamp, ActiveRecord::Transactions, ActiveRecord::Validations, ActiveResource::CustomMethods, ActiveResource::Observing, ActiveResource::Validations, Callbacks, Configurable, Rescuable, Testing::Performance, Testing::SetupAndTeardown, Rails::Railtie::Configurable, Sprockets::Helpers::RailsHelper

Defined in:: activesupport/lib/active_support/concern.rb

Overview

A typical module looks like this:

module M
  def self.included(base)
    base.extend ClassMethods
    scope :disabled, where(:disabled => true)
  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

  module ClassMethods
    ...
  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
    class_eval do
      def self.method_injected_by_foo
        ...
      end
    end
  end
end

module Bar
  extend ActiveSupport::Concern
  include Foo

  included do
    self.method_injected_by_foo
  end
end

class Host
  include Bar # works, Bar takes care now of its dependencies
end

Class Method Summary collapse

.extended(base) ⇒ Object

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ `Object`



101
102
103

# File 'activesupport/lib/active_support/concern.rb', line 101

def self.extended(base)
  base.instance_variable_set("@_dependencies", [])
end

Instance Method Details

#append_features(base) ⇒ `Object`

# File 'activesupport/lib/active_support/concern.rb', line 105

def append_features(base)
  if base.instance_variable_defined?("@_dependencies")
    base.instance_variable_get("@_dependencies") << self
    return false
  else
    return false if base < self
    @_dependencies.each { |dep| base.send(:include, dep) }
    super
    base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
    if const_defined?("InstanceMethods")
      base.send :include, const_get("InstanceMethods")
      ActiveSupport::Deprecation.warn "The InstanceMethods module inside ActiveSupport::Concern will be " \
        "no longer included automatically. Please define instance methods directly in #{self} instead.", caller
    end
    base.class_eval(&@_included_block) if instance_variable_defined?("@_included_block")
  end
end

#included(base = nil, &block) ⇒ `Object`

# File 'activesupport/lib/active_support/concern.rb', line 123

def included(base = nil, &block)
  if base.nil?
    @_included_block = block
  else
    super
  end
end