did-you-mean 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Leonardo Bessa
+
+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,39 @@
+= did-you-mean
+
+Did-you-mean compares the misspelled method name with all other method names and suggests the one with closest textual match.
+
+== Installation
+
+  sudo gem install did-you-mean
+
+== Basic Usage
+
+# First include the module in the Object class
+  require 'did-you-mean'
+  class Object
+      include DidYouMean
+  end
+
+# Search method names by textual proximity
+  "FOO".methods.search('down_case')[0..5]
+  ["downcase", "downcase!", "swapcase", "upcase", "concat", "swapcase!"]
+
+# Avoiding NoMethodError on method_missing
+  %w(a o u i e).sot
+  Did you mean Array.sort (yes/no)?
+  yes
+  ["a", "e", "i", "o", "u"]
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Leonardo Bessa. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "did-you-mean"
+    gem.summary = %Q{Runtime corrector for misspelled method calls}
+    gem.description = %Q{Did-you-mean compares the misspelled method name with all other method names and suggests the one with closest textual match.}
+    gem.email = "leobessa@gmail.com"
+    gem.homepage = "http://github.com/leobessa/did-you-mean"
+    gem.authors = ["Leonardo Bessa"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency('levenshtein', '>= 0.2.0')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "did-you-mean #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/did-you-mean.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{did-you-mean}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Leonardo Bessa"]
+  s.date = %q{2010-04-12}
+  s.description = %q{Did-you-mean compares the misspelled method name with all other method names and suggests the one with closest textual match.}
+  s.email = %q{leobessa@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "did-you-mean.gemspec",
+     "lib/did-you-mean.rb",
+     "spec/did-you-mean_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/leobessa/did-you-mean}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Runtime corrector for misspelled method calls}
+  s.test_files = [
+    "spec/did-you-mean_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<levenshtein>, [">= 0.2.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<levenshtein>, [">= 0.2.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<levenshtein>, [">= 0.2.0"])
+  end
+end
+

data/lib/did-you-mean.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'levenshtein'
+
+module DidYouMean
+  def self.included(base)
+    base.class_eval do
+      def methods_with_a_search
+        methods_array = methods_with_no_search
+        class << methods_array
+          def search(query)
+            self.sort_by {|name| Levenshtein.normalized_distance(name.to_s, query.to_s) }
+          end
+        end
+        methods_array
+      end
+      alias_method :methods_with_no_search, :methods
+      alias_method :methods, :methods_with_a_search
+
+      unless method_defined? :method_missing
+        def method_missing(meth, *args, &block); super; end
+      end
+      alias_method :method_missing_without_method_search, :method_missing
+      alias_method :method_missing, :method_missing_with_method_search
+
+    end
+
+  end
+  def method_missing_with_method_search(name,*args,&block)
+    unless (self.respond_to? name)
+      best_match = self.methods.search(name).first
+      $stdout.print "Did you mean #{self.class}.#{best_match} (yes/no)?\n"
+      response = $stdin.gets
+      return self.send(best_match,*args,&block) if /yes/ =~ response
+    end
+    method_missing_without_method_search name,*args,&block
+  end
+end 

data/spec/did-you-mean_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DidYouMean" do
+
+  context "methods search" do
+    subject do
+      Class.new{include(DidYouMean)}.new
+    end
+
+    it "should search methods by textual proximity" do
+      def subject.foo; end
+      subject.methods.search(:fo).first.should == "foo"
+    end
+
+    it "should put javascript_driver method in first place when searching by default_javascript_driver" do
+      def subject.javascript_driver; end
+      subject.methods.search(:default_javascript_driver).first.should == "javascript_driver"
+    end
+
+  end
+
+  context "method missing" do
+    subject do
+      Class.new{include(DidYouMean)}.new
+    end
+
+    it "should suggest methods by textual proximity and call it if develepor types yes" do
+      def subject.foo; end
+      $stdout.should_receive(:print).with("Did you mean #{subject.class}.foo (yes/no)?\n")
+      $stdin.should_receive(:gets).and_return('yes')
+      subject.should_receive(:foo)
+      subject.fo
+    end
+    
+    it "should suggest methods by textual proximity and dont call it if develepor types no" do
+      def subject.foo; end
+      $stdout.should_receive(:print).with("Did you mean #{subject.class}.foo (yes/no)?\n")
+      $stdin.should_receive(:gets).and_return('no')
+      subject.should_not_receive(:foo)
+      lambda {subject.fo}.should raise_error(NoMethodError)      
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'did-you-mean'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: did-you-mean
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Leonardo Bessa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-12 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: levenshtein
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
+description: Did-you-mean compares the misspelled method name with all other method names and suggests the one with closest textual match.
+email: leobessa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- did-you-mean.gemspec
+- lib/did-you-mean.rb
+- spec/did-you-mean_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/leobessa/did-you-mean
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Runtime corrector for misspelled method calls
+test_files: 
+- spec/did-you-mean_spec.rb
+- spec/spec_helper.rb