guessmethod 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.3 2007-11-16
+
+* Cleaned up / reworked comments and spec to reflect the fact that the original method/const_missing goes first.
+* Got spec coverage to 100%.
+* Slightly modified string/levenshtein to fix coverage issue (my idiocy? rcov bug?)
+* GuessConstant no longer checks if a class/module responds to const_missing.  They all do.  So that check and the const_missing definition are unnecessary.
+* Added rcov rake task.
+
 == 0.1.2 2007-11-12
 
 * GuessMethod and GuessConstant now both try the original method_ or const_missing, capturing the error, before trying.  On failure, raises the original error.

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/string/levenshtein.rb
 scripts/txt2html
 setup.rb
 spec/guessmethod_spec.rb
+spec/leven_spec.rb
 spec/spec_helper.rb
 website/index.html
 website/index.txt

data/README.txt

@@ -14,7 +14,7 @@ If you accidentally try to access <tt>File::RDWr</tt>, you'll get <tt>File::RDWR
 
 == Options
 
-<tt>GuessMethod::Options</tt> is a hash with configuration values.
+<tt>GuessMethod::GuessMethodOptions</tt> is a hash with configuration values.
 
 * <code>GuessMethodOptions[:insert_weight]</code>, <code>GuessMethodOptions[:delete_weight]</code>, and <code>GuessMethodOptions[:substitution_weight]</code> change how the levenshtein distance is calculated between method and constant names.  The default values are all 1.
 * <code>GuessMethodOptions[:threshold]</code> determines what levenshtein distance a method or constant must be within to count as a possible match.  Values over 2 can give you unpredictable results, especially for short names.  The default value is 2.

data/Rakefile

@@ -133,6 +133,12 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList['spec/*_spec.rb']
 end
 
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['spec/*spec.rb']
+  # t.verbose = true     # uncomment to see the executed command
+end
+
 desc "Default task is to run specs"
 task :default => :spec
 

data/lib/guessmethod/version.rb

@@ -2,7 +2,7 @@ module GuessMethod #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/guessmethod.rb

@@ -2,11 +2,8 @@ require 'string/levenshtein'
 
 # The GuessMethod module aliases out method_missing and
 # replaces it with its own, which attempts to find a
-# similarly named method callable on the object at hand.
-# If it finds one, it calls that instead, and prints
-# a message to stderr explaining as much.  If it doesn't
-# find a suitable method, the orignial method_missing
-# gets called.
+# similarly named method callable on the object at hand
+# if the objects original method_missing fails.
 module GuessMethod
   
   GuessMethodOptions = {
@@ -56,17 +53,11 @@ module GuessMethod
   
   # The GuessConstant module aliases out const_missing and
   # replaces it with its own, which attempts to find a
-  # similarly named constant for the object at hand.
-  # If it finds one, it returns that instead, and prints
-  # a message to stderr explaining as much.  If it doesn't
-  # find a suitable constant, the orignial const_missing
-  # gets called. 
+  # similarly named constant for the object at hand
+  # if the original method_missing fails.
   module GuessConstant
     def self.extended(base)   #:nodoc:
       base.class_eval do
-        unless respond_to? :const_missing
-          def self.const_missing(sym); super; end
-        end
         class << self
           alias_method :unguessed_const_missing, :const_missing
           alias_method :const_missing, :guess_const_missing

data/lib/string/levenshtein.rb

@@ -1,6 +1,7 @@
 class String
   
-  # Calculates the levenshtein distance between strings.  This method was taken from
+  # Calculates the levenshtein distance between strings
+  # This method was modified from the version appearing in
   # The Ruby Way, 2nd Edition, Hal Fulton, pp. 97-98
   def levenshtein(other, ins=2, del=2, sub=1)
     
@@ -21,13 +22,14 @@ class String
     # populate matrix
     for i in 1..other.length
       for j in 1..self.length
-    # critical comparison
-        dm[i][j] = [
+        # critical comparison
+        comparisons_array = [
              dm[i-1][j-1] +
                (self[j-1] == other[i-1] ? 0 : sub),
                  dm[i][j-1] + ins,
              dm[i-1][j] + del
-       ].min
+           ]
+        dm[i][j] = comparisons_array.min
       end
     end
 

data/spec/guessmethod_spec.rb

@@ -3,12 +3,21 @@ require 'lib/guessmethod.rb'
 
 describe 'GuessMethod naturally' do
   
+  before(:all) do
+    class Ambiguous
+      FOOD = 2
+      FOOF = 3
+      def food; end
+      def foof; end
+    end
+  end
+  
   it "should define guess_method_missing on Object" do
     Object.should.respond_to? :guess_method_missing
   end
   
   it 'should define guess_const_missing on Object' do
-    Object.should.respond_to? 'guess_const_missing'
+    Object.should.respond_to? :guess_const_missing
   end
   
   it "should figure out toi means to_i" do
@@ -30,7 +39,7 @@ describe 'GuessMethod naturally' do
   it "should be off if it gets turned off" do
     GuessMethodOptions[:active] = false
     lambda{Class.nw}.should raise_error(NoMethodError)
-    lambda{Cass == Class}.should raise_error(NameError)
+    lambda{Cass}.should raise_error(NameError)
     GuessMethodOptions[:active] = true
   end
   
@@ -48,6 +57,18 @@ describe 'GuessMethod naturally' do
   it "should replace RUBY_Version with RUBY_VERSION" do
     RUBY_Version.should == RUBY_VERSION
   end
+  
+  it 'should raise NoMethodError with an ambiguous method' do
+    lambda{Ambiguous.new.foo}.should raise_error(NoMethodError)
+  end
+  
+  it "should raise NameError when there's no constant in threshold" do
+    lambda{File::NOTACONSTANT}.should raise_error(NameError)
+  end
+  
+  it 'should raise NameError with an ambiguous constant' do
+    lambda{Ambiguous::FOO}.should raise_error(NameError)
+  end
 end
 
 describe "On a method_missing-defining class, GuessMethod" do
@@ -64,12 +85,40 @@ describe "On a method_missing-defining class, GuessMethod" do
     end
   end
   
-  it "should pass on to the class' method_missing past the threshold" do
+  it "should allow method_missing to handle its cases" do
     A.new.foo.should == 'bar'
   end
   
   it "should let an object's NoMethodError through if there's no method in the threshold" do
     lambda{A.new.not_a_method}.should raise_error(NoMethodError)
+  end  
+end
+
+describe 'On a const_missing-defining class, GuessMethod' do
+  before(:all) do
+    class Consty
+      BAR = 'French Toast'
+      def self.const_missing(sym)
+        case sym
+        when :FOO
+          42
+        else
+          raise NameError
+        end
+      end
+      include GuessMethod
+    end
   end
   
-end
+  it 'should allow const_missing to handle its cases' do
+    Consty::FOO.should == 42
+  end
+  
+  it "should let an object's NameError through if there's no constant in the threshold" do
+    lambda{Consty::NOWAYJOSE}.should raise_error(NameError)
+  end
+  
+  it 'should supply guessed constants (the other specs in this will work without including GuessMethod)' do
+    Consty::BAZ.should == 'French Toast'
+  end
+end

data/spec/leven_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'lib/string/levenshtein.rb'
+
+describe 'Levenshtein' do
+  
+  it 'should be 0 for equal strings' do
+    'foo'.levenshtein('foo').should == 0
+  end
+  
+  it 'should be 1 for strings that differ by only a subsitution' do
+    'foo'.levenshtein('fof').should == 1
+  end
+  
+  it 'should be 2 for strings that differ by only an insertion' do
+    'foo'.levenshtein('fodo').should == 2
+  end
+  
+  it 'should be 2 for strings that differ by only a deletion' do
+    'foo'.levenshtein('fo').should == 2
+  end
+  
+  it 'should be reflexive' do
+    string1 = 'this is one string'
+    string2 = 'this is a different one'
+    string1.levenshtein(string2).should == string2.levenshtein(string1)
+  end
+  
+  it 'should calculate correctly longer distances' do
+    string1 = 'this is one string'
+    string2 = 'this is a different one'
+    string1.levenshtein(string2).should == 17
+  end
+  
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: guessmethod
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-11-12 00:00:00 -07:00
+  version: 0.1.3
+date: 2007-11-16 00:00:00 -07:00
 summary: an aggressive spell checker for irb
 require_paths: 
 - lib
@@ -40,6 +40,7 @@ files:
 - scripts/txt2html
 - setup.rb
 - spec/guessmethod_spec.rb
+- spec/leven_spec.rb
 - spec/spec_helper.rb
 - website/index.html
 - website/index.txt