ikku 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4916cf8fe3220837e015717ad3360e206115a738
+  data.tar.gz: ef486b20ffa6bd0f791702fa57b1ebe00a1f31e7
+SHA512:
+  metadata.gz: 4ce3e1436b314357b8290c5cd8f147b209029ea77d9fcf4166e14e3f0f47abfb82f5592bc0478a01c122b669a18050822ba68ba8dffeb11a08737d594a3a063f
+  data.tar.gz: c27ce9f7d9d00005b2b16d9ccb48af8d4ee2ca18f48b30606aebd1346d37b1f514566a142e5d5a922248ff5ab0cbd869718d5ed87fe8d0ecea5e3a13c482ffc0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ikku.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Ikku
+Discover haiku from text.
+
+## Requirements
+- Ruby 2.0.0+
+- MeCab with IPADIC (e.g. `brew install mecab mecab-ipadic`)
+
+## Example
+```rb
+# Ikku::Reviewer class is the main interface for this library.
+require "ikku"
+reviewer = Ikku::Reviewer.new
+
+# Judge if given text is haiku or not.
+reviewer.judge("古池や蛙飛び込む水の音")        #=> true
+reviewer.judge("ああ古池や蛙飛び込む水の音ああ") #=> false
+
+# Find one available haiku from given text.
+reviewer.find("ああ古池や蛙飛び込む水の音ああ")
+#=> [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]]
+
+# Search searches all available haikus from given text.
+reviewer.search("ああ古池や蛙飛び込む水の音ああ天秤や京江戸かけて千代の春ああ")
+#=> [
+#     [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]],
+#     [["天秤", "や"], ["京", "江戸", "かけ", "て"], ["千代", "の", "春"]]
+#   ]
+#
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ikku.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ikku/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ikku"
+  spec.version       = Ikku::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Discover haiku from text."
+  spec.homepage      = "https://github.com/r7kamura/ikku"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "natto"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ikku.rb

@@ -0,0 +1,296 @@
+require "csv"
+require "natto"
+require "ikku/version"
+
+module Ikku
+  class Reviewer
+    # Find one available haiku from given text.
+    # @return [Array<Array>]
+    def find(text)
+      nodes = parser.parse(text)
+      nodes.length.times.find do |index|
+        if (phrases = Scanner.new(nodes[index..-1]).scan)
+          break phrases
+        end
+      end
+    end
+
+    # Judge if given text is haiku or not.
+    # @return [true, false]
+    def judge(text)
+      !Scanner.new(parser.parse(text), exactly: true).scan.nil?
+    end
+
+    # Search all available haikus from given text.
+    # @return [Array<Array>]
+    def search(text)
+      nodes = parser.parse(text)
+      nodes.length.times.map do |index|
+        Scanner.new(nodes[index..-1]).scan
+      end.compact
+    end
+
+    private
+
+    def parser
+      @parser ||= Parser.new
+    end
+  end
+
+  # Find one haiku that starts from the 1st node of given nodes.
+  class Scanner
+    RULE = [5, 7, 5]
+
+    attr_writer :count
+
+    def initialize(nodes, exactly: false)
+      @exactly = exactly
+      @nodes = nodes
+    end
+
+    def scan
+      if has_valid_first_node? && has_valid_last_node?
+        @nodes.each_with_index do |node, index|
+          if consume(node)
+            if has_full_count?
+              return phrases unless @exactly
+            end
+          else
+            return
+          end
+        end
+        phrases if has_full_count?
+      end
+    end
+
+    private
+
+    def consume(node)
+      case
+      when node.pronounciation_length > max_consumable_length
+        false
+      when first_of_phrase? && !node.first_of_phrase?
+        false
+      else
+        phrases[phrase_index] ||= []
+        phrases[phrase_index] << node
+        self.count += node.pronounciation_length
+        true
+      end
+    end
+
+    # @note Pronounciation count
+    def count
+      @count ||= 0
+    end
+
+    def first_of_phrase?
+      RULE.inject([]) do |array, length|
+        array << array.last.to_i + length
+      end.include?(count)
+    end
+
+    def has_full_count?
+      count == RULE.inject(0, :+)
+    end
+
+    def has_valid_first_node?
+      @nodes.first.first_of_ikku?
+    end
+
+    def has_valid_last_node?
+      @nodes.last.last_of_ikku?
+    end
+
+    def max_consumable_length
+      RULE[0..phrase_index].inject(0, :+) - count
+    end
+
+    def phrase_index
+      RULE.length.times.find do |index|
+        count < RULE[0..index].inject(0, :+)
+      end || RULE.length - 1
+    end
+
+    def phrases
+      @phrases ||= []
+    end
+  end
+
+  class Parser
+    def parse(text)
+      mecab.enum_parse(text).map do |mecab_node|
+        Node.new(mecab_node)
+      end.select(&:analyzable?)
+    end
+
+    private
+
+    def mecab
+      @mecab ||= Natto::MeCab.new
+    end
+  end
+
+  class Node
+    STAT_ID_FOR_NORMAL = 0
+    STAT_ID_FOR_UNKNOWN = 1
+    STAT_ID_FOR_BOS = 2
+    STAT_ID_FOR_EOS = 3
+
+    # @param node [Natto::MeCabNode]
+    def initialize(node)
+      @node = node
+    end
+
+    def analyzable?
+      !bos? && !eos?
+    end
+
+    def auxiliary_verb?
+      type == "助動詞"
+    end
+
+    def bos?
+      stat == STAT_ID_FOR_BOS
+    end
+
+    def dependent?
+      subtype1 == "非自立"
+    end
+
+    def element_of_ikku?
+      normal?
+    end
+
+    def last_of_ikku?
+      case
+      when type == "連体詞"
+        false
+      when ["名詞接続", "格助詞", "係助詞", "連体化", "接続助詞", "並立助詞", "副詞化", "数接続"].include?(type)
+        false
+      when auxiliary_verb? && root_form == "だ"
+        false
+      else
+        true
+      end
+    end
+
+    def eos?
+      stat == STAT_ID_FOR_EOS
+    end
+
+    def feature
+      @feature ||= CSV.parse(@node.feature)[0]
+    end
+
+    def filler?
+      type == "フィラー"
+    end
+
+    def first_of_ikku?
+      case
+      when !first_of_phrase?
+        false
+      # when filler?
+      #   false
+      when ["、", "・", " ", "　"].include?(surface)
+        false
+      else
+        true
+      end
+    end
+
+    def first_of_phrase?
+      case
+      when particle?
+        false
+      when auxiliary_verb?
+        false
+      when independent?
+        false
+      when postfix?
+        false
+      when dependent? && ["する", "できる"].include?(root_form)
+        false
+      else
+        true
+      end
+    end
+
+    def independent?
+      subtype1 == "自立"
+    end
+
+    def inspect
+      to_s.inspect
+    end
+
+    def normal?
+      stat == STAT_ID_FOR_NORMAL
+    end
+
+    def particle?
+      type == "助詞"
+    end
+
+    def postfix?
+      subtype1 == "接尾"
+    end
+
+    def pronounciation
+      feature[8]
+    end
+
+    def pronounciation_length
+      @pronounciation_length ||= begin
+        if pronounciation
+          pronounciation_mora.length
+        else
+          0
+        end
+      end
+    end
+
+    def pronounciation_mora
+      if pronounciation
+        pronounciation.tr("ぁ-ゔ","ァ-ヴ").gsub(/[^アイウエオカ-モヤユヨラ-ロワヲンヴー]/, "")
+      end
+    end
+
+    def root_form
+      feature[6]
+    end
+
+    def stat
+      @node.stat
+    end
+
+    def subtype1
+      feature[1]
+    end
+
+    def subtype2
+      feature[2]
+    end
+
+    def subtype3
+      feature[3]
+    end
+
+    def surface
+      @node.surface
+    end
+
+    def symbol?
+      type == "記号"
+    end
+
+    def to_s
+      surface
+    end
+
+    def type
+      feature[0]
+    end
+  end
+end

data/lib/ikku/version.rb

@@ -0,0 +1,3 @@
+module Ikku
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ikku
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: natto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ikku.gemspec
+- lib/ikku.rb
+- lib/ikku/version.rb
+homepage: https://github.com/r7kamura/ikku
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Discover haiku from text.
+test_files: []
+has_rdoc: