typo_safe 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # TypoSafe
 
-Protect your Ruby code from typos!
+Protect your Ruby code from typos! You've heard of Type Safe languages, well now Ruby can be Typo Safe! Typo Safe code will revolutionise programming.
 
 ## Installation
 
@@ -18,12 +18,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+I'm pretty sure you don't ever want to use this gem, not even in development.
+
+# Typo Safe a single class written by a fat-fingered developer:
+
+```ruby
+require 'typo_safe'
+
+class SomeClass
+	include TypoSafe
+
+	def print_hell0
+		puts "hello from the print_hello method!"
+	end
+
+	def print_goodbye
+		puts "goodbye from the print_goodbye method!"
+	end
+end
+
+SomeClass.new.print_hello
+SomeClass.new.pring_goodbye
+```
+
+## Why?!
+
+A discussion in Campfire:
+
+![Alt text](http://i.imgur.com/oHTdT.png)
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Write, then test your changes (`rake test`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+## TODO
+
+* Make the gem respect public/private methods (at the moment you can call a private method by using a typo)
+* Benchmark Levenshtein calculations and possibly cache
+* At the moment when there is a conflict (two methods have the same Levenshtein distance) the first is picked, maybe favour locally defined methods over inherited methods
+* Make including TypoSafe on Object work (for global protection!)

data/lib/typo_safe.rb

@@ -0,0 +1,32 @@
+require "typo_safe/version"
+require 'text'
+
+module TypoSafe
+	@@maximum_levenshtein_distance_for_match = 4
+
+	def method_missing(requested_method, *args, &block)
+		distances = []
+		methods.select{ |m|
+			a = method(m).arity
+			(a >= 0 && a == args.size) || (a < 0 && (0 - a - 1) <= args.size)
+		}.each { |meth|
+			distance = Text::Levenshtein.distance(requested_method.to_s, meth.to_s)
+			distances << {meth: meth, dist: Text::Levenshtein.distance(requested_method.to_s, meth.to_s)} if distance <= @@maximum_levenshtein_distance_for_match
+		}
+
+		if distances.size == 0
+			super
+		else
+			closest_match = distances.sort_by{|dist| dist[:dist]}.first
+			if block_given?
+				send(closest_match[:meth], *args, &block)
+			else
+				send(closest_match[:meth], *args)
+			end
+		end
+	end
+
+	def self.maximum_levenshtein_distance_for_match=(val)
+		@@maximum_levenshtein_distance_for_match = val
+	end
+end

data/lib/typo_safe/version.rb

@@ -1,3 +1,3 @@
 module TypoSafe
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_typo_safe.rb

@@ -0,0 +1,54 @@
+require 'minitest/autorun'
+$:.unshift File.join(File.dirname(__FILE__), '..')
+require 'typo_safe'
+
+class TestTypoSafe < MiniTest::Unit::TestCase
+	def setup
+		@foo = Class.new do
+			include TypoSafe
+			def tset; true; end
+			def xxxxxxxxxx; true; end
+			def aaaaaaaaaa(an_obj, str); yield(an_obj, str); end
+			def bbbbbbbbbb(an_obj, str); an_obj.ping(str); end
+			def cccccccccc; end
+			def ccccccccbb(an_arg); end
+
+			# Methods for test_ignores_methods_that_are_not_arg_or_block_campatible
+			def arity_test_aaaaaaa(arg, other_arg); "aaaaaaa"; end
+			def arity_test_aaaaaab(arg); "aaaaaab"; end
+		end.new
+	end
+
+	def test_typo_method_dispatch
+		assert @foo.test
+	end
+
+	def test_passes_args_and_no_block
+		tbc = MiniTest::Mock.new
+		tbc.expect :ping, true, ["foo"]
+		@foo.bbbbbbbbba(tbc, "foo")
+		assert tbc.verify
+	end
+
+	def test_passes_args_and_block
+		tbc = MiniTest::Mock.new
+		tbc.expect :ping, true, ["foo"]
+		@foo.aaaaaaaaab(tbc, "foo") {|obj, arg| obj.ping(arg)}
+		assert tbc.verify
+	end
+
+	def test_requires_minimum_similarity
+		error = assert_raises(NoMethodError) {@foo.kdygfnkudfjh}
+		assert error.message.match /undefined method `kdygfnkudfjh' for #<#<Class/
+	end
+
+	def test_setting_minimum_similarity
+		TypoSafe::maximum_levenshtein_distance_for_match = 2
+		assert_raises(NoMethodError) {@foo.xxxxxxxyyy}
+	end
+
+	def test_ignores_methods_that_are_not_arg_or_block_campatible
+		assert_equal @foo.arity_test_aaaaaax(1, 2), "aaaaaaa"
+		assert_equal @foo.arity_test_aaaaaax(1), "aaaaaab"
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typo_safe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: text
@@ -39,7 +39,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/typo_safe.rb
 - lib/typo_safe/version.rb
+- test/test_typo_safe.rb
 - typo_safe.gemspec
 homepage: ''
 licenses: []
@@ -65,4 +67,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: You probably don't really want to use this in production. Or ever.
-test_files: []
+test_files:
+- test/test_typo_safe.rb