parameters 0.2.3 → 0.3.0

data/.gitignore

@@ -0,0 +1,10 @@
+doc
+pkg
+tmp/*
+.DS_Store
+.bundle
+.yardoc
+*.db
+*.log
+*.swp
+*~

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 0.3.0 / 2011-12-13
+
+* Added {Parameters::ClassMethods#set_param}.
+* Added {Parameters#set_param}.
+* Added {Parameters::Types}.
+* Improved the type coercion logic (via {Parameters::Types}).
+
 ### 0.2.3 / 2010-10-27
 
 * Have parameter reader/writer class-methods search down the ancestory

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2008-2010 Hal Brodigan
+Copyright (c) 2008-2011 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -19,4 +19,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/README.md

@@ -1,8 +1,9 @@
 # Parameters
 
-* [parameters.rubyforge.org](http://parameters.rubyforge.org/)
-* [github.com/postmodern/parameters](http://github.com/postmodern/parameters/)
-* Postmodern (postmodern.mod3 at gmail.com)
+* [Source](http://github.com/postmodern/parameters)
+* [Issues](http://github.com/postmodern/parameters/issues)
+* [Documentation](http://rubydoc.info/gems/parameters/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
 
 ## Description
 
@@ -21,6 +22,8 @@ have configurable default values.
 
 ## Examples
 
+    require 'parameters'
+
     class Octagon
   
       include Parameters
@@ -42,28 +45,26 @@ have configurable default values.
       # URI, Regexp, DateTime, Date, Symbol, String, Integer, Float
       # and true (for boolean types).
       #
-      parameter :radius,
-                :type => Float,
-                :description => 'The radius of the Octagon'
+      parameter :radius, :type        => Float,
+                         :description => 'The radius of the Octagon'
 
       #
       # A parameter with a lambda for a default value
       #
-      parameter :opacity,
-                :default => lambda { rand },
-                :description => 'The opacity of the Octagon'
+      parameter :opacity, :default     => lambda { rand },
+                          :description => 'The opacity of the Octagon'
   
     end
   
     # Create an object with default values for all parameters
     oct = Octagon.new
-    oct.x # => 0
-    oct.y # => 0.5
+    oct.x       # => 0
+    oct.y       # => 0.5
     oct.opacity # => 0.25
   
     # Create an object with the given parameter values.
     oct = Octagon.new(:radius => 10)
-    oct.radius # => 10
+    oct.radius  # => 10
     oct.opacity # => 0.7
   
     # Set parameter values of a class
@@ -73,7 +74,7 @@ have configurable default values.
     # Create an object with parameter defaulte values inherited from the
     # class parameters
     oct = Octagon.new
-    oct.radius # => 33
+    oct.radius  # => 33
     oct.opacity # => 0.3
 
     # Coerce data from the command-line into the given parameter type
@@ -82,7 +83,7 @@ have configurable default values.
 
 ## Install
 
-    $ sudo gem install parameters
+    $ gem install parameters
 
 ## License
 

data/Rakefile

@@ -2,17 +2,17 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.1.2'
+  gem 'ore-tasks', '~> 0.4'
   require 'ore/tasks'
 
   Ore::Tasks.new
 rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+  warn e.message
+  warn "Run `gem install ore-tasks` to install 'ore/tasks'."
 end
 
 begin
-  gem 'rspec', '~> 2.0.0'
+  gem 'rspec', '~> 2.4'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new
@@ -21,10 +21,11 @@ rescue LoadError => e
     abort "Please run `gem install rspec` to install RSpec."
   end
 end
+task :test => :spec
 task :default => :spec
 
 begin
-  gem 'yard', '~> 0.6.0'
+  gem 'yard', '~> 0.7'
   require 'yard'
 
   YARD::Rake::YardocTask.new  

data/gemspec.yml

@@ -10,8 +10,9 @@ email: postmodern.mod3@gmail.com
 homepage: http://github.com/postmodern/parameters
 has_yard: true
 
+required_ruby_version: ">= 1.8.7"
+
 development_dependencies:
-  ore: ~> 0.2.0
-  ore-tasks: ~> 0.1.2
-  rspec: ~> 2.0.0
-  yard: ~> 0.6.0
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
+  yard: ~> 0.7

data/lib/parameters/class_methods.rb

@@ -29,11 +29,13 @@ module Parameters
     def params=(values)
       values.each do |name,value|
         if has_param?(name)
-          if (value.kind_of?(Parameters::ClassParam) || value.kind_of?(Parameters::InstanceParam))
-            value = value.value
-          end
-
-          get_param(name).value = value
+          get_param(name).value = case value
+                                  when Parameters::ClassParam,
+                                       Parameters::InstanceParam
+                                    value.value
+                                  else
+                                    value
+                                  end
         end
       end
     end
@@ -65,14 +67,6 @@ module Parameters
     def parameter(name,options={})
       name = name.to_sym
 
-      # add the parameter to the class params list
-      params[name] = Parameters::ClassParam.new(
-        name,
-        options[:type],
-        options[:description],
-        options[:default]
-      )
-
       # define the reader class method for the parameter
       meta_def(name) do
         get_param(name).value
@@ -85,6 +79,37 @@ module Parameters
 
       # define the getter/setter instance methods for the parameter
       attr_accessor(name)
+
+      # create the new parameter
+      new_param = Parameters::ClassParam.new(
+        name,
+        options[:type],
+        options[:description],
+        options[:default]
+      )
+
+      # add the parameter to the class params list
+      params[name] = new_param
+      return new_param
+    end
+
+    #
+    # Determines if a class parameter exists with the given name.
+    #
+    # @return [Boolean]
+    #   Specifies whether or not there is a class parameter with the
+    #   specified name.
+    #
+    def has_param?(name)
+      name = name.to_sym
+
+      ancestors.each do |ancestor|
+        if ancestor.included_modules.include?(Parameters)
+          return true if ancestor.params.has_key?(name)
+        end
+      end
+
+      return false
     end
 
     #
@@ -94,10 +119,10 @@ module Parameters
     #   The class parameter name to search for.
     #
     # @return [ClassParam]
-    #   The class parameter with the matching _name_.
+    #   The class parameter with the matching name.
     #
     # @raise [ParamNotFound]
-    #   No class parameter with the specified _name_ could be found.
+    #   No class parameter with the specified name could be found.
     #
     def get_param(name)
       name = name.to_sym
@@ -110,24 +135,38 @@ module Parameters
         end
       end
 
-      raise(Parameters::ParamNotFound,"parameter #{name.to_s.dump} was not found in class #{self.name.dump}",caller)
+      raise(Parameters::ParamNotFound,"parameter #{name.to_s.dump} was not found in class #{self}")
     end
 
     #
-    # @return [Boolean]
-    #   Specifies whether or not there is a class parameter with the
-    #   specified _name_.
+    # Sets a class parameter.
     #
-    def has_param?(name)
+    # @param [Symbol, String] name
+    #   The name of the class parameter.
+    #
+    # @param [Object] value
+    #   The new value for the class parameter.
+    #
+    # @return [Object]
+    #   The new value of the class parameter.
+    #
+    # @raise [ParamNotfound]
+    #   No class parameter with the specified name could be found.
+    #
+    # @since 0.3.0
+    #
+    def set_param(name,value)
       name = name.to_sym
 
       ancestors.each do |ancestor|
         if ancestor.included_modules.include?(Parameters)
-          return true if ancestor.params.has_key?(name)
+          if ancestor.params.has_key?(name)
+            return ancestor.params[name].set(value)
+          end
         end
       end
 
-      return false
+      raise(Parameters::ParamNotFound,"parameter #{name.to_s.dump} was not found in class #{self}")
     end
 
     #

data/lib/parameters/class_param.rb

@@ -42,6 +42,29 @@ module Parameters
       @value = coerce(new_value)
     end
 
+    #
+    # Creates an instance parameter from the class param.
+    #
+    # @param [Object] object
+    #   The object the instance parameter should be connected to.
+    #
+    # @return [InstanceParam]
+    #   The new instance parameter.
+    #
+    # @since 0.3.0
+    #
+    # @api semipublic
+    #
+    def to_instance(object)
+      InstanceParam.new(
+        object,
+        @name,
+        @type,
+        @description,
+        @value
+      )
+    end
+
     #
     # @return [String]
     #   The representation of the class param.

data/lib/parameters/instance_param.rb

@@ -22,10 +22,30 @@ module Parameters
     # @param [String, nil] description
     #   The description of the instance parameter.
     #
-    def initialize(object,name,type=nil,description=nil)
+    # @param [Object] value
+    #   The initial value for the instance parameter.
+    #
+    def initialize(object,name,type=nil,description=nil,value=nil)
       super(name,type,description)
 
       @object = object
+
+      if (self.value.nil? && value)
+        self.value = case value
+                     when Proc
+                       if value.arity > 0
+                         value.call(@object)
+                       else
+                         value.call()
+                       end
+                     else
+                       begin
+                         value.clone
+                       rescue TypeError
+                         value
+                       end
+                     end
+      end
     end
 
     #

data/lib/parameters/param.rb

@@ -1,6 +1,4 @@
-require 'set'
-require 'uri'
-require 'date'
+require 'parameters/types'
 
 module Parameters
   class Param
@@ -28,79 +26,26 @@ module Parameters
     #
     def initialize(name,type=nil,description=nil)
       @name = name.to_sym
-      @type = type
+      @type = case type
+              when Types::Type
+                type
+              when Class
+                if type < Types::Type
+                  type
+                else
+                  Types[type]
+                end
+              else
+                Types[type]
+              end
+
       @description = description
     end
 
     protected
 
-    # Type classes and their coercion methods
-    TYPE_COERSION = {
-      Hash => :coerce_hash,
-      Set => :coerce_set,
-      Array => :coerce_array,
-      URI => :coerce_uri,
-      Regexp => :coerce_regexp,
-      DateTime => :coerce_date,
-      Date => :coerce_date,
-      Symbol => :coerce_symbol,
-      String => :coerce_string,
-      Integer => :coerce_integer,
-      Float => :coerce_float,
-      true => :coerce_boolean
-    }
-
-    #
-    # Coerces a given value into a specific type.
-    #
-    # @param [Class, Proc] type
-    #   The type to coerce the value into. If a Proc is given, it will be
-    #   called with the value to coerce.
-    #
-    # @param [Object] value
-    #   The value to coerce.
-    #
-    # @return [Object]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_type(type,value)
-      if value.nil?
-        nil
-      elsif type.kind_of?(Hash)
-        key_type, value_type = type.entries.first
-        new_hash = {}
-
-        coerce_hash(Hash,value).each do |key,value|
-          key = coerce_type(key_type,key)
-          value = coerce_type(value_type,value)
-
-          new_hash[key] = value
-        end
-
-        return new_hash
-      elsif type.kind_of?(Set)
-        coerce_array(Array,value).map { |element|
-          coerce_type(type.entries.first,element)
-        }.to_set
-      elsif type.kind_of?(Array)
-        coerce_array(Array,value).map do |element|
-          coerce_type(type.entries.first,element)
-        end
-      elsif type.kind_of?(Proc)
-        type.call(value)
-      elsif (method_name = TYPE_COERSION[type])
-        self.send(method_name,type,value)
-      elsif (type.nil? || type == Object)
-        value
-      else
-        type.new(value)
-      end
-    end
-
     #
-    # Coerces a given value into the `type` of the param.
+    # Coerces the value into the param type.
     #
     # @param [Object] value
     #   The value to coerce.
@@ -108,276 +53,11 @@ module Parameters
     # @return [Object]
     #   The coerced value.
     #
-    # @since 0.2.0
-    #
     def coerce(value)
-      coerce_type(@type,value)
-    end
-
-    #
-    # Coerces a given value into a `Hash`.
-    #
-    # @param [Hash{Class => Class}] type
-    #   An optional `Set` containing the type to coerce the keys and values
-    #   of the given value to.
-    #
-    # @param [Hash, #to_hash, Object] value
-    #   The value to coerce into a `Hash`.
-    #
-    # @return [Hash]
-    #   The coerced value.
-    #
-    # @since 0.2.1
-    #
-    def coerce_hash(type,value)
-      if value.kind_of?(Hash)
+      if @type === value 
         value
-      elsif value.kind_of?(Array)
-        Hash[*value]
-      elsif value.respond_to?(:to_hash)
-        value.to_hash
-      else
-        {value => true}
-      end
-    end
-
-    #
-    # Coerces a given value into a `Set`.
-    #
-    # @param [Set[Class]] type
-    #   An optional `Set` containing the type to coerce the elements
-    #   of the given value to.
-    #
-    # @param [Enumerable, Object] value
-    #   The value to coerce into a `Set`.
-    #
-    # @return [Set]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_set(type,value)
-      if value.kind_of?(Set)
-        value
-      elsif (value.kind_of?(Enumerable) || value.respond_to?(:to_set))
-        value.to_set
-      else
-        Set[value]
-      end
-    end
-
-    #
-    # Coerces a given value into an `Array`.
-    #
-    # @param [Array[Class]] type
-    #   An optional `Array` containing the type to coerce the elements
-    #   of the given value to.
-    #
-    # @param [Enumerable, Object] value
-    #   The value to coerce into an `Array`.
-    #
-    # @return [Array]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_array(type,value)
-      if value.kind_of?(Array)
-        value
-      elsif (value.kind_of?(Enumerable) || value.respond_to?(:to_a))
-        value.to_a
-      else
-        [value]
-      end
-    end
-
-    #
-    # Coerces a given value into a `URI`.
-    #
-    # @param [Class] type
-    #   The `URI` type to coerce to.
-    #
-    # @param [URI::Generic, #to_s] value
-    #   The value to coerce into a `URI`.
-    #
-    # @return [URI::Generic]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_uri(type,value)
-      if value.kind_of?(type)
-        value
-      else
-        URI.parse(value.to_s)
-      end
-    end
-
-    #
-    # Coerces a given value into a `Regexp`.
-    #
-    # @param [Class] type
-    #   The `Regexp` type to coerce to.
-    #
-    # @param [Regexp, #to_s] value
-    #   The value to coerce into a `Regexp`.
-    #
-    # @return [Regexp]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_regexp(type,value)
-      if value.kind_of?(Regexp)
-        value
-      else
-        Regexp.new(value.to_s)
-      end
-    end
-
-    #
-    # Coerces a given value into a `Symbol`.
-    #
-    # @param [Class] type
-    #   The `Symbol` class.
-    #
-    # @param [#to_s] value
-    #   The value to coerce.
-    #
-    # @return [Symbol]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_symbol(type,value)
-      if value.kind_of?(type)
-        value
-      else
-        value.to_s.to_sym
-      end
-    end
-
-    #
-    # Coerces a given value into a `String`.
-    #
-    # @param [Class] type
-    #   The `String` class.
-    #
-    # @param [#to_s] value
-    #   The value to coerce into a `String`.
-    #
-    # @return [String]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_string(type,value)
-      if value.kind_of?(type)
-        value
-      else
-        value.to_s
-      end
-    end
-
-    #
-    # Coerces a given value into an `Integer`.
-    #
-    # @param [Class]
-    #   The Integer class.
-    #
-    # @param [String, #to_i] value
-    #   The value to coerce into an `Integer`.
-    #
-    # @return [Integer]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_integer(type,value)
-      if value.kind_of?(type)
-        value
-      elsif value.kind_of?(String)
-        base = if value[0..1] == '0x'
-                 16
-               elsif value[0..0] == '0'
-                 8
-               else
-                 10
-               end
-
-        value.to_i(base)
-      elsif value.respond_to?(:to_i)
-        value.to_i
-      else
-        0
-      end
-    end
-
-    #
-    # Coerces a given value into a `Float`.
-    #
-    # @param [Class] type
-    #   The `Float` class.
-    #
-    # @param [String, #to_f] value
-    #   The value to coerce into a `Float`.
-    #
-    # @return [Float]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_float(type,value)
-      if value.kind_of?(type)
-        value
-      elsif (value.kind_of?(String) || value.respond_to?(:to_f))
-        value.to_f
-      else
-        0.0
-      end
-    end
-
-    #
-    # Coerces a given value into a `DateTime` or `Date`.
-    #
-    # @param [Class] type
-    #   The `DateTime` or `Date` class.
-    #
-    # @param [#to_s] value
-    #   The value to coerce into either a `Date` or `DateTime` object.
-    #
-    # @return [DateTime, Date]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_date(type,value)
-      if value.kind_of?(type)
-        value
-      else
-        type.parse(value.to_s)
-      end
-    end
-
-    #
-    # Coerces a given value into either a `true` or `false` value.
-    #
-    # @param [true] type
-    #
-    # @param [TrueClass, FalseClass, String, Symbol] value
-    #   The value to coerce into either a `true` or `false` value.
-    #
-    # @return [TrueClass, FalseClass]
-    #   The coerced value.
-    #
-    # @since 0.2.0
-    #
-    def coerce_boolean(type,value)
-      case value
-      when FalseClass, NilClass, 'false', :false
-        false
       else
-        true
+        @type.coerce(value)
       end
     end