natto 0.0.9 → 0.1.0

data/README.md

@@ -33,14 +33,18 @@ e.g., for Cygwin
     => #<Natto::MeCab:0x28d93dd4 @options={}, \
                                  @dicts=[#<Natto::DictionaryInfo:0x28d93d34>], \
                                  @ptr=#<FFI::Pointer address=0x28af3e58>>
-    puts m.parse("すもももももももものうち")
-    すもも  名詞,一般,*,*,*,*,すもも,スモモ,スモモ
-    も      助詞,係助詞,*,*,*,*,も,モ,モ
-    もも    名詞,一般,*,*,*,*,もも,モモ,モモ
-    も      助詞,係助詞,*,*,*,*,も,モ,モ
-    もも    名詞,一般,*,*,*,*,もも,モモ,モモ
+    puts m.parse('暑い日にはもってこいの一品ですね。')
+    暑い日にはもってこいの一品ですね。
+    暑い    形容詞,自立,*,*,形容詞・アウオ段,基本形,暑い,アツイ,アツイ
+    日      名詞,非自立,副詞可能,*,*,*,日,ヒ,ヒ
+    に      助詞,格助詞,一般,*,*,*,に,ニ,ニ
+    は      助詞,係助詞,*,*,*,*,は,ハ,ワ
+    もってこい 名詞,一般,*,*,*,*,もってこい,モッテコイ,モッテコイ
     の      助詞,連体化,*,*,*,*,の,ノ,ノ
-    うち    名詞,非自立,副詞可能,*,*,*,うち,ウチ,ウチ
+    一品    名詞,一般,*,*,*,*,一品,イッピン,イッピン
+    です    助動詞,*,*,*,特殊・デス,基本形,です,デス,デス
+    ね      助詞,終助詞,*,*,*,*,ね,ネ,ネ
+    。      終助詞記号,句点,*,*,*,*,。,。,。
     EOS
     => nil
 
@@ -55,7 +59,12 @@ e.g., for Cygwin
 
 ## Changelog
 
-- __2011/01/13: 0.0.9 release.
+- __2011/01/15__: 0.1.0 release.
+    - Added accessors to Natto::DictionaryInfo
+    - Added accessor for version in Natto::MeCab
+    - Continuing update of documentation
+
+- __2011/01/13__: 0.0.9 release.
     - Further development and testing for mecab dictionary access/destruction
     - Continuing update of documentation
 
@@ -90,5 +99,26 @@ e.g., for Cygwin
     - Initial release 
 
 ## Copyright
-
-natto &copy; 2010-2013 by Brooke M. Fujita, licensed under the new BSD license. Please see the [LICENSE](LICENSE) document for further details.
+Copyright &copy; 2010-2013, Brooke M. Fujita.
+All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+ 
+  * Redistributions of source code must retain the above
+    copyright notice, this list of conditions and the
+    following disclaimer.
+ 
+  * Redistributions in binary form must reproduce the above
+    copyright notice, this list of conditions and the
+    following disclaimer in the documentation and/or other
+    materials provided with the distribution.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/natto.rb

@@ -9,25 +9,27 @@ module Natto
   # Options to the <tt>mecab</tt> parser are passed in as a hash at
   # initialization.
   #
-  # ## Usage
-  # _Here is how to use natto under Ruby 1.9:_
+  # <h2>Usage</h2>
+  # Here is how to use natto under Ruby 1.8.n:<br/>
+  #
+  #     require 'rubygems'
   #     require 'natto'
   #
   #     m = Natto::MeCab.new
   #     => #<Natto::MeCab:0x28d93dd4 @options={}, \
   #                                  @dicts=[#<Natto::DictionaryInfo:0x28d93d34>], \
   #                                  @ptr=#<FFI::Pointer address=0x28af3e58>>
-  #     puts m.parse("すもももももももものうち")
-  #     すもも  名詞,一般,*,*,*,*,すもも,スモモ,スモモ
-  #     も      助詞,係助詞,*,*,*,*,も,モ,モ
-  #     もも    名詞,一般,*,*,*,*,もも,モモ,モモ
-  #     も      助詞,係助詞,*,*,*,*,も,モ,モ
-  #     もも    名詞,一般,*,*,*,*,もも,モモ,モモ
-  #     の      助詞,連体化,*,*,*,*,の,ノ,ノ
-  #     うち    名詞,非自立,副詞可能,*,*,*,うち,ウチ,ウチ
+  #     puts m.parse("ネバネバの組み合わせ美味しいです。")
+  #     ネバネバ      名詞,サ変接続,*,*,*,*,ネバネバ,ネバネバ,ネバネバ
+  #     の            助詞,連体化,*,*,*,*,の,ノ,ノ
+  #     組み合わせ    名詞,一般,*,*,*,*,組み合わせ,クミアワセ,クミアワセ
+  #     美味しいです  形容詞,自立,*,*,形容詞・イ段,基本形,美味しい,オイシイ,オイシイ
+  #     です          助動詞,*,*,*,特殊・デス,基本形,です,デス,デス
+  #     。            デス記号,句点,*,*,*,*,。,。,。
   #     EOS
   #     => nil
-  # 
+  #
+  # The <tt>require 'rubygems'</tt> can be omitted for Ruby 1.9.n.
   class MeCab
 
     attr_reader :options, :dicts
@@ -61,19 +63,22 @@ module Natto
     # - :theta --  temperature parameter theta (float, default 0.75)
     # - :cost_factor --  cost factor (integer, default 700)
     # 
-    # _Use single-quotes to preserve format options that contain escape chars._
-    # 
-    # e.g.
+    # <i>Use single-quotes to preserve format options that contain escape chars.</i><br/>
+    # e.g.<br/>
+    #
     #     m = Natto::MeCab.new(:node_format=>'%m\t%f[7]\n')
     #     => #<Natto::MeCab:0x28d8886c @options={:node_format=>"%m\\t%f[7]\\n"}, \
-    #                                     @dicts=[#<Natto::DictionaryInfo:0x28d8863c>], \
-    #                                     @ptr=#<FFI::Pointer address=0x28e3b268>>
-    #     puts m.parse("日本語は難しいです。")
-    #     日本語  ニホンゴ
-    #     は      ハ
-    #     難しい  ムズカシイ
-    #     です    デス
-    #     。      。
+    #                                  @dicts=[#<Natto::DictionaryInfo:0x28d8863c>], \
+    #                                  @ptr=#<FFI::Pointer address=0x28e3b268>>
+    #     puts m.parse('簡単で美味しくて良いですよね。')
+    #     簡単       カンタン
+    #     で         デ
+    #     美味しくて オイシクテ
+    #     良い       ヨイ
+    #     です       デス
+    #     よ         ヨ
+    #     ね         ネ
+    #     。
     #     EOS
     #     => nil
     #
@@ -106,6 +111,12 @@ module Natto
         raise(MeCabError.new(Natto::Binding.mecab_strerror(@ptr)))
     end
 
+    # Returns the <tt>mecab</tt> version.
+    #
+    # @return <tt>mecab</tt> version
+    def version
+      Natto::Binding.mecab_version
+    end
 
     # Returns a <tt>Proc</tt> that is registered to be invoked
     # after the object owning <tt>ptr</tt> has been destroyed.
@@ -146,8 +157,9 @@ module Natto
   # <tt>DictionaryInfo</tt> is a wrapper for a <tt>MeCab</tt>
   # instance's related dictionary information.
   # 
-  # Values may be obtained by using the following symbols 
-  # as keys to the hash of <tt>mecab</tt> dictionary information.
+  # Values for the <tt>mecab</tt> dictionary attributes may be 
+  # obtained by using the following <tt>Symbol</tt>s as keys 
+  # to the associative array of <tt>FFI::Struct</tt> members.
   #
   # - :filename
   # - :charset
@@ -158,14 +170,26 @@ module Natto
   # - :version
   # - :next
   # 
-  # # Usage:
+  # <h2>Usage</h2>
+  #
   #     m = Natto::MeCab.new
   #     sysdic = m.dicts.first
+  #     puts sysdic.filename
+  #     =>  /usr/local/lib/mecab/dic/ipadic/sys.dic
+  #     puts sysdic.charset
+  #     =>  utf8
+  #
+  # It is also possible to use the <tt>Symbol</tt> for the
+  # <tt>mecab</tt> dictionary member to index into the 
+  # <tt>FFI::Struct</tt> layout associative array like so:
+  #     
   #     puts sysdic[:filename]
   #     =>  /usr/local/lib/mecab/dic/ipadic/sys.dic
   #     puts sysdic[:charset]
   #     =>  utf8
+  #
   class DictionaryInfo < FFI::Struct
+
     layout  :filename, :string,
             :charset,  :string,
             :size,     :uint,
@@ -173,6 +197,26 @@ module Natto
             :lsize,    :uint,
             :rsize,    :uint,
             :version,  :ushort,
-            :next,     :pointer 
+            :next,     :pointer
+   
+    # Hack to avoid that deprecation message Object#type.
+    if RUBY_VERSION.to_f < 1.9
+      alias_method :deprecated_type, :type
+      # @private
+      def type
+        self[:type]
+      end
+    end
+
+    # Provides accessor methods for the members of the <tt>DictionaryInfo</tt> structure.
+    #
+    # @param [String] methName
+    # @return member values for the <tt>mecab</tt> dictionary
+    # @raise [NoMethodError] if <tt>methName</tt> is not a member of this <tt>mecab</tt> dictionary <tt>FFI::Struct</tt> 
+    def method_missing(methName)
+      member_sym = methName.id2name.to_sym
+      return self[member_sym] if self.members.include?(member_sym)
+      raise(NoMethodError.new("undefined method '#{methName}' for #{self}"))
+    end
   end
 end

data/lib/natto/version.rb

@@ -16,5 +16,5 @@
 # which are made available via <tt>FFI</tt> bindings to <tt>mecab</tt>.
 module Natto
   # Version string for this Rubygem.
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/test/test_natto.rb

@@ -129,7 +129,13 @@ class TestNatto < Test::Unit::TestCase
     end
   end
 
-  # Tests the dictionary accessor method.
+  # Tests the mecab version string accessor class method of Natto::MeCab.
+  def test_version_accessor
+    m = Natto::MeCab.new
+    assert_equal('0.98', m.version)
+  end
+
+  # Tests the dictionary accessor method of Natto::MeCab
   # Assumes that:
   # a) system dictionary is /usr/local/lib/mecab/dic/ipadic/sys.dic
   # b) system dictionary encoding is utf-8
@@ -142,4 +148,21 @@ class TestNatto < Test::Unit::TestCase
     assert_equal('utf8', sysdic[:charset])
     assert_equal(0x0, sysdic[:next].address)
   end
+
+  # Tests the accessors of Natto::DictionaryInfo
+  # Note: Object#type is deprecated in 1.9.n, but comes with a warning
+  #       in 1.8.n
+  def test_dictionary_info_member_accessors
+    m = Natto::MeCab.new
+    sysdic = m.dicts.first
+    members = %w( filename charset type size lsize rsize version next )
+    members.each do |nomme|
+      assert_not_nil(sysdic.send nomme.to_sym ) 
+    end
+    
+    # NoMethodError will be raised for anything else!
+    assert_raise NoMethodError do
+      sysdic.send :nomethoderror
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Brooke M. Fujita
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 +09:00
+date: 2011-01-15 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,7 @@ licenses:
 post_install_message: 
 rdoc_options: 
 - --title
-- "natto #{Natto::VERSION} -- Ruby-Mecab binding"
+- natto 0.1.0 -- Ruby-Mecab binding
 - --main
 - README.md
 - -c UTF-8