rake-typo 0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+(MIT License)
+
+Copyright (c) 2013 Adam Prescott <https://aprescott.com/>
+
+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.md

@@ -0,0 +1,43 @@
+# No more task typos
+
+Tired of seeing this and not knowing the exact command name?
+
+```
+$ rake ffoo
+
+rake aborted!
+Don't know how to build task 'ffoo'
+(See full trace by running task with --trace)
+```
+
+Add this to your rakefile:
+
+```ruby
+require "rake/typo"
+```
+
+Now you can get suggestions for similar task names:
+
+```
+$ rake ffoo
+
+Don't know how to build task 'food:bar'
+
+Did you mean one of these?
+
+	foo:bar
+	food:bad
+```
+
+# License and contributing
+
+Released under the MIT license. See LICENSE for details.
+
+Any contributions will be assumed by default to be under the same terms.
+
+The quickest way to get changes contributed:
+
+1. Visit the [GitHub repository for rake-typo](https://github.com/aprescott/rake-typo).
+2. [Fork the repository](https://help.github.com/articles/fork-a-repo).
+3. Check out a branch on the latest master for your change: `git checkout -b master new-feature` --- do not make changes on `master`! Make sure that anything added or changed has a test in the `test/` directory. Use the existing files as examples. All tests for new/changed behaviour should pass.
+4. [Send a pull request on GitHub](https://help.github.com/articles/fork-a-repo), including a description of what you've changed. (Note: your contribution will be assumed to be under the same terms of the project by default.)

data/lib/rake/typo.rb

@@ -0,0 +1,61 @@
+require "rake"
+require "rubyfish"
+
+module Rake
+module Typo
+  # Finds the Rake::Task instances in +tasks+ that are most
+  # similar to +task_name+ and returns a list of them, ordered
+  # by name.
+  def self.candidate_tasks(task_name, tasks)
+    best_similarity = nil
+
+    distances = tasks.map do |t|
+      similarity = RubyFish::DamerauLevenshtein.distance(task_name, t.to_s)
+
+      # start off with the first distance count we find to be the best
+      best_similarity ||= similarity
+
+      # seek the lowest we can
+      best_similarity = similarity if similarity < best_similarity
+
+      [similarity, t]
+    end
+
+    distances.select! { |sim, name| sim == best_similarity }
+    distances.sort_by! { |sim, task| task.name }
+    distances.map { |sim, task| task }
+  end
+end
+end
+
+module Rake::TaskManager
+  alias_method :orig_access, :[]
+
+  # Wrap the `TaskManager#[]` method to capture
+  # calls to `#fail` to append possibly misspelled
+  # commands.
+  def [](*args)
+    task_name = args.first
+    begin
+      orig_access(*args)
+    rescue => e
+      msg = "#{e}"
+
+      candidates = Rake::Typo.candidate_tasks(task_name, Rake.application.tasks)
+
+      unless candidates.empty?
+        msg += "\n\n"
+        msg += "Did you mean #{candidates.size == 1 ? "this" : "one of these"}?\n\n"
+
+        candidates.each do |c|
+          msg += "\t#{c.name}\n"
+        end
+      end
+
+      # abort, not fail as in the original, just
+      # to have a friendlier message without a
+      # stacktrace.
+      abort msg
+    end
+  end
+end

data/lib/rake_typo.rb

@@ -0,0 +1 @@
+require "rake/typo"

data/rake-typo.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name         = "rake-typo"
+  s.version      = "0.1"
+  s.authors      = ["Adam Prescott"]
+  s.email        = ["adam@aprescott.com"]
+  s.homepage     = "https://github.com/aprescott/rake-typo"
+  s.summary      = "Get task suggestions when you mistype Rake tasks."
+  s.description  = "Provides a list of possible tasks you might have meant when Rake can't find a task you're trying to run."
+  s.files        = Dir["{lib/**/*,test/**/*}"] + %w[rake-typo.gemspec rakefile LICENSE Gemfile README.md]
+  s.require_path = "lib"
+  s.test_files   = Dir["test/*"]
+
+  s.add_runtime_dependency("rake", ">= 0.8.7", "< 11.0.0")
+  s.add_runtime_dependency("rubyfish", "~> 0.0.5")
+
+  s.add_development_dependency("rspec", "~> 2.5")
+end

data/rakefile

@@ -0,0 +1,11 @@
+require "rake"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.rspec_opts = "-I test --color --format nested"
+  t.pattern = "test/**/*_spec.rb"
+  t.verbose = false
+  t.fail_on_error = true
+end
+
+task :default => :test

data/test/test_helper.rb

@@ -0,0 +1 @@
+require "rake/typo"

data/test/typo_spec.rb

@@ -0,0 +1,27 @@
+require "test_helper.rb"
+
+describe Rake::Typo do
+  subject { Rake::Typo }
+
+  def candidates(task_name, names)
+    names.map! do |n|
+      d = double("")
+      d.stub(:name) { n }
+      d
+    end
+
+    subject.candidate_tasks(task_name, names)
+  end
+
+  describe ".candidate_tasks" do
+    it "meets a few basic requirements" do
+      c = candidates("food", %w[foo])
+      c.size.should == 1
+      c.first.name.should == "foo"
+
+      c = candidates("food", %w[foo fodo])
+      c.size.should == 2
+      c.map { |d| d.name }.sort.should == %w[foo fodo].sort
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rake-typo
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Adam Prescott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - <
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - <
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: rubyfish
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Provides a list of possible tasks you might have meant when Rake can't
+  find a task you're trying to run.
+email:
+- adam@aprescott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rake_typo.rb
+- lib/rake/typo.rb
+- test/test_helper.rb
+- test/typo_spec.rb
+- rake-typo.gemspec
+- rakefile
+- LICENSE
+- Gemfile
+- README.md
+homepage: https://github.com/aprescott/rake-typo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Get task suggestions when you mistype Rake tasks.
+test_files:
+- test/test_helper.rb
+- test/typo_spec.rb