named-parameters 0.0.13 → 0.0.14

data/README.md

@@ -158,12 +158,70 @@ method:
     end
     
     # create an instance of GoogleStorage
-    # and print: [ access-key, secret-key, group-email, apps-domain ]
+    # and print: [ :access-key, :secret-key, :group-email, :apps-domain ]
     GoogleStorage.new :'access-key' => '...', :'secret-key' => '...'
 
 `declared_parameters` is also available from the class methods of user defined
 classes.
 
+You can also pass a list of parameter types to limit the result to specific 
+parameter types:
+
+    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 "#{declared_parameters(:required).join(' ')}"
+    
+        # ... now do the googly stuff ...
+      end
+    end
+
+    # create an instance of GoogleStorage
+    # and print: [ :access-key, :secret-key ]
+    GoogleStorage.new :'access-key' => '...', :'secret-key' => '...'
+
+The method `declared_parameters` is context specific. It returns the list of 
+parameters for the current method. To get a list of parameters for a specific
+method, use `declared_parameters_for`:
+
+    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 "#{declared_parameters(:required).join(' ')}"
+
+        # ... now do the googly stuff ...
+      end
+      
+      def self.required_parameters
+        declared_parameters_for :new, :required
+      end
+
+      def self.optional_parameters
+        declared_parameters_for :new, :optional
+      end
+
+      def self.all_parameters
+        declared_parameters_for :new
+      end
+    end
+
+    # list the required parameters for the class
+    GoogleStorage.required_parameters  # => [ :access-key, :secret-key ]
+
+    # list the optional parameters for the class
+    GoogleStorage.required_parameters  # => [ :group-email, :apps-domain ]
+
+    # list all of the recognized parameters for the class
+    GoogleStorage.all_parameters  # => [ :access-key, :secret-key, :group-email, :apps-domain ]
+    
+Notice that both methods may receive a filter of parameter types.
+
 Filtering Arguments
 -------------------
 Sometimes you'll have a `Hash` object that will have a bunch of keys that may 

data/RELEASENOTES

@@ -1,3 +1,16 @@
+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 
+  type:
+  
+      has_named_parameters :foobar, 
+        :required => :a, :optional => [ :b, :c ]
+      def foobar
+        declared_parameters(:required).inspect
+      end
+  
+      foobar  # => [ :a ]
+
 0.0.13 [Nov 28, 2010]
 - [INTERNAL] instrument -> apply_method_spec, to make it compatible with Rails.
 
@@ -18,7 +31,7 @@
         declared_parameters.inspect
       end
 
-      foobar      # => [ :a, :b, :c ]
+      foobar  # => [ :a, :b, :c ]
 
 - [INTERNAL] Parameter spec table is now retained. 
 

data/VERSION

@@ -1 +1 @@
-0.0.13
+0.0.14

data/lib/named-parameters/module.rb

@@ -33,10 +33,13 @@ module NamedParameters
   # declared in the the `has_named_parameters` clause, or the list specified 
   # in either the `requires` and `recognizes` clause.
   #
+  # @param [Array<Symbol>] type limits the list of parameters returned to the
+  #   parameter types specified. Defaults to `[ :required, :optional, :oneof ]`
+  #
   # @return [Array<Symbol>] the list of symbols representing the name of the declared 
   #   parameters.
   #
-  def declared_parameters
+  def declared_parameters type = [ :required, :optional, :oneof ]
     klazz  = self.instance_of?(Class) ? self : self.class
     specs  = klazz.send :specs
     
@@ -48,7 +51,11 @@ module NamedParameters
     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)
+    Array(type).map{ |k| spec[k].map(&mapper) }.flatten.sort(&sorter)
+  end
+  
+  def declared_parameters_for method, type = [ :required, :optional, :oneof ]
+    declared_parameters(type) { method }
   end
   
   # Filter out keys from `options` that are not declared as parameter to the

data/named-parameters.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{named-parameters}
-  s.version = "0.0.13"
+  s.version = "0.0.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juris Galang"]
-  s.date = %q{2010-11-28}
+  s.date = %q{2010-11-29}
   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. }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: named-parameters
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 0
-  - 13
-  version: 0.0.13
+  - 14
+  version: 0.0.14
 platform: ruby
 authors: 
 - Juris Galang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 -08:00
+date: 2010-11-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency