parameters 0.1.8 → 0.1.9

data/{History.txt → History.rdoc}

@@ -1,3 +1,9 @@
+=== 0.1.9 / 2009-01-30
+
+* Require RSpec >= 1.3.0.
+* Require YARD >= 0.5.3.
+* Added {Parameters::ClassMethods}.
+
 === 0.1.8 / 2009-09-21
 
 * Require Hoe >= 2.3.3.

data/Manifest.txt

@@ -1,6 +1,6 @@
-History.txt
+History.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 lib/parameters.rb
 lib/parameters/exceptions.rb
@@ -13,19 +13,15 @@ lib/parameters/parser.rb
 lib/parameters/class_param.rb
 lib/parameters/instance_param.rb
 lib/parameters/param.rb
+lib/parameters/class_methods.rb
 lib/parameters/parameters.rb
 lib/parameters/version.rb
 lib/parameters/yard.rb
 lib/parameters/yard/handlers.rb
 lib/parameters/yard/handlers/ruby.rb
-lib/parameters/yard/handlers/ruby/eval_block_handler.rb
-lib/parameters/yard/handlers/ruby/metaclass_eval_handler.rb
 lib/parameters/yard/handlers/ruby/parameter_handler.rb
 lib/parameters/yard/handlers/ruby/legacy.rb
-lib/parameters/yard/handlers/ruby/legacy/eval_block_handler.rb
-lib/parameters/yard/handlers/ruby/legacy/metaclass_eval_handler.rb
 lib/parameters/yard/handlers/ruby/legacy/parameter_handler.rb
-tasks/spec.rb
 spec/spec_helper.rb
 spec/classes/test_parameters.rb
 spec/classes/custom_parameters.rb

data/{README.txt → README.rdoc}

@@ -17,7 +17,7 @@ have configurable default values.
 * Change default values of parameters.
 * Give descriptions to parameters.
 * Set parameters en-mass.
-* Parse strings of the form +name=value+ into a Hash of parameters.
+* Parse strings of the form <tt>name=value</tt> into a Hash of parameters.
 
 == EXAMPLES:
 
@@ -61,10 +61,6 @@ have configurable default values.
   # Parse user given name=value parameter strings
   oct.params = Parameters::Parser.parse(ARGV)
 
-== REQUIREMENTS:
-
-* {YARD}[http://yard.soen.ca/] >= 0.2.3.5
-
 == INSTALL:
 
   $ sudo gem install parameters
@@ -73,7 +69,7 @@ have configurable default values.
 
 The MIT License
 
-Copyright (c) 2008-2009 Hal Brodigan
+Copyright (c) 2008-2010 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -3,22 +3,21 @@
 require 'rubygems'
 require 'hoe'
 require 'hoe/signing'
-require './tasks/spec.rb'
-require './tasks/yard.rb'
+
+Hoe.plugin :yard
 
 Hoe.spec('parameters') do
-  self.rubyforge_name = 'parameters'
   self.developer('Postmodern','postmodern.mod3@gmail.com')
-  self.remote_rdoc_dir = '/'
-  self.extra_deps = [
-    ['yard', '>=0.2.3.5']
-  ]
 
-  self.extra_dev_deps = [
-    ['rspec', '>=1.2.8']
-  ]
+  self.rspec_options += ['--colour', '--format', 'specdoc']
 
-  self.spec_extras = {:has_rdoc => 'yard'}
+  self.yard_options += ['--protected']
+  self.remote_yard_dir = '/'
+
+  self.extra_dev_deps += [
+    ['rspec', '>=1.3.0'],
+    ['yard', '>=0.5.3']
+  ]
 end
 
 # vim: syntax=Ruby

data/lib/parameters/class_methods.rb

@@ -0,0 +1,163 @@
+require 'parameters/exceptions'
+require 'parameters/class_param'
+require 'parameters/extensions/meta'
+
+module Parameters
+  module ClassMethods
+    #
+    # @return [Hash]
+    #   Parameters for the class.
+    #
+    def params
+      @params ||= {}
+    end
+
+    #
+    # Sets the values of the class parameters.
+    #
+    # @param [Hash] values
+    #   The names and new values to set the class params to.
+    #
+    # @example
+    #   Test.params = {:x => 5, :y => 2}
+    #   # => {:x=>5, :y=>2}
+    #
+    def params=(values)
+      values.each do |name,value|
+        if has_param?(name)
+          if (value.kind_of?(Parameters::ClassParam) || value.kind_of?(Parameters::InstanceParam))
+            value = value.value
+          end
+
+          get_param(name).value = value
+        end
+      end
+    end
+
+    #
+    # Adds a new parameters to the class.
+    #
+    # @param [Symbol, String] name
+    #   The name of the new parameter.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :description
+    #   The description for the new parameter.
+    #
+    # @option options [Object, Proc] :default
+    #   The default value for the new parameter.
+    #
+    # @example
+    #   parameter 'var'
+    #
+    # @example
+    #   parameter 'var', :default => 3, :description => 'my variable' 
+    #
+    def parameter(name,options={})
+      name = name.to_sym
+
+      # add the parameter to the class params list
+      params[name] = Parameters::ClassParam.new(name,options[:description],options[:default])
+
+      # define the reader class method for the parameter
+      meta_def(name) do
+        params[name].value
+      end
+
+      # define the writer class method for the parameter
+      meta_def("#{name}=") do |value|
+        params[name].value = value
+      end
+
+      # define the getter/setter instance methods for the parameter
+      attr_accessor(name)
+    end
+
+    #
+    # Searches for the class parameter with the matching name.
+    #
+    # @param [Symbol, String] name
+    #   The class parameter name to search for.
+    #
+    # @return [ClassParam]
+    #   The class parameter with the matching _name_.
+    #
+    # @raise [ParamNotFound]
+    #   No class parameter with the specified _name_ could be found.
+    #
+    def get_param(name)
+      name = name.to_sym
+
+      ancestors.each do |ancestor|
+        if ancestor.include?(Parameters)
+          if ancestor.params.has_key?(name)
+            return ancestor.params[name]
+          end
+        end
+      end
+
+      raise(Parameters::ParamNotFound,"parameter #{name.to_s.dump} was not found in class #{self.name.dump}",caller)
+    end
+
+    #
+    # @return [Boolean]
+    #   Specifies whether or not there is a class parameter with the
+    #   specified _name_.
+    #
+    def has_param?(name)
+      name = name.to_sym
+
+      ancestors.each do |ancestor|
+        if ancestor.include?(Parameters)
+          return true if ancestor.params.has_key?(name)
+        end
+      end
+
+      return false
+    end
+
+    #
+    # Iterates over the parameters of the class and it's ancestors.
+    #
+    # @yield [param]
+    #   The block that will be passed each class parameter.
+    #
+    def each_param(&block)
+      ancestors.each do |ancestor|
+        if ancestor.include?(Parameters)
+          ancestor.params.each_value(&block)
+        end
+      end
+
+      return self
+    end
+
+    #
+    # Returns the description of the class parameters with a given name.
+    #
+    # @return [String]
+    #   Description of the class parameter with the specified name.
+    #
+    # @raise [ParamNotFound]
+    #   No class parameter with the specified name could be found.
+    #
+    def describe_param(name)
+      get_param(name).description
+    end
+
+    #
+    # Returns the value of the class parameters with a given name.
+    #
+    # @return [Object]
+    #   Value of the class parameter with the specified name.
+    #
+    # @raise [ParamNotFound]
+    #   No class parameter with the specified name could be found.
+    #
+    def param_value(name)
+      get_param(name).value
+    end
+  end
+end

data/lib/parameters/extensions/meta/object.rb

@@ -4,14 +4,6 @@ class Object # :nodoc:
   def metaclass; class << self; self; end; end
   def meta_eval(&blk); metaclass.instance_eval(&blk); end
 
-  # A class_eval version of meta_eval
-  def metaclass_eval(&blk); metaclass.class_eval(&blk); end
-
-  # A class_def version of meta_def
-  def metaclass_def(name, &blk)
-    metaclass_eval { define_method(name, &blk) }
-  end
-  
   # Adds methods to a metaclass
   def meta_def(name, &blk)
     meta_eval { define_method(name, &blk) }

data/lib/parameters/parameters.rb

@@ -1,4 +1,5 @@
 require 'parameters/exceptions'
+require 'parameters/class_methods'
 require 'parameters/class_param'
 require 'parameters/instance_param'
 require 'parameters/exceptions'
@@ -6,163 +7,7 @@ require 'parameters/extensions/meta'
 
 module Parameters
   def self.included(base)
-    base.metaclass_eval do
-      #
-      # @return [Hash]
-      #   Parameters for the class.
-      #
-      def params
-        @params ||= {}
-      end
-
-      #
-      # Sets the values of the class parameters.
-      #
-      # @param [Hash] values
-      #   The names and new values to set the class params to.
-      #
-      # @example
-      #   Test.params = {:x => 5, :y => 2}
-      #   # => {:x=>5, :y=>2}
-      #
-      def params=(values)
-        values.each do |name,value|
-          if has_param?(name)
-            if (value.kind_of?(Parameters::ClassParam) || value.kind_of?(Parameters::InstanceParam))
-              value = value.value
-            end
-
-            get_param(name).value = value
-          end
-        end
-      end
-
-      #
-      # Adds a new parameters to the class.
-      #
-      # @param [Symbol, String] name
-      #   The name of the new parameter.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [String] :description
-      #   The description for the new parameter.
-      #
-      # @option options [Object, Proc] :default
-      #   The default value for the new parameter.
-      #
-      # @example
-      #   parameter 'var'
-      #
-      # @example
-      #   parameter 'var', :default => 3, :description => 'my variable' 
-      #
-      def parameter(name,options={})
-        name = name.to_sym
-
-        # add the parameter to the class params list
-        params[name] = Parameters::ClassParam.new(name,options[:description],options[:default])
-
-        # define the reader class method for the parameter
-        meta_def(name) do
-          params[name].value
-        end
-
-        # define the writer class method for the parameter
-        meta_def("#{name}=") do |value|
-          params[name].value = value
-        end
-
-        # define the getter/setter instance methods for the parameter
-        attr_accessor(name)
-      end
-
-      #
-      # Searches for the class parameter with the matching name.
-      #
-      # @param [Symbol, String] name
-      #   The class parameter name to search for.
-      #
-      # @return [ClassParam]
-      #   The class parameter with the matching _name_.
-      #
-      # @raise [ParamNotFound]
-      #   No class parameter with the specified _name_ could be found.
-      #
-      def get_param(name)
-        name = name.to_sym
-
-        ancestors.each do |ancestor|
-          if ancestor.include?(Parameters)
-            if ancestor.params.has_key?(name)
-              return ancestor.params[name]
-            end
-          end
-        end
-
-        raise(Parameters::ParamNotFound,"parameter #{name.to_s.dump} was not found in class #{self.name.dump}",caller)
-      end
-
-      #
-      # @return [Boolean]
-      #   Specifies whether or not there is a class parameter with the
-      #   specified _name_.
-      #
-      def has_param?(name)
-        name = name.to_sym
-
-        ancestors.each do |ancestor|
-          if ancestor.include?(Parameters)
-            return true if ancestor.params.has_key?(name)
-          end
-        end
-
-        return false
-      end
-
-      #
-      # Iterates over the parameters of the class and it's ancestors.
-      #
-      # @yield [param]
-      #   The block that will be passed each class parameter.
-      #
-      def each_param(&block)
-        ancestors.each do |ancestor|
-          if ancestor.include?(Parameters)
-            ancestor.params.each_value(&block)
-          end
-        end
-
-        return self
-      end
-
-      #
-      # Returns the description of the class parameters with a given name.
-      #
-      # @return [String]
-      #   Description of the class parameter with the specified name.
-      #
-      # @raise [ParamNotFound]
-      #   No class parameter with the specified name could be found.
-      #
-      def describe_param(name)
-        get_param(name).description
-      end
-
-      #
-      # Returns the value of the class parameters with a given name.
-      #
-      # @return [Object]
-      #   Value of the class parameter with the specified name.
-      #
-      # @raise [ParamNotFound]
-      #   No class parameter with the specified name could be found.
-      #
-      def param_value(name)
-        get_param(name).value
-      end
-    end
+    base.extend ClassMethods
   end
 
   #

data/lib/parameters/version.rb

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

data/lib/parameters/yard/handlers/ruby.rb

@@ -1,4 +1,2 @@
-require 'parameters/yard/handlers/ruby/eval_block_handler'
-require 'parameters/yard/handlers/ruby/metaclass_eval_handler'
 require 'parameters/yard/handlers/ruby/parameter_handler'
 require 'parameters/yard/handlers/ruby/legacy'

data/lib/parameters/yard/handlers/ruby/legacy.rb

@@ -1,3 +1 @@
-require 'parameters/yard/handlers/ruby/legacy/eval_block_handler'
-require 'parameters/yard/handlers/ruby/legacy/metaclass_eval_handler'
 require 'parameters/yard/handlers/ruby/legacy/parameter_handler'

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-gem 'rspec', '>=1.1.3'
+gem 'rspec', '>=1.3.0'
 require 'spec'
 
 require 'parameters/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: parameters
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors: 
 - Postmodern
@@ -30,18 +30,38 @@ cert_chain:
   pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
   -----END CERTIFICATE-----
 
-date: 2009-09-25 00:00:00 -07:00
+date: 2010-01-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: yard
-  type: :runtime
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.3.5
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe-yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -51,7 +71,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.8
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -61,7 +91,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 2.5.0
     version: 
 description: |-
   Parameters allows you to add annotated variables to your classes which may
@@ -73,13 +103,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - Manifest.txt
-- README.txt
+- History.rdoc
 files: 
-- History.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - lib/parameters.rb
 - lib/parameters/exceptions.rb
@@ -92,19 +121,15 @@ files:
 - lib/parameters/class_param.rb
 - lib/parameters/instance_param.rb
 - lib/parameters/param.rb
+- lib/parameters/class_methods.rb
 - lib/parameters/parameters.rb
 - lib/parameters/version.rb
 - lib/parameters/yard.rb
 - lib/parameters/yard/handlers.rb
 - lib/parameters/yard/handlers/ruby.rb
-- lib/parameters/yard/handlers/ruby/eval_block_handler.rb
-- lib/parameters/yard/handlers/ruby/metaclass_eval_handler.rb
 - lib/parameters/yard/handlers/ruby/parameter_handler.rb
 - lib/parameters/yard/handlers/ruby/legacy.rb
-- lib/parameters/yard/handlers/ruby/legacy/eval_block_handler.rb
-- lib/parameters/yard/handlers/ruby/legacy/metaclass_eval_handler.rb
 - lib/parameters/yard/handlers/ruby/legacy/parameter_handler.rb
-- tasks/spec.rb
 - spec/spec_helper.rb
 - spec/classes/test_parameters.rb
 - spec/classes/custom_parameters.rb
@@ -118,8 +143,10 @@ licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --protected
+- --title
+- Parameters Documentation
+- --quiet
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/lib/parameters/yard/handlers/ruby/eval_block_handler.rb

@@ -1,18 +0,0 @@
-require 'yard'
-
-module YARD
-  module Handlers
-    module Ruby
-      class EvalBlockHandler < YARD::Handlers::Ruby::Base
-
-        handles method_call(:module_eval), method_call(:class_eval), method_call(:instance_eval)
-
-        def process
-          if (block = statement.jump(:brace_block, :do_block).last)
-            parse_block(block)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/parameters/yard/handlers/ruby/legacy/eval_block_handler.rb

@@ -1,19 +0,0 @@
-require 'yard/handlers/ruby/legacy/base'
-
-module YARD
-  module Handlers
-    module Ruby
-      module Legacy
-        class EvalBlockHandler < Base
-
-          handles /(\A|\.)(module|class|instance)_eval(\s+|\()/
-
-          def process
-            parse_block if statement.block
-          end
-
-        end
-      end
-    end
-  end
-end

data/lib/parameters/yard/handlers/ruby/legacy/metaclass_eval_handler.rb

@@ -1,21 +0,0 @@
-require 'yard/handlers/ruby/legacy/base'
-
-module YARD
-  module Handlers
-    module Ruby
-      module Legacy
-        class MetaclassEvalHandler < Base
-
-          handles /(\A|\.)metaclass_eval(\s+|\()/
-
-          def process
-            if statement.block
-              parse_block(:namespace => namespace, :scope => :class)
-            end
-          end
-
-        end
-      end
-    end
-  end
-end

data/lib/parameters/yard/handlers/ruby/metaclass_eval_handler.rb

@@ -1,18 +0,0 @@
-require 'yard'
-
-module YARD
-  module Handlers
-    module Ruby
-      class MetaclassEvalHandler < YARD::Handlers::Ruby::Base
-
-        handles method_call(:metaclass_eval)
-
-        def process
-          if (block = statement.jump(:brace_block, :do_block).last)
-            parse_block(block, :namespace => namespace, :scope => :class)
-          end
-        end
-      end
-    end
-  end
-end

data/tasks/spec.rb

@@ -1,10 +0,0 @@
-require 'spec/rake/spectask'
-
-desc "Run all specifications"
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.libs += ['lib', 'spec']
-  t.spec_opts = ['--colour', '--format', 'specdoc']
-end
-
-task :test => :spec
-task :default => :spec