guessmethod 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-07-18
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Chris Shea
+
+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/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/guessmethod.rb
+lib/guessmethod/version.rb
+lib/string/levenshtein.rb
+scripts/txt2html
+setup.rb
+spec/guessmethod_spec.rb
+spec/spec_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,26 @@
+README for guessmethod
+======================
+
+= Usage
+
+<tt>require 'guessmethod'</tt>
+
+<tt>class String; include GuessMethod; end</tt>
+
+Now, you can accidentally call <tt>'1'.toi</tt> and Guess Method will step in and call
+<tt>'1'.to_i</tt> like you meant to.
+
+== Options
+
+<tt>GuessMethod::Options</tt> is a hash with configuration values.  The keys :insert_weight,
+:delete_weight, and :substitution_weight change the behavior of the levenshtein calculation.
+:threshold determines how close a method name needs to be to be counted as a 'match'.  Values
+over 2 can give you unpredictable results, especially for short method names. 
+
+= Warning
+
+This is *not* intended for production.
+
+= Contact
+
+Chris Shea: chris at tie-rack . org

data/Rakefile

@@ -0,0 +1,138 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'guessmethod', 'version')
+
+AUTHOR = 'Chris Shea'  # can also be an array of Authors
+EMAIL = "chris@tie-rack.org"
+DESCRIPTION = "hijacks method_missing to act as a spellchecker"
+GEM_NAME = 'guessmethod' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'guessmethod' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "guessmethod"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = GuessMethod::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'guessmethod documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Default task is to run specs"
+task :default => :spec
+

data/lib/guessmethod/version.rb

@@ -0,0 +1,9 @@
+module GuessMethod #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/guessmethod.rb

@@ -0,0 +1,97 @@
+require 'string/levenshtein'
+require 'highline'
+
+# The GuessMethod module aliases out method_missing and
+# replaces it with its own, which attempts to find a
+# similarly named method callable on the object at hand.
+# If it finds one, it calls that instead, and prints
+# a message to stderr explaining as much.  If it doesn't
+# find a suitable method, the orignial method_missing
+# gets called.
+module GuessMethod
+  
+  Options = {
+    :insert_weight => 1,
+    :delete_weight => 1,
+    :substitution_weight => 1,
+    :threshold => 2
+  }
+  
+  def self.included(base)
+    base.class_eval do
+      unless method_defined? :method_missing
+        def method_missing(meth, *args, &block); super; end
+      end
+      alias_method :old_method_missing, :method_missing
+      alias_method :method_missing, :guess_method_missing
+    end
+  end
+  
+  def guess_method_missing(meth, *args, &block)
+    minimum_distance = self.methods.map {|m| m.levenshtein(meth.to_s,
+        Options[:insert_weight], Options[:delete_weight],
+        Options[:substitution_weight])}.min
+    if minimum_distance <= Options[:threshold]
+      closest_methods = self.methods.find_all {|m|  m.levenshtein(meth.to_s,
+          Options[:insert_weight], Options[:delete_weight],
+          Options[:substitution_weight]) == minimum_distance}
+      if closest_methods.size == 1
+        call_method = closest_methods.first
+        $stderr.puts Outputter.replacing_method(meth, call_method, self)
+        self.send(call_method, *args, &block)
+      else
+        $stderr.puts Outputter.ambiguous_method(meth, closest_methods, self)
+        old_method_missing(meth, *args, &block)
+      end
+    else
+      $stderr.puts Outputter.no_method_in_threshold(meth, self)
+      old_method_missing(meth, *args, &block)
+    end
+  end
+  
+  # GuessMethod::Outputter uses HighLine to format
+  # alert messages generated by the GuessMethod method_missing
+  class Outputter
+    
+    Formatter = HighLine.new
+    
+    def self.object(obj)  #:nodoc:
+      message = Formatter.color(obj.inspect, :green, :bold)
+      message << ':'
+      message << Formatter.color(obj.class, :green)
+    end
+    
+    def self.ambiguous_method(meth, possibilities, obj) #:nodoc:
+      message = Formatter.color('ambigious method:', :red)
+      message << ' '
+      message << Formatter.color(meth, :green)
+      message << ' possible matches '
+      message << possibilities.map {|m| Formatter.color(m, :cyan)}.join(', ')
+      message << ' for '
+      message << Outputter.object(obj)
+    end
+    
+    def self.no_method_in_threshold(meth, obj)  #:nodoc:
+      message = Formatter.color('no method in threshold:', :red)
+      message << ' for '
+      message << Formatter.color(meth, :green)
+      message << ', sending to '
+      message << Outputter.object(obj)
+      message << "'s method_missing"
+    end
+    
+    def self.replacing_method(meth, call_method, obj) #:nodoc:
+      message = Formatter.color('attention:', :red)
+      message << ' sending '
+      message << Formatter.color(call_method, :cyan)
+      message << ' instead of '
+      message << Formatter.color(meth, :cyan)
+      message << ' to '
+      message << Outputter.object(obj)
+    end
+    
+  end
+  
+end
+
+require 'guessmethod/version'

data/lib/string/levenshtein.rb

@@ -0,0 +1,39 @@
+class String
+  
+  # Calculates the levenshtein distance between strings.  This method was taken from
+  # The Ruby Way, 2nd Edition, Hal Fulton, pp. 97-98
+  def levenshtein(other, ins=2, del=2, sub=1)
+    
+    # ins, del, sub are weighted costs
+    return nil if self.nil?
+    return nil if other.nil?
+    dm = []        # distance matrix
+
+    # Initialize first row values
+    dm[0] = (0..self.length).collect { |i| i * ins }
+    fill = [0] * (self.length - 1)
+
+    # Initialize first column values
+    for i in 1..other.length
+      dm[i] = [i * del, fill.flatten]
+    end
+
+    # populate matrix
+    for i in 1..other.length
+      for j in 1..self.length
+    # critical comparison
+        dm[i][j] = [
+             dm[i-1][j-1] +
+               (self[j-1] == other[i-1] ? 0 : sub),
+                 dm[i][j-1] + ins,
+             dm[i-1][j] + del
+       ].min
+      end
+    end
+
+    # The last value in matrix is the
+    # Levenshtein distance between the strings
+    dm[other.length][self.length]
+  end
+
+end

data/scripts/txt2html

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/guessmethod/version.rb'
+
+version  = GuessMethod::VERSION::STRING
+download = 'http://rubyforge.org/projects/guessmethod'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</
>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)