ffi-aspell 0.0.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d5f68f43c75d63cc6396df932cc489fdd686e6b
+  data.tar.gz: 9dff43b8df8ecf21e50a6dec8ef569e1714f51be
+SHA512:
+  metadata.gz: c5055b910a021d5ca54b2aa779528c5c77cc8eda99e2db966e33b58c1f981b42d6e4ae4c3e9e3c59c395db818bc97a2f01f80e58b848979e7b2321a2b7cd7fbe
+  data.tar.gz: 3cabedaa1799f4ecdb46f4c7454df765c98953718389d79a83687f4fd9bae9e252a0d2b53473b0314e743018f11086aac7a6ac9ea94adc3184c028e069c286db

data/.yardopts

@@ -1,9 +1,13 @@
-./lib/ffi/**/*.rb
+./lib/ffi/aspell/**/*.rb ./lib/ffi/aspell.rb
 -m markdown
--M redcarpet
--o ./doc
+-M kramdown
+-o yardoc
 -r ./README.md
 --private
 --protected
+--asset ./doc/css/common.css:css/common.css
+--verbose
 -
+./doc/*.md
 LICENSE
+CONTRIBUTING.md

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012, Yorick Peterse
+Copyright (c) 2012 - 2014, 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

data/doc/DCO.md

@@ -0,0 +1,25 @@
+# Developer's Certificate of Origin 1.0
+
+By making a contribution to this project, I certify that:
+
+1. The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file LICENSE; or
+
+2. The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file LICENSE; or
+
+3. The contribution was provided directly to me by some other
+   person who certified (1), (2) or (3) and I have not modified
+   it.
+
+4. I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.

data/doc/changelog.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 1.0.0 - 2014-09-10
+
+The first stable release of the Gem (at least according to semver). This release
+contains a bunch of under the hood changes, a new project structure and a new
+test suite.
+
+The biggest change is that thanks to Chris Schmich
+(<https://github.com/schmich>) ffi-aspell no longer leaks certain native
+resources. A finalizer is used to clean up these resources but you can
+explicitly free them by calling `close` on a speller object. See the following
+issues/pull-requests for more information:
+
+* <https://github.com/YorickPeterse/ffi-aspell/pull/15>
+* <https://github.com/YorickPeterse/ffi-aspell/pull/16>
+* <https://github.com/YorickPeterse/ffi-aspell/pull/17>
+
+Another big change, and one of the reasons for the major version increase, is
+the removal of support for Ruby 1.8.7. To be exact, ffi-aspell now requires Ruby
+1.9.3 or newer. This simplifies some of the internal encoding handling and just
+generally makes my life easier.

data/doc/css/common.css

@@ -0,0 +1,76 @@
+body
+{
+    font-size:   14px;
+    line-height: 1.6;
+    margin:      0 auto;
+    max-width:   960px;
+}
+
+p code
+{
+    background:    #f2f2f2;
+    padding-left:  3px;
+    padding-right: 3px;
+}
+
+pre.code
+{
+    font-size:   13px;
+    line-height: 1.4;
+    overflow:    auto;
+}
+
+blockquote
+{
+    border-left: 5px solid #eee;
+    margin: 0px;
+    padding-left: 15px;
+}
+
+/**
+ * YARD uses generic table styles, using a special class means those tables
+ * don't get messed up.
+ */
+.table
+{
+    border:          1px solid #ccc;
+    border-right:    none;
+    border-collapse: separate;
+    border-spacing:  0;
+    text-align:      left;
+}
+
+.table.full
+{
+    width: 100%;
+}
+
+    .table .field_name
+    {
+        min-width: 160px;
+    }
+
+    .table thead tr th.no_sort:first-child
+    {
+        width: 25px;
+    }
+
+    .table thead tr th, .table tbody tr td
+    {
+        border-bottom:  1px solid #ccc;
+        border-right:   1px solid #ccc;
+        min-width:      20px;
+        padding:        8px 5px;
+        text-align:     left;
+        vertical-align: top;
+    }
+
+    .table tbody tr:last-child td
+    {
+        border-bottom: none;
+    }
+
+    .table tr:nth-child(odd) td
+    {
+        background: #f9f9f9;
+    }

data/lib/ffi/aspell.rb

@@ -1,258 +1,6 @@
 require 'ffi'
 
-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. 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
-  #
-  module Aspell
-    extend   FFI::Library
-    ffi_lib 'aspell'
-
-    ##
-    # 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
-
-    ##
-    # 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
+require_relative 'aspell/aspell'
+require_relative 'aspell/error'
+require_relative 'aspell/speller'
+require_relative 'aspell/version'

data/lib/ffi/aspell/aspell.rb

@@ -0,0 +1,251 @@
+module FFI
+  ##
+  # 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}.
+  #
+  module Aspell
+    extend   FFI::Library
+    ffi_lib 'aspell'
+
+    ##
+    # Creates a pointer for a configuration struct.
+    #
+    # @method config_new
+    # @scope  class
+    # @return [FFI::Pointer]
+    #
+    attach_function 'config_new',
+      'new_aspell_config',
+      [],
+      :pointer
+
+    ##
+    # Removes a config pointer and frees the memory associated with said
+    # pointer.
+    #
+    # @method config_delete(config)
+    # @scope  class
+    # @param  [FFI::Pointer] config The pointer to remove.
+    #
+    attach_function 'config_delete',
+      'delete_aspell_config',
+      [:pointer],
+      :void
+
+    ##
+    # 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"
+    #
+    # @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
+
+    ##
+    # Retrieves the default value of a configuration item.
+    #
+    # @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')
+    #
+    # @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')
+    #
+    # @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)
+    #
+    # @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.
+    #
+    # @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
+    #
+    # @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.
+    #
+    # @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.
+    #
+    # @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.
+    #
+    # @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)
+    #
+    # @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