ikku 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a0d5455fb93360c656c0480fce5ad87fabbcf9c
-  data.tar.gz: a75862728812464a80e1bfcf5ec6fefa0a3a7c28
+  metadata.gz: b3096ad7728dd91f17e2176eed31a6a5cf7b9666
+  data.tar.gz: a9a26afdf48c5a96da3e4e963442aefe19744916
 SHA512:
-  metadata.gz: 03aad731656adb2308f22025eccbf6a4a7937350ec81a6f90b6835c3896eaf7728ace6dd3e521287c9c72f438cbfac9f5224dcf78341cb4697b765e11b58d675
-  data.tar.gz: c7278be5bc4c5ce7bc2dfd4eb96a75034d9dd52e14f3d934b7fcc95cb6de2f953a8a46dcc071ee6ca2942508e81be743e710ef8098051f6b66794fff0eae54c2
+  metadata.gz: 0b455889d0947433f9124f57ec84d4198e284d2e9e273a24b33aa3039e879bc8c811073beacb6951a865f58e8e1444ea83489c83fdf0015b662922731e9f5cfd
+  data.tar.gz: 91ecfbb73a4a8cd7186443d3f4adebdb933ddcab0cbc06e7a2239144092727469400eb14e450fd01de6708f028a76497d748715cd14f743fbeeae9a35d02656e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0
+- Change some reviewer methods to return `Ikku::Song`
+- Don't allow song with odd parentheses
+
 ## 0.0.9
 - Don't allow ikku ending with 連用タ接続
 

data/README.md

@@ -15,7 +15,7 @@ reviewer = Ikku::Reviewer.new
 ```
 
 ### Ikku::Reviewer#judge
-Judge if given text is haiku or not.
+Judge if given text is valid song or not.
 
 ```rb
 reviewer.judge("古池や蛙飛び込む水の音") #=> true
@@ -23,27 +23,33 @@ reviewer.judge("ああ古池や蛙飛び込む水の音ああ") #=> false
 ```
 
 ### Ikku::Reviewer#find
-Find one available haiku from given text.
+Find one valid song from given text.
 
 ```rb
 reviewer.find("ああ古池や蛙飛び込む水の音ああ")
-#=> [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]]
+#=> #<Ikku::Song>
 ```
 
 ### Ikku::Reviewer#search
-Search all available haikus from given text.
+Search all valid songs from given text.
 
 ```rb
 reviewer.search("ああ古池や蛙飛び込む水の音ああ天秤や京江戸かけて千代の春ああ")
 #=> [
-#     [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]],
-#     [["天秤", "や"], ["京", "江戸", "かけ", "て"], ["千代", "の", "春"]]
+#     #<Ikku::Song>,
+#     #<Ikku::Song>,
 #   ]
-#
 ```
 
-### rule option
-Change the rule by `rule` option (default: `[5, 7, 5]`).
+### Ikku::Song#phrases
+Returns an Array of phrases of `Ikku::Node`.
+
+```rb
+song.phrases #=> [["古池", "や"], ["蛙", "飛び込む"], ["水", "の", "音"]]
+```
+
+### Rule option
+Pass `:rule` option to change the measure rule (default: `[5, 7, 5]`).
 
 ```rb
 reviewer = Ikku::Reviewer.new(rule: [4, 3, 5])

data/lib/ikku/bracket_state.rb

@@ -0,0 +1,52 @@
+module Ikku
+  class BracketState
+    TABLE = {
+      "’" => "‘",
+      "”" => "“",
+      "）" => "（",
+      ")" => "(",
+      "］" => "［",
+      "]" => "[",
+      "}" => "{",
+      "｝" => "｛",
+      "〉" => "〈",
+      "》" => "《",
+      "」" => "「",
+      "』" => "『",
+      "】" => "【",
+      "〕" => "〔",
+      ">" => "<",
+      "＞" => "＜",
+    }
+
+    def consume_all(surfaces)
+      surfaces.each do |surface|
+        consume(surface)
+      end
+      self
+    end
+
+    def odd?
+      !even?
+    end
+
+    private
+
+    def consume(surface)
+      case
+      when TABLE.values.include?(surface)
+        stack.push(surface)
+      when TABLE.include?(surface) && stack.last == TABLE[surface]
+        stack.pop
+      end
+    end
+
+    def even?
+      stack.empty?
+    end
+
+    def stack
+      @stack ||= []
+    end
+  end
+end

