named_parameters 1.1.0 → 1.1.1

data/README

@@ -39,8 +39,6 @@ Surprisingly it is this easy:
                            b: 42)
 
 
-
----
 == Optional parameters
 You may also define optional parameters with defaults values:
     class AnyClass
@@ -103,39 +101,73 @@ actual named parameters hash. Use the super mode like this:
 
     class SomeLibraryClass
         def setup(options)
-            #manual options parsing here
-            options
+            @d = options[:d]
         end
     end
 
     class AnyClass
         named_parameters_super
         def setup(a,b,c)
-            #do something with a, b and c
+            @a = a
+            @b = b
+            @c = c
         end
     end
 
     any_object.setup(a: "a",
                      b: "b",
                      c: "c",
-                     d: "d") # => {:a => "a", :b => "b", :c => "c", :d => "d"}
+                     d: "d")
+    any_object.a # => "a"
+    any_object.b # => "b"
+    any_object.c # => "c"
+    any_object.d # => "d"
 
 == Combine super and strict
 In case you need to combine super and strict mode, do:
 
     class AnyClass < SomeLibraryClass
-        named_parameters_strict_super # or named_parmeters_super_strict
+        named_parameters_strict_super # or named_parameters_super_strict
         def some_method(a,b,c)
             # do something with a and b, maybe something with c will be done in super
         end
     end
 
+
+== <my_method>_has_named_parameters
+There are actually two ways to make a your method accessible with named parameters. You can either declare the named
+parameters just before the method definition (this is done above) or you can define them anytime after the method
+definition:
+
+    class AnyClass
+        def some_method(a,b,c)
+            # do something with a, b and c
+        end
+
+        # lots of other code, if you like so
+        # ...
+
+        some_method_has_named_parameters(a: "a", b: "b")
+    end
+
+This will do the same as:
+
+    class AnyClass
+        named_parameters(a: "a", b: "b")
+        def some_method(a,b,c)
+            # do something with a, b and c
+        end
+    end
+
+With this method you can also use super and strict mode as usual
+
 == Acknowledgements
 
 Kudos to Juris Galang and his gem named-parameters. (http://www.rubygems.org/gems/named-parameters)
-Defenitely have a look at this gem also, if you want to use named parameters.
+Definitely have a look at this gem also, if you want to use named parameters.
 
 == Changelog
+[1.1.1] * Added documentation for ghost methods "my_method_has_named_parameters"
 [1.1.0] * Added ghost methods "my_method_has_named_parameters"
 [1.0.2] * Removed unimportant methods from documentation (again)
 [1.0.1] * Removed unimportant methods from documentation

data/lib/named_parameters.rb

@@ -1,8 +1,19 @@
 #
-# Include this module to enable the NamedParameters#named_parameters macro
+# Include this module to enable the NamedParameters#named_parameters macros
 #
 module NamedParameters
 
+  # Works like NamedParameters#named_parameters, but instead of using it right before a method definition,
+  # you use it afterwards. You can also add the strict and super mode. Replace the +my_method+ with the name of the
+  # method that you want to have named parameters
+  # @see NamedParameters#named_parameters
+  # @see NamedParameters#named_parameters_strict
+  # @see NamedParameters#named_parameters_super
+  # @see NamedParameters#named_parameters_strict_super
+  def my_method_has_named_parameters(optionals = { })
+    # Empty method just for the documentation. Those methods are realized in NamedParameters#method_missing
+  end
+
   # Makes the next method callable via named parameters (options hash)
   # The caller hash may contain keys that are not contained in the parameters of the next method
   # @param [Hash[Symbol,Object]] optionals Optional default values for the parameters
@@ -33,7 +44,6 @@ module NamedParameters
     _named_parameters optionals, true, true
   end
 
-
   alias_method :named_parameters_super_strict, :named_parameters_strict_super
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: named_parameters
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec