fuzzy-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11666c5fe11d863034d4f1ad664411266ea89237
+  data.tar.gz: 82c71856bc61b0c711d6809874f4acdfadfbd1c8
+SHA512:
+  metadata.gz: d3e3f31a517595367d32dd456a50b72ed889aa082850872ccb993ee537a4d200635113142473391b951237638575f5e251e3c044716ec8f11fb98a97d9168a41
+  data.tar.gz: cf0cba0c205be51c54cab8a2a4ce96e607f7206c4cc70945c1183a2acd900a9d4edb691ad92a3af493f45c89a3b1c58c0179ca813a4b40fb1c2ef78c1bacac4d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fuzzy-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ben Weissmann
+
+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,112 @@
+
+Fuzzy Ruby
+==========
+
+[![Build Status](https://travis-ci.org/benweissmann/fuzzy-ruby.svg)](https://travis-ci.org/benweissmann/fuzzy-ruby)
+
+One of the most difficult parts of programming is spelling everything correctly.
+Particularly in a dynamic-typed language like Ruby, a single typo can cause
+a critical runtime failure.
+
+Traditional solutions to this problem include complex static analysis,
+burdonsome code reviews, and onerous unit testing.
+
+Fuzzy Ruby is a much easier solution to this problem: it modifies the Ruby
+runtime environment so misspellings will automatically be corrected.
+
+
+Example
+=======
+
+Without `fuzzy-ruby`:
+
+```ruby
+irb(main):001:0> "Hello".revers
+NoMethodError: undefined method `revers' for "Hello":String
+irb(main):002:0> my_variable = 123
+=> 123
+irb(main):003:0> my_vraiable
+NameError: undefined local variable or method `my_vraiable' for main:Object
+```
+
+With `fuzzy-ruby`:
+
+
+```ruby
+rirb(main):001:0> require 'fuzzy-ruby'
+=> true
+irb(main):002:0> "Hello".revers
+=> "olleH"
+irb(main):003:0> my_variable = 123
+=> 123
+irb(main):004:0> my_vraiable
+=> 123
+```
+
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fuzzy-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzy-ruby
+
+
+Advanced Usage
+==============
+
+A simple `require 'fuzzy-ruby'` will load Fuzzy Ruby and set it up to
+automatically correct misspellings. However, if you'd like more fine-grained
+control, you can use `require 'fuzzy-ruby/api'`, which just gives you access
+to the `FuzzyRuby` api without modifying your runtime environment.
+
+#### `FuzzyRuby.install`
+
+Without a block, sets up Fuzzy Ruby to autocorrect misspellings until
+`FuzzyRuby.uninstall` is called. With a block, runs the block with Fuzzy Ruby
+installed, and then automatically uninstalls it when the block completes or
+raises an error. The return value or error from the block is propagated up.
+
+#### `FuzzyRuby.uninstall`
+
+Undoes a `FuzzyRuby.install`.
+
+#### `FuzzyRuby.mode = :autocorrect | :autocorrect_with_warning | :warn_only`
+
+Sets the mode of Fuzzy Ruby. By default, Fuzzy Ruby uses `:autocorrect`, which
+automatically corrects typos without warning. Other modes are
+`:autocorrect_with_warning`, which autocorrect but prints a warning to stderr,
+and `:warn_only`, which just prints the warning, but does not correct.
+
+
+License
+=======
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+How Does It Work?
+=================
+
+Fuzzy Ruby overrides `method_missing` on `Object`. This allows us to intercept
+methods calls to any object, as well as local variable access. We then grab the
+list of methods on the object, as well as the list of local variables
+(using the `binding_of_caller` gem) and select the best match using the
+Jaro-Winkler text distance algorithm (from the `amatch` gem). We then use
+`eval` or `send` to run the method or access the local variable.
+
+
+Notes
+=====
+
+Don't actually use this. Please.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*.rb']
+end
+
+task :default => :test

data/fuzzy-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzy-ruby"
+  spec.version       = FuzzyRuby::VERSION
+  spec.authors       = ["Ben Weissmann"]
+  spec.email         = ["ben@benweissmann.com"]
+
+  spec.summary       = %q{Auto-correct your Ruby code using fuzzy matching.}
+  spec.homepage      = "https://github.com/benweissmann/fuzzy-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "amatch", "~> 0.3.0"
+  spec.add_runtime_dependency "binding_of_caller", "~> 0.7.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/fuzzy-ruby.rb

@@ -0,0 +1,3 @@
+require "fuzzy-ruby/api"
+
+FuzzyRuby.install

data/lib/fuzzy-ruby/api.rb

@@ -0,0 +1,96 @@
+require 'amatch'
+require 'binding_of_caller'
+require 'fuzzy-ruby/version'
+
+module FuzzyRuby
+  class << self
+    VALID_MODES = [:autocorrect, :autocorrect_with_warning, :warn_only]
+    @mode = :autocorrect
+    @enabled = false
+
+    def mode= new_mode
+      unless VALID_MODES.include? new_mode
+        raise ArgumentError.new "Invalid mode: #{new_mode}"
+      end
+
+      @mode = new_mode
+    end
+
+    def install
+      # Enable automatic autocorrection
+      @enabled = true
+
+      if block_given?
+        begin
+          return yield
+        ensure
+          uninstall
+        end
+      end
+    end
+
+    def uninstall
+      @enabled = false
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    attr_reader :mode
+
+    private
+
+    # Automatically corrects a method call or local variable access.
+    #
+    # May actually call the corrected version / return the value of the
+    # corrected variable name, or may just print a parming, or both, based
+    # on the value of @mode
+    #
+    # binding: The binding in which the method call or variable access occurred
+    # receiver: The object whose methods are being called
+    # name: Name of the method or variable, as a symbol
+    # args: Array of arguments passed to the method
+    # block: Block passed to the method
+    def autocorrect binding, receiver, name, args, block
+      # assemble possible methods or variables we could correct to
+      methods = receiver.methods.map(&:to_s)
+      vars = binding.eval("local_variables").map(&:to_s)
+
+      # match the mostly likely one
+      matcher = Amatch::JaroWinkler.new(name.to_s)
+      best = (vars + methods).sort_by{|m| matcher.match(m)}.last
+
+      # print a warning depending on mode
+      case @mode
+      when :autocorrect_with_warning
+        STDERR.puts "WARNING: Autocorrecting #{name} to #{best}"
+      when :warn_only
+        STDERR.puts "WARNING: by #{name}, you probably meant #{best}"
+      end
+
+      # execute the corrected version
+      if @mode != :warn_only
+        if methods.include? best
+          return receiver.send(best.to_sym, *args, &block)
+        else
+          return binding.eval(best)
+        end
+      end
+    end
+  end
+end
+
+
+# hook into method_missing on Object
+class Object
+  alias_method :__fuzzyruby_method_missing_old__, :method_missing
+  def method_missing name, *args, &block
+    if FuzzyRuby.enabled?
+      FuzzyRuby.send :autocorrect, binding.of_caller(1), self, name, args, block
+    else
+      __fuzzyruby_method_missing_old__ name, *args, &block
+    end
+  end
+end
+

data/lib/fuzzy-ruby/version.rb

@@ -0,0 +1,3 @@
+module FuzzyRuby
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Weissmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben@benweissmann.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fuzzy-ruby.gemspec
+- lib/fuzzy-ruby.rb
+- lib/fuzzy-ruby/api.rb
+- lib/fuzzy-ruby/version.rb
+homepage: https://github.com/benweissmann/fuzzy-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Auto-correct your Ruby code using fuzzy matching.
+test_files: []