autocorrect 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,49 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ree-1.8.7-2011.03@autocorrect"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]] ; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  [[ -s ".rvm/hooks/after_use" ]] && . ".rvm/hooks/after_use"
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id"
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+#   # Ensure that Bundler is installed. Install it if it is not.
+#   if ! command -v bundle >/dev/null; then
+#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
+#      gem install bundler
+#   fi
+#
+#   # Bundle while reducing excess noise.
+#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
+#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
+#
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in autocorrect.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,19 @@
+# Autocorrect
+
+It looks like you mis-spelled that method name. Would you like some help?
+
+If you want some help in correcting your method name typos when developing a
+chunk of Ruby code, stick this gem in your project and do:
+
+    require 'autocorrect/whiny'
+
+If you are utterly, mind-bogglingly insane, you could always do:
+
+    require 'autocorrect/insane'
+
+and I'll attempt to correct your method name typos for you.
+
+## Disclaimer
+
+This is not a serious gem. I had a crazy idea while I was reading Eloquent Ruby
+and thought I'd try it out. ;-)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/autocorrect.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "autocorrect/version"
+
+Gem::Specification.new do |s|
+  s.name        = "autocorrect"
+  s.version     = Autocorrect::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Graeme Mathieson"]
+  s.email       = ["mathie@woss.name"]
+  s.homepage    = "http://github.com/mathie/autocorrect"
+  s.summary     = %q{If you can't spell, or type, your method names we're here to help.}
+  s.description = %q{A crazy gem that 'corrects' your misspelling of method names. Please don't actually use it, I was just testing an idea in my head!}
+
+  s.rubyforge_project = "autocorrect"
+
+  s.add_dependency 'text'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/autocorrect.rb

@@ -0,0 +1,3 @@
+module Autocorrect
+  # Your code goes here...
+end

data/lib/autocorrect/common.rb

@@ -0,0 +1,35 @@
+require 'text/levenshtein'
+
+module Autocorrect
+  module Common
+    private
+    def guess_callable_method_for(method, arity)
+      nearest_methods(method).find { |possible_method| [arity, -1].include? method(possible_method).arity }
+    end
+
+    def guess_closest_matched_name_method_for(method)
+      nearest_methods(method)[0]
+    end
+
+    def nearest_methods(method)
+      potential_methods = methods_grouped_by_distance(method)
+      nearest_distance = potential_methods.keys.sort[0]
+      potential_methods[nearest_distance]
+    end
+
+    def methods_grouped_by_distance(method)
+      methods.group_by { |potential_method| Text::Levenshtein.distance(potential_method.to_s, method.to_s) }
+    end
+
+    def print_method_with_args(method, args)
+      "#{method.to_s}(#{args.map { |arg| arg.inspect }.join(", ")})"
+    end
+
+    def raise_method_missing_with_mismatched_args_warning_for(guessed_method, called_method, args, block_present, with_caller = nil)
+      message = "You have called a method that doesn't exist.\n"
+      message << "You tried to call '#{print_method_with_args(called_method, args)}'.\n"
+      message << "We suspect you meant '#{guessed_method}' but you got the number of arguments wrong too (#{method(guessed_method).arity} expected, got #{args.length})."
+      raise NoMethodError, message, with_caller || caller
+    end
+  end
+end

data/lib/autocorrect/insane.rb

@@ -0,0 +1,31 @@
+require 'autocorrect/common'
+
+module Autocorrect
+  module Insane
+    include Autocorrect::Common
+
+    def method_missing(method, *args, &block)
+      # Cargo-culted from whiny_nil.rb
+      if method == :to_ary || method == :to_str
+        super
+      elsif guessed_method = guess_callable_method_for(method, args.length)
+        method_missing_warning_for guessed_method, method, args
+        send guessed_method, *args, &block
+      elsif guessed_method = guess_closest_matched_name_method_for(method)
+        raise_method_missing_with_mismatched_args_warning_for guessed_method, method, args, caller
+      else
+        super
+      end
+    end
+
+    private
+    def method_missing_warning_for(guessed_method, called_method, args)
+      message = "You have called a method that doesn't exist.\n"
+      message << "You tried to call '#{print_method_with_args(called_method, args)}'.\n"
+      message << "We suspect you meant '#{print_method_with_args(guessed_method, args)}' and so we're calling it on your behalf."
+      STDERR.puts message
+    end
+  end
+end
+
+Object.send :include, Autocorrect::Insane

data/lib/autocorrect/version.rb

@@ -0,0 +1,3 @@
+module Autocorrect
+  VERSION = "0.0.1"
+end

data/lib/autocorrect/whiny.rb

@@ -0,0 +1,30 @@
+require 'autocorrect/common'
+
+module Autocorrect
+  module Whiny
+    include Autocorrect::Common
+
+    def method_missing(method, *args, &block)
+      # Cargo-culted from whiny_nil.rb
+      if method == :to_ary || method == :to_str
+        super
+      elsif guessed_method = guess_callable_method_for(method, args.length)
+        raise_method_missing_warning_for guessed_method, method, args, caller
+      elsif guessed_method = guess_closest_matched_name_method_for(method)
+        raise_method_missing_with_mismatched_args_warning_for guessed_method, method, args, caller
+      else
+        super
+      end
+    end
+
+    private
+    def raise_method_missing_warning_for(guessed_method, called_method, args, with_caller = nil)
+      message = "You have called a method that doesn't exist.\n"
+      message << "You tried to call '#{print_method_with_args(called_method, args)}'.\n"
+      message << "We suspect you meant '#{print_method_with_args(guessed_method, args)}'.\n"
+      raise NoMethodError, message, with_caller || caller
+    end
+  end
+end
+
+Object.send :include, Autocorrect::Whiny

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: autocorrect
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Graeme Mathieson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: text
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A crazy gem that 'corrects' your misspelling of method names. Please don't actually use it, I was just testing an idea in my head!
+email: 
+- mathie@woss.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.markdown
+- Rakefile
+- autocorrect.gemspec
+- lib/autocorrect.rb
+- lib/autocorrect/common.rb
+- lib/autocorrect/insane.rb
+- lib/autocorrect/version.rb
+- lib/autocorrect/whiny.rb
+has_rdoc: true
+homepage: http://github.com/mathie/autocorrect
+licenses: []
+
+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: autocorrect
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: If you can't spell, or type, your method names we're here to help.
+test_files: []
+