ffi-aspell 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d04d81f2d51d61e43e32ac2212789bb04bd2db60
-  data.tar.gz: 9a92c7b85b9f079ea4f2c033cab554be7272c1e7
+  metadata.gz: 9de124725c6b91091475f71adab06a9fd3ab3895
+  data.tar.gz: afa6929f7f48223e2ae5f9f2baac4fc70217776e
 SHA512:
-  metadata.gz: f88c9093936ceab1e8b4da735890b4e47b99d2741dc1b43c2d133b54ebdc23a8e261c1f4e5c08e284554bc42ca3dda7d01886d7197ea3b21a34e1313af1ccad3
-  data.tar.gz: 2b6c55c9e9e30cdb03e858d795b5828cf1e19a4a21c3e72c1eca3932e793763f17c92b6b39f74af2e6290bb1a35837cf53c95e73a0c889047154d5608eb76f71
+  metadata.gz: 96f4d2869585cbe7ed271ec0e746f86a0b610cb2c5376e584b1fc0d599bbf674495cad396d7474c898d8f0a452b600191fc6ee7d71d60703768a1c6c4eeca6ef
+  data.tar.gz: 907f703554fe23a837c966e0e879379e4b9c964fe656e11a4d21f10d2ce337110791b9ec6933ba7ae858c9ba8f4d1b0eaaa56d1170f659502ea0373136b5602d

data/doc/changelog.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 1.0.1 - 201411-05
+## 1.0.2 - 2014-11-13
+
+The Speller class now checks if a dictionary is installed upon initialization or
+when updating a speller (instead of just crashing). See
+<https://github.com/YorickPeterse/ffi-aspell/pull/20> for more information.
+
+## 1.0.1 - 2014-11-05
 
 An alternative library name for Aspell was added so that this Gem now works on
 Ubuntu systems.

data/lib/ffi/aspell/aspell.rb

@@ -16,6 +16,13 @@ module FFI
     extend   FFI::Library
     ffi_lib ['aspell', 'libaspell.so.15']
 
+    ##
+    # Structure for storing dictionary information.
+    #
+    class DictInfo < FFI::Struct
+      layout :code, :string
+    end
+
     ##
     # Creates a pointer for a configuration struct.
     #
@@ -247,5 +254,63 @@ module FFI
       'aspell_string_enumeration_next',
       [:pointer],
       :string
+
+    ##
+    # Gets a list of all installed aspell dictionaries.
+    # 
+    # @method dict_info_list(config)
+    # @scope  class
+    # @param  [FFI::Pointer] config 
+    # @return [FFI::Pointer] list A list of dictionaries which can be used
+    # by {FFI::Aspell.dict_info_list_elements}.
+    #
+    attach_function 'dict_info_list',
+      'get_aspell_dict_info_list',
+      [:pointer],
+      :pointer
+
+    ##
+    # Gets all elements from the dictionary list.
+    # 
+    # @method dict_info_list_elements(list)
+    # @scope  class
+    # @param  [FFI::Pointer] list A list of dictionaries as returned
+    #  by {FFI::Aspell.dict_info_list}.
+    # @return [FFI::Pointer] dictionary Returns an enumeration of 
+    #  {FFI::Aspell::DictInfo} structs.
+    #
+    attach_function 'dict_info_list_elements',
+      'aspell_dict_info_list_elements',
+      [:pointer],
+      :pointer
+
+    ##
+    # Deletes an enumeration of dictionaries.
+    # 
+    # @method delete_dict_info_enumeration(enumeration)
+    # @scope  class
+    # @param  [FFI::Pointer] enumeration An enumeration of dictionaries returned
+    #  by {FFI::Aspell.dict_info_list_elements}.
+    #
+    attach_function 'delete_dict_info_enumeration',
+      'delete_aspell_dict_info_enumeration',
+      [:pointer],
+      :void
+
+    ##
+    # Retrieves the next element in the list of dictionaries.
+    # 
+    # @method dict_info_enumeration_next(elements)
+    # @scope  class
+    # @param  [FFI::Pointer] elements Pointer to a dictionary enumeration as returned
+    #  by {FFI::Aspell.dict_info_list_elements}.
+    # @return [DictInfo|NilClass] dictInfo Returns an object of {FFI::Aspell::DictInfo}
+    #  information, which contains dictionary information.
+    #
+    attach_function 'dict_info_enumeration_next',
+      'aspell_dict_info_enumeration_next',
+      [:pointer],
+      DictInfo
+
   end # Aspell
 end # FFI

data/lib/ffi/aspell/speller.rb

@@ -193,6 +193,15 @@ module FFI
         return @config.nil?
       end
 
+      ##
+      # Checks if a dictionary is available or not
+      #
+      # @return [TrueClass|FalseClass]
+      #
+      def dictionary_available?(dictionary)
+        return available_dictionaries.include?(dictionary)
+      end
+
       ##
       # Checks if the given word is correct or not.
       #
@@ -399,6 +408,19 @@ module FFI
         end
       end
 
+      ## 
+      # Raises error if used dictionary is not installed.
+      #
+      # @raise [ArgumentError] Raised if dictionary does not exist.
+      # @return [nil]
+      # 
+      def check_dictionary
+        dictionary = get('lang')
+        if !dictionary_available?(dictionary)
+          raise(ArgumentError, "The used dictionary #{dictionary.inspect} is not available")
+        end
+      end
+
       ##
       # Updates the internal speller object to use the current config.
       #
@@ -413,7 +435,31 @@ module FFI
           self,
           self.class.finalizer(@config, @speller)
         )
+
+        check_dictionary
+      end
+
+      ## 
+      # Get all availbale aspell dictionary codes
+      #
+      # @return [Array]
+      #
+      def available_dictionaries
+        list = Aspell.dict_info_list(@config)
+        elements = Aspell.dict_info_list_elements(list)
+        dicts = []
+
+        while element = Aspell.dict_info_enumeration_next(elements)
+          break if element == FFI::Pointer::NULL          
+          dict_info = Aspell::DictInfo.new(element)
+          dicts << handle_output(dict_info[:code])
+        end
+
+        Aspell.delete_dict_info_enumeration(elements)
+        
+        return dicts
       end
+
     end # Speller
   end # Aspell
 end # FFI

data/lib/ffi/aspell/version.rb

@@ -1,5 +1,5 @@
 module FFI
   module Aspell
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end # Aspell
 end # FFI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-aspell
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Yorick Peterse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi