ffi-aspell 0.0.3 → 1.0.0

data/lib/ffi/aspell/error.rb

@@ -4,8 +4,6 @@ module FFI
     # Error class used by methods such as {FFI::Aspell::Speller#get} and
     # {FFI::Aspell::Speller#set}.
     #
-    # @since 13-04-2012
-    #
     class ConfigError < StandardError; end
   end # Aspell
 end # FFI

data/lib/ffi/aspell/speller.rb

@@ -72,28 +72,83 @@ module FFI
     #
     #     speller.suggestions('cookei') # => ["cookie", ...]
     #
+    # ### Cleaning up
+    #
+    # When you're finished with the `Speller` object, you can let the finalizer
+    # automatically free resources, otherwise, call {#close} to explicitly free
+    # the underlying resources:
+    #
+    #     speller = FFI::Aspell::Speller.new
+    #     speller.correct?('cookie') # => true
+    #     speller.close
+    #
+    # Alternatively, you can use the block form of {.open} to automatically
+    # free the resources:
+    #
+    #     FFI::Aspell::Speller.open do |speller|
+    #       puts speller.correct?('cookie') # => prints "true"
+    #     end
+    #
+    # {.open} takes the same parameters as {Speller#initialize Speller.new}.
+    #
     # 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
+      # @return [Array]
       #
       SUGGESTION_MODES = ['ultra', 'fast', 'normal', 'bad-spellers']
 
+      ##
+      # Creates a new instance of the class. If a block is given, the instance
+      # is yielded and automatically closed when exiting the block.
+      #
+      # @yield  If a block is given, the speller instance is yielded.
+      #
+      # @yieldparam [Speller] speller The created speller. {Speller#close} is
+      #  automatically called when exiting the block.
+      #
+      # @return [Speller]
+      #
+      # @see [#initialize]
+      #
+      def self.open(*args)
+        speller = self.new(*args)
+
+        if block_given?
+          begin
+            yield speller
+          ensure
+            speller.close
+          end
+        end
+
+        return speller
+      end
+
+      ##
+      # Returns a proc for a finalizer, used for cleaning up native resources.
+      #
+      # @param  [FFI::Pointer] config
+      # @param  [FFI::Pointer] speller
+      # @return [Proc]
+      #
+      def self.finalizer(config, speller)
+        return proc {
+          Aspell.config_delete(config)
+          Aspell.speller_delete(speller)
+        }
+      end
+
       ##
       # Creates a new instance of the class, sets the language as well as the
       # options specified in the `options` hash.
       #
-      # @since 13-04-2012
       # @param [String] language The language to use.
+      #
       # @param [Hash] options A hash containing extra configuration options,
       #  such as the "personal" option to set.
       #
@@ -103,29 +158,61 @@ module FFI
         options['lang'] = language if language
 
         options.each { |k, v| set(k, v) }
+
+        update_speller
+      end
+
+      ##
+      # Closes the speller and frees underlying resources. Calling this is not
+      # absolutely required as the resources will eventually be freed by the
+      # finalizer.
+      #
+      # @raise [RuntimeError] Raised if the speller is closed.
+      #
+      def close
+        check_closed
+
+        # Remove finalizer since we're manually freeing resources.
+        ObjectSpace.undefine_finalizer(self)
+
+        Aspell.config_delete(@config)
+
+        @config = nil
+
+        Aspell.speller_delete(@speller)
+
+        @speller = nil
+      end
+
+      ##
+      # Checks if the speller is closed or not.
+      #
+      # @return [TrueClass|FalseClass]
+      #
+      def closed?
+        return @config.nil?
       end
 
       ##
       # Checks if the given word is correct or not.
       #
-      # @since  13-04-2012
       # @param  [String] word The word to check.
+      # @raise  [RuntimeError] Raised if the speller is closed.
       # @return [TrueClass|FalseClass]
       #
       def correct?(word)
+        check_closed
+
         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,
+          @speller,
           handle_input(word.to_s),
           word.bytesize
         )
 
-        Aspell.speller_delete(speller)
-
         return correct
       end
 
@@ -133,21 +220,23 @@ module FFI
       # 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.
+      # @raise  [RuntimeError] Raised if the speller is closed.
       # @return [Array]
       #
       def suggestions(word)
+        check_closed
+
         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,
+        list = Aspell.speller_suggest(
+          @speller,
           handle_input(word),
           word.bytesize
         )
+
         suggestions = []
         elements    = Aspell.word_list_elements(list)
 
@@ -156,7 +245,6 @@ module FFI
         end
 
         Aspell.string_enumeration_delete(elements)
-        Aspell.speller_delete(speller)
 
         return suggestions
       end
@@ -164,40 +252,38 @@ module FFI
       ##
       # Sets the suggestion mode for {FFI::Aspell::Speller#suggestions}.
       #
-      # @since 13-04-2012
       # @param [String] mode The suggestion mode to use.
+      # @raise [RuntimeError] Raised if the speller is closed.
       #
       def suggestion_mode=(mode)
+        check_closed
+
         set('sug-mode', mode)
       end
 
       ##
       # Returns the suggestion mode that's currently used.
       #
-      # @since  13-04-2012
+      # @raise  [RuntimeError] Raised if the speller is closed.
       # @return [String]
       #
       def suggestion_mode
+        check_closed
+
         return get('sug-mode')
       end
 
       ##
       # Sets a configuration option.
       #
-      # @since 13-04-2012
       # @param [#to_s] key The configuration key to set.
       # @param [#to_s] value The value of the configuration key.
+      # @raise [RuntimeError] Raised if the speller is closed.
       # @raise [FFI::Aspell::ConfigError] Raised when the configuration value
       #  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
+        check_closed
 
         if key == 'sug-mode' and !SUGGESTION_MODES.include?(value)
           raise(ConfigError, "The suggestion mode #{value} is invalid")
@@ -206,21 +292,21 @@ module FFI
         unless Aspell.config_replace(@config, key.to_s, value.to_s)
           raise(ConfigError, "Failed to set the configuration item #{key}")
         end
+
+        update_speller
       end
 
       ##
       # Retrieves the value of the specified configuration item.
       #
-      # @since  13-04-2012
       # @param  [#to_s] key The configuration key to retrieve.
       # @return [String]
+      # @raise  [RuntimeError] Raised if the speller is closed.
       # @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
+        check_closed
 
         value = Aspell.config_retrieve(@config, key.to_s)
 
@@ -234,16 +320,14 @@ module FFI
       ##
       # 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  [RuntimeError] Raised if the speller is closed.
       # @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
+        check_closed
 
         value = Aspell.config_retrieve_default(@config, key.to_s)
 
@@ -257,15 +341,13 @@ module FFI
       ##
       # 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 [RuntimeError] Raised if the speller is closed.
       # @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
+        check_closed
 
         unless Aspell.config_remove(@config, key.to_s)
           raise(
@@ -274,41 +356,64 @@ module FFI
               "it doesn't exist"
           )
         end
+
+        update_speller
       end
 
+      private
+
       ##
       # Converts word to encoding expected in aspell
       # from current ruby encoding
       #
-      # @param [String] word The word to convert
-      # return [String] word
+      # @param  [String] word The word to convert
+      # @return [String] word
       #
       def handle_input(word)
-        if defined?(Encoding)
-          enc = get('encoding')
-          word.encode!(enc)
-        end
+        enc = get('encoding')
 
-        word
+        return word.encode(enc)
       end
-      private :handle_input
 
       ##
       # Converts word from aspell encoding to what ruby expects
       #
-      # @param [String] word The word to convert
-      # return [String] word
+      # @param  [String] word The word to convert
+      # @return [String] word
       #
       def handle_output(word)
-        if defined?(Encoding)
-          enc = get('encoding')
-          word.force_encoding(enc).encode!
-        end
+        enc = get('encoding')
 
-        word
+        return word.force_encoding(enc).encode
+      end
+
+      ##
+      # Raises error if speller is closed.
+      #
+      # @raise  [RuntimeError] Raised if the speller is closed.
+      # @return [nil]
+      #
+      def check_closed
+        if closed?
+          raise(RuntimeError, 'This Speller object has already been closed')
+        end
       end
-      private :handle_output
 
+      ##
+      # Updates the internal speller object to use the current config.
+      #
+      def update_speller
+        ObjectSpace.undefine_finalizer(self)
+
+        Aspell.speller_delete(@speller)
+
+        @speller = Aspell.speller_new(@config)
+
+        ObjectSpace.define_finalizer(
+          self,
+          self.class.finalizer(@config, @speller)
+        )
+      end
     end # Speller
   end # Aspell
 end # FFI

data/lib/ffi/aspell/version.rb

@@ -1,5 +1,5 @@
 module FFI
   module Aspell
-    VERSION = '0.0.3'
+    VERSION = '1.0.0'
   end # Aspell
 end # FFI

metadata

@@ -1,146 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: ffi-aspell
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Yorick Peterse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-07 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.11
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.11
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bacon
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
 description: FFI bindings for Aspell
 email: yorickpeterse@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .yardopts
-- Gemfile
+- ".yardopts"
 - LICENSE
-- README.md
-- Rakefile
-- ffi-aspell.gemspec
+- doc/DCO.md
+- doc/changelog.md
+- doc/css/common.css
 - lib/ffi/aspell.rb
+- lib/ffi/aspell/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
+homepage: https://github.com/yorickpeterse/ffi-aspell
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: FFI bindings for Aspell
 test_files: []
 has_rdoc: yard