Sha256: be829ff9dad1118d343143da8f672d24686cb54ccae88bccf0704431630e8720

Contents?: true

Size: 1.51 KB

Versions: 76

Compression:

Stored size: 1.51 KB

Contents

require 'active_support/option_merger'

class Object
  # An elegant way to factor duplication out of options passed to a series of
  # method calls. Each method called in the block, with the block variable as
  # the receiver, will have its options merged with the default +options+ hash
  # provided. Each method called on the block variable must take an options
  # hash as its final argument.
  #
  # Without <tt>with_options></tt>, this code contains duplication:
  #
  #   class Account < ActiveRecord::Base
  #     has_many :customers, dependent: :destroy
  #     has_many :products,  dependent: :destroy
  #     has_many :invoices,  dependent: :destroy
  #     has_many :expenses,  dependent: :destroy
  #   end
  #
  # Using <tt>with_options</tt>, we can remove the duplication:
  #
  #   class Account < ActiveRecord::Base
  #     with_options dependent: :destroy do |assoc|
  #       assoc.has_many :customers
  #       assoc.has_many :products
  #       assoc.has_many :invoices
  #       assoc.has_many :expenses
  #     end
  #   end
  #
  # It can also be used with an explicit receiver:
  #
  #   I18n.with_options locale: user.locale, scope: 'newsletter' do |i18n|
  #     subject i18n.t :subject
  #     body    i18n.t :body, user_name: user.name
  #   end
  #
  # <tt>with_options</tt> can also be nested since the call is forwarded to its receiver.
  # Each nesting level will merge inherited defaults in addition to their own.
  def with_options(options)
    yield ActiveSupport::OptionMerger.new(self, options)
  end
end

Version data entries

76 entries across 76 versions & 5 rubygems

Version Path
activesupport-4.1.16 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.16.rc1 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.15 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.15.rc1 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.14.2 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.14.1 lib/active_support/core_ext/object/with_options.rb
angular-rails4-templates-0.4.1 vendor/ruby/2.1.0/gems/activesupport-4.1.13/lib/active_support/core_ext/object/with_options.rb
angular-rails4-templates-0.4.0 vendor/ruby/2.1.0/gems/activesupport-4.1.13/lib/active_support/core_ext/object/with_options.rb
angular-rails4-templates-0.3.0 vendor/ruby/2.1.0/gems/activesupport-4.1.13/lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.14 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.14.rc2 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.14.rc1 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.13 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.13.rc1 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.12 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.12.rc1 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.11 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.10 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.10.rc4 lib/active_support/core_ext/object/with_options.rb
activesupport-4.1.10.rc3 lib/active_support/core_ext/object/with_options.rb