ffi-hunspell 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'FFI Hunspell Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2010-10-05
+
+* Initial release.
+

data/LICENSE.txt

@@ -0,0 +1,23 @@
+
+The MIT License
+
+Copyright (c) 2010 Hal Brodigan
+
+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,55 @@
+# ffi-hunspell
+
+* [github.com/postmodern/ffi-hunspell](http://github.com/postmodern/ffi-hunspell)
+* [github.com/postmodern/ffi-hunspell/issues](http://github.com/postmodern/ffi-hunspell/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+Ruby FFI bindings for [Hunspell](http://hunspell.sourceforge.net/).
+
+## Examples
+
+Open a dictionary:
+
+    require 'ffi/hunspell'
+    
+    dict = FFI::Hunspell.dict('/usr/share/myspell/en_US')
+    # ...
+    dict.close
+
+    FFI::Hunspell.dict('/usr/share/myspell/en_US') do |dict|
+      # ...
+    end
+
+Check if a word is valid:
+
+    dict.check?('dog')
+    # => true
+
+    dict.check?('d0g')
+    # => false
+
+Find the stems of a word:
+
+    dict.stem('dogs')
+    # => ["dog"]
+
+Suggest alternate spellings for a word:
+
+    dict.suggest('arbitrage')
+    # => ["arbitrage", "arbitrages", "arbitrager", "arbitraged", "arbitrate"]
+
+## Requirements
+
+* [libhunspell](http://hunspell.sourceforge.net/) >= 1.2.0
+* [ffi](http://github.com/ffi/ffi) ~> 0.6.0
+
+## Install
+
+    $ sudo gem install ffi-hunspell
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.1.2'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.0.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/ffi-hunspell.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'ffi-hunspell.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
+end

data/gemspec.yml

@@ -0,0 +1,19 @@
+name: ffi-hunspell
+version: 0.1.0
+summary: FFI bindings for Hunspell
+description: Ruby FFI bindings for Hunspell spell checker.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/ffi-hunspell
+has_yard: true
+
+requirements: libhunspell >= 1.2.0
+
+dependencies:
+  ffi: ~> 0.6.0
+
+development_dependencies:
+  ore: ~> 0.2.0
+  ore-tasks: ~> 0.1.2
+  yard: ~> 0.6.0

data/lib/ffi/hunspell.rb

@@ -0,0 +1,2 @@
+require 'ffi/hunspell/hunspell'
+require 'ffi/hunspell/dictionary'

data/lib/ffi/hunspell/dictionary.rb

@@ -0,0 +1,186 @@
+require 'ffi/hunspell/hunspell'
+
+module FFI
+  module Hunspell
+    class Dictionary
+
+      #
+      # Creates a new dictionary.
+      #
+      # @param [String] affix_path
+      #   The path to the `.aff` file.
+      #
+      # @param [String] dict_path
+      #   The path to the `.dic` file.
+      #
+      # @param [String] key
+      #   The optional key for encrypted dictionary files.
+      #
+      def initialize(affix_path,dic_path,key=nil)
+        @ptr = if key
+                 Hunspell.Hunspell_create_key(affix_path,dic_path,key)
+               else
+                 Hunspell.Hunspell_create(affix_path,dic_path)
+               end
+      end
+
+      #
+      # Opens a Hunspell dictionary.
+      #
+      # @param [String] path
+      #   The path prefix shared by the `.aff` and `.dic` files.
+      #
+      # @yield [dict]
+      #   The given block will be passed the Hunspell dictionary.
+      #
+      # @yieldparam [Dictionary] dict
+      #   The opened dictionary.
+      #
+      # @return [Dictionary]
+      #   If no block is given, the open dictionary will be returned.
+      #
+      def self.open(path)
+        dict = self.new("#{path}.aff","#{path}.dic")
+
+        if block_given?
+          yield dict
+
+          dict.close
+          return nil
+        else
+          return dict
+        end
+      end
+
+      #
+      # Determines if the dictionary is closed.
+      #
+      # @return [Boolean]
+      #   Specifies whether the dictionary was closed.
+      #
+      def closed?
+        @ptr.nil?
+      end
+
+      #
+      # The encoding of the dictionary file.
+      #
+      # @return [String]
+      #   The encoding of the dictionary file.
+      #
+      def encoding
+        Hunspell.Hunspell_get_dic_encoding(self)
+      end
+
+      #
+      # Adds a word to the dictionary.
+      #
+      # @param [String] word
+      #   The word to add to the dictionary.
+      #
+      def add(word)
+        Hunspell.Hunspell_add(self,word.to_s)
+      end
+
+      def add_affix(word,example)
+        Hunspell.Hunspell_add_affix(self,word.to_s,example.to_s)
+      end
+
+      alias << add
+
+      #
+      # Removes a word from the dictionary.
+      #
+      # @param [String] word
+      #   The word to remove.
+      #
+      def remove(word)
+        Hunspell.Hunspell_remove(self,word.to_s)
+      end
+
+      alias delete remove
+
+      #
+      # Checks if the word is validate.
+      #
+      # @param [String] word
+      #   The word in question.
+      #
+      # @return [Boolean]
+      #   Specifies whether the word is valid.
+      #
+      def check?(word)
+        Hunspell.Hunspell_spell(self,word.to_s) != 0
+      end
+
+      alias valid? check?
+
+      #
+      # Finds the stems of a word.
+      #
+      # @param [String] word
+      #   The word in question.
+      #
+      # @return [Array<String>]
+      #   The stems of the word.
+      #
+      def stem(word)
+        stems = []
+
+        FFI::MemoryPointer.new(:pointer) do |output|
+          count = Hunspell.Hunspell_stem(self,output,word.to_s)
+          ptr = output.get_pointer(0)
+
+          stems = ptr.get_array_of_string(0,count)
+        end
+
+        return stems
+      end
+
+      #
+      # Suggests alternate spellings of a word.
+      #
+      # @param [String] word
+      #   The word in question.
+      #
+      # @return [Array<String>]
+      #   The suggestions for the word.
+      #
+      def suggest(word)
+        suggestions = []
+
+        FFI::MemoryPointer.new(:pointer) do |output|
+          count = Hunspell.Hunspell_suggest(self,output,word.to_s)
+          ptr = output.get_pointer(0)
+
+          suggestions = ptr.get_array_of_string(0,count)
+        end
+
+        return suggestions
+      end
+
+      #
+      # Closes the dictionary.
+      #
+      # @return [nil]
+      #
+      def close
+        Hunspell.Hunspell_destroy(self)
+
+        @ptr = nil
+        return nil
+      end
+
+      #
+      # Converts the dictionary to a pointer.
+      #
+      # @return [FFI::Pointer]
+      #   The pointer for the dictionary.
+      #
+      def to_ptr
+        @ptr
+      end
+
+    end
+  end
+end

data/lib/ffi/hunspell/hunspell.rb

@@ -0,0 +1,48 @@
+require 'ffi'
+
+module FFI
+  module Hunspell
+    extend FFI::Library
+
+    ffi_lib 'hunspell-1.2'
+
+    attach_function :Hunspell_create, [:string, :string], :pointer
+    attach_function :Hunspell_create_key, [:string, :string, :string], :pointer
+    attach_function :Hunspell_destroy, [:pointer], :void
+    attach_function :Hunspell_spell, [:pointer, :string], :int
+    attach_function :Hunspell_get_dic_encoding, [:pointer], :string
+    attach_function :Hunspell_suggest, [:pointer, :pointer, :string], :int
+    attach_function :Hunspell_analyze, [:pointer, :pointer, :string], :int
+    attach_function :Hunspell_stem, [:pointer, :pointer, :string], :int
+    attach_function :Hunspell_generate, [:pointer, :pointer, :string, :string], :int
+    attach_function :Hunspell_add, [:pointer, :string], :int
+    attach_function :Hunspell_add_with_affix, [:pointer, :string, :string], :int
+    attach_function :Hunspell_remove, [:pointer, :string], :int
+    attach_function :Hunspell_free_list, [:pointer, :pointer, :int], :void
+
+    #
+    # missing functions:
+    #
+    #   attach_function :Hunspell_stem2, [:pointer, :pointer, :pointer, :int], :int
+    #   attach_function :Hunspell_generate2, [:pointer, :pointer, :string, :pointer, :int], :int
+    #
+
+    #
+    # Opens a Hunspell dictionary.
+    #
+    # @param [String] path
+    #   The path prefix shared by the `.aff` and `.dic` files.
+    #
+    # @yield [dict]
+    #   The given block will be passed the Hunspell dictionary.
+    #
+    # @yieldparam [Dictionary] dict
+    #   The opened dictionary.
+    #
+    # @return [nil]
+    #
+    def Hunspell.dict(path,&block)
+      Dictionary.open(path,&block)
+    end
+  end
+end

data/spec/dictionary_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'ffi/hunspell/dictionary'
+
+describe Hunspell::Dictionary do
+  subject { Hunspell::Dictionary }
+
+  let(:root) { '/usr/share/myspell' || ENV['HUNSPELL_ROOT'] }
+  let(:path) { File.join(root,'en_US') }
+
+  let(:aff_path) { "#{path}.aff" }
+  let(:dic_path) { "#{path}.dic" }
+
+  it "should open a dictionary file from a path" do
+    subject.open(path) do |dict|
+      dict.should_not be_nil
+    end
+  end
+
+  it "should create a dictionary from '.aff' and '.dic' files" do
+    dict = subject.new(aff_path,dic_path)
+    dict.should_not be_nil
+
+    dict.close
+  end
+
+  it "should close the dictionary" do
+    dict = subject.open(path)
+    dict.close
+
+    dict.should be_closed
+  end
+
+  it "should provide the encoding of the dictionary files" do
+    subject.open(path) do |dict|
+      dict.encoding.should_not be_empty
+    end
+  end
+
+  it "should check if a word is valid" do
+    subject.open(path) do |dict|
+      dict.should be_valid('dog')
+      dict.should_not be_valid('dxg')
+    end
+  end
+
+  it "should find the stems of a word" do
+    subject.open(path) do |dict|
+      dict.stem('fishing').should == %w[fishing fish]
+    end
+  end
+
+  it "should suggest alternate spellings for words" do
+    subject.open(path) do |dict|
+      dict.suggest('arbitrage').should == %w[
+        arbitrage
+        arbitrages
+        arbitrager
+        arbitraged
+        arbitrate
+      ]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'ffi'
+
+include FFI

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-hunspell
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ore
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 2
+        version: 0.1.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id004
+description: Ruby FFI bindings for Hunspell spell checker.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ffi-hunspell.gemspec
+- gemspec.yml
+- lib/ffi/hunspell.rb
+- lib/ffi/hunspell/dictionary.rb
+- lib/ffi/hunspell/hunspell.rb
+- spec/dictionary_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/ffi-hunspell
+licenses: 
+- MIT
+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: 
+- libhunspell >= 1.2.0
+rubyforge_project: ffi-hunspell
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: FFI bindings for Hunspell
+test_files: 
+- spec/dictionary_spec.rb