ikku 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4916cf8fe3220837e015717ad3360e206115a738
-  data.tar.gz: ef486b20ffa6bd0f791702fa57b1ebe00a1f31e7
+  metadata.gz: 53a3541a871522f9f4f7fb8a7c93a7f8facd4ba2
+  data.tar.gz: ce083237fba85ad5a1c020ab2daaff7cc9553c0b
 SHA512:
-  metadata.gz: 4ce3e1436b314357b8290c5cd8f147b209029ea77d9fcf4166e14e3f0f47abfb82f5592bc0478a01c122b669a18050822ba68ba8dffeb11a08737d594a3a063f
-  data.tar.gz: c27ce9f7d9d00005b2b16d9ccb48af8d4ee2ca18f48b30606aebd1346d37b1f514566a142e5d5a922248ff5ab0cbd869718d5ed87fe8d0ecea5e3a13c482ffc0
+  metadata.gz: 83037032d994c2edc903ca02842ac25a862e3be36cbaba41a910423aacaf67647d8e77ae474a6585bd2b0c4154b79f41580ffb5c55844573d437c4ff96a9956a
+  data.tar.gz: 74b6b805415141237b872f9a40f04c1b48a96afde381643942f49486e673135d84a5b69668c91178951cc5af4bf6cf95930036bfe4c7ad7d187078f9be287b59

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.2
+- Add rule option
+
+## 0.0.1
+- 1st Release

data/README.md

@@ -6,20 +6,34 @@ Discover haiku from text.
 - MeCab with IPADIC (e.g. `brew install mecab mecab-ipadic`)
 
 ## Example
+### Ikku::Reviewer
+Ikku::Reviewer class is the main interface for this library.
+
 ```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
+### Ikku::Reviewer#judge
+Judge if given text is haiku or not.
+
+```rb
+reviewer.judge("古池や蛙飛び込む水の音") #=> true
 reviewer.judge("ああ古池や蛙飛び込む水の音ああ") #=> false
+```
+
+### Ikku::Reviewer#find
+Find one available haiku from given text.
 
-# Find one available haiku from given text.
+```rb
 reviewer.find("ああ古池や蛙飛び込む水の音ああ")
 #=> [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]]
+```
+
+### Ikku::Reviewer#search
+Search searches all available haikus from given text.
 
-# Search searches all available haikus from given text.
+```rb
 reviewer.search("ああ古池や蛙飛び込む水の音ああ天秤や京江戸かけて千代の春ああ")
 #=> [
 #     [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]],
@@ -27,3 +41,10 @@ reviewer.search("ああ古池や蛙飛び込む水の音ああ天秤や京江戸
 #   ]
 #
 ```
+
+### rule option
+Change the rule by `rule` option (default: `[5, 7, 5]`).
+
+```rb
+reviewer.judge("すもももももももものうち", rule: [4, 3, 5]) #=> true
+```

data/lib/ikku.rb

@@ -6,10 +6,10 @@ module Ikku
   class Reviewer
     # Find one available haiku from given text.
     # @return [Array<Array>]
-    def find(text)
+    def find(text, rule: nil)
       nodes = parser.parse(text)
       nodes.length.times.find do |index|
-        if (phrases = Scanner.new(nodes[index..-1]).scan)
+        if (phrases = Scanner.new(nodes[index..-1], rule: rule).scan)
           break phrases
         end
       end
@@ -17,16 +17,16 @@ module Ikku
 
     # Judge if given text is haiku or not.
     # @return [true, false]
-    def judge(text)
-      !Scanner.new(parser.parse(text), exactly: true).scan.nil?
+    def judge(text, rule: nil)
+      !Scanner.new(parser.parse(text), exactly: true, rule: rule).scan.nil?
     end
 
     # Search all available haikus from given text.
     # @return [Array<Array>]
-    def search(text)
+    def search(text, rule: nil)
       nodes = parser.parse(text)
       nodes.length.times.map do |index|
-        Scanner.new(nodes[index..-1]).scan
+        Scanner.new(nodes[index..-1], rule: rule).scan
       end.compact
     end
 
@@ -39,13 +39,14 @@ module Ikku
 
   # Find one haiku that starts from the 1st node of given nodes.
   class Scanner
-    RULE = [5, 7, 5]
+    DEFAULT_RULE = [5, 7, 5]
 
     attr_writer :count
 
-    def initialize(nodes, exactly: false)
+    def initialize(nodes, exactly: false, rule: nil)
       @exactly = exactly
       @nodes = nodes
+      @rule = rule
     end
 
     def scan
@@ -85,13 +86,13 @@ module Ikku
     end
 
     def first_of_phrase?
-      RULE.inject([]) do |array, length|
+      rule.inject([]) do |array, length|
         array << array.last.to_i + length
       end.include?(count)
     end
 
     def has_full_count?
-      count == RULE.inject(0, :+)
+      count == rule.inject(0, :+)
     end
 
     def has_valid_first_node?
@@ -103,18 +104,22 @@ module Ikku
     end
 
     def max_consumable_length
-      RULE[0..phrase_index].inject(0, :+) - count
+      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
+      rule.length.times.find do |index|
+        count < rule[0..index].inject(0, :+)
+      end || rule.length - 1
     end
 
     def phrases
       @phrases ||= []
     end
+
+    def rule
+      @rule || DEFAULT_RULE
+    end
   end
 
   class Parser

data/lib/ikku/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ikku
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md