ffi-hunspell 0.2.6 → 0.3.0

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+before_install:
+  - sudo apt-get install libhunspell-dev hunspell-en-us
+  - gem install ffi rubygems-tasks rspec yard
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
+script: rake test

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.3.0 / 2013-05-01
+
+* Detect Ubuntu's hunspell directory (`/usr/share/hunspell`).
+* {FFI::Hunspell::Dictionary#encoding} now returns an `Encoding` object.
+* Encode Strings returned from {FFI::Hunspell::Dictionary#stem} and
+  {FFI::Hunspell::Dictionary#suggestions} to match the dictionary's native
+  encoding.
+
 ### 0.2.6 / 2013-02-05
 
 * Removed the env dependency.

data/README.md

@@ -2,9 +2,11 @@
 
 * [Source](https://github.com/postmodern/ffi-hunspell)
 * [Issues](https://github.com/postmodern/ffi-hunspell/issues)
-* [Documentation](http://rubydoc.info/gems/ffi-hunspell)
+* [Documentation](http://rubydoc.info/gems/ffi-hunspell/frames)
 * [Email](postmodern.mod3 at gmail.com)
 
+[![Build Status](https://secure.travis-ci.org/postmodern/ffi-hunspell.png?branch=master)](https://travis-ci.org/postmodern/ffi-hunspell)
+
 ## Description
 
 Ruby FFI bindings for [Hunspell][libhunspell].
@@ -54,15 +56,6 @@ Suggest alternate spellings for a word:
 
     $ 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
 
 Copyright (c) 2010-2013 Hal Brodigan

data/ffi-hunspell.gemspec

@@ -2,126 +2,59 @@
 
 require 'yaml'
 
-Gem::Specification.new do |gemspec|
-  files = if File.directory?('.git')
-            `git ls-files`.split($/)
-          elsif File.directory?('.hg')
-            `hg manifest`.split($/)
-          elsif File.directory?('.svn')
-            `svn ls -R`.split($/).select { |path| File.file?(path) }
-          else
-            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
-          end
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
 
-  filter_files = lambda { |paths|
-    case paths
-    when Array
-      (files & paths)
-    when String
-      (files & Dir[paths])
-    end
-  }
-
-  version = {
-    :file => 'lib/ffi/hunspell/version.rb',
-    :constant => 'FFI::Hunspell::VERSION'
-  }
-
-  defaults = {
-    'name' => File.basename(File.dirname(__FILE__)),
-    'files' => files,
-    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
-    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
-    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
-  }
-
-  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
-
-  gemspec.name = metadata.fetch('name',defaults[:name])
-  gemspec.version = if metadata['version']
-                      metadata['version']
-                    elsif File.file?(version[:file])
-                      require File.join('.',version[:file])
-                      eval(version[:constant])
-                    end
-
-  gemspec.summary = metadata.fetch('summary',metadata['description'])
-  gemspec.description = metadata.fetch('description',metadata['summary'])
-
-  case metadata['license']
-  when Array
-    gemspec.licenses = metadata['license']
-  when String
-    gemspec.license = metadata['license']
-  end
-
-  case metadata['authors']
-  when Array
-    gemspec.authors = metadata['authors']
-  when String
-    gemspec.author = metadata['authors']
-  end
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-  gemspec.email = metadata['email']
-  gemspec.homepage = metadata['homepage']
+                  require 'ffi/hunspell/version'
+                  FFI::Hunspell::VERSION
+                end
 
-  case metadata['require_paths']
-  when Array
-    gemspec.require_paths = metadata['require_paths']
-  when String
-    gemspec.require_path = metadata['require_paths']
-  end
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
 
-  gemspec.files = filter_files[metadata['files']]
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gemspec.executables = metadata['executables']
-  gemspec.extensions = metadata['extensions']
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
 
-  if Gem::VERSION < '1.7.'
-    gemspec.default_executable = gemspec.executables.first
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
   end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
-  gemspec.test_files = filter_files[metadata['test_files']]
-
-  unless gemspec.files.include?('.document')
-    gemspec.extra_rdoc_files = metadata['extra_doc_files']
-  end
-
-  gemspec.post_install_message = metadata['post_install_message']
-  gemspec.requirements = metadata['requirements']
-
-  if gemspec.respond_to?(:required_ruby_version=)
-    gemspec.required_ruby_version = metadata['required_ruby_version']
-  end
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
-  if gemspec.respond_to?(:required_rubygems_version=)
-    gemspec.required_rubygems_version = metadata['required_ruby_version']
-  end
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
 
-  parse_versions = lambda { |versions|
-    case versions
-    when Array
-      versions.map { |v| v.to_s }
-    when String
-      versions.split(/,\s*/)
-    end
-  }
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
 
-  if metadata['dependencies']
-    metadata['dependencies'].each do |name,versions|
-      gemspec.add_dependency(name,parse_versions[versions])  
-    end
-  end
+  split = lambda { |string| string.split(/,\s*/) }
 
-  if metadata['runtime_dependencies']
-    metadata['runtime_dependencies'].each do |name,versions|
-      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
     end
   end
 
-  if metadata['development_dependencies']
-    metadata['development_dependencies'].each do |name,versions|
-      gemspec.add_development_dependency(name,parse_versions[versions])  
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
     end
   end
 end

data/gemspec.yml

@@ -1,15 +1,17 @@
 name: ffi-hunspell
-version: 0.2.6
+version: 0.3.0
 summary: FFI bindings for Hunspell
-description: Ruby FFI bindings for Hunspell spell checker.
+description: Ruby FFI bindings for the Hunspell spell checker.
 license: MIT
 authors: Postmodern
 email: postmodern.mod3@gmail.com
-homepage: https://github.com/postmodern/ffi-hunspell
+homepage: https://github.com/postmodern/ffi-hunspell#readme
 has_yard: true
 
 requirements: libhunspell >= 1.2.0
 
+required_ruby_version: ">= 1.9.1"
+
 dependencies:
   ffi: ~> 1.0
 

data/lib/ffi/hunspell/dictionary.rb

@@ -37,10 +37,8 @@ module FFI
           raise("invalid dic path #{dic_path.inspect}")
         end
 
-        @ptr = if key
-                 Hunspell.Hunspell_create_key(affix_path,dic_path,key)
-               else
-                 Hunspell.Hunspell_create(affix_path,dic_path)
+        @ptr = if key then Hunspell.Hunspell_create_key(affix_path,dic_path,key)
+               else        Hunspell.Hunspell_create(affix_path,dic_path)
                end
       end
 
@@ -59,7 +57,7 @@ module FFI
       # @return [Dictionary]
       #   If no block is given, the open dictionary will be returned.
       #
-      # @raise [RuntimeError]
+      # @raise [ArgumentError]
       #   The dictionary files could not be found in any of the directories.
       #
       def self.open(name)
@@ -67,7 +65,7 @@ module FFI
 
         Hunspell.directories.each do |dir|
           affix_path = File.join(dir,"#{name}.#{AFF_EXT}")
-          dic_path = File.join(dir,"#{name}.#{DIC_EXT}")
+          dic_path   = File.join(dir,"#{name}.#{DIC_EXT}")
 
           if (File.file?(affix_path) && File.file?(dic_path))
             dict = self.new(affix_path,dic_path)
@@ -83,7 +81,7 @@ module FFI
           end
         end
 
-        raise("unable to find the dictionary #{name.dump} in any of the directories")
+        raise(ArgumentError,"unable to find the dictionary #{name.dump} in any of the directories")
       end
 
       #
@@ -99,11 +97,13 @@ module FFI
       #
       # The encoding of the dictionary file.
       #
-      # @return [String]
+      # @return [Encoding]
       #   The encoding of the dictionary file.
       #
       def encoding
-        Hunspell.Hunspell_get_dic_encoding(self)
+        @encoding ||= Encoding.const_get(
+          Hunspell.Hunspell_get_dic_encoding(self).gsub('-','_')
+        )
       end
 
       #
@@ -163,14 +163,14 @@ module FFI
 
         FFI::MemoryPointer.new(:pointer) do |output|
           count = Hunspell.Hunspell_stem(self,output,word.to_s)
-          ptr = output.get_pointer(0)
+          ptr   = output.get_pointer(0)
 
           if count > 0
             stems = ptr.get_array_of_string(0,count)
           end
         end
 
-        return stems
+        return stems.map { |word| force_encoding(word) }
       end
 
       #
@@ -187,14 +187,14 @@ module FFI
 
         FFI::MemoryPointer.new(:pointer) do |output|
           count = Hunspell.Hunspell_suggest(self,output,word.to_s)
-          ptr = output.get_pointer(0)
+          ptr   = output.get_pointer(0)
 
           if count > 0
             suggestions = ptr.get_array_of_string(0,count)
           end
         end
 
-        return suggestions
+        return suggestions.map { |word| force_encoding(word) }
       end
 
       #
@@ -219,6 +219,21 @@ module FFI
         @ptr
       end
 
+      protected
+
+      #
+      # Encodes a String into the dictionary's encoding.
+      #
+      # @param [String] string
+      #   The unencoded String.
+      #
+      # @return [String]
+      #   The encoded String.
+      #
+      def force_encoding(string)
+        string.force_encoding(encoding)
+      end
+
     end
   end
 end

data/lib/ffi/hunspell/hunspell.rb

@@ -68,6 +68,8 @@ module FFI
       # Debian
       '/usr/local/share/myspell/dicts',
       '/usr/share/myspell/dicts',
+      # Ubuntu
+      '/usr/share/hunspell',
       # Fedora
       '/usr/local/share/myspell',
       '/usr/share/myspell',

data/spec/dictionary_spec.rb

@@ -35,6 +35,14 @@ describe Hunspell::Dictionary do
 
       dict.should be_closed
     end
+
+    context "when given an unknown dictionary name" do
+      it "should raise an ArgumentError" do
+        lambda {
+          subject.open('foo')
+        }.should raise_error(ArgumentError)
+      end
+    end
   end
 
   subject { described_class.new(affix_path,dic_path) }
@@ -42,7 +50,7 @@ describe Hunspell::Dictionary do
   after(:all) { subject.close }
 
   it "should provide the encoding of the dictionary files" do
-    subject.encoding.should_not be_empty
+    subject.encoding.should == Encoding::ISO_8859_1
   end
 
   it "should check if a word is valid" do
@@ -55,6 +63,12 @@ describe Hunspell::Dictionary do
       subject.stem('fishing').should == %w[fishing fish]
     end
 
+    it "should force_encode all strings" do
+      subject.suggest('fishing').all? { |string|
+        string.encoding == subject.encoding
+      }.should be_true
+    end
+
     context "when there are no stems" do
       it "should return []" do
         subject.stem("zzzzzzz").should == []
@@ -64,13 +78,19 @@ describe Hunspell::Dictionary do
 
   describe "#suggest" do
     it "should suggest alternate spellings for words" do
-      subject.suggest('arbitrage').should == %w[
-        arbitrage
-        arbitrages
-        arbitrager
-        arbitraged
-        arbitrate
-      ]
+      subject.suggest('arbitrage').should include(*[
+        'arbitrage',
+        'arbitrages',
+        'arbitrager',
+        'arbitraged',
+        'arbitrate'
+      ])
+    end
+
+    it "should force_encode all strings" do
+      subject.suggest('arbitrage').all? { |string|
+        string.encoding == subject.encoding
+      }.should be_true
     end
 
     context "when there are no suggestions" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-hunspell
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -75,7 +75,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
-description: Ruby FFI bindings for Hunspell spell checker.
+description: Ruby FFI bindings for the Hunspell spell checker.
 email: postmodern.mod3@gmail.com
 executables: []
 extensions: []
@@ -87,6 +87,7 @@ files:
 - .gemtest
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - ChangeLog.md
 - LICENSE.txt
@@ -100,7 +101,7 @@ files:
 - spec/dictionary_spec.rb
 - spec/hunspell_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/postmodern/ffi-hunspell
+homepage: https://github.com/postmodern/ffi-hunspell#readme
 licenses:
 - MIT
 post_install_message: 
@@ -112,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,10 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - libhunspell >= 1.2.0
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: FFI bindings for Hunspell
-test_files:
-- spec/dictionary_spec.rb
-- spec/hunspell_spec.rb
+test_files: []