natto 0.9.7 → 0.9.8

data/CHANGELOG

@@ -1,5 +1,11 @@
 ## CHANGELOG
 
+- __2015/02/10__: 0.9.8 release.
+    - Migrated natto code home from Bitbucket to GitHub.
+    - Improved documentation following said migration.
+    - Minor refactoring to Natto::MeCabNode#to_s.
+    - Updating LICENSE for year 2015. 
+
 - __2014/12/20__: 0.9.7 release.
     - Issue 14: [adding automatic discovery for mecab library; no need to
 	explicitly set

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2015, Brooke M. Fujita.
+Copyright (c) 2015, Brooke M. Fujita.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -9,10 +9,10 @@ and morphological analyzer for the Japanese language.
 
 -  No compiler is necessary, as natto is _not_ a C extension.
 -  It will run on CRuby (mri/yarv) and JRuby (jvm) equally well.
--  It will work with MeCab installations on Windows, Unix/Linux or Mac OS.
+-  It will work with MeCab installations on Windows, Unix/Linux or OS X.
 -  natto provides a naturally Ruby-esque interface to MeCab.
 
-You can learn more about [natto at bitbucket](https://bitbucket.org/buruzaemon/natto/).
+You can learn more about [natto at GitHub](https://github.com/buruzaemon/natto).
 
 
 ## Requirements
@@ -24,7 +24,7 @@ natto requires the following:
 -  Ruby _1.9 or greater_
 -  [ffi _1.9.0 or greater_](http://rubygems.org/gems/ffi)
 
-## Installation on *nix and Mac OS
+## Installation on *nix and OS X
 Install natto with the following gem command:
 
     gem install natto
@@ -42,16 +42,16 @@ However, if you are using a CRuby on Windows, then you will first need to instal
 
         gem install natto
 
-6. If you are on a 64-bit Windows and you use a 64-bit Ruby or JRuby, then you might want to [build a 64-bit version of libmecab.dll](https://bitbucket.org/buruzaemon/natto/wiki/64-Bit-Windows).
+6. If you are on a 64-bit Windows and you use a 64-bit Ruby or JRuby, then you might want to [build a 64-bit version of libmecab.dll](https://github.com/buruzaemon/natto/wiki/64-Bit-Windows).
 
 
 ## Configuration
 -  ***No explicit configuration should be necessary, as natto will try to locate the `mecab` library based upon its runtime environment.***
     - On Windows, it will query the Windows Registry to determine where `libmecab.dll` is installed
-    - On Mac OS and \*nix, it will query `mecab-config --libs` 
+    - On OS X and \*nix, it will query `mecab-config --libs` 
 -   ***But if natto cannot find the `mecab` library, `LoadError` will be raised.***
     - Please set the `MECAB_PATH` environment variable to the exact name/path to your `mecab` library.
-    - e.g., for Mac OS
+    - e.g., for OS X
 
             export MECAB_PATH=/usr/local/Cellar/mecab/0.996/lib/libmecab.dylib 
 
@@ -134,7 +134,7 @@ However, if you are using a CRuby on Windows, then you will first need to instal
     EOS
 
     # parse more text and use a block to:
-    # - iterate the resulting MeCab nodes
+    # - iterate over the resulting MeCabNode instances
     # - output morpheme surface and part-of-speech ID
     #
     # * ignore any end-of-sentence nodes
@@ -164,13 +164,11 @@ However, if you are using a CRuby on Windows, then you will first need to instal
     # language processing tasks, it is far more efficient
     # to iterate over MeCab nodes using an Enumerator
     # 
-    # this example uses the node-format option to customize
-    # the resulting morpheme feature to extract:
-    # - surface
-    # - part-of-speech
-    # - reading
-    #
-    # * again, ignore any end-of-sentence nodes
+    # this example uses the -F node-format option to customize
+    # the resulting MeCabNode feature attribute to extract:
+    # - %m    ... surface
+    # - %f[0] ... part-of-speech
+    # - %f[7] ... reading
     #
     nm = Natto::MeCab.new('-F%m\t%f[0]\t%f[7]')
 
@@ -193,7 +191,8 @@ However, if you are using a CRuby on Windows, then you will first need to instal
     
     enum.rewind
 
-    enum.each { |n| puts n.feature }
+    # again, ignore any end-of-sentence nodes
+    enum.each { |n| puts n.feature if !n.is_eos? }
     この    連体詞  コノ
     星      名詞    ホシ
     の      助詞    ノ
@@ -215,11 +214,11 @@ However, if you are using a CRuby on Windows, then you will first need to instal
    
 
 ## Learn more 
-- You can read more about natto on the [project Wiki](https://bitbucket.org/buruzaemon/natto/wiki/Home).
+- You can read more about natto on the [project Wiki](https://github.com/buruzaemon/natto/wiki).
 
 ## Contributing to natto
--  Use [mercurial](http://mercurial.selenic.com/) and [check out the latest code at bitbucket](https://bitbucket.org/buruzaemon/natto/src/) to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
--  [Browse the issue tracker](https://bitbucket.org/buruzaemon/natto/issues/) to make sure someone already hasn't requested it and/or contributed it.
+-  Use [git](http://git-scm.com/) and [check out the latest code at GitHub](https://github.com/buruzaemon/natto) to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+-  [Browse the issue tracker](https://github.com/buruzaemon/natto/issues) to make sure someone already hasn't requested it and/or contributed it.
 -  Fork the project.
 -  Start a feature/bugfix branch.
 -  Commit and push until you are happy with your contribution.
@@ -230,4 +229,4 @@ However, if you are using a CRuby on Windows, then you will first need to instal
 Please see the {file:CHANGELOG} for this gem's release history.
 
 ## Copyright
-Copyright © 2014-2015, Brooke M. Fujita. All rights reserved. Please see the {file:LICENSE} file for further details.
+Copyright © 2015, Brooke M. Fujita. All rights reserved. Please see the {file:LICENSE} file for further details.

data/lib/natto.rb

@@ -1,6 +1,6 @@
 require 'natto/natto'
 
-# Copyright (c) 2014-2015, Brooke M. Fujita.
+# Copyright (c) 2015, Brooke M. Fujita.
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

data/lib/natto/binding.rb

@@ -175,7 +175,7 @@ module Natto
   end
 end
 
-# Copyright (c) 2014-2015, Brooke M. Fujita.
+# Copyright (c) 2015, Brooke M. Fujita.
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

data/lib/natto/natto.rb

@@ -13,35 +13,93 @@ module Natto
   #
   #     require 'natto'
   #
-  #     nm = Natto::MeCab.new('-Ochasen')
+  #     text = '凡人にしか見えねえ風景ってのがあるんだよ。'
+  #
+  #     nm = Natto::MeCab.new
   #     => #<Natto::MeCab:0x28d3bdc8 \
   #          @tagger=#<FFI::Pointer address=0x28afb980>, \
   #          @libpath="/usr/local/lib/libmecab.so"       \
-  #          @options={:output_format_type=>"chasen"},   \
+  #          @options={},                                \
   #          @dicts=[#<Natto::DictionaryInfo:0x289a1f14  \
   #                    @filepath="/usr/local/lib/mecab/dic/ipadic/sys.dic", \
-  #                    charset=utf8 \
-  #                    type=0>], \
+  #                    charset=utf8,                     \
+  #                    type=0>],                         \
   #          @version=0.996>
   #
-  #     nm.parse('凡人にしか見えねえ風景ってのがあるんだよ。') do |n| 
-  #       puts "#{n.surface}\t#{n.feature}" 
+  #     # print entire MeCab result to stdout
+  #     #
+  #     puts nm.parse(text)
+  #     凡人    名詞,一般,*,*,*,*,凡人,ボンジン,ボンジン
+  #     に      助詞,格助詞,一般,*,*,*,に,ニ,ニ
+  #     しか    助詞,係助詞,*,*,*,*,しか,シカ,シカ
+  #     見え    動詞,自立,*,*,一段,未然形,見える,ミエ,ミエ
+  #     ねえ    助動詞,*,*,*,特殊・ナイ,音便基本形,ない,ネエ,ネー
+  #     風景    名詞,一般,*,*,*,*,風景,フウケイ,フーケイ
+  #     って    助詞,格助詞,連語,*,*,*,って,ッテ,ッテ
+  #     の      名詞,非自立,一般,*,*,*,の,ノ,ノ
+  #     が      助詞,格助詞,一般,*,*,*,が,ガ,ガ
+  #     ある    動詞,自立,*,*,五段・ラ行,基本形,ある,アル,アル
+  #     ん      名詞,非自立,一般,*,*,*,ん,ン,ン
+  #     だ      助動詞,*,*,*,特殊・ダ,基本形,だ,ダ,ダ
+  #     よ      助詞,終助詞,*,*,*,*,よ,ヨ,ヨ
+  #     。      記号,句点,*,*,*,*,。,。,。
+  #     EOS
+  #
+  #     # pass a block to iterate over each MeCabNode instance
+  #     #
+  #     nm.parse(text) do |n| 
+  #       puts "#{n.surface},#{n.feature}" if !n.is_eos?
   #     end 
-  #     凡人   名詞,一般,*,*,*,*,凡人,ボンジン,ボンジン
-  #     に     助詞,格助詞,一般,*,*,*,に,ニ,ニ 
-  #     しか   助詞,係助詞,*,*,*,*,しか,シカ,シカ 
-  #     見え   動詞,自立,*,*,一段,未然形,見える,ミエ,ミエ
-  #     ねえ   助動詞,*,*,*,特殊・ナイ,音便基本形,ない,ネエ,ネー 
-  #     風景   名詞,一般,*,*,*,*,風景,フウケイ,フーケイ
-  #     って   助詞,格助詞,連語,*,*,*,って,ッテ,ッテ
-  #     の     名詞,非自立,一般,*,*,*,の,ノ,ノ 
-  #     が     助詞,格助詞,一般,*,*,*,が,ガ,ガ
-  #     ある   動詞,自立,*,*,五段・ラ行,基本形,ある,アル,アル 
-  #     ん     名詞,非自立,一般,*,*,*,ん,ン,ン
-  #     だ     助動詞,*,*,*一般,特殊・ダ,基本形,だ,ダ,ダ
-  #     よ     助詞,終助詞,*,*,*,*,よ,ã¨,ヨ
-  #     。     記号,句点,*,*,*,*,。,。,。
-  #            BOS/EOS,*,*,*,*,*,*,*,*BOS
+  #     凡人,名詞,一般,*,*,*,*,凡人,ボンジン,ボンジン 
+  #     に,助詞,格助詞,一般,*,*,*,に,ニ,ニ 
+  #     しか,助詞,係助詞,*,*,*,*,しか,シカ,シカ 
+  #     見え,動詞,自立,*,*,一段,未然形,見える,ミエ,ミエ 
+  #     ねえ,助動詞,*,*,*,特殊・ナイ,音便基本形,ない,ネエ,ネー 
+  #     風景,名詞,一般,*,*,*,*,風景,フウケイ,フーケイ 
+  #     って,助詞,格助詞,連語,*,*,*,って,ッテ,ッテ 
+  #     の,名詞,非自立,一般,*,*,*,の,ノ,ノ 
+  #     が,助詞,格助詞,一般,*,*,*,が,ガ,ガ 
+  #     ある,動詞,自立,*,*,五段・ラ行,基本形,ある,アル,アル 
+  #     ん,名詞,非自立,一般,*,*,*,ん,ン,ン 
+  #     だ,助動詞,*,*,*,特殊・ダ,基本形,だ,ダ,ダ 
+  #     よ,助詞,終助詞,*,*,*,*,よ,ヨ,ヨ 
+  #     。,記号,句点,*,*,*,*,。,。,。 
+  #
+  #
+  #     # customize MeCabNode feature attribute with node-formatting
+  #     # %m   ... morpheme surface
+  #     # %F,  ... comma-delimited ChaSen feature values
+  #     #          reading (index 7) 
+  #     #          part-of-speech (index 0) 
+  #     # %h   ... part-of-speech ID (IPADIC)
+  #     #
+  #     nm = Natto::MeCab.new('-F%m,%F,[7,0],%h')
+  #     
+  #     # Enumerator effectively iterates the MeCabNodes
+  #     #
+  #     enum = nm.enum_parse(text)
+  #     => #<Enumerator: #<Enumerator::Generator:0x29cc5f8>:each>
+  #
+  #     # output the feature attribute of each MeCabNode
+  #     # only output normal nodes, ignoring any end-of-sentence 
+  #     # or unknown nodes 
+  #     #
+  #     enum.map.with_index {|n,i| puts "#{i}: #{n.feature}" if n.is_nor?} 
+  #     0: 凡人,ボンジン,名詞,38
+  #     1: に,ニ,助詞,13
+  #     2: しか,シカ,助詞,16
+  #     3: 見え,ミエ,動詞,31
+  #     4: ねえ,ネー,助動詞,25
+  #     5: 風景,フーケイ,名詞,38
+  #     6: って,ッテ,助詞,15
+  #     7: の,ノ,名詞,63
+  #     8: が,ガ,助詞,13
+  #     9: ある,アル,動詞,31
+  #     10: ん,ン,名詞,63
+  #     11: だ,ダ,助動詞,25
+  #     12: よ,ヨ,助詞,17
+  #     13: 。,。,記号,7
+  #
   #
   class MeCab
     include Natto::Binding
@@ -89,15 +147,15 @@ module Natto
     # <i>Use single-quotes to preserve format options that contain escape chars.</i><br/>
     # e.g.<br/>
     #
-    #     nm = Natto::MeCab.new(:node_format=>'%m¥t%f[7]¥n')
+    #     nm = Natto::MeCab.new(node_format: '%m¥t%f[7]¥n')
     #     => #<Natto::MeCab:0x28d2ae10 
     #          @tagger=#<FFI::Pointer address=0x28a97980>, \
-    #          @libpath="/usr/local/lib/libmecab.so",     \
+    #          @libpath="/usr/local/lib/libmecab.so",      \
     #          @options={:node_format=>"%m¥t%f[7]¥n"},     \
     #          @dicts=[#<Natto::DictionaryInfo:0x28d2a85c  \
     #                    @filepath="/usr/local/lib/mecab/dic/ipadic/sys.dic" \
-    #                    charset=utf8, \
-    #                    type=0>] \
+    #                    charset=utf8,                     \
+    #                    type=0>]                          \
     #          @version=0.996>
     # 
     #     puts nm.parse('才能とは求める人間に与えられるものではない。')
@@ -121,6 +179,7 @@ module Natto
     def initialize(options={})
       @options = self.class.parse_mecab_options(options) 
       @dicts = []
+      # TODO invoke function for enhancing MeCabNode after this point
 
       opt_str  = self.class.build_options_str(@options)
       @tagger  = self.class.mecab_new2(opt_str)
@@ -362,7 +421,7 @@ module Natto
   class MeCabError < RuntimeError; end
 end
 
-# Copyright (c) 2014-2015, Brooke M. Fujita.
+# Copyright (c) 2015, Brooke M. Fujita.
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

data/lib/natto/option_parse.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 module Natto
 
   # Module `OptionParse` encapsulates methods and behavior 
@@ -116,7 +117,7 @@ module Natto
   end
 end
 
-# Copyright (c) 2014-2015, Brooke M. Fujita.
+# Copyright (c) 2015, Brooke M. Fujita.
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

data/lib/natto/struct.rb

@@ -49,9 +49,11 @@ module Natto
   #     puts sysdic.filepath
   #     => /usr/local/lib/mecab/dic/ipadic/sys.dic
   #
+  #     # what charset (encoding) is the system dictionary?
   #     puts sysdic.charset
   #     => utf8
   # 
+  #     # is this really the system dictionary?
   #     puts sysdic.is_sysdic?
   #     => true
   class DictionaryInfo < MeCabStruct
@@ -60,8 +62,10 @@ module Natto
 
     # System dictionary.
     SYS_DIC = 0
+
     # User dictionary.
     USR_DIC = 1
+
     # Unknown dictionary.
     UNK_DIC = 2
 
@@ -263,7 +267,11 @@ module Natto
     #
     # @return [String] encoded object id, underlying FFI pointer, stat, surface, and feature 
     def to_s
-      %(#{super.chop} @pointer=#{@pointer}, stat=#{self[:stat]}, @surface="#{self.surface}", @feature="#{self.feature}">)
+       [ super.chop,
+         "@pointer=#{@pointer},",
+         "stat=#{self[:stat]},", 
+         "@surface=\"#{self.surface}\",",
+         "@feature=\"#{self.feature}\">" ].join(' ')
     end
 
     # Overrides `Object#inspect`.
@@ -303,10 +311,13 @@ module Natto
     def is_eon?
       self.stat == EON_NODE
     end
+
+
   end
+
 end
 
-# Copyright (c) 2014-2015, Brooke M. Fujita.
+# Copyright (c) 2015, Brooke M. Fujita.
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

data/lib/natto/version.rb

@@ -27,10 +27,10 @@
 # `Natto`.
 module Natto
   # Version string for this Rubygem.
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end
 
-# Copyright (c) 2014-2015, Brooke M. Fujita.
+# Copyright (c) 2015, Brooke M. Fujita.
 # All rights reserved.
 # 
 # Redistribution and use in source and binary forms, with or without

metadata

@@ -1,73 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: natto
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
+  prerelease: 
 platform: ruby
 authors:
 - Brooke M. Fujita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.9.0
-description: |
-  No compiler is necessary, as natto is not a C extension. It will run on CRuby (mri/yarv) and JRuby (jvm) equally well. It will also run on Windows, Unix/Linux, and Mac OS. natto provides a naturally Ruby-esque interface to MeCab.
+description: ! 'No compiler is necessary, as natto is not a C extension. It will run
+  on CRuby (mri/yarv) and JRuby (jvm) equally well. It will also run on Windows, Unix/Linux,
+  and OS X. natto provides a naturally Ruby-esque interface to MeCab.
+
+'
 email: buruzaemon@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
-- CHANGELOG
-- LICENSE
-- README.md
 - lib/natto.rb
 - lib/natto/binding.rb
 - lib/natto/natto.rb
 - lib/natto/option_parse.rb
 - lib/natto/struct.rb
 - lib/natto/version.rb
-homepage: https://bitbucket.org/buruzaemon/natto
+- README.md
+- LICENSE
+- CHANGELOG
+- .yardopts
+homepage: https://github.com/buruzaemon/natto
 licenses:
 - BSD
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
 - MeCab, 0.996 or greater
 - FFI, 1.9.0 or greater
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A gem leveraging FFI (foreign function interface), natto combines the Ruby
   programming language with MeCab, the part-of-speech and morphological analyzer for
   the Japanese language.
 test_files: []
-has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: fad99a300fd0a04d95e5ffacb7352b3855506e85
-  data.tar.gz: 1e9ba71a7690d14099f45d0350fba7d388b7e4e9
-SHA512:
-  metadata.gz: 185db00a5a3fba01b27ad27ea0e89e03e698b8d5ccfbef400539c0e48648ab77abe5b90e5cad9c7777dc5d6a79297b4dea99e3ecdae4111bb25f8d78614b164c
-  data.tar.gz: fec5fd24301277deff762c68762b89fec9f33736a6cf918b7d4ec61a9019ff03433d6f96528d8220ca7f35a352950afd93f4b5500cf5fe9baf5b0ccbedeb5efe