maybeyoumeant 0.2.0 → 0.3.0

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem 'rainbow', '~> 1.1.1'
+gem 'paint', '~> 0.8.3'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/HISTORY.txt

@@ -0,0 +1,9 @@
+0.3.0 
+ - Working for Ruby 1.9
+ - Improved on Levenshtein space complexity
+0.2.0 Merged in janlelis changes:
+ - Rainbow replaced with Paint
+ - ask_user feature
+ - Fixes for Ruby 1.9
+0.1.0 Initial release. Broken for Ruby 1.9
+

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/maybeyoumeant.rb

@@ -1,44 +1,55 @@
 module MaybeYouMeant; end
 
 require 'rubygems'
-require 'rainbow'
+require 'paint'
 
-require 'maybeyoumeant/matrix'
+require 'maybeyoumeant/config'
 require 'maybeyoumeant/levenshtein'
 require 'maybeyoumeant/object_extensions'
 require 'maybeyoumeant/nil_logger'
 require 'maybeyoumeant/std_err_logger'
-require 'maybeyoumeant/config'
 
 module MaybeYouMeant
-  @@logger = StdErrLogger.new
+  @logger = StdErrLogger.new
   def self.logger=(logger)
-    @@logger = logger
+    @logger = logger
   end
 
+  # Logs a message to the current logger.
+  # The current logger is either STDOUT (be default), or a
+  # nil logger if debug is disabled.
   def self.log(msg = nil, &block)
-    # msg ||= yield if block_given?
-    @@logger.log(msg, &block)
+    @logger.log(msg, &block)
   end
 
-
-  def self.tweak_history(method, nearby)
+  # Returns true if in an IRB session, false if not.
+  def self.irb_session?
     begin
-      @@irb ||= Kernel.const_get('IRB') && Kernel.const_get('Readline') && Readline.const_defined?('HISTORY')
+      @irb ||= Kernel.const_get('IRB') && Kernel.const_get('Readline') && Readline.const_defined?('HISTORY')
     rescue NameError
-      @@irb = false
+      @irb = false
     end
-    return unless @@irb
+    return @irb
+  end
 
-    line = Readline::HISTORY[-1]
+  # Updates IRB history to include the fixed command.
+  # For example if:
+  #  'hello'.ucase
+  # is executed, IRB history will be update with
+  #  'hello'.upcase
+  def self.tweak_history(method, nearby)
+    return unless irb_session? && !Readline::HISTORY.empty?
+
+    line = Readline::HISTORY[Readline::HISTORY.size - 1]
     Readline::HISTORY.pop if Config::remove_from_history
 
-    if Config.add_to_history
-      # Try to match .#{method}\W before replacing all occurences of method.
-      line.gsub!(/(\W|^)#{method}((?=\W)|$)/, "\\1#{nearby}")
-      log("Maybe you meant: #{line}".foreground(:black).bright)
-      Readline::HISTORY.push line
-    end
+    # Try to match .#{method}\W before replacing all occurrences of method.
+    line.gsub!(/(\W|^)#{method.to_s}((?=\W)|$)/, "\\1#{nearby.to_s}")
+    log((Paint["Maybe you meant: ", :red]) + line.to_s)
+
+    Readline::HISTORY.push line if Config.add_to_history
   end
+
+  MaybeYouMeant::ObjectExtentions.install_instance_methods
 end
 

data/lib/maybeyoumeant/config.rb

@@ -15,19 +15,19 @@ module MaybeYouMeant::Config
     MaybeYouMeant::StdErrLogger === MaybeYouMeant.logger
   end
 
-  @@call_nearby = true
+  @call_nearby = true
 
   # When true if a nearby method is found it is automatically called.
   # Defaults to true.
   def self.call_nearby=(enabled)
-    @@call_nearby = enabled
+    @call_nearby = enabled
   end
 
   def self.call_nearby
-    @@call_nearby
+    @call_nearby
   end
 
-  @@add_to_history = true
+  @add_to_history = true
 
   # When true and a nearby method is called the history is manipulated to
   # have the nearby method name. Defaults to true.
@@ -36,24 +36,37 @@ module MaybeYouMeant::Config
   # Say object foo has a method 'foob' you will get the following in your history:
   # foo.foo -> foob.foob
   def self.add_to_history=(enabled)
-    @@add_to_history = true
+    @add_to_history = true
   end
 
   def self.add_to_history
-    @@add_to_history
+    @add_to_history
   end
 
-  @@remove_from_history = false
+  @remove_from_history = false
 
   # When true and a nearby method is called the history is manipulated to
   # have the line with the incorrect method name removed.
   # Defaults to false.
   def self.remove_from_history(enabled)
-    @@remove_from_history = enabled
+    @remove_from_history = enabled
   end
 
   def self.remove_from_history
-    @@remove_from_history
+    @remove_from_history
+  end
+
+  @ask_user = false
+
+  # When true, the nearby method is not called directly, but the user
+  # can decide if he wants to call it
+  # Defaults to false
+  def self.ask_user=(enabled)
+    @ask_user = enabled
+  end
+
+  def self.ask_user
+    @ask_user
   end
 
 end

data/lib/maybeyoumeant/levenshtein.rb

@@ -7,35 +7,43 @@ class MaybeYouMeant::Levenshtein
   # care about a threshold distance we only need to calculate
   # a diagonal instead of the full distance. This could be
   # further optimized to be evaluated lazily.
-  def self.distance(s, t)
+  #
+  # If max is provided the return value is the Levenshtein distance if it
+  # is less than max, otherwise it is any value greater than or equal to
+  # max.
+  def self.distance(s, t, max = nil)
     m = s.length
     n = t.length
 
-    d = ::Matrix.rows(Array.new(m + 1) { Array.new(n + 1, 0) }, false)
+    # If the string lengths differ by more than max return immediately.
+    return max if max && (m - n).abs >= max
 
-    0.upto m do |i|
-      d[i, 0] = i
-    end
+    cur = Array.new(n + 1, 0)
+    nxt = Array.new(n + 1, 0)
 
     0.upto n do |j|
-      d[0, j] = j
+      cur[j] = j
     end
 
     1.upto m do |i|
+      nxt[0] = i
       1.upto n do |j|
         # This is not unicode safe.
         if s[i - 1] == t[j - 1]
-          d[i, j] = d[i - 1, j - 1]
+          nxt[j] = cur[j - 1]
         else
-          d[i, j] = [
-            d[i - 1, j] + 1,     # deletion
-            d[i, j - 1] + 1,     # insertion
-            d[i - 1, j - 1] + 1  # substitution
+          nxt[j] = [
+            cur[j] + 1,      #deletion
+            nxt[j - 1] + 1,  #insertion
+            cur[j - 1] + 1,  #substitution
           ].min
         end
       end
+      tmp = cur
+      cur = nxt
+      nxt = tmp
     end
     
-    return d[m, n]
+    return cur[n]
   end
 end

data/lib/maybeyoumeant/object_extensions.rb

@@ -1,17 +1,45 @@
 # Extends Object to call a method similar to the one called when the 
 # method has not been defined on the object.
 module MaybeYouMeant::ObjectExtentions
+  # Not 100% sure what the problem is, but if you start mucking about
+  # with the following methods in Ruby 1.9 things go horrible wrong,
+  # so we just ignore them. They're likely to be correct anyway.
+  IGNORE_LIST = [
+    :to_str,
+    :to_int,
+    :to_ary,
+    :to_hash,
+    :to_a
+  ]
+
+  def self.user_confirmation(nearby)
+    Paint["Do you want to call ", :green] +
+    Paint[nearby, :green, :bright] +
+    Paint[" instead?", :green] +
+    " [Y,n]: "
+  end
 
   module InstanceMethods
     # Calls a nearby method if one is found. If no nearby method is
     # found the original method_missing is called, which raises a
     # NoMethodError.
     def method_missing(method, *args, &block)
+      # Don't handle methods on the ignore list.
+      return super if IGNORE_LIST.include?(method)
+
       nearby = nearby_method(method)
-      # MaybeYouMeant.log { "Maybe you meant to call #{nearby}?" } if nearby
+
       return super unless MaybeYouMeant::Config.call_nearby && nearby
+
+      if MaybeYouMeant::Config.ask_user
+        print MaybeYouMeant::ObjectExtentions.user_confirmation(nearby)
+        choice = gets
+        return super if !choice || choice =~ /^n/i
+      end
+
       MaybeYouMeant.tweak_history(method, nearby)
-      return send(nearby, *args, &block)
+
+      send(nearby, *args, &block)
     end
 
     # Returns the closest matching method to methods already defined on the object.
@@ -21,7 +49,7 @@ module MaybeYouMeant::ObjectExtentions
 
       distance = {}
       nearby_methods = self.methods.select do |method|
-        d = MaybeYouMeant::Levenshtein.distance(name.to_s, method.to_s)
+        d = MaybeYouMeant::Levenshtein.distance(name.to_s, method.to_s, max_distance + 1)
         distance[method] = d if d <= max_distance
         d <= max_distance
       end
@@ -34,7 +62,9 @@ module MaybeYouMeant::ObjectExtentions
 
   end
 
-  # Add the instance methods to the base object.
-  Object.send(:include, InstanceMethods)
+  def self.install_instance_methods
+    # Add the instance methods to the base object.
+    Object.send(:include, InstanceMethods)
+  end
 end
 

data/maybeyoumeant.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{maybeyoumeant}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Liehann Loots"]
+  s.date = %q{2011-07-18}
+  s.description = %q{
+  If you misspell a method in IRB this plugin searches through methods
+  defined on the object and calls the closest method to the one you entered.
+  For example lets say you typed:
+   'hello world'.capitalze
+  Instead of raising a NoMethodError 'hello world'.capitalize would automatically
+  be called.
+  }
+  s.email = %q{liehannl@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "HISTORY.txt",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/maybeyoumeant.rb",
+    "lib/maybeyoumeant/config.rb",
+    "lib/maybeyoumeant/levenshtein.rb",
+    "lib/maybeyoumeant/nil_logger.rb",
+    "lib/maybeyoumeant/object_extensions.rb",
+    "lib/maybeyoumeant/std_err_logger.rb",
+    "maybeyoumeant.gemspec",
+    "spec/.helper.rb.swo",
+    "spec/helper.rb",
+    "spec/lib/foo.rb",
+    "spec/maybeyoumeant/.matrix_spec.rb.swo",
+    "spec/maybeyoumeant/levenshtein_spec.rb",
+    "spec/maybeyoumeant/object_extensions_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/liehann/maybeyoumeant}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{IRB plugin that suggests corrections for misspelled method names.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<paint>, ["~> 0.8.3"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.2"])
+    else
+      s.add_dependency(%q<paint>, ["~> 0.8.3"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 1.3.2"])
+    end
+  else
+    s.add_dependency(%q<paint>, ["~> 0.8.3"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 1.3.2"])
+  end
+end
+

data/spec/maybeyoumeant/levenshtein_spec.rb

@@ -12,5 +12,9 @@ describe Levenshtein do
   it "calculates a correct distance between two strings" do
     Levenshtein.distance('kitten', 'sitting').should == 3
   end
+
+  it "calculates correct distance between match and to_path" do
+    d = MaybeYouMeant::Levenshtein.distance(:to_path.to_s, :match.to_s, 3).should >= 3
+  end
 end
 

data/spec/maybeyoumeant/object_extensions_spec.rb

@@ -2,11 +2,11 @@ require 'helper'
 
 describe ObjectExtentions do
   it 'finds a nearby method' do
-    Foo.new.nearby_method(:boo).should == 'foo'
+    Foo.new.nearby_method(:boo).to_s.should == 'foo'
   end
 
   it 'has a threshold of 2' do
-    Foo.new.nearby_method(:foobr).should == 'foo'
+    Foo.new.nearby_method(:foobr).to_s.should == 'foo'
   end
 
   it 'returns nil if there are no nearby methods' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: maybeyoumeant
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Liehann Loots
@@ -19,26 +19,23 @@ date: 2011-07-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
-  name: rainbow
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 57
         segments: 
-        - 1
-        - 1
-        - 1
-        version: 1.1.1
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  type: :development
+        - 0
+        - 8
+        - 3
+        version: 0.8.3
+  type: :runtime
+  name: paint
   prerelease: false
-  name: shoulda
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,12 +44,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: shoulda
   prerelease: false
-  name: bundler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +60,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: bundler
   prerelease: false
-  name: jeweler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -79,12 +76,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: jeweler
   prerelease: false
-  name: rcov
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,12 +90,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
   type: :development
+  name: rcov
   prerelease: false
-  name: rspec
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -109,7 +106,10 @@ dependencies:
         - 3
         - 2
         version: 1.3.2
-  requirement: *id006
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id006
 description: "\n  If you misspell a method in IRB this plugin searches through methods\n  defined on the object and calls the closest method to the one you entered.\n  For example lets say you typed:\n   'hello world'.capitalze\n  Instead of raising a NoMethodError 'hello world'.capitalize would automatically\n  be called.\n  "
 email: liehannl@gmail.com
 executables: []
@@ -122,6 +122,7 @@ extra_rdoc_files:
 files: 
 - .document
 - Gemfile
+- HISTORY.txt
 - LICENSE.txt
 - README.rdoc
 - Rakefile
@@ -129,16 +130,15 @@ files:
 - lib/maybeyoumeant.rb
 - lib/maybeyoumeant/config.rb
 - lib/maybeyoumeant/levenshtein.rb
-- lib/maybeyoumeant/matrix.rb
 - lib/maybeyoumeant/nil_logger.rb
 - lib/maybeyoumeant/object_extensions.rb
 - lib/maybeyoumeant/std_err_logger.rb
+- maybeyoumeant.gemspec
 - spec/.helper.rb.swo
 - spec/helper.rb
 - spec/lib/foo.rb
 - spec/maybeyoumeant/.matrix_spec.rb.swo
 - spec/maybeyoumeant/levenshtein_spec.rb
-- spec/maybeyoumeant/matrix_spec.rb
 - spec/maybeyoumeant/object_extensions_spec.rb
 has_rdoc: true
 homepage: http://github.com/liehann/maybeyoumeant

data/lib/maybeyoumeant/matrix.rb

@@ -1,15 +0,0 @@
-require 'matrix'
-
-class MaybeYouMeant::Matrix
-
-  module InstanceMethods
-    def []=(i, j, v)
-      @rows[i][j] = v
-    end
-  end
-
-  # Add matrix methods if this is ruby 1.8 and they're not present.
-  unless ::Matrix.instance_methods.include?(:[]=)
-    ::Matrix.send(:include, InstanceMethods)
-  end
-end

data/spec/maybeyoumeant/matrix_spec.rb

@@ -1,14 +0,0 @@
-require 'helper'
-
-describe Matrix do
-  it "adds an index setter to ::Matrix" do
-    ::Matrix.instance_methods.should include '[]='
-  end
-
-  it "should set values in a ::Matrix" do
-    m = ::Matrix[[0, 0, 0], [0, 0, 0]]
-    m[1, 2] = 3
-    m[1, 2].should == 3
-  end
-end
-