natto 0.1.0 → 0.1.1

data/README.md

@@ -27,13 +27,26 @@ e.g., for Cygwin
     export MECAB_PATH=cygmecab-1
 
 ## Usage
+    require 'rubygems' if RUBY_VERSION.to_f < 1.9
     require 'natto'
 
-    m = Natto::MeCab.new
+    mecab = Natto::MeCab.new
     => #<Natto::MeCab:0x28d93dd4 @options={}, \
                                  @dicts=[#<Natto::DictionaryInfo:0x28d93d34>], \
-                                 @ptr=#<FFI::Pointer address=0x28af3e58>>
-    puts m.parse('暑い日にはもってこいの一品ですね。')
+                                 @ptr=#<FFI::Pointer address=0x28af3e58>, \
+                                 @version="0.98">
+
+    puts mecab.version
+    => 0.98
+
+    sysdic = mecab.dicts.first
+    puts sysdic.filename
+    => /usr/local/lib/mecab/dic/ipadic/sys.dic
+
+    puts sysdic.charset
+    => utf8
+
+    puts mecab.parse('暑い日にはもってこいの一品ですね。')
     暑い日にはもってこいの一品ですね。
     暑い    形容詞,自立,*,*,形容詞・アウオ段,基本形,暑い,アツイ,アツイ
     日      名詞,非自立,副詞可能,*,*,*,日,ヒ,ヒ
@@ -59,7 +72,11 @@ e.g., for Cygwin
 
 ## Changelog
 
-- __2011/01/15__: 0.1.0 release.
+- __2011/01/15__: 0.1.1 release.
+    - Internal tweak to accessor for version in Natto::MeCab
+    - Continuing update of documentation
+
+- __2011/01/14__: 0.1.0 release.
     - Added accessors to Natto::DictionaryInfo
     - Added accessor for version in Natto::MeCab
     - Continuing update of documentation

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.1.0"
+  VERSION = "0.1.1"
 end

data/lib/natto.rb

@@ -10,29 +10,29 @@ module Natto
   # initialization.
   #
   # <h2>Usage</h2>
-  # Here is how to use natto under Ruby 1.8.n:<br/>
   #
-  #     require 'rubygems'
+  #     require 'rubygems' if RUBY_VERSION.to_f < 1.9
   #     require 'natto'
   #
-  #     m = Natto::MeCab.new
+  #     mecab = Natto::MeCab.new
   #     => #<Natto::MeCab:0x28d93dd4 @options={}, \
   #                                  @dicts=[#<Natto::DictionaryInfo:0x28d93d34>], \
-  #                                  @ptr=#<FFI::Pointer address=0x28af3e58>>
-  #     puts m.parse("ネバネバの組み合わせ美味しいです。")
+  #                                  @ptr=#<FFI::Pointer address=0x28af3e58>, \
+  #                                  @version="0.98">
+  #
+  #     puts mecab.parse("ネバネバの組み合わせ美味しいです。")
   #     ネバネバ      名詞,サ変接続,*,*,*,*,ネバネバ,ネバネバ,ネバネバ
   #     の            助詞,連体化,*,*,*,*,の,ノ,ノ
   #     組み合わせ    名詞,一般,*,*,*,*,組み合わせ,クミアワセ,クミアワセ
-  #     美味しいです  形容詞,自立,*,*,形容詞・イ段,基本形,美味しい,オイシイ,オイシイ
+  #     美味しい      形容詞,自立,*,*,形容詞・イ段,基本形,美味しい,オイシイ,オイシイ
   #     です          助動詞,*,*,*,特殊・デス,基本形,です,デス,デス
   #     。            デス記号,句点,*,*,*,*,。,。,。
   #     EOS
   #     => nil
   #
-  # The <tt>require 'rubygems'</tt> can be omitted for Ruby 1.9.n.
   class MeCab
 
-    attr_reader :options, :dicts
+    attr_reader :options, :dicts, :version
 
     # Supported options to the <tt>mecab</tt> parser.
     # See the <tt>mecab</tt> help for more details. 
@@ -66,11 +66,13 @@ module Natto
     # <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')
+    #     mecab = 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('簡単で美味しくて良いですよね。')
+    #                                  @ptr=#<FFI::Pointer address=0x28e3b268>, \
+    #                                  @version="0.98">
+    #
+    #     puts mecab.parse('簡単で美味しくて良いですよね。')
     #     簡単       カンタン
     #     で         デ
     #     美味しくて オイシクテ
@@ -98,6 +100,8 @@ module Natto
         @dicts << Natto::DictionaryInfo.new(@dicts.last[:next])
       end
 
+      @version = Natto::Binding.mecab_version
+
       ObjectSpace.define_finalizer(self, self.class.create_free_proc(@ptr))
     end
 
@@ -111,15 +115,11 @@ 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.
+    # Returns a <tt>Proc</tt> that will properly free resources
+    # when this <tt>MeCab</tt> instance is garbage collected.
+    # The <tt>Proc</tt> returned is registered to be invoked
+    # after the <tt>MeCab</tt> instance  owning <tt>ptr</tt> 
+    # has been destroyed.
     #
     # @param [FFI::Pointer] ptr
     # @return [Proc] to release <tt>mecab</tt> resources properly
@@ -139,6 +139,7 @@ module Natto
       SUPPORTED_OPTS.each do |k|
         if options.has_key? k
           key = k.to_s.gsub('_', '-')  
+          # all-morphs and partial are just flags
           if %w( all-morphs partial ).include? key
             opt << "--#{key}" if options[k]==true
           else
@@ -171,11 +172,15 @@ module Natto
   # - :next
   # 
   # <h2>Usage</h2>
+  # <tt>mecab</tt> dictionary attributes can be obtained by
+  # using the corresponding accessor.
   #
-  #     m = Natto::MeCab.new
+  #     mecab = Natto::MeCab.new
   #     sysdic = m.dicts.first
+  #
   #     puts sysdic.filename
   #     =>  /usr/local/lib/mecab/dic/ipadic/sys.dic
+  #
   #     puts sysdic.charset
   #     =>  utf8
   #
@@ -185,6 +190,7 @@ module Natto
   #     
   #     puts sysdic[:filename]
   #     =>  /usr/local/lib/mecab/dic/ipadic/sys.dic
+  #
   #     puts sysdic[:charset]
   #     =>  utf8
   #
@@ -202,7 +208,13 @@ module Natto
     # Hack to avoid that deprecation message Object#type.
     if RUBY_VERSION.to_f < 1.9
       alias_method :deprecated_type, :type
-      # @private
+      # <tt>Object#type</tt> override defined when <tt>RUBY_VERSION</tt> is
+      # less than 1.9. This is a hack to avoid the <tt>Object#type</tt>
+      # deprecation warning thrown up in Ruby 1.8.7.
+      #
+      # <i>This method override is not defined when the Ruby interpreter
+      # is 1.9 or greater.</i>
+      # @return [Fixnum] <tt>mecab</tt> dictionary type
       def type
         self[:type]
       end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Brooke M. Fujita
@@ -55,7 +55,7 @@ licenses:
 post_install_message: 
 rdoc_options: 
 - --title
-- natto 0.1.0 -- Ruby-Mecab binding
+- natto 0.1.1 -- Ruby-Mecab binding
 - --main
 - README.md
 - -c UTF-8