multi_methods.rb 1.0.0

data/lib/multi_methods.rb

@@ -0,0 +1,77 @@
+module MultiMethods
+    def self.included base
+      base.extend( ClassMethods )
+      base.class_eval { include InstanceMethods }
+    end
+
+    module ClassMethods
+
+      def create_method( name, &block ) 
+        self.send( :define_method, name, block )
+      end
+
+      def defmulti method_name, default_dispatch_fn = nil
+        self.instance_variable_set( "@" + method_name.to_s, [] )
+
+        create_method( method_name ) do |*args|
+          dispatch_table = self.class.instance_variable_get( "@" + method_name.to_s )
+
+          dispatch_table.each do |m|
+            predicate = if m.keys.first.respond_to? :call
+                          raise "Dispatch method already defined by defmulti" if default_dispatch_fn
+                          m.keys.first
+                        elsif  m.keys.first == :default
+                          :default
+                        else
+                          lambda { |args| return default_dispatch_fn.call(args) == m.keys.first }
+                        end
+
+            destination_fn = m.values.first
+
+            if predicate == :default  || predicate.call(args)
+              if destination_fn.is_a? UnboundMethod
+                break destination_fn.bind( self ).call(args)
+              else
+                break destination_fn.call(args)
+              end
+              break
+            end
+            raise "No matching dispatcher function found" if dispatch_table.last == m
+          end
+        end
+      end
+    
+      def defmethod method_name, dispatch_value, default_dispatch_fn
+        multi_method = self.instance_variable_get( "@" + method_name.to_s)  
+        raise "MultiMethod #{method_name} not defined" unless  multi_method
+        multi_method << {  dispatch_value => default_dispatch_fn } 
+      end
+    end #ClassMethods
+
+
+    module InstanceMethods
+
+      def defmulti_local &block
+        instance_eval &block 
+
+        #clean up after evaling block
+        instance_eval do 
+          method_name = instance_variable_get( :@added_multi_method )
+          self.class.send(:undef_method, method_name)
+          self.class.send(:remove_instance_variable,  ('@' + method_name.to_s).to_sym )
+          self.send( :remove_instance_variable, :@added_multi_method )
+        end
+      end
+
+      def defmulti method_name, default_dispatch_fn = nil
+        instance_variable_set( :@added_multi_method, method_name )
+        self.class.defmulti method_name, default_dispatch_fn
+      end
+
+      def defmethod method_name, dispatch_value, default_dispatch_fn
+        self.class.defmethod method_name, dispatch_value, default_dispatch_fn
+      end
+    end #InstanceMethods
+end
+
+Object.send( :include, MultiMethods )

data/specs/multi_methods_spec.rb

@@ -0,0 +1,209 @@
+require File.dirname(__FILE__) + '/square'
+require File.dirname(__FILE__)  + '/../multi_methods'
+
+
+describe "hacking Square with multi_methods" do
+
+  describe "defmulti_local" do
+    before(:each) do
+      @our_square.dispatch_fn = nil
+      @our_square.class.dispatch_fn = nil
+    end
+
+    before(:all) do
+      class Square
+
+        def tuna1 *args
+          @dispatch_fn = :tuna1
+        end
+
+        def tuna_gateway *args
+          defmulti_local do  
+            defmulti :tuna, lambda{ |args| args[0] + args[1] }
+            defmethod :tuna, 2, self.class.instance_method(:tuna1)
+            defmethod :tuna, 4, self.class.method(:tuna2)
+            defmethod :tuna, :default, lambda{ |args| @default_fn = :tuna_default }
+
+            tuna(*args) 
+          end
+        end
+      end
+
+      @our_square = Square.new
+    end
+    
+    it "should dispatch to tuna1 when the sum of the first to parameters is 2" do
+      @our_square.tuna_gateway(1,1)
+      @our_square.dispatch_fn.should == :tuna1
+      @our_square.class.dispatch_fn.should == nil
+    end
+
+    it "should dispatch to tuna2 when the sum of the first to parameters is 4" do
+      @our_square.tuna_gateway(3,1)
+      @our_square.dispatch_fn.should == nil
+      @our_square.class.dispatch_fn.should == :tuna2
+    end
+
+    it "should remove all traces of metaprogramming after the defmulti_local block exits" do
+      @our_square.tuna_gateway(3,1)
+      @our_square.methods.should_not include 'tuna'
+      @our_square.class.instance_variables.should_not include '@tuna'
+      @our_square.class.instance_variables.should_not include '@added_multi_method'
+    end 
+  end
+
+  describe "causes of exceptions" do
+    before do
+      @our_square = Square.new
+    end
+    it "should raise an exception if trying to construct a defmethod without a previously defined defmulti of the same name" do
+      lambda do
+        @our_square.class.instance_eval { defmethod :chicken, lambda{ |args| args[0] }, instance_method(:chicken1) }
+      end.should raise_error( Exception, "MultiMethod chicken not defined" )
+    end
+
+    it "should raise an exception if no predicates match and there is no default defmethod" do
+      @our_square.class.instance_eval do
+        defmulti :chicken, lambda{ |args| args[1].class }
+        defmethod :chicken, Fixnum, instance_method(:chicken1)
+        defmethod :chicken, String, method(:chicken2)
+      end
+      lambda { @our_square.chicken( true ) }.should raise_error( Exception, "No matching dispatcher function found" )
+    end
+
+    it "should raise an exception if defining individual dispatch predicates AND a default dispatch fn" do
+      @our_square.class.instance_eval do
+        defmulti :chicken, lambda{ |args| args[1].class }
+        defmethod :chicken, Fixnum, instance_method(:chicken1)
+        defmethod :chicken, String, method(:chicken2)
+        defmethod :chicken, lambda { |args| true }, lambda { |args| puts "never get here" }
+      end
+      lambda do 
+        @our_square.chicken(2)
+      end.should raise_error( Exception, "Dispatch method already defined by defmulti" )
+    end
+
+  end
+
+  describe "class level with a single dispatch fn" do
+    describe "dispatch by on type of 2nd arg" do
+      before do
+        @our_square = Square.new
+
+        @our_square.class.instance_eval do
+          defmulti :chicken, lambda{ |args| args[1].class }
+          defmethod :chicken, Fixnum, instance_method(:chicken1)
+          defmethod :chicken, String, method(:chicken2)
+          defmethod :chicken, :default, lambda { @dispatch_fn = :chicken_default; return :chicken_default }
+        end
+
+        @our_square.dispatch_fn = nil
+        @our_square.class.dispatch_fn = nil
+      end
+      
+      it "should create an instance method named chicken and a class level instance variable" do
+        @our_square.methods.should include 'chicken'
+        @our_square.class.instance_variables.should include '@chicken'
+      end
+
+      it "should dispatch to chicken1 if the 2nd arg is a Fixnum" do
+        @our_square.chicken( true, 2 )
+        @our_square.dispatch_fn.should == :chicken1
+        @our_square.class.dispatch_fn.should be_nil
+      end
+
+      it "should dispatch to chicken1 if the 2nd arg is a Fixnum and return the correct value from chicken1" do
+        result = @our_square.chicken( true, 2 )
+        result.should == :chicken1
+      end
+
+      it "should dispatch to chicken2 if the 2nd arg is a String" do
+        @our_square.chicken( true, "two" )
+        @our_square.dispatch_fn.should be_nil
+        @our_square.class.dispatch_fn.should == :chicken2
+      end
+
+      it "should dispatch to the default lambda if the 2nd arg is neither a Fixnum nor a String and return the correct value" do
+        result = @our_square.chicken( true, true )
+        @our_square.dispatch_fn.should be_nil
+        @our_square.class.dispatch_fn.should == :chicken_default
+        result.should == :chicken_default
+      end
+    end
+
+    describe "dispatch based on the # of args " do
+      before do
+        @our_square = Square.new
+
+        @our_square.class.instance_eval do
+          defmulti :chicken, lambda{ |args| args.size }
+          defmethod :chicken, 1, instance_method(:chicken1)
+          defmethod :chicken, 2, method(:chicken2)
+          defmethod :chicken, :default, lambda { @dispatch_fn = :chicken_default}
+        end
+
+        @our_square.dispatch_fn = nil
+        @our_square.class.dispatch_fn = nil
+      end
+
+      it "should dispatch to chicken1 if called with one arg" do
+        @our_square.chicken(1)
+        @our_square.dispatch_fn.should == :chicken1
+        @our_square.class.dispatch_fn.should be_nil
+      end
+
+      it "should dispatch to chicken2 if called with two args" do
+        @our_square.chicken(1,2)
+        @our_square.dispatch_fn.should be_nil
+        @our_square.class.dispatch_fn.should == :chicken2
+      end
+
+      it "should dispatch to chicken3 if called with three args" do
+        @our_square.chicken(1,2,3)
+        @our_square.class.dispatch_fn.should == :chicken_default
+        @our_square.dispatch_fn.should be_nil
+      end
+
+      it "should dispatch to chicken3 if called with four args" do
+        @our_square.chicken(1,2,3,4)
+        @our_square.class.dispatch_fn.should == :chicken_default
+        @our_square.dispatch_fn.should be_nil
+      end
+    end 
+  end
+
+  describe "class level with multiple predicates" do
+      before do
+        @our_square = Square.new
+
+        @our_square.class.instance_eval do
+          defmulti :chicken
+          defmethod :chicken, lambda{ |args| args[0].class == Fixnum && args[1].class == Fixnum }, instance_method(:chicken1)
+          defmethod :chicken, lambda{ |args| args[0].class == String && args[1].class  == String }, method(:chicken2)
+          defmethod :chicken, :default, lambda { @dispatch_fn = :chicken_default}
+        end
+
+        @our_square.dispatch_fn = nil
+        @our_square.class.dispatch_fn = nil
+      end
+
+      it "should dispatch to chicken1 if the first two parameters are Fixnums" do
+        result = @our_square.chicken(1, 2)
+        @our_square.dispatch_fn.should == :chicken1
+        @our_square.class.dispatch_fn.should be_nil
+      end
+
+      it "should dispatch to chicken2 if the first two parameters are Strings" do
+        @our_square.chicken("one", "two")
+        @our_square.dispatch_fn.should be_nil 
+        @our_square.class.dispatch_fn.should == :chicken2
+      end
+
+      it "should dispatch to chicken3 if the first two parameters are neither Fixnums or Strings" do
+        @our_square.chicken("one", 2)
+        @our_square.dispatch_fn.should be_nil 
+        @our_square.class.dispatch_fn.should == :chicken_default
+      end
+  end
+
+end

data/specs/square.rb

@@ -0,0 +1,25 @@
+class Square
+    class <<self 
+      attr_accessor :dispatch_fn
+    end
+    attr_accessor :dispatch_fn 
+
+  def chicken1 *args
+    @dispatch_fn = :chicken1
+    return :chicken1
+  end
+
+  def self.chicken2 *args
+    @dispatch_fn = :chicken2
+    return :chicken2
+  end
+
+  def tuna1 *args
+    @dispatch_fn = :tuna1
+  end
+
+  def self.tuna2 *args
+    @dispatch_fn = :tuna2
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: multi_methods.rb
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Paul Santa Clara
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-05 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: |
+  Supports general dispatch using clojure style multi-methods.  This can be used
+  for anything from basic function overloading to a function dispatch based on arbitrary complexity.
+
+email: kesserich1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/multi_methods.rb
+- specs/multi_methods_spec.rb
+- specs/square.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: General dispatch for ruby
+test_files: []
+