parameters 0.1.9 → 0.2.0

data/lib/parameters/parameters.rb

@@ -19,35 +19,42 @@ module Parameters
   #
   def initialize_params(values={})
     self.class.each_param do |param|
+      new_param = InstanceParam.new(
+        self,
+        param.name,
+        param.type,
+        param.description
+      )
+
       # do not override existing instance value if present
-      if instance_variable_get("@#{param.name}".to_sym).nil?
-        begin
-          if param.value.kind_of?(Proc)
-            value = if param.value.arity > 0
-                      param.value.call(self)
-                    else
-                      param.value.call()
-                    end
-          else
+      if new_param.value.nil?
+        if param.value.kind_of?(Proc)
+          value = if param.value.arity > 0
+                    param.value.call(self)
+                  else
+                    param.value.call()
+                  end
+        else
+          begin
             value = param.value.clone
+          rescue TypeError
+            value = param.value
           end
-        rescue TypeError
-          value = param.value
         end
 
-        instance_variable_set("@#{param.name}".to_sym,value)
+        new_param.value = value
       end
 
-      self.params[param.name] = InstanceParam.new(self,param.name,param.description)
+      self.params[param.name] = new_param
     end
 
     self.params = values if values.kind_of?(Hash)
   end
 
   #
-  # Initializes the parameters using initialize_params. If a +Hash+
+  # Initializes the parameters using initialize_params. If a `Hash`
   # is passed in as the first argument, it will be used to set the values
-  # of parameters described within the Hash.
+  # of parameters described within the `Hash`.
   #
   def initialize(*args,&block)
     initialize_params(args.first)
@@ -62,12 +69,15 @@ module Parameters
   # @param [Hash] options
   #   Additional options.
   #
-  # @option options [String] :description
-  #   The description for the new parameter.
+  # @option options [Class, Array[Class]] :type
+  #   The type to enforce the new parameter values to.
   #
   # @option options [Object, Proc] :default
   #   The default value for the new parameter.
   #
+  # @option options [String] :description
+  #   The description for the new parameter.
+  #
   # @return [InstanceParam]
   #   The newly created instance parameter.
   #
@@ -80,7 +90,6 @@ module Parameters
   def parameter(name,options={})
     name = name.to_sym
     default = options[:default]
-    description = options[:description]
 
     # resolve the default value
     if default.kind_of?(Proc)
@@ -93,25 +102,33 @@ module Parameters
       value = default
     end
 
+    # create the new parameter
+    new_param = InstanceParam.new(
+      self,
+      name,
+      options[:type],
+      options[:description]
+    )
+
     # set the instance variable
-    instance_variable_set("@#{name}".to_sym,value)
+    new_param.value = value
 
     # add the new parameter
-    self.params[name] = InstanceParam.new(self,name,description)
+    self.params[name] = new_param
 
     instance_eval %{
       # define the reader method for the parameter
       def #{name}
-        instance_variable_get("@#{name}".to_sym)
+        get_param(#{name.inspect}).value
       end
 
       # define the writer method for the parameter
-      def #{name}=(value)
-        instance_variable_set("@#{name}".to_sym,value)
+      def #{name}=(new_value)
+        get_param(#{name.inspect}).value = new_value
       end
     }
 
-    return params[name]
+    return new_param
   end
 
   #
@@ -243,10 +260,10 @@ module Parameters
 
   #
   # Requires that the instance parameters with specific names have
-  # non +nil+ values.
+  # non `nil` values.
   #
   # @return [true]
-  #   All the instance parameters have non +nil+ values.
+  #   All the instance parameters have non `nil` values.
   #
   # @raise [MissingParam]
   #   One of the instance parameters was not set.

data/lib/parameters/version.rb

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

data/parameters.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{parameters}
+  s.version = "0.2.0"
+
+  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.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"
+  ]
+  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"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/parameters}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<yard>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<yard>, [">= 0.5.3"])
+  end
+end
+

data/spec/class_param_spec.rb

@@ -0,0 +1,171 @@
+require 'parameters/class_param'
+
+require 'spec_helper'
+require 'set'
+
+describe Parameters::ClassParam do
+  describe "type coercion" do
+    it "should coerce values into Sets" do
+      param = Parameters::ClassParam.new(:x,Set)
+
+      param.value = [1, 2, 3, 2]
+      param.value.should == Set[1, 2, 3]
+    end
+
+    it "should coerce values into Sets with types" do
+      param = Parameters::ClassParam.new(:x,Set[Integer])
+
+      param.value = ['x', '0', '1', '2', '3']
+      param.value.should == Set[0, 1, 2, 3]
+    end
+
+    it "should coerce values into Arrays" do
+      param = Parameters::ClassParam.new(:x,Array)
+
+      param.value = Set[1, 2, 3]
+      param.value.should == [1, 2, 3]
+    end
+
+    it "should coerce values into Arrays with types" do
+      param = Parameters::ClassParam.new(:x,Array[Integer])
+
+      param.value = Set['1', '2', '3']
+      param.value.should == [1, 2, 3]
+    end
+
+    it "should coerce values into URIs" do
+      param = Parameters::ClassParam.new(:x,URI)
+
+      param.value = 'http://bla.com/'
+      param.value.should == URI::HTTP.build(:host => 'bla.com')
+    end
+
+    it "should coerce values into Regexp" do
+      param = Parameters::ClassParam.new(:x,Regexp)
+
+      param.value = 'x*'
+      param.value.should == /x*/
+    end
+
+    it "should coerce values into Dates" do
+      param = Parameters::ClassParam.new(:x,Date)
+
+      param.value = '2010-02-18'
+      param.value.should == Date.new(2010,2,18)
+    end
+
+    it "should coerce values into DateTimes" do
+      param = Parameters::ClassParam.new(:x,DateTime)
+
+      param.value = '2010-02-18T00:36:31-08:00'
+      param.value.should == DateTime.new(2010,2,18,0,36,31,Rational(-1,3),2299161)
+    end
+
+    it "should coerce values into Symbols" do
+      param = Parameters::ClassParam.new(:x,Symbol)
+
+      param.value = 'str'
+      param.value.should == :str
+    end
+
+    it "should coerce values into Strings" do
+      param = Parameters::ClassParam.new(:x,String)
+
+      param.value = :str
+      param.value.should == 'str'
+    end
+
+    it "should coerce values into Floats" do
+      param = Parameters::ClassParam.new(:x,Float)
+
+      param.value = '0.5'
+      param.value.should == 0.5
+    end
+
+    it "should coerce values into Integers" do
+      param = Parameters::ClassParam.new(:x,Integer)
+
+      param.value = '5'
+      param.value.should == 5
+    end
+
+    it "should coerce values into hex Integers" do
+      param = Parameters::ClassParam.new(:x,Integer)
+
+      param.value = '0xa'
+      param.value.should == 10
+    end
+
+    it "should coerce values into octal Integers" do
+      param = Parameters::ClassParam.new(:x,Integer)
+
+      param.value = '010'
+      param.value.should == 8
+    end
+
+    it "should coerce values into true boolean values" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = true
+      param.value.should == true
+    end
+
+    it "should coerce non-false boolean values as true" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = '1'
+      param.value.should == true
+    end
+
+    it "should coerce 'true' boolean values into true" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = 'true'
+      param.value.should == true
+    end
+
+    it "should coerce :true boolean values into true" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = :true
+      param.value.should == true
+    end
+
+    it "should coerce values into false" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = false
+      param.value.should == false
+    end
+
+    it "should coerce 'false' boolean values into false" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = 'false'
+      param.value.should == false
+    end
+
+    it "should coerce :false boolean values into false" do
+      param = Parameters::ClassParam.new(:x,true)
+
+      param.value = :false
+      param.value.should == false
+    end
+
+    it "should not coerce nil into a type" do
+      param = Parameters::ClassParam.new(:x,String)
+      obj1 = Object.new
+
+      param.value = nil
+      param.value.should be_nil
+    end
+
+    it "should not coerce unknown types" do
+      param = Parameters::ClassParam.new(:x)
+      obj1 = Object.new
+
+      param.value = obj1
+      param.value.should == obj1
+    end
+  end
+end

data/spec/instance_param_spec.rb

@@ -0,0 +1,190 @@
+require 'parameters/instance_param'
+
+require 'spec_helper'
+require 'set'
+
+describe Parameters::InstanceParam do
+  it "should read values from another object" do
+    obj = Object.new
+    param = Parameters::InstanceParam.new(obj,:x)
+
+    obj.instance_variable_set(:"@x",5)
+    param.value.should == 5
+  end
+
+  it "should write values to another object" do
+    obj = Object.new
+    param = Parameters::InstanceParam.new(obj,:x)
+
+    param.value = 5
+    obj.instance_variable_get(:"@x").should == 5
+  end
+
+  describe "type coercion" do
+    before(:each) do
+      @obj = Object.new
+    end
+
+    it "should coerce values into Sets" do
+      param = Parameters::InstanceParam.new(@obj,:x,Set)
+
+      param.value = [1, 2, 3, 2]
+      param.value.should == Set[1, 2, 3]
+    end
+
+    it "should coerce values into Sets with types" do
+      param = Parameters::InstanceParam.new(@obj,:x,Set[Integer])
+
+      param.value = ['x', '0', '1', '2', '3']
+      param.value.should == Set[0, 1, 2, 3]
+    end
+
+    it "should coerce values into Arrays" do
+      param = Parameters::InstanceParam.new(@obj,:x,Array)
+
+      param.value = Set[1, 2, 3]
+      param.value.should == [1, 2, 3]
+    end
+
+    it "should coerce values into Arrays with types" do
+      param = Parameters::InstanceParam.new(@obj,:x,Array[Integer])
+
+      param.value = Set['1', '2', '3']
+      param.value.should == [1, 2, 3]
+    end
+
+    it "should coerce values into URIs" do
+      param = Parameters::InstanceParam.new(@obj,:x,URI)
+
+      param.value = 'http://bla.com/'
+      param.value.should == URI::HTTP.build(:host => 'bla.com')
+    end
+
+    it "should coerce values into Regexp" do
+      param = Parameters::InstanceParam.new(@obj,:x,Regexp)
+
+      param.value = 'x*'
+      param.value.should == /x*/
+    end
+
+    it "should coerce values into Dates" do
+      param = Parameters::InstanceParam.new(@obj,:x,Date)
+
+      param.value = '2010-02-18'
+      param.value.should == Date.new(2010,2,18)
+    end
+
+    it "should coerce values into DateTimes" do
+      param = Parameters::InstanceParam.new(@obj,:x,DateTime)
+
+      param.value = '2010-02-18T00:36:31-08:00'
+      param.value.should == DateTime.new(2010,2,18,0,36,31,Rational(-1,3),2299161)
+    end
+
+    it "should coerce values into Symbols" do
+      param = Parameters::InstanceParam.new(@obj,:x,Symbol)
+
+      param.value = 'str'
+      param.value.should == :str
+    end
+
+    it "should coerce values into Strings" do
+      param = Parameters::InstanceParam.new(@obj,:x,String)
+
+      param.value = :str
+      param.value.should == 'str'
+    end
+
+    it "should coerce values into Floats" do
+      param = Parameters::InstanceParam.new(@obj,:x,Float)
+
+      param.value = '0.5'
+      param.value.should == 0.5
+    end
+
+    it "should coerce values into Integers" do
+      param = Parameters::InstanceParam.new(@obj,:x,Integer)
+
+      param.value = '5'
+      param.value.should == 5
+    end
+
+    it "should coerce values into hex Integers" do
+      param = Parameters::InstanceParam.new(@obj,:x,Integer)
+
+      param.value = '0xa'
+      param.value.should == 10
+    end
+
+    it "should coerce values into octal Integers" do
+      param = Parameters::InstanceParam.new(@obj,:x,Integer)
+
+      param.value = '010'
+      param.value.should == 8
+    end
+
+    it "should coerce true boolean values" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = true
+      param.value.should == true
+    end
+
+    it "should coerce non-false boolean values into true" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = '1'
+      param.value.should == true
+    end
+
+    it "should coerce 'true' boolean values into true" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = 'true'
+      param.value.should == true
+    end
+
+    it "should coerce :true boolean values into true" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = :true
+      param.value.should == true
+    end
+
+    it "should coerce false values" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = false
+      param.value.should == false
+    end
+
+    it "should coerce 'false' boolean values into false" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = 'false'
+      param.value.should == false
+    end
+
+    it "should coerce :false boolean values into false" do
+      param = Parameters::InstanceParam.new(@obj,:x,true)
+
+      param.value = :false
+      param.value.should == false
+    end
+
+    it "should not coerce nil into a type" do
+      param = Parameters::InstanceParam.new(@obj,:x,String)
+
+      param.value = nil
+      param.value.should be_nil
+    end
+
+    it "should not coerce unknown types" do
+      param = Parameters::InstanceParam.new(@obj,:x)
+      obj1 = Object.new
+
+      param.value = obj1
+      param.value.should == obj1
+    end
+  end
+end