hunspell-ffi 0.1.3.alpha → 0.1.3.alpha2

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+*.gem

data/CHANGES

@@ -0,0 +1,10 @@
+= 0.1.3 (Work in progress)
+  * Update ffi version (~>1.0.7)
+  * New alias: Hunspell#check? for Hunspell#check
+  * New methods: #add(word), #remove(word), #add_with_affix(word, example) to 
+    add/remove words from the run-time dictionary.
+  * Show a warning when we cannot find aff/dic files.
+
+= 0.1.2 / 2010-08-07
+  * First release that works on OSX and Debian
+  

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    hunspell-ffi (0.1.3.alpha2)
+      ffi (~> 1.0.7)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hunspell-ffi!

data/README.rdoc

@@ -1,29 +1,53 @@
 = hunspell-ffi
 
-A Ruby FFI interface to the Hunspell spelling checker
+A Ruby FFI interface to the Hunspell spelling checker.
+
+"Hunspell is the spell checker of OpenOffice.org and Mozilla Firefox 3 & Thunderbird, Google Chrome, and it is also used by proprietary softwares, like Mac OS X, memoQ, Opera and SDL Trados."
+ - http://hunspell.sourceforge.net/
 
 It should work wherever Ruby FFI works (tested on Ruby 1.9.2, 1.8.7, JRuby 1.5.1). 
 
+This should be a drop-in replacement for rhunspell (https://github.com/tiendung/rhunspell), but using ffi.
+
 == Installation
-  1. Install hunspell (OSX: 'brew install hunspell' Debian: 'apt-get install hunspell')
-  2. gem install hunspell-ffi
+=== Install Hunspell
+On Mac OS X: Hunspell (libhunspell) is already installed on OSX 10.6.
+
+On Debian: 
+ apt-get install hunspell
+ 
+=== Install the Gem
+  gem install hunspell-ffi
 
 == Usage
   require 'hunspell-ffi'
   dict = Hunspell.new("path/to/cakes.aff", "path/to/cakes.dic")
-  dict.spell("Baumkuchen")    # => true  same as #check
+  dict.spell("Baumkuchen")    # => true  same as #check, #check?
   dict.spell("Bomcuken")      # => false
+  dict.check?("Bomcuken")     # => false
   dict.suggest("Baumgurken")  # => ["Baumkuchen"]
   dict.suggest("qwss43easd")  # => []
+  
+  # Modify the run-time dictionary:
+  dict.add("Geburtstagskuchen")
+  dict.remove("Fichte")
 
-== Author
-Andreas Haller
-andreashaller@gmail.com
+== Authors
+Andreas Haller (https://github.com/ahaller) and contributors.
+Full list of contributors: https://github.com/ahaller/hunspell-ffi/contributors
 
 == License
-Hereby placed under public domain, do what you want, just do not hold me accountable...
+Hereby placed under public domain, do what you want, just do not hold me accountable.
+
+== Help wanted
+I hear Hunspell has some superpowers like stemming and some that i never even heard of. 
+Maybe you want to help out to bring something of that power into the ruby world. 
+Or maybe we can think of a nice way to find to locate .dict files on a system or something. 
+Anyways, feel free to fork and send pull requests. kthxbye. Andreas.
+
+The source is on GitHub: https://github.com/ahaller/hunspell-ffi
 
-== TODO 
-Add other hunspell methods (add, remove, analyze, stem ...)
+=== TODOs
+Figure out how to use and add hunspell analyzing methods (analyze, stem ...)
 
 Test on Windows

data/hunspell-ffi.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+Gem::Specification.new do |s|
+  s.name        = 'hunspell-ffi'
+  s.version     = '0.1.3.alpha2'
+  s.date        = '2011-03-23'
+  s.authors     = ["Andreas Haller"]
+  s.email       = ["andreashaller@gmail.com"]
+  s.homepage    = "http://github.com/ahaller/hunspell-ffi"
+  s.summary     = "A Ruby FFI interface to the Hunspell spelling checker"
+  
+  s.add_dependency 'ffi', '~> 1.0.7'
+  s.required_rubygems_version = ">= 1.3.6"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+end

data/lib/hunspell-ffi.rb

@@ -22,7 +22,8 @@ class Hunspell
   def spell(word)
     C.Hunspell_spell(@handler, word)
   end
-  alias_method :check, :spell  
+  alias_method :check, :spell
+  alias_method :check?, :check  
   
   # Returns an array with suggested words or returns and empty array.
   def suggest(word)

metadata

@@ -6,8 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 1
   - 3
-  - alpha
-  version: 0.1.3.alpha
+  - alpha2
+  version: 0.1.3.alpha2
 platform: ruby
 authors: 
 - Andreas Haller
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2011-03-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,13 +24,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 0
-        - 6
-        - 3
-        version: 0.6.3
+        - 7
+        version: 1.0.7
   type: :runtime
   version_requirements: *id001
 description: 
@@ -43,12 +43,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- CHANGES
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- hunspell-ffi.gemspec
+- lib/hunspell-ffi.rb
 - test/cakes.aff
 - test/cakes.dic
 - test/test_hunspell.rb
-- lib/hunspell-ffi.rb
-- Rakefile
-- README.rdoc
 has_rdoc: true
 homepage: http://github.com/ahaller/hunspell-ffi
 licenses: []
@@ -84,4 +89,6 @@ signing_key:
 specification_version: 3
 summary: A Ruby FFI interface to the Hunspell spelling checker
 test_files: 
+- test/cakes.aff
+- test/cakes.dic
 - test/test_hunspell.rb