parameters 0.1.4 → 0.1.5

data/History.txt

@@ -1,3 +1,11 @@
+=== 0.1.5 / 2009-05-06
+
+* Added Parameters::Parser for parsing parameter values passed in from
+  the command-line or the web.
+* Changed Parameters::MissingParam and Parameters::ParamNotFound to
+  inherit from StandardError.
+* All specs pass on Ruby 1.9.1-p0.
+
 === 0.1.4 / 2009-01-17
 
 * All specs now pass with RSpec 1.1.12.

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/parameters/exceptions/param_not_found.rb
 lib/parameters/extensions.rb
 lib/parameters/extensions/meta.rb
 lib/parameters/extensions/meta/object.rb
+lib/parameters/parser.rb
 lib/parameters/class_param.rb
 lib/parameters/instance_param.rb
 lib/parameters/param.rb
@@ -18,4 +19,5 @@ tasks/spec.rb
 spec/spec_helper.rb
 spec/helpers/test_parameters.rb
 spec/helpers/inherited_parameters.rb
+spec/parser_spec.rb
 spec/parameters_spec.rb

data/README.txt

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

data/lib/parameters/exceptions/missing_param.rb

@@ -1,4 +1,4 @@
 module Parameters
-  class MissingParam < RuntimeError
+  class MissingParam < StandardError
   end
 end

data/lib/parameters/exceptions/param_not_found.rb

@@ -1,4 +1,4 @@
 module Parameters
-  class ParamNotFound < RuntimeError
+  class ParamNotFound < StandardError
   end
 end

data/lib/parameters/instance_param.rb

@@ -18,14 +18,14 @@ module Parameters
     # Returns the value of the instance param.
     #
     def value
-      @object.instance_variable_get("@#{@name}")
+      @object.instance_variable_get("@#{@name}".to_sym)
     end
 
     #
     # Sets the value of the instance param.
     #
     def value=(value)
-      @object.instance_variable_set("@#{@name}",value)
+      @object.instance_variable_set("@#{@name}".to_sym,value)
     end
 
     #

data/lib/parameters/parameters.rb

@@ -147,7 +147,7 @@ module Parameters
   def initialize_parameters
     self.class.each_param do |param|
       # do not override existing instance value if present
-      unless instance_variable_get("@#{param.name}")
+      unless instance_variable_get("@#{param.name}".to_sym)
         begin
           if param.value.kind_of?(Proc)
             value = param.value.call()
@@ -158,7 +158,7 @@ module Parameters
           value = param.value
         end
 
-        instance_variable_set("@#{param.name}",value)
+        instance_variable_set("@#{param.name}".to_sym,value)
       end
 
       self.params[param.name] = InstanceParam.new(self,param.name,param.description)
@@ -196,7 +196,7 @@ module Parameters
     name = name.to_sym
 
     # set the instance variable
-    instance_variable_set("@#{name}",options[:default])
+    instance_variable_set("@#{name}".to_sym,options[:default])
 
     # add the new parameter
     self.params[name] = InstanceParam.new(self,name,options[:description])
@@ -204,12 +204,12 @@ module Parameters
     instance_eval %{
       # define the reader method for the parameter
       def #{name}
-        instance_variable_get("@#{name}")
+        instance_variable_get("@#{name}".to_sym)
       end
 
       # define the writer method for the parameter
       def #{name}=(value)
-        instance_variable_set("@#{name}",value)
+        instance_variable_set("@#{name}".to_sym,value)
       end
     }
 
@@ -318,7 +318,7 @@ module Parameters
     names.each do |name|
       name = name.to_s
 
-      unless instance_variable_get("@#{name}")
+      unless instance_variable_get("@#{name}".to_sym)
         raise(Parameters::MissingParam,"parameter #{name.dump} has no value",caller)
       end
     end

data/lib/parameters/parser.rb

@@ -0,0 +1,73 @@
+require 'uri'
+
+module Parameters
+  module Parser
+    #
+    # The Array of parameter patterns and their parsers.
+    #
+    def Parser.formats
+      @@parameters_parser_formats ||= []
+    end
+
+    #
+    # Itereates over each parameter pattern and parser, passing them to the
+    # specified _block_.
+    #
+    def Parser.each_format(&block)
+      Parser.formats.each do |format|
+        block.call(format[:pattern],format[:parser])
+      end
+    end
+
+    #
+    # Adds a new parameter _pattern_ using the specified _block_ as the
+    # parser.
+    #
+    def Parser.recognize(pattern,&block)
+      Parser.formats.unshift({
+        :pattern => pattern,
+        :parser => block
+      })
+    end
+
+    #
+    # Parses the specified _value_ string and returns the native Ruby value.
+    # If the _value_ matches one of the patterns within +FORMATS+,
+    # then the associated parser will be used to parse the _value_.
+    #
+    def Parser.parse_value(value)
+      Parser.each_format do |pattern,parser|
+        if value.match(pattern)
+          return parser.call(value)
+        end
+      end
+
+      return value
+    end
+
+    #
+    # Parses the specified _name_and_value_ string of the form
+    # "name=value" and extracts both the _name_ and the _value_, saving
+    # both the _name_ and _value_ within the +params+ Hash. If the
+    # extracted _value_ matches one of the patterns within +FORMATS+,
+    # then the associated parser will first parse the _value_.
+    #
+    def Parser.parse_param(name_and_value)
+      name, value = name_and_value.split('=',2)
+
+      value = Parser.parse_value(value) if value
+      return {name.to_sym => value}
+    end
+
+    Parser.recognize(/^'(\\'|[^'])+'/) { |value|
+      value[1...-1].gsub("\\'","'")
+    }
+    Parser.recognize(/^[a-zA-Z][a-zA-Z0-9]*:\/\//) { |value| URI(value) }
+    Parser.recognize('false') { |value| false }
+    Parser.recognize('true') { |value| true }
+    Parser.recognize(/^[0-9]+$/) { |value| value.to_i }
+    Parser.recognize(/^0[0-7]+$/) { |value| value.oct }
+    Parser.recognize(/^0x[0-9a-fA-F]+$/) { |value| value.hex }
+
+  end
+end

data/lib/parameters/version.rb

@@ -1,3 +1,3 @@
 module Parameters
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/parameters_spec.rb

@@ -77,10 +77,10 @@ describe Parameters do
     end
 
     it "should set instance variables for paramters" do
-      @test.instance_variable_get('@var_with_default').should == 'thing'
+      @test.instance_variable_get(:@var_with_default).should == 'thing'
 
       @test.var = 3
-      @test.instance_variable_get('@var').should == 3
+      @test.instance_variable_get(:@var).should == 3
     end
 
     it "should allow using lambdas for the default values of parameters" do

data/spec/parser_spec.rb

@@ -0,0 +1,40 @@
+require 'parameters/parser'
+
+require 'spec_helper'
+
+describe Parameters::Parser do
+  it "should parse string values" do
+    Parameters::Parser.parse_value("'bla \\' \\\" bla'").should == "bla ' \\\" bla"
+  end
+
+  it "should parse decimal values" do
+    Parameters::Parser.parse_value("100").should == 100
+  end
+
+  it "should parse octal values" do
+    Parameters::Parser.parse_value("012").should == 10
+  end
+
+  it "should parse hexadecimal values" do
+    Parameters::Parser.parse_value("0xff").should == 0xff
+  end
+
+  it "should parse boolean values" do
+    Parameters::Parser.parse_value('true').should == true
+    Parameters::Parser.parse_value('false').should == false
+  end
+
+  it "should parse URI values" do
+    url = 'http://example.com/'
+
+    Parameters::Parser.parse_value(url).should == URI(url)
+  end
+
+  it "should parse params of the form 'name'" do
+    Parameters::Parser.parse_param('var').should == {:var => nil}
+  end
+
+  it "should parse params of the form 'name=value'" do
+    Parameters::Parser.parse_param('var1=test').should == {:var1 => 'test'}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: parameters
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Postmodern
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-17 00:00:00 -08:00
+date: 2009-05-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.12.2
     version: 
 description: Parameters allows you to add annotated variables to your classes which may have configurable default values.
 email: 
@@ -45,6 +45,7 @@ files:
 - lib/parameters/extensions.rb
 - lib/parameters/extensions/meta.rb
 - lib/parameters/extensions/meta/object.rb
+- lib/parameters/parser.rb
 - lib/parameters/class_param.rb
 - lib/parameters/instance_param.rb
 - lib/parameters/param.rb
@@ -54,6 +55,7 @@ files:
 - spec/spec_helper.rb
 - spec/helpers/test_parameters.rb
 - spec/helpers/inherited_parameters.rb
+- spec/parser_spec.rb
 - spec/parameters_spec.rb
 has_rdoc: true
 homepage: http://parameters.rubyforge.org/