configurable 0.1.0

data/lib/config_parser/option.rb

@@ -0,0 +1,52 @@
+require 'config_parser/utils'
+
+class ConfigParser  
+  class Option
+
+    attr_reader :short 
+    attr_reader :long
+    attr_reader :arg_name
+    attr_reader :desc     
+    attr_reader :block
+    
+    def initialize(options={}, &block)
+      @short = Utils.shortify(options[:short])
+      @long = Utils.longify(options[:long])
+      @arg_name = options[:arg_name]
+      @desc = options[:desc]
+      @block = block
+    end
+    
+    # Returns an array of non-nil switches mapping to this option 
+    # (ie [long, short]).  May be overridden in subclasses.
+    def switches
+      [long, short].compact
+    end
+
+    # Selects the value or the shifts a value off of argv and sets
+    # that value in config.  
+    #
+    # Parse is a hook for fancier ways of determining an option
+    # value and/or setting the value in config.  Parse recieves 
+    # the switch (ie long or short) mapping to self for subclasses
+    # that need it (ex the Switch class).
+    def parse(switch, value, argv)
+      if arg_name
+        unless value
+          raise "no value provided for: #{switch}" if argv.empty?
+          value = argv.shift
+        end
+        block ? block.call(value) : value
+      else
+        raise "value specified for flag" if value
+        block ? block.call : nil
+      end
+    end
+
+    def to_s
+      short_str = short ? short + ',' : '   '
+      desc_str = desc.kind_of?(Lazydoc::Comment) ? desc.trailer : desc
+      "%-37s%-43s" % ["    #{short_str} #{long} #{arg_name}", desc_str]
+    end
+  end
+end

data/lib/config_parser/switch.rb

@@ -0,0 +1,29 @@
+class ConfigParser 
+  class Switch < Option
+    attr_reader :negative_long
+
+    def initialize(options={})
+      super
+      raise ArgumentError, "arg_name specified for switch: #{arg_name}" if arg_name
+      raise ArgumentError, "no long specified" unless long
+      @negative_long = Utils.longify("no-#{long[2,long.length-2]}")
+    end
+
+    def switches
+      [long, negative_long, short].compact
+    end
+
+    def parse(switch, value, argv)
+      raise "value specified for switch" if value
+      value = (switch == negative_long ? false : true)
+      block ? block.call(value) : value
+    end
+
+    def to_s
+      short_str = short ? short + ',' : '   '
+      long_str = long ? "--[no-]#{long[2,long.length-2]}" : ''
+      desc_str = desc.kind_of?(Lazydoc::Comment) ? desc.trailer : desc
+      "%-37s%-43s" % ["    #{short_str} #{long_str}", desc_str]
+    end
+  end
+end

data/lib/config_parser/utils.rb

@@ -0,0 +1,133 @@
+class ConfigParser
+  module Utils
+    module_function
+    
+    # The option break argument
+    OPTION_BREAK = "--"
+
+    # Matches a nested long option, with or without a value
+    # (ex: '--opt', '--nested:opt', '--opt=value').  After 
+    # the match:
+    #
+    #   $1:: the switch
+    #   $3:: the value
+    #
+    LONG_OPTION = /^(--[A-z].*?)(=(.*))?$/
+
+    # Matches a nested short option, with or without a value
+    # (ex: '-o', '-n:o', '-o=value').  After the match:
+    #
+    #   $1:: the switch
+    #   $4:: the value
+    #
+    SHORT_OPTION = /^(-[A-z](:[A-z])*)(=(.*))?$/
+
+    # Matches the alternate syntax for short options
+    # (ex: '-n:ovalue', '-ovalue').  After the match:
+    #
+    #   $1:: the switch
+    #   $3:: the value
+    #
+    ALT_SHORT_OPTION = /^(-[A-z](:[A-z])*)(.+)$/
+    
+    # Turns the input string into a short-format option.  Raises
+    # an error if the option does not match SHORT_OPTION.  Nils
+    # are returned directly.
+    #
+    #   ConfigParser.shortify("-o")         # => '-o'
+    #   ConfigParser.shortify(:o)           # => '-o'
+    #
+    def shortify(str)
+      return nil if str == nil
+  
+      str = str.to_s
+      str = "-#{str}" unless str[0] == ?-
+      unless str =~ SHORT_OPTION && $3 == nil
+        raise ArgumentError, "invalid short option: #{str}"
+      end
+      str
+    end
+
+    # Turns the input string into a long-format option.  Underscores
+    # are converted to hyphens. Raises an error if the option does
+    # not match LONG_OPTION.  Nils are returned directly.
+    #
+    #   ConfigParser.longify("--opt")       # => '--opt'
+    #   ConfigParser.longify(:opt)          # => '--opt'
+    #   ConfigParser.longify(:opt_ion)      # => '--opt-ion'
+    #
+    def longify(str)
+      return nil if str == nil
+  
+      str = str.to_s
+      str = "--#{str}" unless str =~ /^--/
+      str.gsub!(/_/, '-')
+      unless str =~ LONG_OPTION && $3 == nil
+        raise ArgumentError, "invalid long option: #{str}"
+      end
+      str
+    end
+    
+    # Options:
+    #
+    #   :long      the long key ("--key") 
+    #   :arg_name  the argument name ("KEY") 
+    #
+    def setup_option(key, options={})
+      options[:long] ||= "--#{key}"
+      options[:long].to_s =~ /^(--)?(.*)$/ 
+      options[:arg_name] ||= $2.upcase
+      
+      lambda {|value| config[key] = value }
+    end
+    
+    # Options:
+    #
+    #   :long      the long key ("--key") 
+    #
+    def setup_flag(key, default=true, options={})
+      options[:long] ||= "--#{key}"
+      
+      lambda {config[key] = !default }
+    end
+    
+    # Options:
+    #
+    #   :long      the long key ("--[no-]key") 
+    #
+    def setup_switch(key, default=true, options={})
+      options[:long] ||= "--#{key}"
+      options[:long].to_s =~ /^(--)?(\[no-\])?(.*)$/ 
+      options[:long] = "--[no-]#{$3}" unless $2
+      
+      lambda {|value| config[key] = (value ? !default : default) }
+    end
+    
+    # Options:
+    #
+    #   :long      the long key ("--key")
+    #   :arg_name  the argument name ("KEY" or "A,B,C" for a comma split) 
+    #   :split     the split character
+    #
+    def setup_list(key, options={})
+      options[:long] ||= "--#{key}"
+      
+      if split = options[:split]
+        options[:arg_name] ||= %w{A B C}.join(split)
+      else
+        options[:long].to_s =~ /^(--)?(.*)$/ 
+        options[:arg_name] ||= $2.upcase
+      end
+      
+      n = options[:n]
+      
+      lambda do |value|
+        array = (config[key] ||= [])
+        array.concat(split ? value.split(split) : [value])
+        if n && array.length > n
+          raise "too many assignments: #{key.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/configurable.rb

@@ -0,0 +1,155 @@
+require 'configurable/class_methods'
+
+# Configurable enables the specification of configurations within a class definition.
+#
+#   class ConfigClass
+#     include Configurable
+# 
+#     config :one, 'one'
+#     config :two, 'two'
+#     config :three, 'three'
+#
+#     def initialize(overrides={})
+#       initialize_config(overrides)
+#     end
+#   end
+#
+#   c = ConfigClass.new
+#   c.config.class         # => Configurable::DelegateHash
+#   c.config               # => {:one => 'one', :two => 'two', :three => 'three'}
+#
+# The <tt>config</tt> object acts as a forwarding hash; declared configurations
+# map to accessors while undeclared configurations are stored internally:
+#
+#   c.config[:one] = 'ONE'
+#   c.one                  # => 'ONE'
+#
+#   c.one = 1           
+#   c.config               # => {:one => 1, :two => 'two', :three => 'three'}
+#
+#   c.config[:undeclared] = 'value'
+#   c.config.store         # => {:undeclared => 'value'}
+#
+# The writer for a configuration can be defined by providing a block to config.  
+# The Validation module provides a number of common validation/transform 
+# blocks which can be accessed through the class method 'c':
+#
+#   class SubClass < ConfigClass
+#     config(:one, 'one') {|v| v.upcase }
+#     config :two, 2, &c.integer
+#   end
+#
+#   s = SubClass.new
+#   s.config               # => {:one => 'ONE', :two => 2, :three => 'three'}
+#
+#   s.one = 'aNothER'             
+#   s.one                  # => 'ANOTHER'
+#
+#   s.two = -2
+#   s.two                  # => -2
+#   s.two = "3"
+#   s.two                  # => 3
+#   s.two = nil            # !> ValidationError
+#   s.two = 'str'          # !> ValidationError
+# 
+# Configurations are inherited from the parent and may be overridden in
+# subclasses.
+#
+# === Options
+#
+# Alternative reader and writer methods may be specified as options to config.
+# When alternate methods are specified, Configurable assumes the methods are 
+# declared elsewhere and will not define accessors.  
+# 
+#   class AlternativeClass
+#     include Configurable
+#
+#     config_attr :sym, 'value', :reader => :get_sym, :writer => :set_sym
+#
+#     def initialize
+#       initialize_config
+#     end
+#
+#     def get_sym
+#       @sym
+#     end
+#
+#     def set_sym(input)
+#       @sym = input.to_sym
+#     end
+#   end
+#
+#   alt = AlternativeClass.new
+#   alt.respond_to?(:sym)     # => false
+#   alt.respond_to?(:sym=)    # => false
+#   
+#   alt.config[:sym] = 'one'
+#   alt.get_sym               # => :one
+#
+#   alt.set_sym('two')
+#   alt.config[:sym]          # => :two
+#
+# Idiosyncratically, true, false, and nil may also be provided as 
+# reader/writer options. 
+#
+#   true     Same as using the defaults, accessors are defined.
+#
+#   false    Sets the default reader/writer but does not define
+#            the accessors (think 'define reader/writer' => false).
+#
+#   nil      Does not define a reader/writer, and does not define
+#            the accessors. In effect this will define a config
+#            that does not map to the instance, but will be
+#            present in instance.config
+#
+module Configurable
+
+  # Extends including classes with Configurable::ClassMethods
+  def self.included(mod) # :nodoc:
+    mod.extend ClassMethods if mod.kind_of?(Class)
+  end
+
+  # A ConfigHash bound to self
+  attr_reader :config
+
+  # Reconfigures self with the given overrides. Only the specified configs
+  # are modified. Keys are symbolized.
+  #
+  # Returns self.
+  def reconfigure(overrides={})
+    overrides.each_pair do |key, value|
+      config[key] = value
+    end
+
+    self
+  end
+
+  # Reinitializes configurations in the copy such that
+  # the new object has it's own set of configurations,
+  # separate from the original object.
+  def initialize_copy(orig)
+    super
+    initialize_config(orig.config)
+  end
+
+  protected
+
+  # Initializes config. Default config values 
+  # are overridden as specified by overrides.
+  def initialize_config(overrides={})
+    delegates = self.class.configurations
+
+    # note the defaults could be stored first and overridden
+    # by the overrides, but this is likely more efficient
+    # on average since delegates duplicate default values.
+    store = {}
+    overrides.each_pair do |key, value| 
+      store[key] = value
+    end
+    delegates.each_pair do |key, delegate|
+      store[key] = delegate.default unless store.has_key?(key)
+    end
+
+    @config = DelegateHash.new(delegates, store).bind(self)
+  end
+end

data/lib/configurable/class_methods.rb

@@ -0,0 +1,308 @@
+require 'lazydoc/attributes'
+require 'configurable/delegate_hash'
+require 'configurable/validation'
+require 'configurable/indifferent_access'
+
+autoload(:ConfigParser, 'config_parser')
+
+module Configurable
+  
+  # ClassMethods extends classes that include Configurable and
+  # provides methods for declaring configurations.
+  module ClassMethods
+    include Lazydoc::Attributes
+
+    # A hash holding the class configurations.
+    attr_reader :configurations
+
+    def self.extended(base) # :nodoc:
+      caller.each_with_index do |line, index|
+        case line
+        when /\/configurable.rb/ then next
+        when Lazydoc::CALLER_REGEXP
+          base.instance_variable_set(:@source_file, File.expand_path($1))
+          break
+        end
+      end
+  
+      configurations = {}.extend IndifferentAccess
+      base.instance_variable_set(:@configurations, configurations)
+    end
+
+    def inherited(child) # :nodoc:
+      unless child.instance_variable_defined?(:@source_file)
+        caller.first =~ Lazydoc::CALLER_REGEXP
+        child.instance_variable_set(:@source_file, File.expand_path($1)) 
+      end
+  
+      configurations = {}
+      configurations.extend IndifferentAccess if @configurations.kind_of?(IndifferentAccess)
+      @configurations.each_pair {|key, config| configurations[key] = config.dup } 
+      child.instance_variable_set(:@configurations, configurations)
+      super
+    end
+
+    def parser
+      ConfigParser.new do |parser|
+        configurations.to_a.sort_by do |(key, config)| 
+          config.attributes[:order] || 0
+        end.each do |(key, config)|
+          parser.define(key, config.default, config.attributes)
+        end
+      end
+    end
+
+    # Loads the contents of path as YAML. Returns an empty hash if the path
+    # is empty, does not exist, or is not a file.
+    def load_config(path)
+      # the last check prevents YAML from auto-loading itself for empty files
+      return {} if path == nil || !File.file?(path) || File.size(path) == 0
+      YAML.load_file(path) || {}
+    end
+    
+    protected
+
+    def use_indifferent_access(value=true)
+      current = @configurations
+      @configurations = value ? HashWithIndifferentAccess.new : {}
+      current.each_pair do |key, value|
+        @configurations[key] = value
+      end
+    end
+
+    # Declares a class configuration and generates the associated accessors. 
+    # If a block is given, the <tt>key=</tt> method will set <tt>@key</tt> 
+    # to the return of the block, which executes in class-context.  
+    #
+    #   class SampleClass
+    #     include Configurable
+    #
+    #     config :str, 'value'
+    #     config(:upcase, 'value') {|input| input.upcase } 
+    #   end
+    #
+    #   # An equivalent class to illustrate class-context
+    #   class EquivalentClass
+    #     attr_accessor :str
+    #     attr_reader :upcase
+    #
+    #     UPCASE_BLOCK = lambda {|input| input.upcase }
+    #
+    #     def upcase=(input)
+    #       @upcase = UPCASE_BLOCK.call(input)
+    #     end
+    #   end
+    #
+    def config(key, value=nil, options={}, &block)
+      # register with Lazydoc
+      options[:desc] ||= Lazydoc.register_caller
+      
+      if block_given?
+        options = default_options(block).merge!(options)
+
+        instance_variable = "@#{key}".to_sym
+        config_attr(key, value, options) do |input|
+          instance_variable_set(instance_variable, yield(input))
+        end
+      else
+        config_attr(key, value, options)
+      end
+    end
+
+    # Declares a class configuration and generates the associated accessors. 
+    # If a block is given, the <tt>key=</tt> method will perform the block
+    # with instance-context.
+    #
+    #   class SampleClass
+    #     include Configurable
+    #
+    #     def initialize
+    #       initialize_config
+    #     end
+    #
+    #     config_attr :str, 'value'
+    #     config_attr(:upcase, 'value') {|input| @upcase = input.upcase } 
+    #   end
+    #
+    #   # An equivalent class to illustrate instance-context
+    #   class EquivalentClass
+    #     attr_accessor :str
+    #     attr_reader :upcase
+    #
+    #     def upcase=(input)
+    #       @upcase = input.upcase
+    #     end
+    #   end
+    #
+    def config_attr(key, value=nil, options={}, &block)
+      options = default_options(block).merge!(options)
+
+      # define the default public reader method
+      reader = options.delete(:reader)
+
+      case reader
+      when true
+        reader = key
+        attr_reader(key) 
+        public(key)
+      when false
+        reader = key
+      end
+
+      # define the default public writer method
+      writer = options.delete(:writer)
+
+      if block_given? && writer != true
+        raise ArgumentError, "a block may not be specified without writer == true"
+      end
+
+      case writer
+      when true
+        writer = "#{key}="
+        block_given? ? define_method(writer, &block) : attr_writer(key)
+        public writer
+      when false
+        writer = "#{key}="
+      end
+  
+      # register with Lazydoc
+      options[:desc] ||= Lazydoc.register_caller
+      
+      configurations[key] = Delegate.new(reader, writer, value, options)
+    end
+
+    # Adds a configuration to self accessing the configurations for the
+    # configurable class.  Unlike config_attr and config, nest does not
+    # create accessors; the configurations must be accessed through
+    # the instance config method.
+    #
+    #   class A
+    #     include Configurable
+    #     config :key, 'value'
+    #
+    #     def initialize(overrides={})
+    #       initialize_config(overrides)
+    #     end
+    #   end
+    #
+    #   class B
+    #     include Configurable
+    #     nest :a, A
+    #
+    #     def initialize(overrides={})
+    #       initialize_config(overrides)
+    #     end
+    #   end
+    #
+    #   b = B.new
+    #   b.config[:a]                   # => {:key => 'value'}
+    #
+    # Nest may be provided a block which receives the first value for
+    # the nested config and is expected to initialize an instance of
+    # configurable_class.  In this case a reader for the instance is
+    # created and access becomes quite natural.
+    #
+    #   class C
+    #     include Configurable
+    #     nest(:a, A) {|overrides| A.new(overrides) }
+    #
+    #     def initialize(overrides={})
+    #       initialize_config(overrides)
+    #     end
+    #   end
+    #
+    #   c = C.new
+    #   c.a.key                        # => "value"
+    #
+    #   c.a.key = "one"
+    #   c.config[:a].to_hash           # => {:key => 'one'}
+    #
+    #   c.config[:a][:key] = 'two'
+    #   c.a.key                        # => "two"
+    #
+    #   c.config[:a] = {:key => 'three'}
+    #   c.a.key                        # => "three"
+    # 
+    # Nesting with an initialization block creates private methods
+    # that config[:a] uses to read and write the instance configurations;
+    # these methods are "#{key}_config" and "#{key}_config=" by default, 
+    # but they may be renamed using the :reader and :writer options.
+    #
+    # Nest checks for recursive nesting and raises an error if
+    # a recursive nest is detected.
+    #
+    def nest(key, configurable_class, options={})
+      unless configurable_class.kind_of?(Configurable::ClassMethods)
+        raise ArgumentError, "not a Configurable class: #{configurable_class}" 
+      end
+
+      reader = options.delete(:reader)
+      writer = options.delete(:writer)
+  
+      if block_given?
+        # define instance accessor methods
+        instance_var = "@#{key}".to_sym
+        reader = "#{key}_config" unless reader
+        writer = "#{key}_config=" unless writer
+    
+        # the public accessor
+        attr_reader key
+        public(key)
+  
+        # the reader returns the config for the instance
+        define_method(reader) do
+          instance_variable_get(instance_var).config
+        end
+  
+        # the writer initializes the instance if necessary,
+        # or reconfigures the instance if it already exists
+        define_method(writer) do |value|
+          if instance_variable_defined?(instance_var) 
+            instance_variable_get(instance_var).reconfigure(value)
+          else
+            instance_variable_set(instance_var, yield(value))
+          end
+        end
+        private(reader, writer)
+      else
+        reader = writer = nil
+      end
+  
+      # register with Lazydoc
+      options[:desc] ||= Lazydoc.register_caller
+      
+      value = DelegateHash.new(configurable_class.configurations).update
+      configurations[key] = Delegate.new(reader, writer, value, options)
+  
+      check_infinite_nest(configurable_class.configurations)
+    end
+
+    # Alias for Validation
+    def c
+      Validation
+    end
+
+    private
+    
+    def default_options(block)
+      Validation::ATTRIBUTES[block].merge(
+        :reader => true, 
+        :writer => true,
+        :order => configurations.length)
+    end
+    
+    # helper to recursively check a set of 
+    # configurations for an infinite nest
+    def check_infinite_nest(configurations) # :nodoc:
+      raise "infinite nest detected" if configurations == self.configurations
+  
+      configurations.each_pair do |key, config|
+        config_hash = config.default(false)
+    
+        if config_hash.kind_of?(DelegateHash)
+          check_infinite_nest(config_hash.delegates)
+        end
+      end
+    end
+  end
+end