ispell 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.0 / 2008-11-13
+
+* Birthday!

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ispell.rb
+test/test_ispell.rb

data/README.txt

@@ -0,0 +1,85 @@
+= ispell
+
+* http://rubzilla.rubyforge.org/ispell
+
+== DESCRIPTION:
+
+This is a ruby interface to the once popular Ispell package.
+Please keep in mind, that every instance forks an ispell process.
+It was since then mostly superseeded by Aspell, but still remains quite
+useful. Especially it has a good support for Russian using ru-ispell
+dictionaries.
+
+Ispell is a fast screen-oriented spelling checker that shows you your
+errors in the context of the original file, and suggests possible
+corrections when it can figure them out.  Compared to UNIX spell, it
+is faster and much easier to use.  Ispell can also handle languages
+other than English.
+
+== FEATURES/PROBLEMS:
+
+This library was modelled after the Perl ispell module.
+However, no support for adding words or modifying the dictionary in any
+way is provided at that stage.
+
+
+== SYNOPSIS:
+
+  require 'ispell'
+
+  speller = Ispell.new('/usr/bin/ispell', 'english')
+
+  speller.suggest('mantisa') # => 'mantissa'
+  speller.suggest('cake')    # => 'cake'
+
+  results = speller.spellcheck('hello wonderfull wordl nice 42 trouting')
+  puts "Misspelled words: #{results.collect {|w| w.original}.join(',')}"
+  results.each do |res|
+    case res.type
+    when :miss, :guess
+      puts "#{res.original} => #{res.guesses.join(',')}"
+    when :none
+      puts "#{res.original} wasn't found"
+    else
+      puts "#{res.type.to_s} type of result"
+    end
+  end
+
+  speller.destroy!
+
+== REQUIREMENTS:
+
+* ispell binary
+
+You can get it from http://fmg-www.cs.ucla.edu/geoff/ispell.html
+For Russian dictionaries visit
+http://scon155.phys.msu.su/~swan/orthography.html
+
+== INSTALL:
+
+* sudo gem install ispell
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Roman Shterenzon
+
+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/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ispell.rb'
+
+Hoe.new('ispell', Ispell::VERSION) do |p|
+  p.developer('Roman Shterenzon', 'romanbsd@yahoo.com')
+  p.rubyforge_name = 'rubzilla'
+  p.remote_rdoc_dir = 'ispell'
+  p.name = 'ispell'
+end
+
+# vim: syntax=Ruby

data/lib/ispell.rb

@@ -0,0 +1,127 @@
+class Ispell
+  VERSION = '0.1.0'
+
+  class Result
+    TYPES = { '*' => :ok, '+' => :root, '&' => :miss,
+      '?' => :guess, '-' => :compound, '#' => :none }
+    attr_accessor :type, :root, :original, :offset, :count, :guesses
+
+    # Freezes all instance variables
+    def freeze!
+      instance_variables.each {|v| eval("#{v}.freeze")}
+      self
+    end
+  end
+
+  # Create new speller instance, optionally can specify the ispell binary
+  # and the desired language.
+  def initialize(ispell='/usr/bin/ispell', lang='english')
+    @ispell_bin, @lang = ispell, lang
+    @options = ['-a','-S',"-d #{lang}"]
+    @ispell = nil
+    start!
+  end
+
+  # Consider run-together words as legal compounds.
+  def allow_compounds!(bool = true)
+    if bool
+      @options.delete('-B')
+      @options.unshift('-C')
+    else
+      @options.delete('-C')
+      @options.unshift('-B')
+    end
+    restart!
+  end
+
+  # Make  possible root/affix combinations that aren't in the dictionary.
+  def make_wild_guesses!(bool = true)
+    if bool
+      @options.delete('-P')
+      @options.unshift('-m')
+    else
+      @options.delete('-m')
+      @options.unshift('-P')
+    end
+    restart!
+  end
+
+  # Spell check the provided line, returns an +Array+ of +Ispell::Result+
+  def spellcheck(line)
+    line.gsub!(/\r/,'')
+    line.gsub!(/\s+/, ' ')
+    results = to_ispell(line)
+    results.collect do |line|
+      tokens = line.split(/,?:?\s+/)
+      res = Result.new
+      res.type = Result::TYPES[tokens.shift]
+      case res.type
+      when :root
+        res.root = tokens.shift
+      when :none
+        res.original = tokens.shift
+        res.offset = tokens.shift
+      when :miss, :guess
+        res.original = tokens.shift
+        res.count = tokens.shift
+        res.offset = tokens.shift
+        res.guesses = tokens
+      end
+      res.freeze!
+    end
+  end
+  alias :check :spellcheck
+
+  # Suggest a replacement for a given word, or the word itself if it's ok.
+  # Picks the first word from the suggestions list.
+  # If the word wasn't found, for leave_erroneous=true the original word 
+  # is returned, for leave_erroneous=false an empty string is returned.
+  def suggest(word, leave_erroneous=false)
+    res = spellcheck(word).at(0)
+    return word unless res
+    case res.type
+    when :ok
+      return word
+    when :miss, :guess
+      return res.guesses.at(0)
+    when :none
+      return leave_erroneous ? word : ''
+    else
+      return ''
+    end
+  end
+
+  # Stop the ispell
+  def destroy!
+    @ispell.close
+    @ispell = nil
+  end
+
+  # Start the ispell
+  def start!
+    return if @ispell
+    @ispell = IO.popen("#{@ispell_bin} #{@options.join(' ')}", 'r+')
+    # Swallow the greeting line
+    @ispell.gets
+    # Turn on the terse mode
+    @ispell.puts('!')
+  end
+
+  # Restart the ispell
+  def restart!
+    destroy!
+    start!
+  end
+
+  private
+  # Send a line to ispell and return the result as array
+  def to_ispell(line)
+    raise "Ispell not running" unless @ispell
+    @ispell.puts(line)
+    lines = []
+    while ! (line = @ispell.gets).eql?("\n")
+      lines.push(line)
+    end
+    lines
+  end
+end

data/test/test_ispell.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'test/unit'
+require 'ispell'
+
+class TestIspell < Test::Unit::TestCase
+  def setup
+    @speller = Ispell.new
+    @domain = {
+      'cake' => 'cake',
+      'caskade' => 'cascade',
+      'mantisa' => 'mantissa',
+      'phisical' => 'physical'
+    }
+
+  end
+
+  def test_suggest
+    @domain.each do |pair|
+      assert_equal(pair[1], @speller.suggest(pair[0]))
+    end
+  end
+
+  def test_spellcheck
+    assert_equal(:miss, @speller.check('mantisa').at(0).type)
+    assert_nil(@speller.check('cake').at(0))
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: ispell
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Roman Shterenzon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: This is a ruby interface to the once popular Ispell package. Please keep in mind, that every instance forks an ispell process. It was since then mostly superseeded by Aspell, but still remains quite useful. Especially it has a good support for Russian using ru-ispell dictionaries.  Ispell is a fast screen-oriented spelling checker that shows you your errors in the context of the original file, and suggests possible corrections when it can figure them out.  Compared to UNIX spell, it is faster and much easier to use.  Ispell can also handle languages other than English.
+email: 
+- romanbsd@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/ispell.rb
+- test/test_ispell.rb
+has_rdoc: true
+homepage: http://rubzilla.rubyforge.org/ispell
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rubzilla
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This is a ruby interface to the once popular Ispell package
+test_files: 
+- test/test_ispell.rb