Contents

module Netzke
  # This module allows delegating the configuration options for a component into the level of the component's class.
  # As an example, let's take the :title option understood by any Ext.panel.Panel-derived component. Netzke::Base calls:
  #
  #     delegates_to_dsl :title
  #
  # which provides any child class with a DSL method `title` which can be used like this:
  #
  #     class MyComponent < Netzke::Base
  #       title "My cool component"
  #     end
  #
  # This will provide for :title => "My cool component" being a default option for MyComponent's instances.
  #
  # This is very handy when a frequently-inherited class implements some common option. Another example would be the :model option in Basepack::Grid/FormPanel. This way the child class will not need to mess up with the `default_config` method if all it needs is specify that default option.
  module ConfigToDslDelegator
    extend ActiveSupport::Concern

    module ClassMethods
      # Delegates specified configuration options to the class level. See ConfigToDslDelegator.
      def delegates_to_dsl(*option_names)
        delegated_options = read_inheritable_attribute(:delegated_options) || []
        delegated_options += option_names
        write_inheritable_attribute(:delegated_options, delegated_options)
      end

      def inherited(inherited_class) # :nodoc:
        super

        properties = read_inheritable_attribute(:delegated_options) || []
        properties.size.times do |i|
          inherited_class.class.send(:define_method, properties[i], lambda { |value|
            default_config = read_inheritable_attribute(:default_config) || {}
            default_config.merge!(properties[i].to_sym => value)
            write_inheritable_attribute(:default_config, default_config)
          })
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
netzke-core-0.7.5	lib/netzke/config_to_dsl_delegator.rb
netzke-core-0.7.4	lib/netzke/config_to_dsl_delegator.rb