maybeyoumeant 0.2.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'rainbow', '~> 1.1.1'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'rspec', "~> 1.3.2"
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Liehann Loots
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= Maybe You Meant
+
+May You Meant is an IRB extension that guesses the method you meant to call
+when you make a typo.
+
+Say for example you call
+ 'hello world'.ucase
+Maybe You Meant will output
+ Maybe you meant: 'hello world'.upcase
+and automatically call the correct method and insert the new line into your
+IRB history.
+
+== Installation
+
+ gem install maybeyoumeant
+
+The rainbow gem is installed for color console output.
+
+Put the following into you .irbrc
+ require 'rubygems'
+ require 'maybeyoumeant'
+
+== Configuration
+
+ # To turn off logging
+ MaybeYouMeant::Config.debug = false
+
+ # To not automatically call methods
+ MaybeYouMeant::Config.call_nearby = false
+
+ # To not add an updated line to IRB history
+ MaybeYouMeant::Config.add_to_history = false
+
+ # To remove the incorrect line from IRB history
+ MaybeYouMeant::Config.remove_from_history = true
+
+== How It Works
+
+Object is monkey-patched to intercept NoMethodErrors. Levenshtein distances are calculated
+for other methods on the object, and the closest one is selected and called.
+
+== Contributing to maybeyoumeant
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Liehann Loots. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "maybeyoumeant"
+  gem.homepage = "http://github.com/liehann/maybeyoumeant"
+  gem.license = "MIT"
+  gem.summary = "IRB plugin that suggests corrections for misspelled method names."
+  gem.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.
+  }
+  gem.email = "liehannl@gmail.com"
+  gem.authors = ["Liehann Loots"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new do |test|
+  test.libs << 'lib' << 'spec/lib'
+  # test.verbose = true
+  test.pattern = 'spec/**/*_spec.rb'
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "maybeyoumeant #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/maybeyoumeant/config.rb

@@ -0,0 +1,59 @@
+module MaybeYouMeant::Config
+  # Set to true to log when a nearby message is automatically called.
+  # Default value is true.
+  def self.debug=(enabled)
+    raise 'Debug can only be set to true or false.' unless enabled == true || enabled == false
+    if enabled
+      MaybeYouMeant.logger = MaybeYouMeant::StdErrLogger.new
+    else
+      MaybeYouMeant.logger = MaybeYouMeant::NilLogger.new
+    end
+  end
+
+  # Indicates if debug logger is currently enabled.
+  def self.debug
+    MaybeYouMeant::StdErrLogger === MaybeYouMeant.logger
+  end
+
+  @@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
+  end
+
+  def self.call_nearby
+    @@call_nearby
+  end
+
+  @@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.
+  # This is done with a simple search and replace and may not be perfect,
+  # especially for short methods.
+  # 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
+  end
+
+  def self.add_to_history
+    @@add_to_history
+  end
+
+  @@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
+  end
+
+  def self.remove_from_history
+    @@remove_from_history
+  end
+
+end

data/lib/maybeyoumeant/levenshtein.rb

@@ -0,0 +1,41 @@
+class MaybeYouMeant::Levenshtein
+  # Computes the Levenshtein distance between two strings.
+  #
+  # This is currently completely unoptimized, both in terms
+  # of space and time. Two planned optimizations are to only
+  # use two rows instead of a matrix, and as ultimately we only
+  # 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)
+    m = s.length
+    n = t.length
+
+    d = ::Matrix.rows(Array.new(m + 1) { Array.new(n + 1, 0) }, false)
+
+    0.upto m do |i|
+      d[i, 0] = i
+    end
+
+    0.upto n do |j|
+      d[0, j] = j
+    end
+
+    1.upto m do |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]
+        else
+          d[i, j] = [
+            d[i - 1, j] + 1,     # deletion
+            d[i, j - 1] + 1,     # insertion
+            d[i - 1, j - 1] + 1  # substitution
+          ].min
+        end
+      end
+    end
+    
+    return d[m, n]
+  end
+end

data/lib/maybeyoumeant/matrix.rb

@@ -0,0 +1,15 @@
+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/lib/maybeyoumeant/nil_logger.rb

@@ -0,0 +1,6 @@
+# Ignores all logging calls.
+class MaybeYouMeant::NilLogger
+  def log(msg = nil, &block)
+  end
+end
+

data/lib/maybeyoumeant/object_extensions.rb

@@ -0,0 +1,40 @@
+# Extends Object to call a method similar to the one called when the 
+# method has not been defined on the object.
+module MaybeYouMeant::ObjectExtentions
+
+  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)
+      nearby = nearby_method(method)
+      # MaybeYouMeant.log { "Maybe you meant to call #{nearby}?" } if nearby
+      return super unless MaybeYouMeant::Config.call_nearby && nearby
+      MaybeYouMeant.tweak_history(method, nearby)
+      return send(nearby, *args, &block)
+    end
+
+    # Returns the closest matching method to methods already defined on the object.
+    def nearby_method(name)
+      max_distance = 2
+      max_distance = 1 if name.to_s.length <= 3
+
+      distance = {}
+      nearby_methods = self.methods.select do |method|
+        d = MaybeYouMeant::Levenshtein.distance(name.to_s, method.to_s)
+        distance[method] = d if d <= max_distance
+        d <= max_distance
+      end
+      return nil if nearby_methods.empty?
+      nearby_methods.sort! do |method, other|
+        distance[method] <=> distance[other]
+      end
+      nearby_methods[0]
+    end
+
+  end
+
+  # Add the instance methods to the base object.
+  Object.send(:include, InstanceMethods)
+end
+

data/lib/maybeyoumeant/std_err_logger.rb

@@ -0,0 +1,8 @@
+# Logs to STDERR.
+class MaybeYouMeant::StdErrLogger
+  def log(msg = nil, &block)
+    msg ||= yield if block_given?
+    STDERR.puts(msg)
+  end
+end
+

data/lib/maybeyoumeant.rb

@@ -0,0 +1,44 @@
+module MaybeYouMeant; end
+
+require 'rubygems'
+require 'rainbow'
+
+require 'maybeyoumeant/matrix'
+require 'maybeyoumeant/levenshtein'
+require 'maybeyoumeant/object_extensions'
+require 'maybeyoumeant/nil_logger'
+require 'maybeyoumeant/std_err_logger'
+require 'maybeyoumeant/config'
+
+module MaybeYouMeant
+  @@logger = StdErrLogger.new
+  def self.logger=(logger)
+    @@logger = logger
+  end
+
+  def self.log(msg = nil, &block)
+    # msg ||= yield if block_given?
+    @@logger.log(msg, &block)
+  end
+
+
+  def self.tweak_history(method, nearby)
+    begin
+      @@irb ||= Kernel.const_get('IRB') && Kernel.const_get('Readline') && Readline.const_defined?('HISTORY')
+    rescue NameError
+      @@irb = false
+    end
+    return unless @@irb
+
+    line = Readline::HISTORY[-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
+  end
+end
+

data/spec/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'spec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'maybeyoumeant'
+include MaybeYouMeant
+
+require 'foo'
+

data/spec/lib/foo.rb

@@ -0,0 +1,4 @@
+class Foo
+  def foo
+  end
+end

data/spec/maybeyoumeant/levenshtein_spec.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+describe Levenshtein do
+  it "calculates a zero distance between empty strings" do
+    Levenshtein.distance('', '').should == 0
+  end
+
+  it "calculates a one distance between two characters" do
+    Levenshtein.distance('a', 'b').should == 1
+  end
+
+  it "calculates a correct distance between two strings" do
+    Levenshtein.distance('kitten', 'sitting').should == 3
+  end
+end
+

data/spec/maybeyoumeant/matrix_spec.rb

@@ -0,0 +1,14 @@
+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
+

data/spec/maybeyoumeant/object_extensions_spec.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+describe ObjectExtentions do
+  it 'finds a nearby method' do
+    Foo.new.nearby_method(:boo).should == 'foo'
+  end
+
+  it 'has a threshold of 2' do
+    Foo.new.nearby_method(:foobr).should == 'foo'
+  end
+
+  it 'returns nil if there are no nearby methods' do
+    Foo.new.nearby_method(:foobar).should be_nil
+  end
+
+  it 'calls a similar method if there is one' do
+    f = Foo.new
+    f.should_receive(:foo)
+    f.boo
+  end
+
+  it 'raises NoMethodError if there are no similar methods' do
+    f = Foo.new
+    lambda { f.foobar }.should raise_error NoMethodError
+  end
+end
+

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: maybeyoumeant
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Liehann Loots
+autorequire: 
+bindir: bin
+cert_chain: []
+
+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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  requirement: *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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- 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
+- 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
+licenses: 
+- MIT
+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.3.7
+signing_key: 
+specification_version: 3
+summary: IRB plugin that suggests corrections for misspelled method names.
+test_files: []
+