data/lib/ikku/node.rb

@@ -44,7 +44,7 @@ module Ikku
       case
       when !first_of_phrase?
         false
-      when pronounciation_length.zero?
+      when type == "記号" && !["括弧開", "括弧閉"].include?(subtype1)
         false
       else
         true

data/lib/ikku/reviewer.rb

@@ -1,5 +1,5 @@
 require "ikku/parser"
-require "ikku/scanner"
+require "ikku/song"
 
 module Ikku
   class Reviewer
@@ -7,30 +7,30 @@ module Ikku
       @rule = rule
     end
 
-    # Find one available haiku from given text.
-    # @return [Array<Array>]
+    # Find one valid song from given text.
+    # @return [Ikku::Song]
     def find(text)
       nodes = parser.parse(text)
       nodes.length.times.find do |index|
-        if (phrases = Scanner.new(nodes[index..-1], rule: @rule).scan)
-          break phrases
+        if (song = Song.new(nodes[index..-1], rule: @rule)).valid?
+          break song
         end
       end
     end
 
-    # Judge if given text is haiku or not.
+    # Judge if given text is valid song or not.
     # @return [true, false]
     def judge(text)
-      !Scanner.new(parser.parse(text), exactly: true, rule: @rule).scan.nil?
+      Song.new(parser.parse(text), exactly: true, rule: @rule).valid?
     end
 
-    # Search all available haikus from given text.
+    # Search all valid songs from given text.
     # @return [Array<Array>]
     def search(text)
       nodes = parser.parse(text)
       nodes.length.times.map do |index|
-        Scanner.new(nodes[index..-1], rule: @rule).scan
-      end.compact
+        Song.new(nodes[index..-1], rule: @rule)
+      end.select(&:valid?)
     end
 
     private

data/lib/ikku/scanner.rb

@@ -1,11 +1,9 @@
 module Ikku
-  # Find one haiku that starts from the 1st node of given nodes.
+  # Find one set of valid phrases that starts from the 1st node of given nodes.
   class Scanner
-    DEFAULT_RULE = [5, 7, 5]
-
     attr_writer :count
 
-    def initialize(nodes, exactly: false, rule: nil)
+    def initialize(exactly: false, nodes: nil, rule: nil)
       @exactly = exactly
       @nodes = nodes
       @rule = rule
@@ -17,17 +15,17 @@ module Ikku
     end
 
     def scan
-      if has_valid_first_node? && has_valid_last_node?
+      if has_valid_first_node?
         @nodes.each_with_index do |node, index|
           if consume(node)
-            if has_full_count?
+            if satisfied?
               return phrases unless @exactly
             end
           else
             return
           end
         end
-        phrases if has_full_count?
+        phrases if satisfied?
       end
     end
 
@@ -52,13 +50,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?
@@ -66,25 +64,25 @@ module Ikku
     end
 
     def has_valid_last_node?
-      @nodes.last.last_of_ikku?
+      phrases.last.last.last_of_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
+    def satisfied?
+      has_full_count? && has_valid_last_node?
     end
   end
 end

data/lib/ikku/song.rb

@@ -0,0 +1,61 @@
+require "ikku/bracket_state"
+require "ikku/scanner"
+
+module Ikku
+  class Song
+    DEFAULT_RULE = [5, 7, 5]
+
+    def initialize(nodes, exactly: false, rule: nil)
+      @exactly = exactly
+      @nodes = nodes
+      @rule = rule
+    end
+
+    def phrases
+      if instance_variable_defined?(:@phrases)
+        @phrases
+      else
+        @phrases = scan
+      end
+    end
+
+    def valid?
+      case
+      when phrases.nil?
+        false
+      when has_odd_parentheses?
+        false
+      else
+        true
+      end
+    end
+
+    private
+
+    def has_odd_parentheses?
+      bracket_state.odd?
+    end
+
+    def nodes
+      phrases.flatten
+    end
+
+    def rule
+      @rule || DEFAULT_RULE
+    end
+
+    def scan
+      Scanner.new(exactly: @exactly, nodes: @nodes, rule: rule).scan
+    end
+
+    def bracket_state
+      @bracket_state ||= BracketState.new.tap do |state|
+        state.consume_all(surfaces)
+      end
+    end
+
+    def surfaces
+      nodes.map(&:surface)
+    end
+  end
+end

data/lib/ikku/version.rb

@@ -1,3 +1,3 @@
 module Ikku
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/spec/ikku/reviewer_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe Ikku::Reviewer do
       instance.find(text)
     end
 
-    context "without ikku" do
+    context "with invalid song" do
       let(:text) do
         "test"
       end
@@ -26,16 +26,24 @@ RSpec.describe Ikku::Reviewer do
       it { is_expected.to be_nil }
     end
 
-    context "with valid ikku" do
-      it { is_expected.to be_a Array }
+    context "with valid song" do
+      it { is_expected.to be_a Ikku::Song }
     end
 
-    context "with text including ikku" do
+    context "with text including song" do
       let(:text) do
         "ああ#{super()}ああ"
       end
 
-      it { is_expected.to be_a Array }
+      it { is_expected.to be_a Ikku::Song }
+    end
+
+    context "with text including song ending with 連用タ接続" do
+      let(:text) do
+        "リビングでコーヒー飲んでだめになってる"
+      end
+
+      it { is_expected.to be_nil }
     end
   end
 
@@ -44,11 +52,11 @@ RSpec.describe Ikku::Reviewer do
       instance.judge(text)
     end
 
-    context "with valid ikku" do
+    context "with valid song" do
       it { is_expected.to be true }
     end
 
-    context "with invalid ikku" do
+    context "with invalid song" do
       let(:text) do
         "#{super()}ああ"
       end
@@ -56,7 +64,7 @@ RSpec.describe Ikku::Reviewer do
       it { is_expected.to be false }
     end
 
-    context "with rule option and valid ikku" do
+    context "with rule option and valid song" do
       let(:rule) do
         [4, 3, 5]
       end
@@ -68,7 +76,7 @@ RSpec.describe Ikku::Reviewer do
       it { is_expected.to be true }
     end
 
-    context "with rule option and invalid ikku" do
+    context "with rule option and invalid song" do
       let(:rule) do
         [4, 3, 5]
       end
@@ -100,21 +108,45 @@ RSpec.describe Ikku::Reviewer do
       it { is_expected.to be false }
     end
 
-    context "with ikku starting with no pronounciation length node" do
+    context "with song starting with symbol" do
       let(:text) do
-        "「#{super()}"
+        "、#{super()}"
       end
 
       it { is_expected.to be false }
     end
 
-    context "with ikku ending with 連用タ接続 (撮っ)" do
+    context "with song ending with 連用タ接続 (撮っ)" do
       let(:text) do
         "新宿の桜と庭の写真撮っ"
       end
 
       it { is_expected.to be false }
     end
+
+    context "with song including even parentheses" do
+      let(:text) do
+        "古池や「蛙＜飛び込む＞」水の音"
+      end
+
+      it { is_expected.to be true }
+    end
+
+    context "with song including odd parentheses" do
+      let(:text) do
+        "古池や「蛙＜飛び込む」＞水の音"
+      end
+
+      it { is_expected.to be false }
+    end
+
+    context "with song starting with parenthesis" do
+      let(:text) do
+        "（#{super()}）"
+      end
+
+      it { is_expected.to be true }
+    end
   end
 
   describe "#search" do
@@ -122,7 +154,7 @@ RSpec.describe Ikku::Reviewer do
       instance.search(text)
     end
 
-    context "without ikku" do
+    context "without song" do
       let(:text) do
         "test"
       end
@@ -130,11 +162,11 @@ RSpec.describe Ikku::Reviewer do
       it { is_expected.to be_a Array }
     end
 
-    context "with valid ikku" do
+    context "with valid song" do
       it { is_expected.to be_a Array }
     end
 
-    context "with text including ikku" do
+    context "with text including song" do
       let(:text) do
         "ああ#{super()}ああ"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ikku
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -96,10 +96,12 @@ files:
 - Rakefile
 - ikku.gemspec
 - lib/ikku.rb
+- lib/ikku/bracket_state.rb
 - lib/ikku/node.rb
 - lib/ikku/parser.rb
 - lib/ikku/reviewer.rb
 - lib/ikku/scanner.rb
+- lib/ikku/song.rb
 - lib/ikku/version.rb
 - spec/ikku/reviewer_spec.rb
 - spec/spec_helper.rb