named-parameters 0.0.8 → 0.0.9

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.md

@@ -140,6 +140,29 @@ in a class definition:
     has_named_parameters :'self.new', :optional => params, :strict
     has_named_parameters :initialize, :optional => params, :strict
 
+What Was Declared?
+------------------
+You can get a list of declared parameters for a method by invoking 
+`recognized_parameters`:
+
+    class GoogleStorage
+      requires   :'access-key', :'secret-key'
+      recognizes [ :'group-email', 'group@example.org' ], [ :'apps-domain', 'example.org' ]
+
+      def initialize options
+        # list the parameters declared
+        puts "#{recognized_parameters.join(' ')}"
+        
+        # ... now do the googly stuff ...
+      end
+    end
+    
+    # create an instance of GoogleStorage
+    # and print: [ access-key, secret-key, group-email, apps-domain ]
+    GoogleStorage.new :'access-key' => '...', :'secret-key' => '...'
+
+`recognized_parameters` is also accessible from singleton methods.
+
 Permissive Mode
 ---------------
 When a method is declared with `has_named_parameters` that method will only 

data/RELEASENOTES

@@ -1,3 +1,23 @@
+0.0.9 [Nov 24, 2010]
+- [FEATURE] You can now query what parameters have been declared for a method:
+
+      class Foo
+        has_named_parameters :bar, 
+          :required => :x, :optional => [ :y, :z ]
+        def bar options = { }
+          required_parameters.inspect
+        end
+        
+        has_named_parameters :'self.zoo', 
+          :required => :a, :optional => [ :b, :c ]
+        def self.zoo
+          required_parameters.inspect
+        end
+      end
+      
+      Foo.new.bar  # => [ :x, :y, :z ]
+      Foo.zoo      # => [ :a, :b, :c ]
+      
 0.0.8 [Nov 22, 2010]
 - [INTERNAL] Parameter spec will no longer be shared between singleton and 
   instance methods. Bonus performance improvement: it no longer needs to keep

data/Rakefile

@@ -6,16 +6,9 @@ begin
   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. 
-
-    It does this by extending the language with a `has_named_parameters` clause 
-    that allows a class to declare the parameters that are acceptable to a method.
-
-    The `has_named_parameters` dictates how the presence of these parameters are
-    enforced and raises an `ArgumentError` when a method invocation is made that
-    violates the rules for those parameters.
-    }
+    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"]

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/lib/named-parameters/module.rb

@@ -28,6 +28,36 @@ module NamedParameters
   end
 
   private
+  # Returns the list of declared parameters for the calling method, ie: the 
+  # concatenation `: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.
+  #
+  # @returns [Array] list of symbols representing the name of the declared 
+  #   parameters.
+  #
+  def recognized_parameters
+    klazz  = self.instance_of?(Class) ? self : self.class
+    specs  = klazz.send :specs
+
+    method = self.instance_of?(Class) ? :"self.#{calling_method}" : calling_method
+    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 }
+    [ :required, :optional, :oneof ].map{ |k| spec[k].map(&mapper) }.flatten.sort(&sorter)
+  end
+  
+  # returns the name of the current method
+  def current_method
+    caller[0][/`([^']*)'/, 1].to_sym
+  end
+
+  # returns the name of the calling method
+  def calling_method
+    caller[1][/`([^']*)'/, 1].to_sym
+  end
+    
   # this is the method used to validate the name of the received parameters 
   # (based on the defined spec) when an instrumented method is invoked.
   #
@@ -39,14 +69,14 @@ module NamedParameters
     
     # determine what keys are allowed, unless mode is :permissive
     # in which case we don't care unless its listed as required or oneof
-    order   = lambda{ |x, y| x.to_s <=> y.to_s }
-    allowed = spec[:mode] == :permissive ? [] : (optional + required + oneof).sort(&order)
+    sorter  = lambda{ |x, y| x.to_s <=> y.to_s }
+    allowed = spec[:mode] == :permissive ? [] : (optional + required + oneof).sort(&sorter)
     
     # determine what keys were passed;
     # also, plugin the names of parameters assigned with default values
     keys = params.keys.map{ |k| k.to_sym }
-    keys.sort! &order
-    required.sort! &order
+    keys.sort! &sorter
+    required.sort! &sorter
     
     # this lambda is used to present the list of parameters as a string
     list = lambda{ |params| params.join(", ") }
@@ -77,7 +107,7 @@ module NamedParameters
       "Unrecognized parameter specified on call to #{name}: #{list[k]}" \
       unless k.empty?
   end
-  
+
   module ClassMethods
     # Declares that `method` will enforce named parameters behavior as 
     # described in `spec`; a method declared with `:required` and/or 
@@ -191,7 +221,7 @@ module NamedParameters
     def singleton_method_added name  # :nodoc:
       instrument :"self.#{name}" do
         method = self.eigenclass.instance_method name
-        spec   = specs.delete(key_for :"self.#{name}") 
+        spec   = specs[key_for :"self.#{name}"]
         owner  = "#{self.name}::"
         eigenclass.instance_eval do
           intercept method, owner, name, spec
@@ -204,7 +234,7 @@ module NamedParameters
     def method_added name  # :nodoc:
       instrument name do
         method = instance_method name
-        spec   = specs.delete(key_for name)
+        spec   = specs[key_for name]
         owner  = "#{self.name}#"
         intercept method, owner, name, spec
       end
@@ -256,7 +286,8 @@ module NamedParameters
     
     def key_for method
       type = method.to_s =~ /^self\./ ? :singleton : :instance
-      :"#{self.name}::#{type}.#{method}"
+      name = method.to_s.sub(/^self\./, '')
+      :"#{self.name}::#{type}.#{name}"
     end
     
     # check if in the process of instrumenting a method

data/lib/named-parameters.rb

@@ -3,4 +3,6 @@ require 'named-parameters/module'
 
 # Extend object to automatically make it available for all
 # user defined classes...
-Object.extend NamedParameters::ClassMethods
+class Object 
+  include NamedParameters
+end

data/named-parameters.gemspec

@@ -1,52 +1,47 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{named-parameters}
-  s.version = "0.0.8"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juris Galang"]
-  s.date = %q{2010-11-22}
-  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 does this by extending the language with a `has_named_parameters` clause 
-    that allows a class to declare the parameters that are acceptable to a method.
-
-    The `has_named_parameters` dictates how the presence of these parameters are
-    enforced and raises an `ArgumentError` when a method invocation is made that
-    violates the rules for those parameters.
-    }
+  s.date = %q{2010-11-24}
+  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. }
   s.email = %q{jurisgalang@gmail.com}
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
     ".document",
