ffi-hunspell 0.1.0 → 0.2.0

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.2.0 / 2011-01-22
+
+* Added {FFI::Hunspell.lang}.
+* Added {FFI::Hunspell.lang=}.
+* Added {FFI::Hunspell.directories}.
+* Have {FFI::Hunspell::Dictionary.open} accept a language name, and search
+  {FFI::Hunspell.directories} for the dictionary files.
+
 ### 0.1.0 / 2010-10-05
 
 * Initial release.

data/LICENSE.txt

@@ -1,6 +1,3 @@
-
-The MIT License
-
 Copyright (c) 2010 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -1,7 +1,8 @@
 # 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)
+* [Source](http://github.com/postmodern/ffi-hunspell)
+* [Issues](http://github.com/postmodern/ffi-hunspell/issues)
+* [Documentation](http://rubydoc.info/gems/ffi-hunspell)
 * Postmodern (postmodern.mod3 at gmail.com)
 
 ## Description
@@ -14,14 +15,18 @@ Open a dictionary:
 
     require 'ffi/hunspell'
     
-    dict = FFI::Hunspell.dict('/usr/share/myspell/en_US')
-    # ...
-    dict.close
+    FFI::Hunspell.dict do |dict|
+      # ...
+    end
 
-    FFI::Hunspell.dict('/usr/share/myspell/en_US') do |dict|
+    FFI::Hunspell.dict('en_GB') do |dict|
       # ...
     end
 
+    dict = FFI::Hunspell.dict('en_GB')
+    # ...
+    dict.close
+
 Check if a word is valid:
 
     dict.check?('dog')
@@ -49,6 +54,15 @@ Suggest alternate spellings for a word:
 
     $ sudo gem install ffi-hunspell
 
+## Known Issues
+
+Some Linux distributions do not install the `libhunspell-1.2.so`
+shared library file, but instead installs `libhunspell-1.2.so.0`.
+Simply create a symbolic link to the hunspell shared library,
+so that {FFI::Hunspell} can find the library:
+
+    # ln -s /usr/lib/libhunspell-1.2.so.0 /usr/lib/libhunspell-1.2.so
+
 ## License
 
 See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'ore-tasks', '~> 0.1.2'
+  gem 'ore-tasks', '~> 0.2.0'
   require 'ore/tasks'
 
   Ore::Tasks.new
@@ -21,6 +21,7 @@ rescue LoadError => e
     abort "Please run `gem install rspec` to install RSpec."
   end
 end
+task :test => :spec
 task :default => :spec
 
 begin

data/ffi-hunspell.gemspec

@@ -6,5 +6,5 @@ begin
   end
 rescue NameError
   STDERR.puts "The 'ffi-hunspell.gemspec' file requires Ore."
-  STDERR.puts "Run `gem install ore` to install Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
 end

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ffi-hunspell
-version: 0.1.0
+version: 0.2.0
 summary: FFI bindings for Hunspell
 description: Ruby FFI bindings for Hunspell spell checker.
 license: MIT
@@ -14,6 +14,6 @@ dependencies:
   ffi: ~> 0.6.0
 
 development_dependencies:
-  ore: ~> 0.2.0
-  ore-tasks: ~> 0.1.2
+  ore-tasks: ~> 0.2.0
+  rspec: ~> 2.0.0
   yard: ~> 0.6.0

data/lib/ffi/hunspell/dictionary.rb

@@ -2,8 +2,17 @@ require 'ffi/hunspell/hunspell'
 
 module FFI
   module Hunspell
+    #
+    # Represents a dictionary for a specific language.
+    #
     class Dictionary
 
+      # The affix file extension
+      AFF_EXT = 'aff'
+
+      # The dictionary file extension
+      DIC_EXT = 'dic'
+
       #
       # Creates a new dictionary.
       #
@@ -16,7 +25,18 @@ module FFI
       # @param [String] key
       #   The optional key for encrypted dictionary files.
       #
+      # @raise [RuntimeError]
+      #   Either the affix or dic files did not exist.
+      #
       def initialize(affix_path,dic_path,key=nil)
+        unless File.file?(affix_path)
+          raise("invalid affix path #{affix_path.inspect}")
+        end
+
+        unless File.file?(dic_path)
+          raise("invalid dic path #{dic_path.inspect}")
+        end
+
         @ptr = if key
                  Hunspell.Hunspell_create_key(affix_path,dic_path,key)
                else
@@ -27,8 +47,8 @@ module FFI
       #
       # Opens a Hunspell dictionary.
       #
-      # @param [String] path
-      #   The path prefix shared by the `.aff` and `.dic` files.
+      # @param [Symbol, String] name
+      #   The name of the dictionary to open.
       #
       # @yield [dict]
       #   The given block will be passed the Hunspell dictionary.
@@ -39,17 +59,31 @@ module FFI
       # @return [Dictionary]
       #   If no block is given, the open dictionary will be returned.
       #
-      def self.open(path)
-        dict = self.new("#{path}.aff","#{path}.dic")
+      # @raise [RuntimeError]
+      #   The dictionary files could not be found in any of the directories.
+      #
+      def self.open(name)
+        name = name.to_s
+
+        Hunspell.directories.each do |dir|
+          affix_path = File.join(dir,"#{name}.#{AFF_EXT}")
+          dic_path = File.join(dir,"#{name}.#{DIC_EXT}")
 
-        if block_given?
-          yield dict
+          if (File.file?(affix_path) && File.file?(dic_path))
+            dict = self.new(affix_path,dic_path)
 
-          dict.close
-          return nil
-        else
-          return dict
+            if block_given?
+              yield dict
+
+              dict.close
+              return nil
+            else
+              return dict
+            end
+          end
         end
+
+        raise("unable to find the dictionary #{name.dump} in any of the directories")
       end
 
       #

data/lib/ffi/hunspell/hunspell.rb

@@ -27,11 +27,65 @@ module FFI
     #   attach_function :Hunspell_generate2, [:pointer, :pointer, :string, :pointer, :int], :int
     #
 
+    # The language to default to, if no 'LANG' env variable was set.
+    DEFAULT_LANG = 'en_US'
+
+    #
+    # The default language.
+    #
+    # @return [String]
+    #   The name of the default language.
+    #
+    # @since 0.2.0
+    #
+    def Hunspell.lang
+      @lang ||= if ENV['LANG']
+                  ENV['LANG'].split('.',2).first
+                else
+                  DEFAULT_LANG
+                end
+    end
+
+    #
+    # Sets the default language.
+    #
+    # @param [String] name
+    #   The new language name.
+    #
+    # @return [String]
+    #   The name of the new default language.
+    #
+    # @since 0.2.0
+    #
+    def Hunspell.lang=(new_lang)
+      @lang = new_lang.to_s
+    end
+
+    #
+    # The directories to search for dictionary files.
+    #
+    # @return [Array]
+    #   The directory paths.
+    #
+    # @since 0.2.0
+    #
+    def Hunspell.directories
+      @directories ||= [
+        '/usr/local/share/myspell',
+        '/usr/share/myspell'
+      ]
+    end
+
+    # prepend the ~/.hunspell_default directory to DIRS
+    if (home = (ENV['HOME'] || ENV['HOMEPATH']))
+      directories.unshift(File.join(home,'.hunspell_default'))
+    end
+
     #
     # Opens a Hunspell dictionary.
     #
-    # @param [String] path
-    #   The path prefix shared by the `.aff` and `.dic` files.
+    # @param [Symbol, String] name
+    #   The name of the dictionary to open.
     #
     # @yield [dict]
     #   The given block will be passed the Hunspell dictionary.
@@ -41,8 +95,8 @@ module FFI
     #
     # @return [nil]
     #
-    def Hunspell.dict(path,&block)
-      Dictionary.open(path,&block)
+    def Hunspell.dict(name=Hunspell.lang,&block)
+      Dictionary.open(name,&block)
     end
   end
 end

data/spec/dictionary_spec.rb

@@ -4,53 +4,52 @@ 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(:lang) { 'en_US' }
 
-  let(:aff_path) { "#{path}.aff" }
-  let(:dic_path) { "#{path}.dic" }
+  let(:affix_path) { File.join(Hunspell.directories.last,"#{lang}.aff") }
+  let(:dic_path) { File.join(Hunspell.directories.last,"#{lang}.dic") }
 
-  it "should open a dictionary file from a path" do
-    subject.open(path) do |dict|
+  it "should find and open a dictionary file for a given language" do
+    subject.open(lang) 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 = subject.new(affix_path,dic_path)
     dict.should_not be_nil
 
     dict.close
   end
 
   it "should close the dictionary" do
-    dict = subject.open(path)
+    dict = subject.open(lang)
     dict.close
 
     dict.should be_closed
   end
 
   it "should provide the encoding of the dictionary files" do
-    subject.open(path) do |dict|
+    subject.open(lang) do |dict|
       dict.encoding.should_not be_empty
     end
   end
 
   it "should check if a word is valid" do
-    subject.open(path) do |dict|
+    subject.open(lang) 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|
+    subject.open(lang) do |dict|
       dict.stem('fishing').should == %w[fishing fish]
     end
   end
 
   it "should suggest alternate spellings for words" do
-    subject.open(path) do |dict|
+    subject.open(lang) do |dict|
       dict.suggest('arbitrage').should == %w[
         arbitrage
         arbitrages

data/spec/hunspell_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'ffi/hunspell/hunspell'
+
+describe Hunspell do
+  it "should have a default language" do
+    subject.lang.should_not be_nil
+    subject.lang.should_not be_empty
+  end
+
+  it "should have directories to search within" do
+    subject.directories.should_not be_empty
+  end
+
+  it "should open a dictionary file" do
+    subject.dict('en_US') do |dict|
+      dict.should_not be_nil
+    end
+  end
+
+  it "should open the dictionary file for the default language" do
+    subject.dict do |dict|
+      dict.should_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,12 @@
 require 'rspec'
-require 'ffi'
+require 'ffi/hunspell'
 
 include FFI
+
+RSpec.configure do |specs|
+  specs.before(:suite) do
+    if ENV['HUNSPELL_ROOT']
+      Hunspell.directories << ENV['HUNSPELL_ROOT']
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 -07:00
+date: 2011-01-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ore
+  name: ore-tasks
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -48,7 +48,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: ore-tasks
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -56,10 +56,10 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        - 1
         - 2
-        version: 0.1.2
+        - 0
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -86,6 +86,7 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- .gemtest
 - .rspec
 - .yardopts
 - ChangeLog.md
@@ -98,6 +99,7 @@ files:
 - lib/ffi/hunspell/dictionary.rb
 - lib/ffi/hunspell/hunspell.rb
 - spec/dictionary_spec.rb
+- spec/hunspell_spec.rb
 - spec/spec_helper.rb
 has_rdoc: yard
 homepage: http://github.com/postmodern/ffi-hunspell
@@ -133,3 +135,4 @@ specification_version: 3
 summary: FFI bindings for Hunspell
 test_files: 
 - spec/dictionary_spec.rb
+- spec/hunspell_spec.rb