natto 0.0.8 → 0.0.9

data/README.md

@@ -55,6 +55,10 @@ e.g., for Cygwin
 
 ## Changelog
 
+- __2011/01/13: 0.0.9 release.
+    - Further development and testing for mecab dictionary access/destruction
+    - Continuing update of documentation
+
 - __2011/01/07__: 0.0.8 release.
     - Adding support for accessing dictionaries 
     - Further tweaking of documentation with markdown
@@ -87,4 +91,4 @@ e.g., for Cygwin
 
 ## Copyright
 
-natto © 2010-2013 by Brooke M. Fujita, licensed under the new BSD license. Please see the [LICENSE](file.LICENSE.html) document for further details.
+natto © 2010-2013 by Brooke M. Fujita, licensed under the new BSD license. Please see the [LICENSE](LICENSE) document for further details.

data/lib/natto.rb

@@ -110,7 +110,7 @@ module Natto
     # Returns a <tt>Proc</tt> that is registered to be invoked
     # after the object owning <tt>ptr</tt> has been destroyed.
     #
-    # @param [FFI::MemoryPointer] ptr
+    # @param [FFI::Pointer] ptr
     # @return [Proc] to release <tt>mecab</tt> resources properly
     def self.create_free_proc(ptr)
       Proc.new do

data/lib/natto/version.rb

@@ -1,50 +1,20 @@
 # coding: utf-8
 
-# natto combines the Ruby programming language with MeCab, 
-# the part-of-speech and morphological analyzer for the
-# Japanese language.
-# 
-# ## Requirements
-# natto requires the following:
+# <tt>Natto</tt> is the namespace for objects that provide
+# a binding to the <tt>mecab</tt> parser and related resources.
 #
-# -  [MeCab _0.98_](http://sourceforge.net/projects/mecab/files/mecab/0.98/)
-# -  [ffi _0.6.3 or greater_](http://rubygems.org/gems/ffi)
-# -  Ruby _1.8.7 or greater_
+# <tt>Natto::MeCab</tt> is a wrapper class for the <tt>mecab</tt> 
+# parser.
 #
-# ## Installation
-# Install natto with the following gem command:
-#     gem install natto
+# <tt>Natto::DictionaryInfo</tt> is a wrapper for a <tt>Natto::MeCab</tt>
+# instance's related dictionary information.
 #
-# ## Configuration
-# - natto will try to locate the <tt>mecab</tt> library based upon its runtime environment.
-# - In case of <tt>LoadError</tt>, please set the <tt>MECAB_PATH</tt> environment variable to the exact name/path to your <tt>mecab</tt> library.
+# <tt>Natto::MeCabError</tt> is a general error class for the 
+# <tt>Natto</tt> module.
 #
-#  e.g., for bash on UNIX/Linux
-#       export MECAB_PATH=mecab.so
-#  e.g., on Windows
-#       set MECAB_PATH=C:\Program Files\MeCab\bin\libmecab.dll
-#  e.g., for Cygwin
-#       export MECAB_PATH=cygmecab-1
-#
-# ## Usage
-# 
-#       require 'natto'
-#
-#       m = Natto::MeCab.new
-#       => #<Natto::MeCab:0x28d93dd4 @options={}, \
-#                                    @dicts=[#<Natto::DictionaryInfo:0x28d93d34>], \
-#                                    @ptr=#<FFI::Pointer address=0x28af3e58>>
-#       puts m.parse("すもももももももものうち")
-#       すもも  名詞,一般,*,*,*,*,すもも,スモモ,スモモ
-#       も      助詞,係助詞,*,*,*,*,も,モ,モ
-#       もも    名詞,一般,*,*,*,*,もも,モモ,モモ
-#       も      助詞,係助詞,*,*,*,*,も,モ,モ
-#       もも    名詞,一般,*,*,*,*,もも,モモ,モモ
-#       の      助詞,連体化,*,*,*,*,の,ノ,ノ
-#       うち    名詞,非自立,副詞可能,*,*,*,うち,ウチ,ウチ
-#       EOS
-#       => nil
+# Module <tt>Natto::Binding</tt> encapsulates methods and behavior 
+# which are made available via <tt>FFI</tt> bindings to <tt>mecab</tt>.
 module Natto
   # Version string for this Rubygem.
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/test/test_natto.rb

@@ -1,9 +1,11 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 $:.unshift('lib')
 require 'rubygems' if RUBY_VERSION.to_f < 1.9
 require 'test/unit'
 require 'natto'
 
+# TestNatto encapsulates tests for the basic
+# behavior of natto.
 class TestNatto < Test::Unit::TestCase
   def setup
     @klass = Class.new do
@@ -12,12 +14,15 @@ class TestNatto < Test::Unit::TestCase
   end
 
   def teardown
+    @klass = nil
   end
 
+  # Tests the class methods include callback.
   def test_classmethods_include
     assert_equal('0.98', @klass.mecab_version)
   end
 
+  # Tests the build_options_str function.
   def test_build_options_str
     res = Natto::MeCab.build_options_str
     assert_equal('', res)
@@ -82,6 +87,8 @@ class TestNatto < Test::Unit::TestCase
 
   end
 
+  # Tests the state of a Natto::MeCab instance
+  # after construction.
   def test_construction
     m = nil
     assert_nothing_raised do
@@ -102,6 +109,8 @@ class TestNatto < Test::Unit::TestCase
     assert_equal(opts, m.options)
   end
 
+  # Tests the initialize method for error cases for
+  # erroneous mecab options.
   def test_initialize_with_errors
     assert_raise Natto::MeCabError do
       Natto::MeCab.new(:output_format_type=>'not_defined_anywhere')
@@ -120,6 +129,10 @@ class TestNatto < Test::Unit::TestCase
     end
   end
 
+  # Tests the dictionary accessor method.
+  # Assumes that:
+  # a) system dictionary is /usr/local/lib/mecab/dic/ipadic/sys.dic
+  # b) system dictionary encoding is utf-8
   def test_dictionary_accessor
     m = Natto::MeCab.new
     dicts = m.dicts

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Brooke M. Fujita
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-07 00:00:00 +09:00
+date: 2011-01-13 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,7 +57,7 @@ rdoc_options:
 - --title
 - "natto #{Natto::VERSION} -- Ruby-Mecab binding"
 - --main
-- README
+- README.md
 - -c UTF-8
 require_paths: 
 - lib