named_parameters 1.0.2 → 1.1.0

data/README

@@ -136,6 +136,7 @@ Kudos to Juris Galang and his gem named-parameters. (http://www.rubygems.org/gem
 Defenitely have a look at this gem also, if you want to use named parameters.
 
 == Changelog
+[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
 [1.0.0] * Added strict and super modes

data/lib/named_parameters.rb

@@ -3,6 +3,13 @@
 #
 module NamedParameters
 
+  # 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
+  def named_parameters(optionals = { })
+    _named_parameters optionals, false, false
+  end
+
   # Makes the next method callable via named parameters (options hash)
   # The caller hash may only contain keys that are in the parameters of the next method
   # @param [Hash[Symbol,Object]] optionals Optional default values for the parameters
@@ -26,6 +33,7 @@ module NamedParameters
     _named_parameters optionals, true, true
   end
 
+
   alias_method :named_parameters_super_strict, :named_parameters_strict_super
 
   private
@@ -36,11 +44,31 @@ module NamedParameters
   end
 
   #noinspection RubyArgCount
-  self.class.class_eval do # :nodoc:
-    alias :method_added_before_named_parameters :method_added #:nodoc:
+  self.class.class_eval do
+    alias :method_added_before_named_parameters :method_added
     private :method_added_before_named_parameters
   end
 
+  # Enables the <method>_has_named_parameter ghost methods
+  def method_missing method, *args, &block
+    # catch only methods like <method_name> + _has_named_parameters + <mode definition>
+    if /\A(?<method_name>.+)_has_named_parameters(?<mode>_super_strict|_strict_super|_super|_strict)?\z/ =~ method.to_s
+      # find out mode
+      mode = "" if mode.nil?
+      call_super = mode.include? 'super'
+      # find out strict
+      strict     = mode.include? 'strict'
+      # redefine
+      _redefine_with_named_parameters(method_name,
+                                      args[0] || { },
+                                      strict,
+                                      call_super)
+    else
+      # if method is not like above pattern, do the original stuff
+      super method, *args, &block
+    end
+  end
+
   # Makes sure a method is redefined as soon as it is defined. Only when named_parameters was called right before
   def method_added(method_name)
     # redefine the method
@@ -55,14 +83,6 @@ module NamedParameters
     method_added_before_named_parameters method_name
   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
-  #   Parameters, that are not
-  def named_parameters(optionals = { })
-    _named_parameters optionals, false, false
-  end
-
   # @param [Hash[Symbol,Object]] optionals Optional default values for the parameters
   # @param [Boolean] strict Shall keys in the caller options hash, that are not in the parameter list, throw an error?
   # @param [Boolean] call_super Shall super be called with the caller option hash as the only parameter?

data/spec/named_parameters_spec.rb

@@ -60,14 +60,64 @@ class Book < Item
       instance_variable_set("@#{attribute}", yield(send(attribute)))
     end
   end
+end
+
+class Magazine < Item
+  include NamedParameters
+
+  attr_reader :author, :title
+
+  def edit_attributes(author, title)
+    @author = author
+    @title  = title
+  end
+
+  edit_attributes_has_named_parameters(author: 'unknown')
 
+
+  def edit_only_valid_attributes(author, title)
+    @author = author if author.is_a? String
+    @title = title if title.is_a? String
+  end
+
+  edit_only_valid_attributes_has_named_parameters_strict(author: 'unknown')
+
+
+  def setup(author, title)
+    edit_attributes(author: author,
+                    title:  title)
+  end
+
+  setup_has_named_parameters_super(author: 'unknown')
+
+  def setup_only_valid_attributes(author, title, id)
+    edit_attributes(author: author,
+                    title:  title)
+  end
+
+  setup_only_valid_attributes_has_named_parameters_strict_super(author: 'unknown')
+
+  def change_attributes(attributes)
+    attributes.each do |attribute|
+      instance_variable_set("@#{attribute}", yield(send(attribute)))
+    end
+  end
+
+  change_attributes_has_named_parameters(attributes: [])
+
+  def check_for_attributes(author, title)
+    @author == author && @title == title
+  end
+
+  check_for_attributes_has_named_parameters
 end
 
 describe NamedParameters do
 
-  attr_reader :book
+  attr_reader :book, :magazine
   before :each do
-    @book = Book.new
+    @book     = Book.new
+    @magazine = Magazine.new
   end
 
   describe 'default' do
@@ -170,7 +220,124 @@ describe NamedParameters do
       book.author.should == 'ORSON SCOTT CARD'
       book.title.should == 'ENDERS GAME'
     end
+  end
+
+  describe 'ghost_methods' do
+
+    describe 'default' do
+      it 'should work with all parameters given' do
+        magazine.edit_attributes(author: 'Orson Scott Card',
+                                 title:  'Enders Game')
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'Orson Scott Card'
+      end
+
+      it 'should work with only mandatory parameters given' do
+        magazine.edit_attributes(title: 'Enders Game')
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'unknown'
+      end
+
+      it 'should throw an error when a mandatory parameter misses' do
+        -> { magazine.edit_attributes(author: 'Orson Scott Card') }.should raise_error(RuntimeError)
+      end
+
+      it 'should ignore options that are not part of the parameters' do
+        magazine.edit_attributes(author: 'Orson Scott Card',
+                                 title:  'Enders Game',
+                                 year:   1985)
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'Orson Scott Card'
+      end
+    end
+
+    describe 'strict named parameters' do
+
+      it 'should work with all parameters given' do
+        magazine.edit_only_valid_attributes(author: 'Orson Scott Card',
+                                            title:  'Enders Game')
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'Orson Scott Card'
+      end
+
+      it 'should work with only mandatory parameters given' do
+        magazine.edit_only_valid_attributes(title: 'Enders Game')
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'unknown'
+      end
+
+      it 'should throw an error when a mandatory parameter misses' do
+        -> { magazine.edit_only_valid_attributes(author: 'Orson Scott Card') }.should raise_error(RuntimeError)
+      end
+
+      it 'should throw an error when there are options that are not part of the parameters' do
+        -> { magazine.edit_only_valid_attributes(author: 'Orson Scott Card',
+                                                 title:  'Enders Game',
+                                                 year:   1985) }.should raise_error(RuntimeError)
+      end
+
+    end
 
+
+    describe 'with super' do
+
+      it 'should call super with all options as the only parameter' do
+        magazine.setup(author: 'Orson Scott Card',
+                       title:  'Enders Game',
+                       year:   1985,
+                       id:     1)
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'Orson Scott Card'
+        magazine.id.should == 1
+      end
+
+    end
+
+    describe 'with super and strict' do
+
+      it 'should call super' do
+        magazine.setup_only_valid_attributes(author: 'Orson Scott Card',
+                                             title:  'Enders Game',
+                                             id:     1)
+        magazine.title.should == 'Enders Game'
+        magazine.author.should == 'Orson Scott Card'
+        magazine.id.should == 1
+      end
+
+      it 'should throw error when there are unwanted options' do
+        -> { magazine.setup_only_valid_attributes(author: 'Orson Scott Card',
+                                                  title:  'Enders Game',
+                                                  year:   1985,
+                                                  id:     1) }.should raise_error(RuntimeError)
+      end
+
+    end
+
+    describe 'with block' do
+      it 'should forward blocks' do
+        magazine.edit_attributes(author: 'Orson Scott Card',
+                                 title:  'Enders Game')
+        magazine.change_attributes(attributes: [:author, :title]) do |attribute|
+          attribute.to_s.upcase
+        end
+        magazine.author.should == 'ORSON SCOTT CARD'
+        magazine.title.should == 'ENDERS GAME'
+      end
+    end
+
+    describe 'missing methods' do
+      it 'should not catch any other missing methods' do
+        -> { magazine.some_weird_method }.should raise_error(NoMethodError)
+      end
+    end
+
+    it 'should handle no optionals' do
+      -> { magazine.check_for_attributes(author: 'Orson Scott Card') }.should raise_error(RuntimeError)
+      magazine.setup(author: 'Orson Scott Card',
+                     title:  'Enders Game')
+      magazine.check_for_attributes(author: 'Orson Scott Card',
+                                    title:  'Enders Game').should be_true
+    end
   end
 
 end

metadata

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