configurable 0.7.0 → 1.0.0

data/lib/configurable/config_types/float_type.rb

@@ -0,0 +1,11 @@
+module Configurable
+  module ConfigTypes
+    class FloatType < ObjectType
+      matches Float
+      
+      def cast(input)
+        Float(input)
+      end
+    end
+  end
+end

data/lib/configurable/config_types/integer_type.rb

@@ -0,0 +1,11 @@
+module Configurable
+  module ConfigTypes
+    class IntegerType < ObjectType
+      matches Integer
+      
+      def cast(input)
+        Integer(input)
+      end
+    end
+  end
+end

data/lib/configurable/config_types/nest_type.rb

@@ -0,0 +1,39 @@
+module Configurable
+  module ConfigTypes
+    class NestType < ObjectType
+      class << self
+        def init(&block)
+          define_method(:init, &block) if block
+          self
+        end
+      end
+      matches Hash
+      
+      attr_reader :configurable
+      
+      def initialize(attrs={})
+        @configurable = attrs[:configurable]
+        
+        unless configurable.respond_to?(:config) && configurable.class.respond_to?(:configs)
+          raise ArgumentError, "invalid configurable: #{configurable.inspect}"
+        end
+        
+        super
+      end
+      
+      def init(input)
+        obj = configurable.dup
+        obj.config.merge!(input)
+        obj
+      end
+      
+      def cast(input)
+        configurable.class.configs.import(input)
+      end
+      
+      def uncast(value)
+        configurable.class.configs.export(value)
+      end
+    end
+  end
+end

data/lib/configurable/config_types/object_type.rb

@@ -0,0 +1,58 @@
+module Configurable
+  module ConfigTypes
+    class ObjectType
+      class << self
+        attr_reader :matchers
+      
+        def inherited(base) # :nodoc:
+          unless base.instance_variable_defined?(:@matchers)
+            base.instance_variable_set(:@matchers, matchers.dup)
+          end
+        end
+        
+        def subclass(*matchers, &caster)
+          subclass = Class.new(self)
+          subclass.matches(*matchers)
+          subclass.cast(&caster)
+          subclass
+        end
+      
+        def cast(&block)
+          define_method(:cast, &block) if block
+          self
+        end
+      
+        def uncast(&block)
+          define_method(:uncast, &block) if block
+          self
+        end
+      
+        def errors(&block)
+          define_method(:errors, &block) if block
+          self
+        end
+      
+        def matches(*matchers)
+          @matchers = matchers
+          self
+        end
+      
+        def matches?(value)
+          matchers.any? {|matcher| matcher === value }
+        end
+      end
+      matches()
+      
+      def initialize(attrs={})
+      end
+      
+      def cast(input)
+        input
+      end
+      
+      def uncast(value)
+        value
+      end
+    end
+  end
+end

data/lib/configurable/config_types/string_type.rb

@@ -0,0 +1,15 @@
+module Configurable
+  module ConfigTypes
+    class StringType < ObjectType
+      matches String
+      
+      def cast(input)
+        String(input)
+      end
+      
+      def uncast(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/configurable/conversions.rb

@@ -0,0 +1,91 @@
+require 'configurable/config_classes'
+require 'config_parser'
+
+module Configurable
+  
+  # A set of methods used to convert various inputs based on a hash of (key,
+  # Config) pairs.  Extend the hash and then use the methods.
+  module Conversions
+    include ConfigTypes
+    
+    # Initializes and returns a ConfigParser generated using the configs for
+    # self.  Arguments given to parser are passed to the ConfigParser
+    # initializer.
+    def to_parser(*args, &block)
+      parser = ConfigParser.new(*args, &block)
+      traverse do |nesting, config|
+        next if config[:hidden] == true || nesting.any? {|nest| nest[:hidden] == true }
+        
+        nest_keys   = nesting.collect {|nest| nest.key }
+        long, short = nesting.collect {|nest| nest.name }.push(config.name).join(':'), nil
+        long, short = short, long if long.length == 1
+        
+        guess_attrs = {
+          :long => long,
+          :short => short
+        }
+        
+        config_attrs = {
+          :key       => config.key, 
+          :nest_keys => nest_keys,
+          :default   => config.default,
+          :callback  => lambda {|value| config.type.cast(value) }
+        }
+        
+        attrs = guess_attrs.merge(config.metadata).merge(config_attrs)
+        parser.on(attrs)
+      end
+      
+      parser.sort_opts!
+      parser
+    end
+    
+    # Returns a hash of the default values for each config in self.
+    def to_default
+      default = {}
+      each_pair do |key, config|
+        default[key] = config.default
+      end
+      default
+    end
+    
+    def import(source, target={})
+      each_value do |config|
+        name = config.name
+        
+        if source.has_key?(name)
+          target[config.key] = config.cast(source[name])
+        end
+      end
+      
+      target
+    end
+    
+    def export(source, target={})
+      each_value do |config|
+        key = config.key
+        
+        if source.has_key?(key)
+          target[config.name] = config.uncast(source[key])
+        end
+      end
+      
+      target
+    end
+    
+    # Yields each config in configs to the block with nesting, after appened
+    # self to nesting.
+    def traverse(nesting=[], &block)
+      each_value do |config|
+        if config.type.kind_of?(NestType)
+          nesting.push config
+          configs = config.type.configurable.class.configs
+          configs.traverse(nesting, &block)
+          nesting.pop
+        else
+          yield(nesting, config)
+        end
+      end
+    end
+  end
+end

data/lib/configurable/module_methods.rb

@@ -1,4 +1,3 @@
-require 'lazydoc'
 require 'configurable/class_methods'
 
 module Configurable

data/lib/configurable/version.rb

@@ -1,7 +1,3 @@
 module Configurable
-  MAJOR = 0
-  MINOR = 7
-  TINY = 0
-  
-  VERSION="#{MAJOR}.#{MINOR}.#{TINY}"
+  VERSION = '1.0.0'
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: configurable
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 7
   - 0
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -14,63 +15,101 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-02 00:00:00 -06:00
+date: 2011-07-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: lazydoc
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: "1.0"
   type: :runtime
   version_requirements: *id001
-description: 
-email: simon.a.chiang@gmail.com
+- !ruby/object:Gem::Dependency 
+  name: config_parser
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 5
+        - 4
+        version: 0.5.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id003
+description: Configurable adds methods to declare class configurations. Configurations are inheritable, delegate to methods, and have hash-like access. Configurable constructs configs such that they easily map to config files, web forms, and the command line.
+email: 
+- simon.a.chiang@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - MIT-LICENSE
-- README
-- History
+- README.rdoc
+- History.rdoc
+- Help/Command Line.rdoc
+- Help/Config Syntax.rdoc
+- Help/Config Types.rdoc
 files: 
-- lib/cdoc.rb
-- lib/cdoc/cdoc_html_generator.rb
-- lib/cdoc/cdoc_html_template.rb
-- lib/config_parser.rb
-- lib/config_parser/option.rb
-- lib/config_parser/switch.rb
-- lib/config_parser/utils.rb
 - lib/configurable.rb
 - lib/configurable/class_methods.rb
-- lib/configurable/config.rb
+- lib/configurable/config_classes.rb
+- lib/configurable/config_classes/list_config.rb
+- lib/configurable/config_classes/nest_config.rb
+- lib/configurable/config_classes/scalar_config.rb
 - lib/configurable/config_hash.rb
-- lib/configurable/indifferent_access.rb
+- lib/configurable/config_types.rb
+- lib/configurable/config_types/boolean_type.rb
+- lib/configurable/config_types/float_type.rb
+- lib/configurable/config_types/integer_type.rb
+- lib/configurable/config_types/nest_type.rb
+- lib/configurable/config_types/object_type.rb
+- lib/configurable/config_types/string_type.rb
+- lib/configurable/conversions.rb
 - lib/configurable/module_methods.rb
-- lib/configurable/nest_config.rb
-- lib/configurable/ordered_hash_patch.rb
-- lib/configurable/utils.rb
-- lib/configurable/validation.rb
 - lib/configurable/version.rb
 - MIT-LICENSE
-- README
-- History
+- README.rdoc
+- History.rdoc
+- Help/Command Line.rdoc
+- Help/Config Syntax.rdoc
+- Help/Config Types.rdoc
 has_rdoc: true
-homepage: http://tap.rubyforge.org/configurable
+homepage: http://github.com/thinkerbot/configurable
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- README
+- README.rdoc
 - -S
 - -N
 - --title
@@ -78,23 +117,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
-rubyforge_project: tap
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: configurable

data/README

@@ -1,207 +0,0 @@
-= Configurable[http://tap.rubyforge.org/configurable]
-
-Class configurations that map to the command line.
-
-== Description
-
-Configurable allows the declaration of class configurations.  Configurations
-are inheritable, delegate to methods, and have hash-like access. Configurable
-maps configurations to the command line through ConfigParser and is used by
-the Tap[http://tap.rubyforge.org] framework.
-
-Check out these links for development and bug tracking.
-
-* Website[http://tap.rubyforge.org/configurable]
-* Github[http://github.com/bahuvrihi/configurable/tree/master]
-* {Google Group}[http://groups.google.com/group/ruby-on-tap]
-
-==== Minimal Example
-
-Include Configurable and declare configurations using the config method.
-Configs now have accessors and initialize with the default value.
-
-  class ConfigClass
-    include Configurable
-    config :key, 'default', :short => 'k'   # a sample config
-  end
-
-  c = ConfigClass.new
-  c.key                   # => 'default'
-  c.key = 'new value'
-  c.config[:key]          # => 'new value'
-
-Use a ConfigParser to parse configurations from the command line. Non-class
-options may be defined with (mostly) the same syntax as {OptionParser}[http://www.ruby-doc.org/core/classes/OptionParser.html]:
-
-  parser = ConfigParser.new
-  
-  # add class configurations
-  parser.add(ConfigClass.configurations)
-  
-  # define an option a-la OptionParser
-  parser.on '-s', '--long ARGUMENT', 'description' do |value|
-    parser[:long] = value
-  end
-  
-  parser.parse "one two --key value -s VALUE three"  
-  # => ['one', 'two', 'three']
-  
-  parser.config                             
-  # => {
-  # :key => 'value',
-  # :long => 'VALUE'
-  # }
-  
-  "\n" + parser.to_s
-  # => %Q{
-  #    -k, --key KEY                    a sample config
-  #    -s, --long ARGUMENT              description
-  # }
-
-== Usage
-
-The config method is used to declare class configurations. A block may be
-provided to validate/transform inputs; many standard validations are available
-through the 'c' method (an alias for the
-{Validation}[link:classes/Configurable/Validation.html] module).
-
-  class ConfigClass
-    include Configurable
-    
-    # basic #
-    
-    config :key, 'default'                    # a simple config
-    config :flag, false, &c.flag              # a flag config
-    config :switch, false, &c.switch          # a --[no-]switch config
-    config :num, 10, &c.integer               # integer only
-    
-    # fancy #
-    
-    config :range, 1..10, &c.range            # specifies a range
-    config :select, 'a', &c.select('a','b')   # value must be 'a' or 'b'
-    config :list, [], &c.list                 # allows a list of entries
-    
-    # custom #
-    
-    config :upcase, 'default' do |value|      # custom transformation
-      value.upcase
-    end
-    
-    config :alt, 'default',                   # alternative flags
-      :short => 's',
-      :long => 'long',
-      :arg_name => 'CUSTOM'
-    
-    # Initializes a new instance, setting the overriding configs.
-    def initialize(config={})
-      initialize_config(config)
-    end
-  end
-  
-ConfigParser uses the config declarations to parse configurations and to make
-a documented help string:
-
-  parser = ConfigParser.new
-  parser.add(ConfigClass.configurations)
-  
-  parser.parse "a b --key=value --flag --no-switch --num 8 c"  
-  # => ['a', 'b', 'c']
-  
-  parser.config  
-  # => {
-  # :key => 'value',
-  # :flag => true,
-  # :switch => false,
-  # :num => '8',
-  # :range => 1..10,
-  # :select => 'a',
-  # :list => [],
-  # :upcase => 'default',
-  # :alt => 'default'
-  # }
-  
-  "\n" + parser.to_s
-  # => %Q{
-  #        --key KEY                    a simple config
-  #        --flag                       a flag config
-  #        --[no-]switch                a --[no-]switch config
-  #        --num NUM                    integer only
-  #        --range RANGE                specifies a range
-  #        --select SELECT              value must be 'a' or 'b'
-  #        --list LIST                  allows a list of entries
-  #        --upcase UPCASE              custom transformation
-  #    -s, --long CUSTOM                alternative flags
-  # }
-
-Configurable classes typically call initialize_config to set configurations
-during initialization. The validation/transformation blocks are called as
-configurations are set. Notice how the :num and :upcase configs are translated
-on the instance:
-  
-  c = ConfigClass.new(parser.config)
-  c.config.to_hash      
-  # => {
-  # :key => 'value',
-  # :flag => true,
-  # :switch => false,
-  # :num => 8,                    # no longer a string
-  # :range => 1..10,
-  # :select => 'a',
-  # :list => [],
-  # :upcase => 'DEFAULT',         # no longer downcase
-  # :alt => 'default'
-  # }
-
-Configurations automatically generate accessors (the blocks are basically
-writer methods), and may be accessed through the config object. Configurations
-are validated every time they are set, regardless of whether they are set
-through an accessor or config.
-  
-  c.upcase                    # => 'DEFAULT'
-  
-  c.config[:upcase] = 'neW valuE'
-  c.upcase                    # => 'NEW VALUE'
-
-  c.upcase = 'fiNal Value'
-  c.config[:upcase]           # => 'FINAL VALUE'
-  
-  c.select = 'b'              # ok
-  c.select = 'c'              # !> ValidationError
-  c.config[:select] = 'c'     # !> ValidationError
-
-By default config treats string and symbol keys identically, making YAML an
-obvious choice for configuration files.
-
-  yaml_str = %Q{
-  key: a new value
-  flag: false
-  range: 1..100
-  }
-  
-  c.reconfigure(YAML.load(yaml_str))
-  c.config.to_hash
-  # => {
-  # :key => 'a new value',
-  # :flag => false,
-  # :switch => false,
-  # :num => 8,
-  # :range => 1..100,
-  # :select => 'b',
-  # :list => [],
-  # :upcase => 'FINAL VALUE',
-  # :alt => 'default'
-  # }
-
-See the Configurable module for more details.
-
-== Installation
-
-Configurable is available as a gem on Gemcutter[http://gemcutter.org/gems/configurable].
-
-  % gem install configurable
-
-== Info 
-
-Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com]
-License:: {MIT-Style}[link:files/MIT-LICENSE.html]
-