-    "GPL-LICENSE",
-    "MIT-LICENSE",
-    "README.md",
-    "RELEASENOTES",
-    "Rakefile",
-    "VERSION",
-    "lib/named-parameters.rb",
-    "lib/named-parameters/module.rb",
-    "lib/named-parameters/object.rb",
-    "named-parameters.gemspec",
-    "spec/named-parameters_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
+     ".gitignore",
+     "GPL-LICENSE",
+     "MIT-LICENSE",
+     "README.md",
+     "RELEASENOTES",
+     "Rakefile",
+     "VERSION",
+     "lib/named-parameters.rb",
+     "lib/named-parameters/module.rb",
+     "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.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Poor man's named-parameters in Ruby}
   s.test_files = [
     "spec/named-parameters_spec.rb",
-    "spec/spec_helper.rb"
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/named-parameters_spec.rb

@@ -202,4 +202,28 @@ describe "NamedParameters" do
     lambda { Required.new :y => :y }.should raise_error ArgumentError
     lambda { Required.new :x => :x, :y => :y }.should_not raise_error
   end
+  
+  it "should be able to list of recognized parameters" do
+    class RecognizedParameters
+      requires   :x, :y
+      recognizes :a, :b, :c
+      attr :parameters
+      
+      def initialize opts = { }
+        @parameters = recognized_parameters
+      end
+      
+      has_named_parameters :'self.singleton', 
+        :required => [ :w ], 
+        :optional => [ :x, [ :y, 1 ], { :z => 1 } ],
+        :oneof    => [ :a, :b, :c ]
+      def self.singleton opts = { }
+        recognized_parameters
+      end
+    end
+    
+    o = RecognizedParameters.new(:x => :x, :y => :y)
+    o.parameters.should eql [ :a, :b, :c, :x, :y ]
+    RecognizedParameters.singleton(:w => :w, :a => :a).should eql [ :a, :b, :c, :w, :x, :y, :z ]
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: named-parameters
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Juris Galang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-22 00:00:00 -08:00
+date: 2010-11-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: "This gem simulates named-parameters in Ruby. It's a complement to the common \n    Ruby idiom of using `Hash` args to emulate the use of named parameters. \n\n    It does this by extending the language with a `has_named_parameters` clause \n    that allows a class to declare the parameters that are acceptable to a method.\n\n    The `has_named_parameters` dictates how the presence of these parameters are\n    enforced and raises an `ArgumentError` when a method invocation is made that\n    violates the rules for those parameters.\n    "
+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,6 +58,7 @@ extra_rdoc_files:
 - README.md
 files: 
 - .document
+- .gitignore
 - GPL-LICENSE
 - MIT-LICENSE
 - README.md
@@ -76,8 +77,8 @@ homepage: http://github.com/jurisgalang/named-parameters
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement