multimethod 0.2.0 → 0.2.1

data/ChangeLog

@@ -1,3 +1,7 @@
+2006-12-01  Kurt A. Stephens  <kurt@umleta.com>
+
+	* Fixed ambigous method testing.
+	
 2006-11-29  Kurt A. Stephens  <kurt@umleta.com>
 
 	* Major cleanup and documentation

data/Manifest.txt

@@ -13,6 +13,7 @@ lib/multimethod/parameter.rb
 lib/multimethod/signature.rb
 lib/multimethod/table.rb
 test/add_remove_test.rb
+test/ambiguous_test.rb
 test/method_test.rb
 test/multimethod_test.rb
 test/parameter_test.rb

data/Rakefile

@@ -142,7 +142,7 @@ end
 
 task :make_manifest do 
   open("Manifest.txt", "w") do |f|
-    f.puts Dir['**/*'].reject { |fn| ! test(?f, fn) || fn =~ /CVS|.svn|(~$)/ }.sort.join("\n") + "\n"
+    f.puts Dir['**/*'].reject { |fn| ! test(?f, fn) || fn =~ /CVS|.svn|(~$)|(.gem$)|(^pkg\/)|(^doc\/)/ }.sort.join("\n") + "\n"
   end
 end
 

data/Releases.txt

@@ -1,5 +1,12 @@
 = Multimethod Release History
 
+== Release 0.2.1: 2006/12/01
+
+* Fixed ambiguous method testing.
+* Fixed method name normalization.
+* TODO:
+  * Need more documentation: user's guide.
+
 == Release 0.2.0: 2006/11/29
 
 * Fixed default parameter scoring.

data/lib/multimethod/multimethod.rb

@@ -2,7 +2,7 @@ module Multimethod
   # Represents a Multimethod.
   #
   # A Multimethod has multiple implementations of a method based on the relative scoring
-  # of the Methods based on the argument types of the message.
+  # of the argument types of the message.
   # 
   # A Multimethod has a name.
   #
@@ -17,16 +17,21 @@ module Multimethod
     # The Multimethod::Table that owns this Multimethod.
     attr_accessor :table
 
+    # Enable debugging info.
+    attr_accessor :debug
+
     # Initialize a new Multimethod.
     def initialize(name, *opts)
       raise NameError, "multimethod name not specified" unless name && name.to_s.size > 0
- 
+      @debug = nil
+
       @name = name
       @name_i = 0
       @method = [ ]
       @dispatch = { }
 
       @lookup_method = { }
+      
     end
 
 
@@ -142,10 +147,16 @@ module Multimethod
     def lookup_method_(args)
       scores = score_methods(@method, args)
       if scores.empty?
+        # Method not found.
         result = nil
       else
+        # Check for ambiguous methods.
+        if result = ambiguous_methods(scores)
+          raise NameError, "Ambiguous methods for multimethod '#{@name}' for (#{args.collect{|x| x.name}.join(', ')}): #{result.collect{|x| x.to_s}.join(', ')}"
+        end
+
+        # Select best scoring method.
         result = scores[0][1]
-        raise("Ambigious method") if scores.select{|x| x[0] == result}.size > 1
       end
 
       #if @name.to_s == 'bar'
@@ -158,6 +169,16 @@ module Multimethod
     end
 
 
+    def ambiguous_methods(scores)
+      # Check for additional methods with the same score as
+      # the first method.
+      scores = scores.select{|x| x[0] == scores[0][0]}
+
+      # Map to a list of signatures.
+      scores.size > 1 ? scores.collect{|x| x[1].signature} : nil
+    end
+
+
     # Returns a sorted list of scores and Methods that
     # match the argument types.
     def score_methods(meths, args)
@@ -175,7 +196,7 @@ module Multimethod
       scores.compact!
       scores.sort!
       
-      # $stderr.puts %{  score_methods(#{args.inspect}) => \n#{scores.collect{|x| x.inspect}.join("\n")}}
+      $stderr.puts %{  score_methods(#{args.inspect}) => \n#{scores.collect{|x| x.inspect}.join("\n")}} if @debug
 
       scores
     end
@@ -230,6 +251,7 @@ end_eval
       '&' => 'AND',
       '!' => 'NOT',
       '~' => 'TIL',
+      '_' => '',    # escape '_' as '_'
       nil => nil
     };
     @@name_map.delete(nil)
@@ -238,7 +260,7 @@ end_eval
 
     def self.normalize_name(name)
       name = name.to_s.clone
-      name.sub!(@@name_rx){|x| "_#{@@name_map[x] || '_'}_"}
+      name.gsub!(@@name_rx){|x| "_#{@@name_map[x] || '_'}_"}
 
       name.intern
     end

data/lib/multimethod/multimethod_version.rb

@@ -2,5 +2,5 @@ module Multimethod
 # DO NOT EDIT
 # This file is auto-generated by build scripts.
 # See:  rake update_version
-  MultimethodVersion = '0.2.0'
+  MultimethodVersion = '0.2.1'
 end

data/lib/multimethod/parameter.rb

@@ -14,6 +14,11 @@ module Multimethod
   class Parameter
     include Comparable
 
+    @@debug = nil
+    def self.debug=(x)
+      @@debug = x
+    end
+
     # The score base used for all Parameters with defaults.
     DEFAULT_SCORE_BASE = 200
 
@@ -48,13 +53,10 @@ module Multimethod
     # Initialize a new Parameter.
     def initialize(name = nil, type = nil, default = nil, restarg = false)
       # $stderr.puts "initialize(#{name.inspect}, #{type}, #{default.inspect}, #{restarg.inspect})"
-      if name
-        # Default type if name is specified
-        type ||= Kernel
-      end
 
       @i = nil
       @type = type
+      @type_object = nil
       @default = default
       @restarg = restarg
       @verbose = false
@@ -77,12 +79,13 @@ module Multimethod
       @name = name
     end
 
+
     # Compare two Parameters.
-    # Only type and restarg are significant.
+    # Parameter name is insignificant.
     def <=>(p)
-      x = @type <=> p.type 
-      x = ! @restarg == ! p.restarg ? 0 : 1 if x == 0
-      x = ! @default == ! p.default ? 0 : 1 if x == 0
+      x = type_object <=> p.type_object
+      x = @restarg == p.restarg ? 0 : 1 if x == 0
+      x = @default == p.default ? 0 : 1 if x == 0
       # $stderr.puts "#{to_s} <=> #{p.to_s} => #{x.inspect}"
       x
     end
@@ -90,6 +93,12 @@ module Multimethod
 
     # Scan a string for a Parameter specification.
     def scan_string(str, need_names = true)
+      # @verbose ||= @@debug
+
+      type = nil
+      name = nil
+      default = nil
+
       str.sub!(/\A\s+/, '')
       
       $stderr.puts "  str=#{str.inspect}" if @verbose
@@ -153,12 +162,14 @@ module Multimethod
             str = md.post_match
             default = default + md[1] 
           end
+
+          $stderr.puts "  default=#{default.inspect}" if @verbose       
         end
       end
       
       self.name = name unless @name
-      type ||= Kernel
       self.type = type unless @type
+      default = nil if default && default.empty?
       self.default = default unless @default
 
       str
@@ -171,6 +182,9 @@ module Multimethod
     # to the argument type.  A lower distance means a tighter match
     # of this Parameter.
     #
+    # If +arg+ is nil, this Parameter is being matched as
+    # a restarg or a parameter default.
+    #
     # Parameters with restargs or unspecfied default arguments score lower, see RESTARG_SCORE, DEFAULT_SCORE.
     def score(arg)
       if @restarg
@@ -195,21 +209,30 @@ module Multimethod
     end
 
 
-    # Resolves type by name
+    # Resolves type name
     def type_object
-      if @type.kind_of?(String)
-        @type = Table.instance.name_to_object(@type, 
-                                              @signature.mod, 
-                                              @signature.file, 
-                                              @signature.line)
+      unless @type_object
+        case @type
+        when String
+          @type_object = Table.instance.name_to_object(@type, 
+                                                       @signature && @signature.mod, 
+                                                       @signature && @signature.file, 
+                                                       @signature && @signature.line)
+        when Module
+          @type_object = @type
+        when NilClass
+          @type_object = Kernel
+        else
+          raise("Incorrect parameter type #{@type.inspect}")
+        end
       end
-      @type
+      @type_object
     end
 
 
     # Returns a String representing this Parameter in a Signature string.
     def to_s
-      "#{@type} #{to_ruby_arg}"
+      "#{@type}#{@type ? ' ' : ''}#{to_ruby_arg}"
     end
     
 

data/lib/multimethod/table.rb

@@ -19,6 +19,9 @@ module Multimethod
     # A list of all Multimethod objects.
     attr_accessor :multimethod
 
+    # Enable debugging info.
+    attr_accessor :debug
+
     # Creates a new Table object.
     def initialize(*opts)
       @multimethod_by_name = { }

data/test/add_remove_test.rb

@@ -48,12 +48,13 @@ end
 
       # Remove asdfwert(AddRemoveA x)
       assert_not_nil m = Table.instance.find_method("AddRemoveA#asdfwert(AddRemoveA x)")
-      assert 1, m.size 
+      assert_equal 1, m.size 
       m = m[0]
       assert_not_nil m
       assert_not_nil mm = m.multimethod
       assert_equal   'AddRemoveA#asdfwert(AddRemoveA x)', m.signature.to_s
       assert_equal   AddRemoveA, m.signature.mod
+      assert_equal   'AddRemoveA', m.signature.parameter[1].type
       assert_equal   AddRemoveA, m.signature.parameter[1].type_object
 
       AddRemoveA.remove_multimethod(m)
@@ -69,8 +70,9 @@ end
       m = m[0]
       assert_not_nil m
       assert_not_nil mm = m.multimethod
-      assert_equal   'AddRemoveA#asdfwert(Kernel x)', m.signature.to_s
+      assert_equal   'AddRemoveA#asdfwert(x)', m.signature.to_s
       assert_equal   AddRemoveA, m.signature.mod
+      assert_equal   nil, m.signature.parameter[1].type
       assert_equal   Kernel, m.signature.parameter[1].type_object
 
       AddRemoveA.remove_multimethod(m)

data/test/ambiguous_test.rb

@@ -0,0 +1,46 @@
+require 'test_base'
+
+
+class Amb < Object
+
+  multimethod %q{
+def amb(x = nil)
+  x = "Amb#amb(x = nil) : (#{x.class.name})"
+  x
+end
+}
+
+  multimethod %q{
+def amb(Amb x = nil)
+  x = "Amb#amb(Amb x = nil) : (#{x.class.name})"
+  x
+end
+}
+
+end
+
+
+module Multimethod
+
+  class AmbiguousTest < TestBase
+
+    def setup
+      super
+    end
+    
+    def test_call
+      assert_not_nil mm = Table.instance.lookup_multimethod(:amb)
+      # mm.debug = 1
+
+      a = Amb.new
+      assert_equal "Amb#amb(x = nil) : (Fixnum)", a.amb(1)
+      assert_equal "Amb#amb(Amb x = nil) : (Amb)", a.amb(a)
+      assert_raise(NameError) { a.amb() }
+
+      # mm.debug = nil
+    end
+
+
+  end # class
+  
+end # module

data/test/parameter_test.rb

@@ -26,6 +26,55 @@ module Multimethod
       assert_equal nil, pB.score(C)
       assert_equal 1,   pB.score(D)
     end
+
+
+    def test_parse
+      p2 = parse_parameter("Kernel y = nil")
+      assert_equal 'Kernel', p2.type
+      assert_equal :y, p2.name
+      assert_equal 'nil', p2.default
+      assert       ! p2.restarg
+
+      p2
+    end
+
+
+    def test_equal
+      p1 = parse_parameter("x")
+      p2 = parse_parameter("x")
+      assert p1 == p2
+
+      p1 = parse_parameter("x")
+      p2 = parse_parameter("y")
+      assert p1 == p2
+
+      p1 = parse_parameter("x")
+      assert_equal Kernel, p1.type_object
+      p2 = parse_parameter("Kernel y")
+      assert_equal Kernel, p2.type_object
+      assert p1 == p2
+
+      p1 = parse_parameter("Kernel x")
+      p2 = parse_parameter("Kernel y")
+      assert p1 == p2
+
+      p1 = parse_parameter("Kernel x")
+      assert_equal nil, p1.default
+      p2 = parse_parameter("Kernel y = nil")
+      assert_equal 'nil', p2.default
+      assert p1 != p2
+
+    end
+
+
+    def parse_parameter(x)
+      p1 = Parameter.new
+      # p1.verbose = 1
+      x = p1.scan_string(x)
+      assert_equal 0, x.size
+      p1
+    end
+
   end # class
   
 end # module

data/test/signature_test.rb

@@ -44,13 +44,15 @@ module Multimethod
 
       i = i + 1
       assert_equal :c, m1.parameter[i].name
-      assert_equal Kernel, m1.parameter[i].type
+      assert_equal nil, m1.parameter[i].type
+      assert_equal Kernel, m1.parameter[i].type_object
       assert       !  m1.parameter[i].restarg
       assert       !       m1.parameter[i].default
 
       i = i + 1
       assert_equal :d, m1.parameter[i].name
-      assert_equal Kernel, m1.parameter[i].type
+      assert_equal nil, m1.parameter[i].type
+      assert_equal Kernel, m1.parameter[i].type_object
       assert       m1.parameter[i].restarg
       assert       !       m1.parameter[i].default
 
@@ -82,13 +84,15 @@ module Multimethod
 
       i = i + 1
       assert_equal :c, m1.parameter[i].name
-      assert_equal Kernel, m1.parameter[i].type
+      assert_equal nil, m1.parameter[i].type
+      assert_equal Kernel, m1.parameter[i].type_object
       assert       !  m1.parameter[i].restarg
       assert_equal 'nil', m1.parameter[i].default
 
       i = i + 1
       assert_equal :d, m1.parameter[i].name
-      assert_equal Kernel, m1.parameter[i].type
+      assert_equal nil, m1.parameter[i].type
+      assert_equal Kernel, m1.parameter[i].type_object
       assert       m1.parameter[i].restarg
       assert       !       m1.parameter[i].default
 

data/test/test_base.rb

@@ -13,6 +13,19 @@ module Multimethod
       assert true
     end
     
+    def test_normalize_name
+      assert_equal :foo              , norm(:foo)
+      assert_equal :foo__bar         , norm('foo_bar')
+      assert_equal :foo__bar__baz    , norm('foo_bar_baz')
+      assert_equal :foo_ADD_         , norm('foo+')
+      assert_equal :foo_ADD__ADD_    , norm('foo++')
+      assert_equal :foo_EQ__EQ_      , norm('foo==')
+    end
+
+    def norm(x)
+      Multimethod.normalize_name(x)
+    end
+
     # Helpers.
     def assert_equal_float(x, y, eps = 1.0e-8)
       d = (x * eps).abs
@@ -20,6 +33,7 @@ module Multimethod
       assert y <= (x + d)
     end
     
+
   end # class
 
 end # module

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: multimethod
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-11-29 00:00:00 -05:00
+  version: 0.2.1
+date: 2006-12-01 00:00:00 -05:00
 summary: "Supports Multimethod dispatching.  For more details, see:  http://multimethod.rubyforge.org/files/lib/multimethod_rb.html  http://multimethod.rubyforge.org/files/README.txt http://multimethod.rubyforge.org/"
 require_paths: 
 - lib
@@ -45,6 +45,7 @@ files:
 - lib/multimethod/signature.rb
 - lib/multimethod/table.rb
 - test/add_remove_test.rb
+- test/ambiguous_test.rb
 - test/method_test.rb
 - test/multimethod_test.rb
 - test/parameter_test.rb