spellingbee 0.0.2

data/lib/spellingbee.rb

@@ -0,0 +1,94 @@
+
+class SpellingBee
+  attr_accessor :dict_words, :dict_frequency
+  
+  DEFAULT_DICT = File.join(File.dirname(__FILE__), '..', 'dict', 'default.txt')
+  
+  def initialize(opts = {})
+    options = { :source_text => DEFAULT_DICT }.merge opts
+    @dict_frequency = Hash.new(1)
+    @dict_words = File.new(options[:source_text]).read.downcase.scan(/[a-z]+/)
+    @dict_words.each { |word| @dict_frequency[word] += 1 }
+  end
+    
+  # Returns all the combinations of the word with one character removed
+  # 
+  # Example:
+  #   deletions("word") #=> ["ord", "wrd", "wod", "wor"]
+  #
+  def deletions word
+    n = word.length
+    deletion = (0...n).collect {|i| word[0...i]+word[i+1..-1] }
+  end
+  
+  # Returns all combinations of the word with adjacent words transposed.
+  #
+  # Example:
+  #   transpositions("word") #=> ["owrd", "wrod", "wodr"]
+  #
+  def transpositions word
+    n = word.length
+    (0...n-1).collect {|i| word[0...i]+word[i+1,1]+word[i,1]+word[i+2..-1] }
+  end
+  
+  # Returns all variations of the word with each character replaced by all 
+  # characters from 'a' to 'z'.
+  #
+  # Example:
+  #   replacements("word") #=> ["aord", "bord", "cord", ... "ward", "wbrd" ...]
+  #
+  def replacements word
+    n = word.length
+    new_words = []
+    n.times {|i| ('a'..'z').each {|l| new_words << word[0...i]+l.chr+word[i+1..-1] } }
+    new_words
+  end
+  
+  # Returns all variations of the word with an alphabet inserted between the 
+  # characters.
+  #
+  # Example:
+  #   insertions("word") #=> ["aword", "bword", "cword" ... "waord", "wbord" ... ]
+  #
+  def insertions word
+    n = word.length
+    new_words = []
+    (n+1).times {|i| ('a'..'z').each {|l| new_words << word[0...i]+l.chr+word[i..-1] } }
+    new_words
+  end
+  
+  # Returns the variations of the given spelling. This set will contain all the 
+  # possible variations of the spelling havind edit distance = 1. (Edit 
+  # distance is the number of edits it takes to obtain the second word from 
+  # the first.)
+  def variation_words word
+    ( deletions(word) + transpositions(word) + replacements(word) + insertions(word) ).uniq
+  end
+  
+  # Selects the words from the list that are present in the dictionary.
+  #
+  # Example:
+  # 
+  #    known ["asdfgh", "known", "word", "qqqq"] #=> ["known", "word"] 
+  #
+  def known words
+    known_words = words.find_all { |w| @dict_frequency.has_key? w }
+    known_words.empty? ? nil : known_words
+  end
+  
+  # Returns the suggestion for the correction. If the word is found in the
+  # dictionary, it is returned, otherwise the word closest to it is returned.
+  # If there are no spelling suggestions, the same word is returned.
+  #
+  # Example:
+  #   
+  #   s = Spellingbee.new
+  #   s.correct "spelling"   #=> ["spelling"] -> word from dictionary
+  #   s.correct "speling"    #=> ["spelling"] -> corrected spelling
+  #   s.correct "qqqqqq"     #=> ["qqqqqq"]   -> no suggestions
+  #
+  def correct word
+    known [word] or known(variation_words word) or [word]
+  end
+  
+end

data/lib/spellingbee/version.rb

@@ -0,0 +1,3 @@
+class SpellingBee
+  VERSION = '0.0.2'
+end

data/spellingbee.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "spellingbee/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spellingbee"
+  s.version     = SpellingBee::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nithin Bekal"]
+  s.email       = ["nithinbekal@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/spellingbee"
+  s.summary     = %q{A spelling correction tool for ruby.}
+  s.description = %q{Suggests corrections for mis-spelled words.}
+
+  s.rubyforge_project = "spellingbee"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: spellingbee
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Nithin Bekal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-01 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: Suggests corrections for mis-spelled words.
+email: 
+- nithinbekal@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- dict/default.txt
+- doc/Gemfile.html
+- doc/LICENSE.html
+- doc/README.html
+- doc/Rakefile.html
+- doc/SpellingBee.html
+- doc/created.rid
+- doc/dict/default_txt.html
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/spellingbee/version_rb.html
+- doc/lib/spellingbee_rb.html
+- doc/rdoc.css
+- lib/spellingbee.rb
+- lib/spellingbee/version.rb
+- spellingbee.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/spellingbee
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: spellingbee
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A spelling correction tool for ruby.
+test_files: []
+