ffi-hunspell 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d0c7a4c75c7cc5f876e6486410f2b6b918660cd2b2be23154791f141997c0b
-  data.tar.gz: d8108f59f9f508b19be76969cebc5ee1aae2f5ff2591ce540778bec50cf13649
+  metadata.gz: b29a3ff5f68640f1c8123c5895074ed2d986961a15fd3f8921baf1bd83769831
+  data.tar.gz: fcf088c5e73c7c6dd5ac23db60a8c14c9be58a4dea16e7aa2d0006ed5f019694
 SHA512:
-  metadata.gz: b1c9cd2990898a108c8e60242ae5036de97edb26d819f47654d961bf63ab65947ac6ed60141c105c7673bf0f0a08c8345d31109e21e9239e25467ec0a96147e2
-  data.tar.gz: cd7e8f319039ffe1d946216c87ee504e293c260e5899505bd3f5a4adcf0c8826eabc2f3a16355a8f5c520db824057e88f564f8efccd89a3dfb9993d38bd3c355
+  metadata.gz: ef1c370fd0471c1f50748a6c4775313090b5f676c25ed9976932749149905d80c1c02d574ae8dd553ff7d380ddd7f9b5825f30240ec9f17f45e28ff6e98f2007
+  data.tar.gz: 365cb6e3fb48e17f1303e76cbd0082e57b0d3d5814f8ff7a2c8c0415fcaa1c3287fedd96ad6c0d94fc2e844d459a07556df38bd5ccd64b6f470c8e75bc860236

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - jruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install libhunspell
+        run: |
+          sudo apt update -y && \
+          sudo apt install -y --no-install-recommends --no-install-suggests libhunspell-dev hunspell-en-us
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test
+        env:
+          LANG: en_US.UTF-8

data/ChangeLog.md

@@ -1,3 +1,8 @@
+### 0.6.0 / 2020-11-28
+
+* Added {FFI::Hunspell::Dictionary#add_dic} which adds an extra dictionary
+  file. (@cdchapman)
+
 ### 0.5.0 / 2019-10-24
 
 * Added support for libhunspell-1.7 (@dorner).

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Hal Brodigan
+Copyright (c) 2010-2020 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,8 +5,6 @@
 * [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].
@@ -14,6 +12,7 @@ Ruby FFI bindings for [Hunspell][libhunspell].
 ## Examples
 
 Open a dictionary:
+
 ```rb
 require 'ffi/hunspell'
     
@@ -31,6 +30,7 @@ dict.close
 ```
 
 Check if a word is valid:
+
 ```rb
 dict.check?('dog')
 # => true
@@ -38,30 +38,37 @@ dict.check?('dog')
 dict.check?('d0g')
 # => false
 ```
+
 Find the stems of a word:
+
 ```rb
 dict.stem('dogs')
 # => ["dog"]
 ```
+
 Suggest alternate spellings for a word:
+
 ```rb
 dict.suggest('arbitrage')
 # => ["arbitrage", "arbitrages", "arbitrager", "arbitraged", "arbitrate"]
 ```
+
 ## Requirements
 
-* [libhunspell] >= 1.2.0
+* [libhunspell] >= 1.2.0, <= 1.7.0
 * [ffi] ~> 1.0
 
 ## Install
+
 ```sh
 $ gem install ffi-hunspell
 ```
+
 ## License
 
-Copyright (c) 2010-2016 Hal Brodigan
+Copyright (c) 2010-2020 Hal Brodigan
 
 See {file:LICENSE.txt} for license information.
 
-[libhunspell]: http://hunspell.sourceforge.net/
+[libhunspell]: http://hunspell.github.io/
 [ffi]: https://github.com/ffi/ffi

data/lib/ffi/hunspell/dictionary.rb

@@ -116,6 +116,8 @@ module FFI
         Hunspell.Hunspell_add(self,word.to_s)
       end
 
+      alias << add
+
       #
       # Adds a word to the dictionary with affix flags.
       #
@@ -138,7 +140,27 @@ module FFI
         add_with_affix(word,example)
       end
 
-      alias << add
+      #
+      # Load an extra dictionary file. The extra dictionaries use the
+      # affix file of the allocated Hunspell object.
+      #
+      # Maximal number of extra dictionaries is limited in the source code (20)
+      #
+      # @param [String] dic_path
+      #   The path to the extra `.dic` file.
+      #
+      # @raise [ArgumentError]
+      #   The extra `.dic` file did not exist.
+      #
+      # @since 0.6.0
+      #
+      def add_dic(dic_path)
+        unless File.file?(dic_path)
+          raise(ArgumentError,"invalid extra dictionary path #{dic_path.inspect}")
+        end
+
+        Hunspell.Hunspell_add_dic(self,dic_path)
+      end
 
       #
       # Removes a word from the dictionary.

data/lib/ffi/hunspell/hunspell.rb

@@ -28,6 +28,19 @@ module FFI
     attach_function :Hunspell_remove, [:pointer, :string], :int
     attach_function :Hunspell_free_list, [:pointer, :pointer, :int], :void
 
+    begin
+      attach_function :Hunspell_add_dic, [:pointer, :string], :int
+    rescue FFI::NotFoundError
+      def self.method_missing(symbol,*arguments,&block)
+        if symbol == :Hunspell_add_dic
+          raise NotImplementedError,
+            "Hunspell_add_dic was not found in [#{ffi_libraries.map(&:name).join(", ")}]. You must install Hunspell 1.3.4 or later if you need this functionality."
+        end
+
+        super
+      end
+    end
+
     #
     # missing functions:
     #

data/lib/ffi/hunspell/version.rb

@@ -2,6 +2,6 @@ module FFI
   module Hunspell
     # ffi-hunspell versiont 
     # @since 0.5.0
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/spec/dictionary_spec.rb

@@ -49,7 +49,7 @@ describe Hunspell::Dictionary do
     after { subject.close }
 
     it "should provide the encoding of the dictionary files" do
-      expect(subject.encoding).to be Encoding::ISO_8859_1
+      expect(subject.encoding).to be_instance_of Encoding
     end
 
     it "should check if a word is valid" do
@@ -57,6 +57,44 @@ describe Hunspell::Dictionary do
       expect(subject.valid?('dxg')).to be false
     end
 
+    describe "#add_dic" do
+      let(:extra_dic) { File.join(File.dirname(__FILE__),'fixtures/extra.dic') }
+
+      if FFI::Hunspell.respond_to?(:Hunspell_add_dic)
+        context "when libhunspell supports add_dic" do
+          before do
+            subject.add_dic(extra_dic)
+          end
+
+          it "should add an extra dictionary" do
+            expect(subject.add_dic(extra_dic)).to be 0
+          end
+
+          context "when the given extra dictionary file cannot be found" do
+            it do
+              expect { subject.add_dic('foo') }.to raise_error(ArgumentError)
+            end
+          end
+
+          it "should validate a word from the extra dictionary" do
+            expect(subject.valid?('dxg')).to be true
+          end
+
+          it "should validate an affixed word based on an affix flag from base affix file" do
+            expect(subject.valid?('dxgs')).to be true
+          end
+        end
+      else
+        context "when libhunspell does not support add_dic" do
+          it "should raise an error" do
+            expect {
+              subject.add_dic(extra_dic)
+            }.to raise_error(NotImplementedError)
+          end
+        end
+      end
+    end
+
     describe "#add" do
       it "should add a word" do
         expect(subject.add('cat')).to be 0

data/spec/fixtures/extra.dic

@@ -0,0 +1,2 @@
+1
+dxg/MS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-hunspell
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -48,9 +48,9 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gemtest"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - ChangeLog.md
 - Gemfile
@@ -64,6 +64,7 @@ files:
 - lib/ffi/hunspell/hunspell.rb
 - lib/ffi/hunspell/version.rb
 - spec/dictionary_spec.rb
+- spec/fixtures/extra.dic
 - spec/hunspell_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/postmodern/ffi-hunspell#readme
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - libhunspell >= 1.2.0, <= 1.7.0
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: FFI bindings for Hunspell

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-before_install:
-  - sudo apt-get install libhunspell-dev hunspell-en-us
-  - gem install bundler -v "~> 2.0"
-rvm:
-  - 2.5
-  - 2.6
-  - jruby
-script: bundle exec rake spec