ffi-aspell 0.0.1 → 0.0.2

data/.gems

@@ -0,0 +1,5 @@
+ffi
+rake
+redcarpet
+yard
+bacon

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*.gem
+doc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@ffi-aspell

data/.yardopts

@@ -0,0 +1,9 @@
+./lib/ffi/**/*.rb
+-m markdown
+-M redcarpet
+-o ./doc
+-r ./README.md
+--private
+--protected
+-
+LICENSE

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012, Yorick Peterse
+
+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,64 @@
+# FFI::Aspell
+
+FFI::Aspell is an FFI binding for the Aspell library. It was mainly written as
+[Raspell][raspell], a C binding for Aspell, is buggy and no longer maintained by
+the main author as of April 2012.
+
+## Requirements
+
+* FFI: `gem install ffi`
+* Aspell (`sudo pacman -S aspell` if you're on Arch Linux)
+
+## Usage
+
+Install the gem:
+
+    $ gem install ffi-aspell
+
+Load it:
+
+    require 'ffi/aspell'
+
+The primary class is `FFI::Aspell::Speller`, this class can be used to check for
+spelling errors and the like:
+
+    speller = FFI::Aspell::Speller.new('en_US')
+
+    if speller.correct?('cookie')
+      puts 'The word "cookie" is correct'
+    else
+      puts 'The word "cookie" is incorrect'
+    end
+
+For more information see the YARD documentation.
+
+## Hacking & Contributing
+
+1. Make sure that Aspell and the English and Dutch dictionaries for it are
+   installed as well. On Arch Linux this can be done by running `sudo pacman -S
+   aspell aspell-en aspell-nl`.
+2. Import the gems using RVM: `rvm gemset import .gems`.
+3. Run the tests to see if everything is working: `rake test`
+4. Hack away!
+
+## Coding Standards
+
+* FFI functions go in FFI::Aspell
+* Attached function names should resemble the C function names as much as
+  possible.
+* No more than 80 characters per line of code.
+* Document your code, pull requests with big changes but without documentation
+  will be rejected.
+* Git commits should be signed off, this can be done by running `git commit
+  --sign`. Commits that are not signed off will be rejected.
+* Follow the Git commit standards are described here:
+  <http://ramaze.net/documentation/file.contributing.html#Commit_Messages>.
+* Test your code! Pull requests without tests will not be accepted.
+
+## License
+
+The code in this repository is licensed under the MIT license. A copy of this
+license can be found in the file "LICENSE" in the root directory of this
+repository.
+
+[raspell]: https://github.com/evan/raspell

data/Rakefile

@@ -0,0 +1,3 @@
+Dir['./task/*.rake'].each { |task| import(task) }
+
+task :default => :test

data/ffi-aspell.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/ffi/aspell/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ffi-aspell'
+  s.version     = FFI::Aspell::VERSION
+  s.date        = '2012-04-26'
+  s.authors     = ['Yorick Peterse']
+  s.email       = 'yorickpeterse@gmail.com'
+  s.summary     = 'FFI bindings for Aspell'
+  s.homepage    = 'https://github.com/YorickPeterse/ffi-aspell'
+  s.description = s.summary
+  s.files       = `git ls-files`.split("\n")
+  s.has_rdoc    = 'yard'
+
+  s.add_dependency('ffi', ['>= 1.0.11'])
+
+  s.add_development_dependency('rake', ['>= 0.9.2.2'])
+  s.add_development_dependency('yard',['>= 0.7.5'])
+  s.add_development_dependency('redcarpet', ['>= 2.1.1'])
+  s.add_development_dependency('bacon', ['>= 1.1.0'])
+end

data/lib/ffi/aspell/speller.rb

@@ -4,9 +4,90 @@ module FFI
     # The Speller class is used for spell checking individual words as well as
     # generating a list of suggestions.
     #
+    # ## Usage
+    #
+    # First you'll have to create a new instance:
+    #
+    #     speller = FFI::Aspell::Speller.new
+    #
+    # When creating a new instance you can specify the language as well as a set
+    # of arbitrary Aspell options (e.g. the personal wordlist file). The
+    # language can be set in the first parameter, other options are set as a
+    # hash in the second parameter:
+    #
+    #     speller = FFI::Aspell::Speller.new('nl', :personal => 'aspell.nl.pws')
+    #
+    # Unlike Raspell the keys of the hash used for additional options can be
+    # both strings and symbols.
+    #
+    # Once an instance has been created you can change the options, check the
+    # spelling of a word or retrieve a list of suggestions.
+    #
+    # ### Options
+    #
+    # There are four methods for dealing with Aspell options:
+    #
+    # * {FFI::Aspell::Speller#set}
+    # * {FFI::Aspell::Speller#get}
+    # * {FFI::Aspell::Speller#get_default}
+    # * {FFI::Aspell::Speller#reset}
+    #
+    # There are also two extra methods which can be used to set the suggestion
+    # mode, both these methods are simply shortcuts and use the `#set()` method
+    # for actually setting the values:
+    #
+    #     speller.suggestion_mode = 'fast'
+    #
+    #     if speller.suggestion_mode == 'fast'
+    #       # ...
+    #     end
+    #
+    # Setting an option:
+    #
+    #     speller.set('lang', 'en_US')
+    #
+    # Retrieving an option:
+    #
+    #     speller.get('lang')
+    #
+    # Resetting an option:
+    #
+    #     speller.reset('lang')
+    #
+    # ### Checking a Word
+    #
+    # Checking the spelling of a word is done using
+    # {FFI::Aspell::Speller#correct?}. This method takes a string containing the
+    # word to verify and returns `true` if the word is spelled correctly and
+    # `false` otherwise:
+    #
+    #     speller.correct?('cookie') # => true
+    #     speller.correct?('cookei') # => false
+    #
+    # ### Suggestions
+    #
+    # Suggestions can be generated using {FFI::Aspell::Speller.suggestions}.
+    # This method returns an array containing all the possible suggestions based
+    # on the suggestion mode that is being used:
+    #
+    #     speller.suggestions('cookei') # => ["cookie", ...]
+    #
+    # For more information see the documentation of the individual methods in
+    # this class.
+    #
     # @since 13-04-2012
+    # @todo Currently this class creates a new speller object every time
+    #  {FFI::Aspell::Speller#correct?} and similar methods are called. I'm not
+    #  entirely sure if this is needed, if not it should be modified.
     #
     class Speller
+      ##
+      # Array containing the possible suggestion modes to use.
+      #
+      # @since 18-04-2012
+      #
+      SUGGESTION_MODES = ['ultra', 'fast', 'normal', 'bad-spellers']
+
       ##
       # Creates a new instance of the class, sets the language as well as the
       # options specified in the `options` hash.
@@ -16,8 +97,12 @@ module FFI
       # @param [Hash] options A hash containing extra configuration options,
       #  such as the "personal" option to set.
       #
-      def initialize(language, options = {})
+      def initialize(language = nil, options = {})
+        @config = Aspell.config_new
 
+        options['lang'] = language if language
+
+        options.each { |k, v| set(k, v) }
       end
 
       ##
@@ -28,7 +113,64 @@ module FFI
       # @return [TrueClass|FalseClass]
       #
       def correct?(word)
+        unless word.is_a?(String)
+          raise(TypeError, "Expected String but got #{word.class} instead")
+        end
+
+        speller = Aspell.speller_new(@config)
+        correct = Aspell.speller_check(speller, word.to_s, word.length)
+
+        Aspell.speller_delete(speller)
 
+        return correct
+      end
+
+      ##
+      # Returns an array containing words suggested as an alternative to the
+      # specified word.
+      #
+      # @since  13-04-2012
+      # @param  [String] word The word for which to generate a suggestion list.
+      # @return [Array]
+      #
+      def suggestions(word)
+        unless word.is_a?(String)
+          raise(TypeError, "Expected String but got #{word.class} instead")
+        end
+
+        speller     = Aspell.speller_new(@config)
+        list        = Aspell.speller_suggest(speller, word, word.length)
+        suggestions = []
+        elements    = Aspell.word_list_elements(list)
+
+        while word = Aspell.string_enumeration_next(elements)
+          suggestions << word
+        end
+
+        Aspell.string_enumeration_delete(elements)
+        Aspell.speller_delete(speller)
+
+        return suggestions
+      end
+
+      ##
+      # Sets the suggestion mode for {FFI::Aspell::Speller#suggestions}.
+      #
+      # @since 13-04-2012
+      # @param [String] mode The suggestion mode to use.
+      #
+      def suggestion_mode=(mode)
+        set('sug-mode', mode)
+      end
+
+      ##
+      # Returns the suggestion mode that's currently used.
+      #
+      # @since  13-04-2012
+      # @return [String]
+      #
+      def suggestion_mode
+        return get('sug-mode')
       end
 
       ##
@@ -38,23 +180,92 @@ module FFI
       # @param [#to_s] key The configuration key to set.
       # @param [#to_s] value The value of the configuration key.
       # @raise [FFI::Aspell::ConfigError] Raised when the configuration value
-      #  could not be set.
+      #  could not be set or when an incorrect suggestion mode was given.
       #
       def set(key, value)
+        unless key.respond_to?(:to_s)
+          raise(TypeError, 'Configuration keys should respond to #to_s()')
+        end
+
+        unless value.respond_to?(:to_s)
+          raise(TypeError, 'Configuration values should respond to #to_s()')
+        end
+
+        if key == 'sug-mode' and !SUGGESTION_MODES.include?(value)
+          raise(ConfigError, "The suggestion mode #{value} is invalid")
+        end
 
+        unless Aspell.config_replace(@config, key.to_s, value.to_s)
+          raise(ConfigError, "Failed to set the configuration item #{key}")
+        end
       end
 
       ##
       # Retrieves the value of the specified configuration item.
       #
       # @since  13-04-2012
-      # @param  [String] key The configuration key to retrieve.
+      # @param  [#to_s] key The configuration key to retrieve.
       # @return [String]
       # @raise  [FFI::Aspell::ConfigError] Raised when the configuration item
       #  does not exist.
       #
       def get(key)
+        unless key.respond_to?(:to_s)
+          raise(TypeError, 'Configuration keys should respond to #to_s()')
+        end
+
+        value = Aspell.config_retrieve(@config, key.to_s)
+
+        if value
+          return value
+        else
+          raise(ConfigError, "The configuration item #{key} does not exist")
+        end
+      end
+
+      ##
+      # Retrieves the default value for the given configuration key.
+      #
+      # @since  13-04-2012
+      # @param  [#to_s] key The name of the configuration key.
+      # @return [String]
+      # @raise  [FFI::Aspell::ConfigError] Raised when the configuration item
+      #  does not exist.
+      #
+      def get_default(key)
+        unless key.respond_to?(:to_s)
+          raise(TypeError, 'Configuration keys should respond to #to_s()')
+        end
+
+        value = Aspell.config_retrieve_default(@config, key.to_s)
+
+        if value
+          return value
+        else
+          raise(ConfigError, "The configuration item #{key} does not exist")
+        end
+      end
+
+      ##
+      # Resets a configuration item to its default value.
+      #
+      # @since 13-04-2012
+      # @param [#to_s] key The name of the configuration item to reset.
+      # @raise [FFI::Aspell::ConfigError] Raised when the configuration item
+      #  could not be reset.
+      #
+      def reset(key)
+        unless key.respond_to?(:to_s)
+          raise(TypeError, 'Configuration keys should respond to #to_s()')
+        end
 
+        unless Aspell.config_remove(@config, key.to_s)
+          raise(
+            ConfigError,
+            "The configuration item #{key} could not be reset, most likely " \
+              "it doesn't exist"
+          )
+        end
       end
     end # Speller
   end # Aspell

data/lib/ffi/aspell/version.rb

@@ -1,5 +1,5 @@
 module FFI
   module Aspell
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end # Aspell
 end # FFI

data/lib/ffi/aspell.rb

@@ -1,13 +1,22 @@
 require 'ffi'
 
-$:.unshift(File.expand_path('../', __FILE__))
-
-require 'aspell/error'
-require 'aspell/speller'
+require File.expand_path('../aspell/error', __FILE__)
+require File.expand_path('../aspell/speller', __FILE__)
+require File.expand_path('../aspell/version', __FILE__)
 
 module FFI
   ##
-  # FFI::Aspell is an FFI binding for the Aspell spell checking library.
+  # FFI::Aspell is an FFI binding for the Aspell spell checking library. Basic
+  # usage is as following:
+  #
+  #     require 'ffi/aspell'
+  #
+  #     speller = FFI::Aspell::Speller.new
+  #
+  #     speller.correct?('cookie') # => true
+  #     speller.correct?('cookei') # => false
+  #
+  # For more information see {FFI::Aspell::Speller}.
   #
   # @since 13-04-2012
   #
@@ -15,41 +24,235 @@ module FFI
     extend   FFI::Library
     ffi_lib 'aspell'
 
-    # Configuration functions.
+    ##
+    # Creates a pointer for a configuration struct.
+    #
+    # @since  24-04-2012
+    # @method config_new
+    # @scope  class
+    # @return [FFI::Pointer]
+    #
     attach_function 'config_new',
       'new_aspell_config',
       [],
       :pointer
 
+    ##
+    # Retrieves the value of a given configuration item. The value is returned
+    # as a string or nil upon failure.
+    #
+    # @example
+    #  config = FFI::Aspell.config_new
+    #  value  = FFI::Aspell.config_retrieve(config, 'lang')
+    #
+    #  puts value # => "en_US"
+    #
+    # @since  24-04-2012
+    # @method config_retrieve(config, key)
+    # @scope  class
+    # @param  [FFI::Pointer] config A pointer to a configuration struct.
+    # @param  [String] key The name of the configuration item to retrieve.
+    # @return [String]
+    #
     attach_function 'config_retrieve',
       'aspell_config_retrieve',
       [:pointer, :string],
       :string
 
-    attach_function 'config_get_default',
+    ##
+    # Retrieves the default value of a configuration item.
+    #
+    # @since  24-04-2012
+    # @method config_retrieve_default(config, key)
+    # @scope  class
+    # @see    FFI::Aspell.config_retrieve
+    #
+    attach_function 'config_retrieve_default',
       'aspell_config_get_default',
       [:pointer, :string],
       :string
 
+    ##
+    # Sets the new value of the specified configuration item.
+    #
+    # @example
+    #  config = FFI::Aspell.config_new
+    #
+    #  FFI::Aspell.config_replace(config, 'lang', 'nl')
+    #
+    # @since  24-04-2012
+    # @method config_replace(config, key, value)
+    # @scope  class
+    # @param  [FFI::Pointer] config Pointer to the configuration struct.
+    # @param  [String] key The name of the configuration item to set.
+    # @param  [String] value The new value of the configuration item.
+    # @return [TrueClass|FalseClass]
+    #
     attach_function 'config_replace',
       'aspell_config_replace',
       [:pointer, :string, :string],
       :bool
 
+    ##
+    # Sets the value of the specified configuration item back to its default
+    # value.
+    #
+    # @example
+    #  config = FFI::Aspell.config_new
+    #
+    #  FFI::Aspell.config_replace(config, 'lang', 'nl')
+    #  FFI::Aspell.config_remove(config, 'lang')
+    #
+    # @since  24-04-2012
+    # @method config_remove(config, key)
+    # @scope  class
+    # @param  [FFI::Pointer] config Pointer to the configuration struct.
+    # @param  [String] key The name of the configuration item to reset.
+    # @return [TrueClass|FalseClass]
+    #
     attach_function 'config_remove',
       'aspell_config_remove',
       [:pointer, :string],
       :bool
 
     # Spell checking related functions.
+
+    ##
+    # Creates a pointer to a speller struct.
+    #
+    # @example
+    #  config  = FFI::Aspell.config_new
+    #  speller = FFI::Aspell.speller_new(config)
+    #
+    # @since  24-04-2012
+    # @method speller_new(config)
+    # @scope  class
+    # @param  [FFI::Pointer] config The configuration struct to use for the
+    #  speller.
+    # @return [FFI::Pointer]
+    #
     attach_function 'speller_new',
       'new_aspell_speller',
       [:pointer],
       :pointer
 
+    ##
+    # Removes a speller pointer and frees the memory associated with said
+    # pointer.
+    #
+    # @since  24-04-2012
+    # @method speller_delete(speller)
+    # @scope  class
+    # @param  [FFI::Pointer] speller The pointer to remove.
+    #
+    attach_function 'speller_delete',
+      'delete_aspell_speller',
+      [:pointer],
+      :void
+
+    ##
+    # Checks if a given word is spelled correctly or not. If the word is valid
+    # `true` will be returned, `false` otherwise.
+    #
+    # @example
+    #  config  = FFI::Aspell.config_new
+    #  speller = FFI::Aspell.speller_new(config)
+    #  word    = 'cookie'
+    #  valid   = FFI::Aspell.speller_check(speller, word, word.length)
+    #
+    #  if valid
+    #    puts 'The word "cookie" is valid'
+    #  else
+    #    puts 'The word "cookie" is invalid'
+    #  end
+    #
+    # @since  24-04-2012
+    # @method speller_check(speller, word, length)
+    # @scope  class
+    # @param  [FFI::Pointer] speller Pointer to a speller struct to use.
+    # @param  [String] word The word to check.
+    # @param  [Fixnum] length The length of the word.
+    # @return [TrueClass|FalseClass]
+    #
     attach_function 'speller_check',
       'aspell_speller_check',
       [:pointer, :string, :int],
       :bool
+
+    # Functions for dealing with suggestions.
+
+    ##
+    # Returns a pointer that can be used to retrieve a list of suggestions for a
+    # given word.
+    #
+    # @since  24-04-2012
+    # @method speller_suggest(speller, word, length)
+    # @see    FFI::Aspell.speller_check
+    # @return [FFI::Pointer]
+    #
+    attach_function 'speller_suggest',
+      'aspell_speller_suggest',
+      [:pointer, :string, :int],
+      :pointer
+
+    ##
+    # Returns a pointer to a list which can be used by
+    # {FFI::Aspell.string_enumeration_next} to retrieve all the suggested words.
+    #
+    # @since  24-04-2012
+    # @method word_list_elements(suggestions)
+    # @scope  class
+    # @param  [FFI::Pointer] suggestions A pointer with suggestions as returned
+    #  by {FFI::Aspell.speller_suggest}
+    # @return [FFI::Pointer]
+    #
+    attach_function 'word_list_elements',
+      'aspell_word_list_elements',
+      [:pointer],
+      :pointer
+
+    ##
+    # Removes the pointer returned by {FFI::Aspell.word_list_elements} and frees
+    # the associated memory.
+    #
+    # @since  24-04-2012
+    # @method string_enumeration_delete(elements)
+    # @scope  class
+    # @param  [FFI::Pointer] elements A pointer for a list of elements as
+    #  returned by {FFI::Aspell.word_list_elements}.
+    #
+    attach_function 'string_enumeration_delete',
+      'delete_aspell_string_enumeration',
+      [:pointer],
+      :void
+
+    ##
+    # Retrieves the next item in the list of suggestions.
+    #
+    # @example
+    #  speller  = FFI::Aspell.speller_new(FFI::Aspell.config_new)
+    #  word     = 'cookie'
+    #  list     = FFI::Aspell.speller_suggest(speller, word, word.length)
+    #  elements = FFI::Aspell.word_list_elements(list)
+    #  words    = []
+    #
+    #  while word = FFI::Aspell.string_enumeration_next(elements)
+    #    words << word
+    #  end
+    #
+    #  FFI::Aspell.string_enumeration_delete(elements)
+    #  FFI::Aspell.speller_delete(speller)
+    #
+    # @since  24-04-2012
+    # @method string_enumeration_next(elements)
+    # @scope  class
+    # @param  [FFI::Pointer] elements Pointer to a list of elements as returned
+    #  by {FFI::Aspell.word_list_elements}.
+    # @return [String|NilClass]
+    #
+    attach_function 'string_enumeration_next',
+      'aspell_string_enumeration_next',
+      [:pointer],
+      :string
   end # Aspell
 end # FFI

data/spec/ffi/aspell/speller.rb

@@ -0,0 +1,98 @@
+require File.expand_path('../../../helper', __FILE__)
+
+describe 'FFI::Aspell::Speller' do
+  it 'Set the language in the constructor' do
+    FFI::Aspell::Speller.new.get('lang').should       == 'en_US'
+    FFI::Aspell::Speller.new('en').get('lang').should == 'en'
+    FFI::Aspell::Speller.new('nl').get('lang').should == 'nl'
+  end
+
+  it 'Set options in the constructor' do
+    FFI::Aspell::Speller.new.get('personal').should == '.aspell.en_US.pws'
+
+    FFI::Aspell::Speller.new('en', :personal => 'foo') \
+      .get(:personal).should == 'foo'
+  end
+
+  it 'Raise when setting a non existing option' do
+    should.raise(FFI::Aspell::ConfigError) do
+      FFI::Aspell::Speller.new.set('foo', 'bar')
+    end
+  end
+
+  it 'Raise when retrieving a non existing option' do
+    should.raise(FFI::Aspell::ConfigError) do
+      FFI::Aspell::Speller.new.get('foo')
+    end
+  end
+
+  it 'Retrieve the default value of an option' do
+    FFI::Aspell::Speller.new.get_default('personal') \
+      .should == '.aspell.en_US.pws'
+  end
+
+  it 'Reset an option to its default value' do
+    speller = FFI::Aspell::Speller.new
+
+    speller.set('personal', 'foo')
+
+    speller.get('personal').should == 'foo'
+
+    speller.reset('personal')
+
+    speller.get('personal').should == '.aspell.en_US.pws'
+  end
+
+  it 'Validate various English words' do
+    speller = FFI::Aspell::Speller.new('en')
+
+    speller.correct?('cookie').should == true
+    speller.correct?('werld').should  == false
+    speller.correct?('house').should  == true
+    speller.correct?('huis').should   == false
+  end
+
+  it 'Validate various Dutch words' do
+    speller = FFI::Aspell::Speller.new('nl')
+
+    speller.correct?('koekje').should == true
+    speller.correct?('werld').should  == false
+    speller.correct?('huis').should   == true
+  end
+
+  it 'Change the language of an existing speller object' do
+    speller = FFI::Aspell::Speller.new
+
+    speller.correct?('house').should == true
+    speller.correct?('huis').should  == false
+
+    speller.set('lang', 'nl')
+
+    speller.correct?('house').should == true
+    speller.correct?('huis').should  == true
+  end
+
+  it 'Use an English personal word list' do
+    speller = FFI::Aspell::Speller.new('en')
+
+    speller.correct?('github').should == false
+    speller.correct?('nodoc').should  == false
+
+    speller.set(:personal, File.join(FIXTURES, 'personal.en.pws'))
+
+    speller.correct?('github').should == true
+    speller.correct?('nodoc').should  == true
+  end
+
+  it 'Use a Dutch personal word list' do
+    speller = FFI::Aspell::Speller.new('nl')
+
+    speller.correct?('github').should == false
+    speller.correct?('nodoc').should  == false
+
+    speller.set(:personal, File.join(FIXTURES, 'personal.nl.pws'))
+
+    speller.correct?('github').should == true
+    speller.correct?('nodoc').should  == true
+  end
+end

data/spec/ffi/aspell/suggestions.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../../../helper', __FILE__)
+
+describe 'FFI::Aspell::Speller#suggestions' do
+  it 'Return a list of word suggestions using the default mode' do
+    speller     = FFI::Aspell::Speller.new
+    suggestions = speller.suggestions('cookei')
+
+    suggestions.include?('coke').should   == true
+    suggestions.include?('cookie').should == true
+    suggestions.include?('cooked').should == true
+  end
+
+  it 'Return a list of word suggestions using the "bad-spellers" mode' do
+    speller = FFI::Aspell::Speller.new
+
+    # Get the amount of suggestions for the normal mode. The "bad-spellers" mode
+    # should result in a lot more possible suggestions.
+    normal_length = speller.suggestions('cookei').length
+
+    speller.suggestion_mode = 'bad-spellers'
+    suggestions             = speller.suggestions('cookei')
+
+    suggestions.include?('coke').should   == true
+    suggestions.include?('cookie').should == true
+    suggestions.include?('cooked').should == true
+
+    suggestions.length.should > normal_length
+  end
+
+  it 'Raise an error when an invalid suggestion mode is used' do
+    speller = FFI::Aspell::Speller.new
+
+    should.raise(FFI::Aspell::ConfigError) do
+      speller.suggestion_mode = 'does-not-exist'
+    end
+
+    speller.suggestion_mode.should == 'normal'
+
+    should.not.raise(FFI::Aspell::ConfigError) do
+      speller.suggestion_mode = 'ultra'
+    end
+
+    speller.suggestion_mode.should == 'ultra'
+  end
+end

data/spec/fixtures/personal.en.pws

@@ -0,0 +1,3 @@
+personal_ws-1.1 en 2 utf-8
+github
+nodoc

data/spec/fixtures/personal.nl.pws

@@ -0,0 +1,3 @@
+personal_ws-1.1 nl 2 utf-8
+github
+nodoc

data/spec/helper.rb

@@ -0,0 +1,7 @@
+require 'bacon'
+require File.expand_path('../../lib/ffi/aspell', __FILE__)
+
+Bacon.extend(Bacon::TapOutput)
+Bacon.summary_on_exit
+
+FIXTURES = File.expand_path('../fixtures', __FILE__)

data/task/build.rake

@@ -0,0 +1,15 @@
+namespace :build do
+  desc 'Builds a new Gem'
+  task :gem do
+    root    = File.expand_path('../../', __FILE__)
+    gemspec = Gem::Specification.load(File.join(root, 'ffi-aspell.gemspec'))
+    name    = "#{gemspec.name}-#{gemspec.version.version}.gem"
+    path    = File.join(root, name)
+    pkg     = File.join(root, 'pkg', name)
+
+    # Build and install the gem
+    sh('gem', 'build', File.join(root, 'ffi-aspell.gemspec'))
+    sh('mv' , path, pkg)
+    sh('gem', 'install', pkg)
+  end
+end

data/task/memory.rake

@@ -0,0 +1,50 @@
+# Cheap way of benchmarking the memory usage of various parts of the FFI
+# binding.
+def benchmark_block(amount = 10000)
+  require File.expand_path('../../lib/ffi/aspell', __FILE__)
+
+  start_mem = `ps -o rss= #{Process.pid}`.to_f
+
+  amount.times { yield }
+
+  mem = ((`ps -o rss= #{Process.pid}`.to_f - start_mem) / 1024).round(2)
+
+  puts "Memory increase in Megabytes: #{mem} MB"
+end
+
+namespace :memory do
+  memory = proc { `ps -o rss= #{Process.pid}`.to_i }
+
+  desc 'Show memory usage of Aspell.speller_new'
+  task :speller, [:amount] do |task, args|
+    args.with_defaults(:amount => 10000)
+
+    benchmark_block(args.amount) do
+      speller = FFI::Aspell.speller_new(FFI::Aspell.config_new)
+
+      FFI::Aspell.speller_delete(speller)
+    end
+  end
+
+  desc 'Show memory usage of Speller#correct?'
+  task :correct, [:amount] do |task, args|
+    args.with_defaults(:amount => 10000)
+
+    benchmark_block(args.amount) do
+      speller = FFI::Aspell::Speller.new
+
+      speller.correct?('cookie')
+    end
+  end
+
+  desc 'Show memory usage of Speller#suggestions'
+  task :suggestions, [:amount] do |task, args|
+    args.with_defaults(:amount => 10000)
+
+    benchmark_block(args.amount) do
+      speller = FFI::Aspell::Speller.new
+
+      speller.suggestions('cookei')
+    end
+  end
+end

data/task/test.rake

@@ -0,0 +1,4 @@
+desc 'Runs all the tests using Bacon'
+task :test do
+  Dir['./spec/ffi/aspell/**/*.rb'].sort.each { |spec| require(spec) }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-aspell
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.11
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -81,10 +97,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./lib/ffi/aspell.rb
-- ./lib/ffi/aspell/version.rb
-- ./lib/ffi/aspell/error.rb
-- ./lib/ffi/aspell/speller.rb
+- .gems
+- .gitignore
+- .rvmrc
+- .yardopts
+- LICENSE
+- README.md
+- Rakefile
+- ffi-aspell.gemspec
+- lib/ffi/aspell.rb
+- lib/ffi/aspell/error.rb
+- lib/ffi/aspell/speller.rb
+- lib/ffi/aspell/version.rb
+- pkg/.gitkeep
+- spec/ffi/aspell/speller.rb
+- spec/ffi/aspell/suggestions.rb
+- spec/fixtures/personal.en.pws
+- spec/fixtures/personal.nl.pws
+- spec/helper.rb
+- task/build.rake
+- task/memory.rake
+- task/test.rake
 homepage: https://github.com/YorickPeterse/ffi-aspell
 licenses: []
 post_install_message: 
@@ -105,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: FFI bindings for Aspell