named-parameters 0.0.14 → 0.0.15

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "yard", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    yard (0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  rspec (~> 2.1.0)
+  yard

data/RELEASENOTES

@@ -1,3 +1,12 @@
+0.0.15 [Dec 5, 2010]
+- [BUGFIX] declared_parameters_for usage is now consistent under instance and 
+  singleton context.
+- [INTERNAL] Elevated visibility for declared_parameters, 
+  declared_parameters_for, and filter_parameters to public.
+- [INTERNAL] Added optional processing of block to has_named_parameters and 
+  its ilk.
+- [INTERNAL] Tests added.
+
 0.0.14 [Nov 29, 2010]
 - [FEATURE] Added declared_parameters_for method.
 - [FEATURE] You can now limit/filter the list of declared parameters based on 

data/Rakefile

@@ -1,47 +1,45 @@
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "named-parameters"
-    gem.summary = %Q{Poor man's named-parameters in Ruby}
-    gem.description = %Q{This gem simulates named-parameters in Ruby. 
-      It's a complement to the common Ruby idiom of using Hash args to emulate 
-      the use of named parameters. }
-    gem.email = "jurisgalang@gmail.com"
-    gem.homepage = "http://github.com/jurisgalang/named-parameters"
-    gem.authors = ["Juris Galang"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "yard", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "named-parameters"
+  gem.summary = %Q{Poor man's named-parameters in Ruby}
+  gem.description = %Q{This gem simulates named-parameters in Ruby. 
+    It's a complement to the common Ruby idiom of using Hash args to emulate 
+    the use of named parameters. }
+  gem.email = "jurisgalang@gmail.com"
+  gem.homepage = "http://github.com/jurisgalang/named-parameters"
+  gem.authors = ["Juris Galang"]
+  gem.license = ["MIT", "GPL"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/lib/named-parameters.rb

@@ -1,8 +1,10 @@
-require 'named-parameters/object'
+require "rubygems"
+require "bundler/setup"
+
 require 'named-parameters/module'
 
 # Extend object to automatically make it available for all
 # user defined classes...
-class Object 
+class Object
   include NamedParameters
 end

data/lib/named-parameters/module.rb

@@ -21,39 +21,68 @@
 # @author Juris Galang
 # @copyright 2010 Juris Galang. All Rights Reserved
 #
-module NamedParameters
-  protected
-  def self.included base # :nodoc:
-    base.extend ClassMethods
-  end
+require 'named-parameters/object'
 
-  private
+module NamedParameters
   # Returns the list of declared parameters for the calling method, ie: the 
-  # concatenation `:required`, `:optional`, and `:oneof` parameter list as 
+  # concatenation of `:required`, `:optional`, and `:oneof` parameter list as 
   # declared in the the `has_named_parameters` clause, or the list specified 
   # in either the `requires` and `recognizes` clause.
+  #   
+  #     has_named_parameters :foo, :required => [ :x ], :optional => [ :y ]
+  #     def foo options = { }
+  #       puts declared_parameters.inspect
+  #     end
+  #
+  #     foo :x => 1, :y => 2   # => [ :x, :y ]
   #
   # @param [Array<Symbol>] type limits the list of parameters returned to the
-  #   parameter types specified. Defaults to `[ :required, :optional, :oneof ]`
+  #   parameter types specified.
   #
-  # @return [Array<Symbol>] the list of symbols representing the name of the declared 
-  #   parameters.
+  # @return [Array<Symbol>] the list of symbols representing the name of the 
+  #   declared parameters.
   #
   def declared_parameters type = [ :required, :optional, :oneof ]
     klazz  = self.instance_of?(Class) ? self : self.class
-    specs  = klazz.send :specs
+    specs  = klazz.send :method_specs
+    method = if block_given?
+      yield # insane-fucker! :-)
+    else
+      caller = calling_method
+      self.instance_of?(Class) ? :"self.#{caller}" : caller
+    end
     
-    caller = block_given? ? yield : calling_method # insane-fucker! :-)
-    method = self.instance_of?(Class) ? :"self.#{caller}" : caller
-    spec   = specs[klazz.send(:key_for, method)]
-    return [] if spec.nil?
+    return [] unless spec = specs[klazz.send(:key_for, method)]
 
     mapper = lambda{ |entry| entry.instance_of?(Hash) ? entry.keys.first : entry }
     sorter = lambda{ |x, y| x.to_s <=> y.to_s }
-  
     Array(type).map{ |k| spec[k].map(&mapper) }.flatten.sort(&sorter)
   end
   
+  # Returns the list of declared parameters for a specific method, ie: the 
+  # concatenation of `:required`, `:optional`, and `:oneof` parameter list as 
+  # declared in the the {#has_named_parameters} clause, or the list specified 
+  # in either the `requires` and `recognizes` clause.
+  #   
+  #     has_named_parameters :foo, :required => [ :x ], :optional => [ :y ]
+  #     def foo options = { }
+  #       # ...
+  #     end
+  #
+  #     def bar
+  #       puts declared_parameters_for(:foo).inspect
+  #     end
+  #
+  #     bar   # => [ :x, :y ]
+  #
+  # @param [Symbol] method the name of the method in question.
+  #
+  # @param [Array<Symbol>] type limits the list of parameters returned to the
+  #   parameter types specified.
+  #
+  # @return [Array<Symbol>] the list of symbols representing the name of the 
+  #   declared parameters.
+  #
   def declared_parameters_for method, type = [ :required, :optional, :oneof ]
     declared_parameters(type) { method }
   end
@@ -61,14 +90,13 @@ module NamedParameters
   # Filter out keys from `options` that are not declared as parameter to the
   # method:
   #   
-  #     has_named_parameters :foo, :requires => :x
+  #     has_named_parameters :foo, :required => :x
   #     def foo options = { }
   #       options.inspect
   #     end
   #
-  #     options = { :x => 1, :y => 2, :z => 3 } 
-  #     
   #     # the following will fail because :y and :z is not recognized/declared
+  #     options = { :x => 1, :y => 2, :z => 3 } 
   #     foo options   # => ArgumentError! 
   #
   #     # the following will not fail because we've applied the filter
@@ -76,9 +104,9 @@ module NamedParameters
   #
   # @param [Hash] options the options argument to the method.
   #
-  # @param [Array<Symbol>] the list of symbols representing the declared
-  #   parameters used to filter `options`. Optional, the list returned by
-  #   `declared_parameters` is used by default.
+  # @param [Array<Symbol>] filter the list of symbols representing the declared
+  #   parameters used to filter `options`. If not specified then the list 
+  #   returned by {#declared_parameters} is used by default.
   #
   # @return [Hash] a `Hash` whose keys are limited to what's declared as
   #   as parameter to the method.
@@ -89,6 +117,12 @@ module NamedParameters
     options.reject{ |key, value| !filter.include?(key) }
   end
     
+  protected
+  def self.included base # :nodoc:
+    base.extend ClassMethods
+  end
+
+  private
   # returns the name of the current method
   def current_method # :nodoc:
     caller[0][/`([^']*)'/, 1].to_sym
@@ -102,7 +136,7 @@ module NamedParameters
   # this is the method used to validate the name of the received parameters 
   # (based on the defined spec) when an instrumented method is invoked.
   #
-  def self.validate_specs name, params, spec  # :nodoc:
+  def self.validate_method_specs name, params, spec  # :nodoc:
     mapper   = lambda{ |n| n.instance_of?(Hash) ? n.keys.first : n }
     optional = spec[:optional].map &mapper
     required = spec[:required].map &mapper
@@ -188,7 +222,8 @@ module NamedParameters
         [ k, v ]
       } ]
       spec[:mode] = mode
-      specs[key_for(method)] = spec
+      method_specs[key_for(method)] = spec
+      yield spec if block_given?
     end
     
     # Convenience method, equivalent to declaring:
@@ -200,11 +235,11 @@ module NamedParameters
     #   to be an `Array` of symbols matching the names of the required 
     #   parameters.
     #
-    def requires *params
+    def requires *params, &block
       [ :'self.new', :initialize ].each do |method|
-        spec = specs[key_for method] || { }
+        spec = method_specs[key_for method] || { }
         spec.merge!(:required => params)
-        has_named_parameters method, spec, :strict
+        has_named_parameters method, spec, :strict, &block
       end
     end
     
@@ -217,11 +252,11 @@ module NamedParameters
     #   to be an `Array` of symbols matching the names of the optional
     #   parameters.
     #
-    def recognizes *params
+    def recognizes *params, &block
       [ :'self.new', :initialize ].each do |method|
-        spec = specs[key_for method] || { }
+        spec = method_specs[key_for method] || { }
         spec.merge!(:optional => params)
-        has_named_parameters method, spec, :strict
+        has_named_parameters method, spec, :strict, &block
       end
     end
     
@@ -262,7 +297,7 @@ module NamedParameters
     def singleton_method_added name  # :nodoc:
       apply_method_spec :"self.#{name}" do
         method = self.eigenclass.instance_method name
-        spec   = specs[key_for :"self.#{name}"]
+        spec   = method_specs[key_for :"self.#{name}"]
         owner  = "#{self.name}::"
         eigenclass.instance_eval do
           intercept method, owner, name, spec
@@ -275,7 +310,7 @@ module NamedParameters
     def method_added name  # :nodoc:
       apply_method_spec name do
         method = instance_method name
-        spec   = specs[key_for name]
+        spec   = method_specs[key_for name]
         owner  = "#{self.name}#"
         intercept method, owner, name, spec
       end
@@ -285,7 +320,7 @@ module NamedParameters
     private
     # apply instrumentation to method
     def apply_method_spec method  # :nodoc:
-      if specs.include? key_for(method) and !instrumenting?
+      if method_specs.include? key_for(method) and !instrumenting?
         @instrumenting = true
         yield method
         @instrumenting = false
@@ -311,7 +346,7 @@ module NamedParameters
         params = defaults.merge params
         
         # validate the parameters against the spec
-        NamedParameters::validate_specs fullname, params, spec
+        NamedParameters::validate_method_specs fullname, params, spec
         
         # inject the updated argument values for params into the arguments
         # before actually making method invocation
@@ -321,8 +356,8 @@ module NamedParameters
     end
     
     # initialize specs table as needed 
-    def specs  # :nodoc:
-      @specs ||= { }
+    def method_specs  # :nodoc:
+      @method_specs ||= { }
     end
     
     def key_for method
@@ -338,7 +373,7 @@ module NamedParameters
     
     # initialize the @instrumenting instance variable (housekeeping)
     def self.extended base  # :nodoc:
-      base.instance_variable_set :@instrumenting , false
+      base.instance_variable_set(:@instrumenting, false)
     end
   end
 end

data/lib/named-parameters/object.rb

@@ -1,4 +1,5 @@
 # Do the eigenclass thingy
+# See: http://www.ruby-forum.com/topic/77046
 class Object
   protected
   def eigenclass # :nodoc:

data/named-parameters.gemspec

@@ -5,21 +5,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{named-parameters}
-  s.version = "0.0.14"
+  s.version = "0.0.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juris Galang"]
-  s.date = %q{2010-11-29}
+  s.date = %q{2010-12-05}
   s.description = %q{This gem simulates named-parameters in Ruby. 
-      It's a complement to the common Ruby idiom of using Hash args to emulate 
-      the use of named parameters. }
+    It's a complement to the common Ruby idiom of using Hash args to emulate 
+    the use of named parameters. }
   s.email = %q{jurisgalang@gmail.com}
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
     ".document",
+    ".rspec",
     "GPL-LICENSE",
+    "Gemfile",
+    "Gemfile.lock",
     "MIT-LICENSE",
     "README.md",
     "RELEASENOTES",
@@ -30,10 +33,10 @@ Gem::Specification.new do |s|
     "lib/named-parameters/object.rb",
     "named-parameters.gemspec",
     "spec/named-parameters_spec.rb",
-    "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/jurisgalang/named-parameters}
+  s.licenses = [["MIT", "GPL"]]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Poor man's named-parameters in Ruby}
@@ -47,14 +50,23 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end

data/spec/named-parameters_spec.rb

@@ -246,4 +246,45 @@ describe "NamedParameters" do
     o.boogey.should eql []
     DeclaredParameters.boogey(:w => :w, :a => :a).should eql [ :a, :b, :c, :w, :x, :y, :z ]
   end
+  
+  it "should be able to get the list of declared parameters for specified methods" do
+    class DeclaredParameters
+      has_named_parameters :'instance_method', 
+        :required => [ :w ], 
+        :optional => [ :x, [ :y, 1 ], { :z => 1 } ],
+        :oneof    => [ :a, :b, :c ]
+      def instance_method opts = { }
+      end
+      
+      has_named_parameters :'self.singleton_method', 
+        :required => [ :w ], 
+        :optional => [ :x, [ :y, 1 ], { :z => 1 } ],
+        :oneof    => [ :a, :b, :c ]
+      def self.singleton_method opts = { }
+      end
+      
+      def instance_method_parameters
+        declared_parameters_for :instance_method
+      end
+      
+      def singleton_method_parameters
+        declared_parameters_for :'self.singleton_method'
+      end
+      
+      class << self
+        def instance_method_parameters
+          declared_parameters_for :instance_method
+        end
+        
+        def singleton_method_parameters
+          declared_parameters_for :'self.singleton_method'  
+        end
+      end
+    end
+    o = DeclaredParameters.new(:x => 1, :y => 1)
+    DeclaredParameters.singleton_method_parameters.should eql [ :a, :b, :c, :w, :x, :y, :z ]
+    DeclaredParameters.instance_method_parameters.should eql [ :a, :b, :c, :w, :x, :y, :z ]
+    o.instance_method_parameters.should eql [ :a, :b, :c, :w, :x, :y, :z ]
+    o.singleton_method_parameters.should eql [ :a, :b, :c, :w, :x, :y, :z ]
+  end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
 require 'named-parameters'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: named-parameters
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 15
+  version: 0.0.15
 platform: ruby
 authors: 
 - Juris Galang
@@ -15,29 +15,61 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 -08:00
+date: 2010-12-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
   name: rspec
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 23
         segments: 
         - 1
-        - 2
-        - 9
-        version: 1.2.9
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: yard
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,9 +78,23 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: rcov
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id002
-description: "This gem simulates named-parameters in Ruby. \n      It's a complement to the common Ruby idiom of using Hash args to emulate \n      the use of named parameters. "
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  requirement: *id005
+description: "This gem simulates named-parameters in Ruby. \n    It's a complement to the common Ruby idiom of using Hash args to emulate \n    the use of named parameters. "
 email: jurisgalang@gmail.com
 executables: []
 
@@ -58,7 +104,10 @@ extra_rdoc_files:
 - README.md
 files: 
 - .document
+- .rspec
 - GPL-LICENSE
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - RELEASENOTES
@@ -69,12 +118,12 @@ files:
 - lib/named-parameters/object.rb
 - named-parameters.gemspec
 - spec/named-parameters_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/jurisgalang/named-parameters
-licenses: []
-
+licenses: 
+- - MIT
+  - GPL
 post_install_message: 
 rdoc_options: []