parameters 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.1.1 / 2008-12-27
+
+* Added the require_params helper method.
+* Added print_params methods for displaying parameters of a class or an
+  object.
+
 === 0.1.0 / 2008-12-03
 
 * Initial release.

data/README.txt

@@ -1,7 +1,7 @@
 = Parameters
 
 * http://parameters.rubyforge.org/
-* https://github.com/postmodern/parameters/tree
+* https://github.com/postmodern/parameters
 * Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:

data/lib/parameters.rb

@@ -2,3 +2,4 @@ require 'parameters/param'
 require 'parameters/class_param'
 require 'parameters/instance_param'
 require 'parameters/parameters'
+require 'parameters/version'

data/lib/parameters/class_param.rb

@@ -10,11 +10,30 @@ module Parameters
     # Creates a new ClassParam object with the specified _name_,
     # given _description_ and _value_.
     #
-    def initialize(name,description='',value=nil)
+    def initialize(name,description=nil,value=nil)
       super(name,description)
 
       @value = value
     end
 
+    #
+    # Returns the String representation of the class param.
+    #
+    def to_s
+      text = "  #{@name}"
+
+      text << " [#{@value}]" if @value
+      text << "\t#{@description}" if @description
+
+      return text
+    end
+
+    #
+    # Inspects the class params value.
+    #
+    def inspect
+      @value.inspect
+    end
+
   end
 end

data/lib/parameters/instance_param.rb

@@ -8,7 +8,7 @@ module Parameters
     # Creates a new InstanceParam object with the specified _object_ and
     # _name_, and the given _description_.
     #
-    def initialize(object,name,description='')
+    def initialize(object,name,description=nil)
       super(name,description)
 
       @object = object
@@ -28,6 +28,18 @@ module Parameters
       @object.instance_variable_set("@#{@name}",value)
     end
 
+    #
+    # Returns a String representation of the instance param.
+    #
+    def to_s
+      text = "  #{@name}"
+
+      text << " [#{value}]" if value
+      text << "\t#{@description}" if @description
+
+      return text
+    end
+
     #
     # Inspects the instance params value.
     #

data/lib/parameters/param.rb

@@ -11,7 +11,7 @@ module Parameters
     # Creates a new Param object with the specified _name_ and the given
     # _description_.
     #
-    def initialize(name,description='')
+    def initialize(name,description=nil)
       @name = name.to_sym
       @description = description
     end

data/lib/parameters/parameters.rb

@@ -126,6 +126,15 @@ module Parameters
       def param_value(name)
         get_param(name).value
       end
+
+      #
+      # Print the class parameters to the given _output_ stream.
+      #
+      def print_params(output=STDOUT)
+        each_param do |param|
+          output.puts param
+        end
+      end
     end
   end
 
@@ -147,7 +156,7 @@ module Parameters
         instance_variable_set("@#{param.name}",value)
       end
 
-      params[param.name] = InstanceParam.new(self,param.name,param.description)
+      self.params[param.name] = InstanceParam.new(self,param.name,param.description)
     end
   end
 
@@ -185,7 +194,7 @@ module Parameters
     instance_variable_set("@#{name}",options[:default])
 
     # add the new parameter
-    params[name] = InstanceParam.new(self,name,options[:description])
+    self.params[name] = InstanceParam.new(self,name,options[:description])
 
     instance_eval %{
       # define the reader method for the parameter
@@ -225,11 +234,19 @@ module Parameters
   def params=(values)
     values.each do |name,value|
       if has_param?(name)
-        instance_variable_set("@#{name}",value)
+        self.params[name.to_sym].value = value
       end
     end
   end
 
+  #
+  # Iterates over each instance parameter, passing each one to the given
+  # _block_.
+  #
+  def each_param(&block)
+    self.params.each_value(&block)
+  end
+
   #
   # Returns +true+ if the a parameter with the specified _name_ exists,
   # returns +false+ otherwise.
@@ -237,7 +254,7 @@ module Parameters
   #   obj.has_param?('rhost') # => true
   #
   def has_param?(name)
-    params.has_key?(name.to_sym)
+    self.params.has_key?(name.to_sym)
   end
 
   #
@@ -253,7 +270,7 @@ module Parameters
       raise(ParamNotFound,"parameter #{name.to_s.dump} was not found within #{self.to_s.dump}",caller)
     end
 
-    return params[name]
+    return self.params[name]
   end
 
   #
@@ -277,14 +294,30 @@ module Parameters
   end
 
   #
-  # Sets the values of the parameters listed in the specified _values_.
+  # Print the instance parameters to the given _output_ stream.
+  #
+  def print_params(output=STDOUT)
+    each_param do |param|
+      output.puts param
+    end
+  end
+
+  protected
+
   #
-  #   obj.set_params(:rhost => 'www.example.com', :rport => 80)
-  #   # => {:rhost=>"www.example.com", :rport=>80}
+  # Requires that the parameters with the specified _names_ have
+  # non +nil+ values. If a parameter with a +nil+ value is found
+  # a MissingParam exception will be raised.
   #
-  def set_params(values={})
-    values.each do |name,value|
-      get_param(name).value = value
+  def require_params(*names)
+    names.each do |name|
+      name = name.to_s
+
+      unless instance_variable_get("@#{name}")
+        raise(MissingParam,"parameter #{name.dump} has no value",caller)
+      end
     end
+
+    return true
   end
 end

data/lib/parameters/version.rb

@@ -1,3 +1,3 @@
 module Parameters
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/parameters_spec.rb

@@ -13,6 +13,8 @@ describe Parameters do
                 :default => 'thing',
                 :description => 'This parameter has a default value'
 
+      parameter :var_without_default,
+                :description => 'This parameter does not have a default value'
     end
 
     class InheritedParameters < TestParameters
@@ -116,7 +118,7 @@ describe Parameters do
     end
 
     it "should allow for setting parameters en-mass" do
-      @test.set_params(:var => 3, :var_with_default => 7)
+      @test.params = {:var => 3, :var_with_default => 7}
 
       @test.param_value(:var).should == 3
       @test.param_value(:var_with_default).should == 7
@@ -125,5 +127,11 @@ describe Parameters do
     it "should provide descriptions for parameters" do
       @test.describe_param(:var).should_not be_empty
     end
+
+    it "should require that certain parameters have non nil values" do
+      lambda {
+        @test.instance_eval { require_params(:var_without_default) }
+      }.should raise_error(Parameters::MissingParam)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: parameters
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Postmodern
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-03 00:00:00 -08:00
+date: 2008-12-27 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency