parameters 0.2.0 → 0.2.1

data/.yardopts

@@ -1 +1 @@
---markup markdown --title 'Parameters Documentation' --protected --files ChangeLog.md,LICENSE.txt
+--quiet --markup markdown --title 'Parameters Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -1,3 +1,14 @@
+### 0.2.1 / 2010-05-05
+
+* Added {Parameters::ClassMethods#included}, so that
+  {Parameters::ClassMethods} can be re-extended by mixin modules which
+  include {Parameters}.
+* Added {Parameters::Param#coerce_hash}.
+* Allow a `Proc` to be given as the coercion type for
+  {Parameters::Param#coerce_type}.
+* Allow custom classes to be used for coercion types.
+* Ruby 1.8.6 bug fixes for {Parameters::Param#coerce_type}.
+
 ### 0.2.0 / 2010-02-18
 
 * Migrated to [Jeweler](http://github.com/technicalpickles/jeweler)

data/Rakefile

@@ -7,6 +7,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = 'parameters'
     gem.version = Parameters::VERSION
+    gem.license = 'MIT'
     gem.summary = %Q{Allows you to add annotated variables to your classes}
     gem.description = %Q{Parameters allows you to add annotated variables to your classes which may have configurable default values.}
     gem.email = 'postmodern.mod3@gmail.com'
@@ -16,6 +17,7 @@ begin
     gem.add_development_dependency 'yard', '>= 0.5.3'
     gem.has_rdoc = 'yard'
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/lib/parameters/class_methods.rb

@@ -4,6 +4,10 @@ require 'parameters/extensions/meta'
 
 module Parameters
   module ClassMethods
+    def included(base)
+      base.extend ClassMethods
+    end
+
     #
     # @return [Hash]
     #   Parameters for the class.

data/lib/parameters/param.rb

@@ -36,6 +36,7 @@ module Parameters
 
     # Type classes and their coercion methods
     TYPE_COERSION = {
+      Hash => :coerce_hash,
       Set => :coerce_set,
       Array => :coerce_array,
       URI => :coerce_uri,
@@ -52,8 +53,9 @@ module Parameters
     #
     # Coerces a given value into a specific type.
     #
-    # @param [Class] type
-    #   The type to coerce the value into.
+    # @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.
@@ -66,18 +68,34 @@ module Parameters
     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.first,element)
+          coerce_type(type.entries.first,element)
         }.to_set
       elsif type.kind_of?(Array)
         coerce_array(Array,value).map do |element|
-          coerce_type(type.first,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)
-      else
+      elsif (type.nil? || type == Object)
         value
+      else
+        type.new(value)
       end
     end
 
@@ -96,6 +114,33 @@ module Parameters
       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)
+        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`.
     #

data/lib/parameters/version.rb

@@ -1,3 +1,3 @@
 module Parameters
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/parameters.gemspec

@@ -5,64 +5,69 @@
 
 Gem::Specification.new do |s|
   s.name = %q{parameters}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Postmodern"]
-  s.date = %q{2010-02-18}
+  s.date = %q{2010-05-05}
   s.description = %q{Parameters allows you to add annotated variables to your classes which may have configurable default values.}
   s.email = %q{postmodern.mod3@gmail.com}
   s.extra_rdoc_files = [
     "ChangeLog.md",
-    "LICENSE.txt",
-    "README.md"
+     "LICENSE.txt",
+     "README.md"
   ]
   s.files = [
     ".gitignore",
-    ".specopts",
-    ".yardopts",
-    "ChangeLog.md",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "lib/parameters.rb",
-    "lib/parameters/class_methods.rb",
-    "lib/parameters/class_param.rb",
-    "lib/parameters/exceptions.rb",
-    "lib/parameters/exceptions/missing_param.rb",
-    "lib/parameters/exceptions/param_not_found.rb",
-    "lib/parameters/extensions.rb",
-    "lib/parameters/extensions/meta.rb",
-    "lib/parameters/extensions/meta/object.rb",
-    "lib/parameters/instance_param.rb",
-    "lib/parameters/param.rb",
-    "lib/parameters/parameters.rb",
-    "lib/parameters/version.rb",
-    "parameters.gemspec",
-    "spec/class_param_spec.rb",
-    "spec/classes/custom_parameters.rb",
-    "spec/classes/inherited_parameters.rb",
-    "spec/classes/other_parameters.rb",
-    "spec/classes/test_parameters.rb",
-    "spec/instance_param_spec.rb",
-    "spec/parameters_spec.rb",
-    "spec/spec_helper.rb"
+     ".specopts",
+     ".yardopts",
+     "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "lib/parameters.rb",
+     "lib/parameters/class_methods.rb",
+     "lib/parameters/class_param.rb",
+     "lib/parameters/exceptions.rb",
+     "lib/parameters/exceptions/missing_param.rb",
+     "lib/parameters/exceptions/param_not_found.rb",
+     "lib/parameters/extensions.rb",
+     "lib/parameters/extensions/meta.rb",
+     "lib/parameters/extensions/meta/object.rb",
+     "lib/parameters/instance_param.rb",
+     "lib/parameters/param.rb",
+     "lib/parameters/parameters.rb",
+     "lib/parameters/version.rb",
+     "parameters.gemspec",
+     "spec/class_param_spec.rb",
+     "spec/classes/custom_parameters.rb",
+     "spec/classes/custom_type.rb",
+     "spec/classes/inherited_parameters.rb",
+     "spec/classes/module_parameters.rb",
+     "spec/classes/other_parameters.rb",
+     "spec/classes/test_parameters.rb",
+     "spec/instance_param_spec.rb",
+     "spec/parameters_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.has_rdoc = %q{yard}
   s.homepage = %q{http://github.com/postmodern/parameters}
+  s.licenses = ["MIT"]
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Allows you to add annotated variables to your classes}
   s.test_files = [
-    "spec/parameters_spec.rb",
     "spec/spec_helper.rb",
-    "spec/class_param_spec.rb",
-    "spec/instance_param_spec.rb",
-    "spec/classes/inherited_parameters.rb",
-    "spec/classes/test_parameters.rb",
-    "spec/classes/custom_parameters.rb",
-    "spec/classes/other_parameters.rb"
+     "spec/class_param_spec.rb",
+     "spec/parameters_spec.rb",
+     "spec/instance_param_spec.rb",
+     "spec/classes/inherited_parameters.rb",
+     "spec/classes/custom_type.rb",
+     "spec/classes/test_parameters.rb",
+     "spec/classes/module_parameters.rb",
+     "spec/classes/custom_parameters.rb",
+     "spec/classes/other_parameters.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/class_param_spec.rb

@@ -1,10 +1,25 @@
 require 'parameters/class_param'
 
 require 'spec_helper'
+require 'classes/custom_type'
 require 'set'
 
 describe Parameters::ClassParam do
   describe "type coercion" do
+    it "should coerce values into Hashes" do
+      param = Parameters::ClassParam.new(:x,Hash)
+
+      param.value = 2
+      param.value.should == {2 => true}
+    end
+
+    it "should coerce keys and values within Hashes" do
+      param = Parameters::ClassParam.new(:x,Hash[Symbol => Object])
+
+      param.value = {'a' => true}
+      param.value.should == {:a => true}
+    end
+
     it "should coerce values into Sets" do
       param = Parameters::ClassParam.new(:x,Set)
 
@@ -152,6 +167,23 @@ describe Parameters::ClassParam do
       param.value.should == false
     end
 
+    it "should coerce values using a Proc for the type" do
+      coercion_logic = lambda { |x| x.to_i.floor }
+      param = Parameters::ClassParam.new(:x,coercion_logic)
+
+      param.value = 2.5
+      param.value.should == 2
+    end
+
+    it "should coerce values using custom Classes" do
+      original_value = Object.new
+      param = Parameters::ClassParam.new(:x,CustomType)
+
+      param.value = original_value
+      param.value.class.should == CustomType
+      param.value.value.should == original_value
+    end
+
     it "should not coerce nil into a type" do
       param = Parameters::ClassParam.new(:x,String)
       obj1 = Object.new

data/spec/classes/custom_type.rb

@@ -0,0 +1,9 @@
+class CustomType
+
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+  end
+
+end

data/spec/classes/module_parameters.rb

@@ -0,0 +1,5 @@
+module ModuleParameters
+  include Parameters
+
+  parameter :mixin_var, :description => 'A parameter added by a mixin'
+end

data/spec/instance_param_spec.rb

@@ -1,6 +1,7 @@
 require 'parameters/instance_param'
 
 require 'spec_helper'
+require 'classes/custom_type'
 require 'set'
 
 describe Parameters::InstanceParam do
@@ -25,6 +26,20 @@ describe Parameters::InstanceParam do
       @obj = Object.new
     end
 
+    it "should coerce values into Hashes" do
+      param = Parameters::InstanceParam.new(@obj,:x,Hash)
+
+      param.value = 2
+      param.value.should == {2 => true}
+    end
+
+    it "should coerce keys and values within Hashes" do
+      param = Parameters::InstanceParam.new(@obj,:x,Hash[Symbol => Object])
+
+      param.value = {'a' => true}
+      param.value.should == {:a => true}
+    end
+
     it "should coerce values into Sets" do
       param = Parameters::InstanceParam.new(@obj,:x,Set)
 
@@ -172,6 +187,23 @@ describe Parameters::InstanceParam do
       param.value.should == false
     end
 
+    it "should coerce values using a Proc for the type" do
+      coercion_logic = lambda { |x| x.to_i.floor }
+      param = Parameters::InstanceParam.new(@obj,:x,coercion_logic)
+
+      param.value = 2.5
+      param.value.should == 2
+    end
+
+    it "should coerce values using custom Classes" do
+      original_value = Object.new
+      param = Parameters::InstanceParam.new(@obj,:x,CustomType)
+
+      param.value = original_value
+      param.value.class.should == CustomType
+      param.value.value.should == original_value
+    end
+
     it "should not coerce nil into a type" do
       param = Parameters::InstanceParam.new(@obj,:x,String)
 

data/spec/parameters_spec.rb

@@ -2,13 +2,28 @@ require 'parameters/parameters'
 
 require 'spec_helper'
 
+require 'classes/module_parameters'
 require 'classes/test_parameters'
 require 'classes/custom_parameters'
 require 'classes/inherited_parameters'
 require 'classes/other_parameters'
 
 describe Parameters do
-  describe "in a Class" do
+  context "in a Module" do
+    it "should provide parameters" do
+      ModuleParameters.should have_param(:mixin_var)
+    end
+
+    it "should re-extend ClassMethods when including the module" do
+      new_class = Class.new do
+        include ModuleParameters
+      end
+
+      new_class.should have_param(:mixin_var)
+    end
+  end
+
+  context "in a Class" do
     it "should provide parameters" do
       TestParameters.params.should_not be_empty
     end
@@ -76,7 +91,7 @@ describe Parameters do
     end
   end
 
-  describe "in an Object" do
+  context "in an Object" do
     before(:each) do
       @test = TestParameters.new
       @test_inherited = InheritedParameters.new

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: parameters
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Postmodern
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -08:00
+date: 2010-05-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
         version: 0.5.3
-    version: 
+  type: :development
+  version_requirements: *id002
 description: Parameters allows you to add annotated variables to your classes which may have configurable default values.
 email: postmodern.mod3@gmail.com
 executables: []
@@ -66,7 +79,9 @@ files:
 - parameters.gemspec
 - spec/class_param_spec.rb
 - spec/classes/custom_parameters.rb
+- spec/classes/custom_type.rb
 - spec/classes/inherited_parameters.rb
+- spec/classes/module_parameters.rb
 - spec/classes/other_parameters.rb
 - spec/classes/test_parameters.rb
 - spec/instance_param_spec.rb
@@ -74,8 +89,8 @@ files:
 - spec/spec_helper.rb
 has_rdoc: yard
 homepage: http://github.com/postmodern/parameters
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -85,27 +100,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Allows you to add annotated variables to your classes
 test_files: 
-- spec/parameters_spec.rb
 - spec/spec_helper.rb
 - spec/class_param_spec.rb
+- spec/parameters_spec.rb
 - spec/instance_param_spec.rb
 - spec/classes/inherited_parameters.rb
+- spec/classes/custom_type.rb
 - spec/classes/test_parameters.rb
+- spec/classes/module_parameters.rb
 - spec/classes/custom_parameters.rb
 - spec/classes/other_parameters.rb