parameters 0.1.6 → 0.1.7

data.tar.gz.sig

@@ -0,0 +1,3 @@
+����)u�Dȍj�3���rO�)B</�(�*yB��0	��(����d���ݑ��H>����e�_bف�B�
+Z
+��`��:F�a=�@�o

data/History.txt

@@ -1,3 +1,18 @@
+=== 0.1.7 / 2009-07-19
+
+* Renamed Parameters#initialize_parameters to
+  Parameters#initialize_params.
+* Adjust spacing in the output of ClassParam#to_s
+  and InstanceParam#to_s.
+* Specifically check if the instance variable is nil
+  before initializing it to the default value of the parameter.
+* Handle default value callbacks in Parameters#parameter.
+* Check the arity of all default value callbacks, before
+  passing self to them.
+* Parameters#require_params now specifically tests if
+  the instance variable of the parameter is nil.
+* Added more specs.
+
 === 0.1.6 / 2009-05-11
 
 * Fixed a bug in Parameters.params= and Parameters#params=, where they

data/Manifest.txt

@@ -18,6 +18,7 @@ lib/parameters/version.rb
 tasks/spec.rb
 spec/spec_helper.rb
 spec/classes/test_parameters.rb
+spec/classes/custom_parameters.rb
 spec/classes/inherited_parameters.rb
 spec/classes/other_parameters.rb
 spec/parser_spec.rb

data/Rakefile

@@ -2,13 +2,14 @@
 
 require 'rubygems'
 require 'hoe'
+require 'hoe/signing'
 require './tasks/spec.rb'
 require './lib/parameters/version.rb'
 
-Hoe.new('parameters', Parameters::VERSION) do |p|
-  p.rubyforge_name = 'parameters'
-  p.developer('Postmodern','postmodern.mod3@gmail.com')
-  p.remote_rdoc_dir = '/'
+Hoe.spec('parameters') do
+  self.rubyforge_name = 'parameters'
+  self.developer('Postmodern','postmodern.mod3@gmail.com')
+  self.remote_rdoc_dir = '/'
 end
 
 # vim: syntax=Ruby

data/lib/parameters/class_param.rb

@@ -23,7 +23,7 @@ module Parameters
       text = "  #{@name}"
 
       text << " [#{@value.inspect}]" if @value
-      text << "\t#{@description}" if @description
+      text << "\t\t#{@description}" if @description
 
       return text
     end

data/lib/parameters/instance_param.rb

@@ -35,7 +35,7 @@ module Parameters
       text = "  #{@name}"
 
       text << " [#{value.inspect}]" if value
-      text << "\t#{@description}" if @description
+      text << "\t\t#{@description}" if @description
 
       return text
     end

data/lib/parameters/parameters.rb

@@ -148,13 +148,17 @@ module Parameters
   # _values_, which can override the default values of
   # parameters.
   #
-  def initialize_parameters
+  def initialize_params(values={})
     self.class.each_param do |param|
       # do not override existing instance value if present
-      unless instance_variable_get("@#{param.name}".to_sym)
+      if instance_variable_get("@#{param.name}".to_sym).nil?
         begin
           if param.value.kind_of?(Proc)
-            value = param.value.call()
+            value = if param.value.arity > 0
+                      param.value.call(self)
+                    else
+                      param.value.call()
+                    end
           else
             value = param.value.clone
           end
@@ -167,21 +171,17 @@ module Parameters
 
       self.params[param.name] = InstanceParam.new(self,param.name,param.description)
     end
+
+    self.params = values if values.kind_of?(Hash)
   end
 
   #
-  # Initializes the parameters using initialize_parameters. 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.
   #
   def initialize(*args,&block)
-    initialize_parameters
-
-    values = args.first
-
-    if values.kind_of?(Hash)
-      self.params = values
-    end
+    initialize_params(args.first)
   end
 
   #
@@ -198,12 +198,25 @@ 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)
+      value = if default.arity > 0
+                default.call(self)
+              else
+                default.call()
+              end
+    else
+      value = default
+    end
 
     # set the instance variable
-    instance_variable_set("@#{name}".to_sym,options[:default])
+    instance_variable_set("@#{name}".to_sym,value)
 
     # add the new parameter
-    self.params[name] = InstanceParam.new(self,name,options[:description])
+    self.params[name] = InstanceParam.new(self,name,description)
 
     instance_eval %{
       # define the reader method for the parameter
@@ -328,7 +341,7 @@ module Parameters
     names.each do |name|
       name = name.to_s
 
-      unless instance_variable_get("@#{name}".to_sym)
+      if instance_variable_get("@#{name}".to_sym).nil?
         raise(Parameters::MissingParam,"parameter #{name.dump} has no value",caller)
       end
     end

data/lib/parameters/version.rb

@@ -1,3 +1,3 @@
 module Parameters
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/spec/classes/custom_parameters.rb

@@ -0,0 +1,20 @@
+require 'parameters'
+
+class CustomParameters
+
+  include Parameters
+
+  parameter :var, :description => 'A basic parameter'
+
+  parameter :var_with_default,
+            :default => 10,
+            :description => 'A parameter with a default value'
+
+  def initialize(var=nil,var_with_default=nil)
+    @var = var
+    @var_with_default = var_with_default
+
+    initialize_params()
+  end
+
+end

data/spec/classes/other_parameters.rb

@@ -4,7 +4,7 @@ class OtherParameters
   parameter :var, :description => 'Test parameter'
 
   parameter :var_with_default,
-    :default => 'other',
-    :description => 'This parameter has a default value'
+            :default => 'other',
+            :description => 'This parameter has a default value'
 
 end

data/spec/classes/test_parameters.rb

@@ -4,13 +4,13 @@ class TestParameters
   parameter :var, :description => 'Test parameter'
 
   parameter :var_with_default,
-    :default => 'thing',
-    :description => 'This parameter has a default value'
+            :default => 'thing',
+            :description => 'This parameter has a default value'
 
   parameter :var_without_default,
-    :description => 'This parameter does not have a default value'
+            :description => 'This parameter does not have a default value'
 
   parameter :var_with_lambda,
-    :default => lambda { rand },
-    :description => 'This parameter uses a lambda instead of a default value'
+            :default => lambda { rand },
+            :description => 'This parameter uses a lambda instead of a default value'
 end

data/spec/parameters_spec.rb

@@ -3,6 +3,7 @@ require 'parameters/parameters'
 require 'spec_helper'
 
 require 'classes/test_parameters'
+require 'classes/custom_parameters'
 require 'classes/inherited_parameters'
 require 'classes/other_parameters'
 
@@ -41,6 +42,32 @@ describe Parameters do
       TestParameters.describe_param(:var).should_not be_empty
     end
 
+    it "should be able to initialize parameters" do
+      obj = TestParameters.new
+
+      obj.params.should_not be_empty
+    end
+
+    it "should set initialize parameters with initial nil values" do
+      obj = CustomParameters.new
+
+      obj.var_with_default.should == 10
+    end
+
+    it "should not override previous parameter values" do
+      obj = CustomParameters.new(:test,5)
+
+      obj.var.should == :test
+      obj.var_with_default.should == 5
+    end
+
+    it "should not override previous 'false' values of parameters" do
+      obj = CustomParameters.new(false,false)
+
+      obj.var.should == false
+      obj.var_with_default.should == false
+    end
+
     it "should be able to create an object with initial parameter values" do
       obj = TestParameters.new(:var => 2, :var_with_default => 'stuff')
 
@@ -130,4 +157,50 @@ describe Parameters do
       }.should raise_error(Parameters::MissingParam)
     end
   end
+
+  describe "runtime" do
+    before(:each) do
+      @test = TestParameters.new
+
+      @test.parameter :new_param
+      @test.parameter :new_param_with_default,
+                      :default => 5
+      @test.parameter :new_param_with_lambda,
+                      :default => lambda { |obj| obj.new_param_with_default + 2 }
+    end
+
+    it "should allow for the addition of parameters" do
+      @test.has_param?(:new_param).should == true
+    end
+
+    it "should provide direct access to all parameters" do
+      @test.params[:new_param].should_not be_nil
+      @test.params[:new_param_with_default].should_not be_nil
+      @test.params[:new_param_with_lambda].should_not be_nil
+    end
+
+    it "should add reader methods for parameters" do
+      @test.new_param.should be_nil
+    end
+
+    it "should add writer methods for parameters" do
+      @test.new_param = 10
+      @test.new_param.should == 10
+    end
+
+    it "should set the instance variables of parameters" do
+      @test.instance_variable_get(:@new_param_with_default).should == 5
+
+      @test.new_param_with_default = 10
+      @test.instance_variable_get(:@new_param_with_default).should == 10
+    end
+
+    it "should initialize parameters with default values" do
+      @test.new_param_with_default.should == 5
+    end
+
+    it "should initialize pamareters with default lambda values" do
+      @test.new_param_with_lambda.should == 7
+    end
+  end
 end

metadata

@@ -1,15 +1,36 @@
 --- !ruby/object:Gem::Specification 
 name: parameters
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Postmodern
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9wb3N0
+  bW9kZXJuLm1vZDMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0wOTA2MDMwNDU5MDNaFw0xMDA2MDMwNDU5MDNaMEYxGDAWBgNV
+  BAMMD3Bvc3Rtb2Rlcm4ubW9kMzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  1wvANkTDHFgVih5XLjuTwTZjgBq1lBGybXJiH6Id1lY2JOMqM5FB1DDHVvvij94i
+  mJabN0zkzu6VKWC70y0IwOxY7CPokr0eFdK/D0y7mCq1P8QITv76i2YqAl0eYqIt
+  W+IhIkANQ7E6uMZIZcdnfadC6lPAtlKkqtd9crvRbFgr6e3kyflmohbRnTEJHoRd
+  7SHHsybE6DSn7oTDs6XBTNrNIn5VfZA0z01eeos/+zBm1zKJOK2+/7xtLLDuDU9G
+  +Rd+ltUBbvxUrMNZmDG29pnmN2xTRH+Q8HxD2AxlvM5SRpK6OeZaHV7PaCCAVZ4L
+  T9BFl1sfMvRlABeGEkSyuQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUKwsd+PqEYmBvyaTyoL+uRuk+PhEwDQYJKoZIhvcNAQEFBQAD
+  ggEBAB4TvHsrlbcXcKg6gX5BIb9tI+zGkpzo0Z7jnxMEcNO7NGGwmzafDBI/xZYv
+  xkRH3/HXbGGYDOi6Q6gWt5GujSx0bOImDtYTJTH8jnzN92HzEK5WdScm1QpZKF1e
+  cezArMbxbSPaosxTCtG6LQTkE28lFQsmFZ5xzouugS4h5+LVJiVMmiP+l3EfkjFa
+  GOURU+rNEMPWo8MCWivGW7jes6BMzWHcW7DQ0scNVmIcCIgdyMmpscuAEOSeghy9
+  /fFs57Ey2OXBL55nDOyvN/ZQ2Vab05UH4t+GCxjAPeirzL/29FBtePT6VD44c38j
+  pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
+  -----END CERTIFICATE-----
 
-date: 2009-05-11 00:00:00 -07:00
+date: 2009-07-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,9 +41,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.12.2
+        version: 2.3.2
     version: 
-description: Parameters allows you to add annotated variables to your classes which may have configurable default values.
+description: |-
+  Parameters allows you to add annotated variables to your classes which may
+  have configurable default values.
 email: 
 - postmodern.mod3@gmail.com
 executables: []
@@ -54,12 +77,15 @@ files:
 - tasks/spec.rb
 - spec/spec_helper.rb
 - spec/classes/test_parameters.rb
+- spec/classes/custom_parameters.rb
 - spec/classes/inherited_parameters.rb
 - spec/classes/other_parameters.rb
 - spec/parser_spec.rb
 - spec/parameters_spec.rb
 has_rdoc: true
 homepage: http://parameters.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -81,9 +107,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: parameters
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Parameters allows you to add annotated variables to your classes which may have configurable default values.
 test_files: []
 

metadata.gz.sig

@@ -0,0 +1,2 @@
+~���p�0�0w���(g@�Fm��ؘ`�U�%ӡ#�Dҍen��_$�ϊAq�T3���A�m�d$Ś8��qa
+�k���Az��5`��kebEy�H6��	�w)}uѧ��9�6E���=#^����Ki���3^�u��W���s�ٜ5�L�d j�
d��V�3�sDS���V��-��������U0ؐ6���L�o(Y��9����%��)"���X�T'Q���۴�ȏ�Ё%@�y��t���z��N>�N[