ffi-aspell 0.0.1

data/lib/ffi/aspell.rb

@@ -0,0 +1,55 @@
+require 'ffi'
+
+$:.unshift(File.expand_path('../', __FILE__))
+
+require 'aspell/error'
+require 'aspell/speller'
+
+module FFI
+  ##
+  # FFI::Aspell is an FFI binding for the Aspell spell checking library.
+  #
+  # @since 13-04-2012
+  #
+  module Aspell
+    extend   FFI::Library
+    ffi_lib 'aspell'
+
+    # Configuration functions.
+    attach_function 'config_new',
+      'new_aspell_config',
+      [],
+      :pointer
+
+    attach_function 'config_retrieve',
+      'aspell_config_retrieve',
+      [:pointer, :string],
+      :string
+
+    attach_function 'config_get_default',
+      'aspell_config_get_default',
+      [:pointer, :string],
+      :string
+
+    attach_function 'config_replace',
+      'aspell_config_replace',
+      [:pointer, :string, :string],
+      :bool
+
+    attach_function 'config_remove',
+      'aspell_config_remove',
+      [:pointer, :string],
+      :bool
+
+    # Spell checking related functions.
+    attach_function 'speller_new',
+      'new_aspell_speller',
+      [:pointer],
+      :pointer
+
+    attach_function 'speller_check',
+      'aspell_speller_check',
+      [:pointer, :string, :int],
+      :bool
+  end # Aspell
+end # FFI

data/lib/ffi/aspell/error.rb

@@ -0,0 +1,11 @@
+module FFI
+  module Aspell
+    ##
+    # 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

@@ -0,0 +1,61 @@
+module FFI
+  module Aspell
+    ##
+    # The Speller class is used for spell checking individual words as well as
+    # generating a list of suggestions.
+    #
+    # @since 13-04-2012
+    #
+    class Speller
+      ##
+      # 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.
+      #
+      def initialize(language, options = {})
+
+      end
+
+      ##
+      # Checks if the given word is correct or not.
+      #
+      # @since  13-04-2012
+      # @param  [String] word The word to check.
+      # @return [TrueClass|FalseClass]
+      #
+      def correct?(word)
+
+      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 [FFI::Aspell::ConfigError] Raised when the configuration value
+      #  could not be set.
+      #
+      def set(key, value)
+
+      end
+
+      ##
+      # Retrieves the value of the specified configuration item.
+      #
+      # @since  13-04-2012
+      # @param  [String] key The configuration key to retrieve.
+      # @return [String]
+      # @raise  [FFI::Aspell::ConfigError] Raised when the configuration item
+      #  does not exist.
+      #
+      def get(key)
+
+      end
+    end # Speller
+  end # Aspell
+end # FFI

data/lib/ffi/aspell/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: ffi-aspell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yorick Peterse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-13 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.11
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: FFI bindings for Aspell
+email: yorickpeterse@gmail.com
+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
+homepage: https://github.com/YorickPeterse/ffi-aspell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: FFI bindings for Aspell
+test_files: []
+has_rdoc: yard