dyoder-functor 0.2

data/doc/HISTORY

@@ -0,0 +1,2 @@
+0.1 - Initial implemention of Functor class.
+0.2 - Added method dispatch, to_proc support, tests.

data/doc/README

@@ -0,0 +1,36 @@
+Functor provides pattern-based function and method dispatch for Ruby. To use it in a class:
+
+  class Repeater
+    attr_accessor :times
+    include Functor::Method
+    functor( :repeat, Integer ) { |x| x * @times }
+    functor( :repeat, String ) { |s| [].fill( s, 0..@times ).join(' ') }
+  end
+
+  r = Repeater.new
+  r.times = 5
+  r.repeat( 5 )   # => 25
+  r.repeat( "-" ) # => "- - - - -"
+  r.repeat( 7.3 ) # => RuntimeError!
+
+Warning: This defines a class instance variable @functors behind the scenes as a side-effect. Also, functors won't inherit properly at this point.
+
+You can also define Functor objects directly:
+
+  fib = Functor.new do
+    given( 0 ) { 0 }
+    given( 1 ) { 1 }
+    given( 2..10000 ) { |n| self.call( n - 1 ) + self.call( n - 2 ) }
+  end
+  
+You can use functors directly with functions taking a block like this:
+
+  [ *0..10 ].map( &fib )  # => [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
+  
+You can explicitly bind self using #bind:
+
+  fun.bind( obj )
+  
+which is actually how the method dispatch is implemented.
+
+Arguments are matched first using === and then ==, so anything that supports these methods can be matched against.

data/lib/functor.rb

@@ -0,0 +1,63 @@
+require 'lib/object'
+
+class Functor
+  
+  def self.precedence
+    lambda do |pattern|
+      case pattern ; when Class then 0 ; when Proc then 1 ; when Regexp then 2 ; else 3 ; end
+    end
+  end
+
+  module Method
+    def self.included( k )
+      def k.functor( name, *args, &block )
+        functors = module_eval { @__functors ||= {} }
+        unless functors[ name ]
+          functors[ name ] = Functor.new
+          klass = self.name
+          module_eval <<-CODE
+            def #{name}( *args, &block ) 
+              begin
+                functors = #{klass}.module_eval { @__functors }
+                functors[ :#{name} ].bind( self ).call( *args, &block ) 
+              rescue ArgumentError => e
+                begin
+                  super
+                rescue NoMethodError => f
+                  raise e
+                end
+              end
+            end
+          CODE
+        end
+        functors[ name ].given( *args, &block )
+      end
+    end
+  end
+  
+  def initialize( &block ) @patterns = {}; instance_eval( &block ) if block_given? ; end
+  
+  def given( *pattern, &action ) ; @patterns[ pattern ] = action ; end
+  
+  def bind( object ) ; @object = object ; self ; end
+  
+  def call( *args, &block )
+    args.push( block ) if block_given?
+    candidates = @patterns.keys.select { |pattern| match?( args, pattern ) }
+    raise ArgumentError.new( "argument mismatch for argument(s): #{args.inspect}." ) if candidates.empty?
+    action = @patterns[ candidates.sort( &Functor.precedence ).first ]
+    @object ? @object.instance_exec( *args, &action ) : action.call( *args )
+  end
+  
+  def to_proc
+    lambda { |*args| self.call(*args) }
+  end
+  
+  private
+  
+  def match?( args, pattern )
+    pattern.zip(args).all? { |x,y| x === y or x == y or 
+        ( x.respond_to?(:call) && x.call( y ) ) } if pattern.length == args.length
+  end
+  
+end

data/lib/object.rb

@@ -0,0 +1,17 @@
+class Object
+  # This is an extremely powerful little function that will be built-in to Ruby 1.9.
+  # This version is from Mauricio Fernandez via ruby-talk. Works like instance_eval
+  # except that you can pass parameters to the block. This means you can define a block
+  # intended for use with instance_eval, pass it to another method, which can then
+  # invoke with parameters. This is used quite a bit by the Waves::Mapping code.
+  def instance_exec(*args, &block)
+    mname = "__instance_exec_#{Thread.current.object_id.abs}"
+    class << self; self end.class_eval{ define_method(mname, &block) }
+    begin
+      ret = send(mname, *args)
+    ensure
+      class << self; self end.class_eval{ undef_method(mname) } rescue nil
+    end
+    ret
+  end
+end

data/test/fib.rb

@@ -0,0 +1,16 @@
+require "#{File.dirname(__FILE__)}/helpers"
+
+fib ||= Functor.new do
+  given( 0 ) { 0 }
+  given( 1 ) { 1 }
+  given( Integer ) { |n| self.call( n - 1 ) + self.call( n - 2 ) }
+end
+
+describe "Dispatch on a functor object should" do
+  
+  specify "be able to implement the Fibonacci function" do
+    [*0..10].map( &fib ).should == [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55]
+  end
+  
+end
+  

data/test/functor.rb

@@ -0,0 +1,29 @@
+require "#{File.dirname(__FILE__)}/helpers"
+
+class Repeater
+  attr_accessor :times
+  include Functor::Method
+  functor( :repeat, Integer ) { |x| x * @times }
+  functor( :repeat, String ) { |s| [].fill( s, 0, @times ).join(' ') }
+  functor( :repeat ) { nil }
+end
+
+describe "Dispatch on instance method should" do
+  
+  before do
+    @r = Repeater.new
+    @r.times = 5
+  end
+  
+  specify "invoke different methods with object scope based on arguments" do
+    @r.repeat( 5 ).should == 25
+    @r.repeat( "-" ).should == '- - - - -'
+    @r.repeat.should == nil
+  end
+  
+  specify "raise an exception if there is no matching value" do
+    lambda { @r.repeat( 7.3) }.should.raise(ArgumentError)
+  end
+end
+
+  

data/test/helpers.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+%w{ bacon }.each { |dep| require dep }
+Bacon.summary_on_exit
+
+module Kernel
+  private
+  def specification(name, &block)  Bacon::Context.new(name, &block) end
+end
+
+Bacon::Context.instance_eval do
+  alias_method :specify, :it
+end
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require "functor"

data/test/inheritance.rb

@@ -0,0 +1,31 @@
+require "#{File.dirname(__FILE__)}/helpers"
+
+class A
+  include Functor::Method
+  functor( :smurf, Integer ) { |x| "A: Integer" }
+  functor( :smurf, String ) { |s| "A: String" }
+  functor( :smurf, Symbol ) { |s| smurf( "boo" ) }
+  functor( :smurf, Hash ) { |h| "A: Hash" }
+end
+
+class B < A
+  functor( :smurf, String ) { |s| "B: String" }
+  functor( :smurf, Hash ) { |h| "#{super} and B: Hash" }
+end
+
+describe "Functor methods should support inheritance" do
+  
+  specify "by inheriting base class implementations" do
+    B.new.smurf( 5 ).should == "A: Integer"
+  end
+  
+  specify "by allowing derived classes to override an implementation" do
+    B.new.smurf( "foo" ).should == "B: String"
+    A.new.smurf( :foo ).should == "A: String"
+    B.new.smurf( :foo ).should == "B: String"
+  end
+  
+  specify "by allowing to call the implementation of an overriden method on super" do
+    B.new.smurf( {} ).should == "A: Hash and B: Hash"
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: dyoder-functor
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Dan Yoder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dan@zeraweb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- doc/HISTORY
+- doc/README
+- lib/functor.rb
+- lib/object.rb
+- test/fib.rb
+- test/functor.rb
+- test/helpers.rb
+- test/inheritance.rb
+has_rdoc: true
+homepage: http://dev.zeraweb.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: functor
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Pattern-based dispatch for Ruby, inspired by Topher Cyll's multi.
+test_files: []
+