haiku_gadget 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a15537f69f3e149171a2514415edb876eab3510
-  data.tar.gz: bd8706dfbb15420681f2faeaed23cfddd5b03b14
+  metadata.gz: ea8e5beb816d1856ea38d9ef4e43d962de94337a
+  data.tar.gz: 9d9438f59eabee07b148650ac2eeda7433ac9338
 SHA512:
-  metadata.gz: 323b3add5c00b3a07b77855ace907b81520cb7956385e322d56910c3df208265572566ef174aaf8d93eb984a10c68dd6e88094cf099c93505f9e469f08c847db
-  data.tar.gz: aff4b7a9ef98cd22d1d71df7f5ddc2de9d48a476a4397ee1ed6bf5482d3403deb12d3ef8d4e175f8320666d3be345e8c3f04158236e1d2bd795b00ede0f97173
+  metadata.gz: 32c847c4f65cddce03d8a8d56b6ae52252067972a97a11101ecdec0d66ca41e0113e57598aae03bf6c3a4697b3b6fbe8632e9dbbcdb7aa680036f8721bbf037a
+  data.tar.gz: c35d4991dcceeb1ba12a1d6400f2b1c29aa165e2ac130b2f97c1f2d650becbd162d056f5cc7ab6623a3c4d565d74386b1808d3a6c722124a001f8aecab954865

data/lib/haiku_gadget/haiku_gadget.rb

@@ -46,6 +46,7 @@ module HaikuGadget
       # get a random template defined for the current row
       word_templates = HaikuTemplate.new.template_matrix[row_index]
     end
+
     # generate a HaikuTemplate object that only contains a single line with the desired template
     haiku_template = HaikuTemplate.new [word_templates]
     haiku_template.generate[0]

data/lib/haiku_gadget/haiku_template.rb

@@ -16,15 +16,15 @@ module HaikuGadget
           HaikuTemplate.random_template(LineTemplates::ALL_BOTTOM_LINES)
         ]
       end
-      # clone the two-dimensional array (so syllable counts can be changed)
-      @template_matrix = template_matrix.map { |tm| tm.map { |wt| wt.clone } }
+      # clone the two-dimensional array (so syllable counts can be changed safely)
+      @template_matrix = template_matrix.map { |lt| lt.clone } 
       complete_template
     end
 
     def generate
       lines = []
-      @template_matrix.each do |word_templates|
-        words = HaikuTemplate.real_words_from_templates word_templates
+      @template_matrix.each do |line_template|
+        words = line_template.real_words
         lines << words.join(' ')
       end
       lines
@@ -38,112 +38,25 @@ module HaikuGadget
       end
 
       def complete_template_plurality
-        @template_matrix.each do |word_templates|
-          obj_pluralities = []
-          word_templates.each do |word_template|
-            if word_template.plurality == :any
-              # need to pick a plurality for this word
-              if word_template.obj_num > 0
-                # this word is referencing an object, and its plurality can be randomized
-                unless obj_pluralities[word_template.obj_num]
-                  # this word's plurality has not already been determined via another word on this line
-                  obj_pluralities[word_template.obj_num] = [:singular, :plural].sample
-                end
-                word_template.plurality = obj_pluralities[word_template.obj_num]
-              else
-                word_template.plurality = [:singular, :plural].sample
-              end
-            end
-          end
+        @template_matrix.each do |line_template|
+          line_template.complete_plurality
         end
       end
 
       def complete_template_syllables
         syllables = [5, 7, 5]
         @template_matrix.each_index do |i|
-          while HaikuTemplate.row_syllables(@template_matrix[i]) < syllables[i]
-            increased_syllable_index = HaikuTemplate.increase_row_syllable(@template_matrix[i])
-            break if increased_syllable_index.nil?
-          end
-        end
-      end
-
-      def self.real_words_from_templates(word_templates)
-        words = []
-        word_templates.each do |word_template|
-          if word_template.syllables > 0
-            word = word_template.word_type.get_word(
-              word_template.syllables,
-              word_template.plurality
-            )
-            words << word
-          end
-        end
-        HaikuTemplate.convert_a_to_an words
-        words
-      end
-
-      # where necessary, convert 'a' to 'an'
-      def self.convert_a_to_an(words)
-        words.each_index do |i|
-          if words[i] == 'a' && (i < (words.length - 1)) && %w(a e i o u).include?(words[i + 1].slice(0))
-            # current word is 'a', there are more words after this one, and the next one starts with a, e, i, o or u
-            words[i] = 'an'
-          end
-        end
-      end
-
-      def self.row_syllables(word_templates)
-        word_templates.map { |w| w.syllables }.inject(:+)
-      end
-
-      def self.increase_row_syllable(word_templates)
-        valid_word_indices = HaikuTemplate.get_valid_word_indices word_templates
-
-        increase_syllable_index = nil
-        loop do
-          increase_syllable_index = HaikuTemplate.increased_row_syllable_index(word_templates, valid_word_indices)
-          break if increase_syllable_index || valid_word_indices.length == 0
-        end
-        if increase_syllable_index
-          word_templates[increase_syllable_index].syllables += 1
-          increase_syllable_index
-        else
-          nil
-        end
-      end
-
-      def self.get_valid_word_indices(word_templates)
-        out = []
-        word_templates.each_index do |i|
-          out << i unless word_templates[i].word_type.base_symbol == :custom
-        end
-        out
-      end
-
-      # returns the word index where another syllable can be added (and where dictionary words are available)
-      def self.increased_row_syllable_index(word_templates, valid_word_indices)
-        if valid_word_indices.length > 0
-          word_index = valid_word_indices.sample
-          if word_templates[word_index].word_type.words?(
-            word_templates[word_index].syllables + 1,
-            word_templates[word_index].plurality
-          )
-            word_index
-          else
-            # dictionary has no words of this type, remove this index so it isn't checked in the future
-            valid_word_indices.delete word_index
-            nil
-          end
+          @template_matrix[i].complete_syllables syllables[i]
         end
       end
 
       def self.random_template(templates)
         template_or_array = templates.sample
-        if template_or_array[0].is_a? Array
+        if template_or_array.is_a? Array
           # if NESTED object is an array, recurse
           HaikuTemplate.random_template template_or_array
         else
+          # current object should be of type LineTemplate
           template_or_array
         end
       end

data/lib/haiku_gadget/line_template.rb

@@ -0,0 +1,115 @@
+require File.expand_path('haiku_template.rb', File.dirname(__FILE__))
+require File.expand_path('word_template.rb', File.dirname(__FILE__))
+
+module HaikuGadget
+
+  class LineTemplate
+
+    attr_reader :word_templates
+
+    def initialize(*word_templates)
+      @word_templates = word_templates.flatten
+    end
+
+    def clone
+      LineTemplate.new @word_templates.map{ |wt| wt.clone }
+    end
+
+    def current_syllables
+      @word_templates.map { |w| w.syllables }.inject(:+)
+    end
+
+    def get_valid_word_indices
+      out = []
+      @word_templates.each_index do |i|
+        out << i unless @word_templates[i].word_type.base_symbol == :custom
+      end
+      out
+    end
+
+    def increase_row_syllable
+      valid_word_indices = get_valid_word_indices
+
+      increase_syllable_index = nil
+      loop do
+        increase_syllable_index = increased_row_syllable_index valid_word_indices
+        break if increase_syllable_index || valid_word_indices.length == 0
+      end
+      if increase_syllable_index
+        @word_templates[increase_syllable_index].syllables += 1
+        increase_syllable_index
+      else
+        nil
+      end
+    end
+
+    def increased_row_syllable_index(valid_word_indices)
+      if valid_word_indices.length > 0
+        word_index = valid_word_indices.sample
+        if @word_templates[word_index].word_type.words?(
+          @word_templates[word_index].syllables + 1,
+          @word_templates[word_index].plurality
+        )
+          word_index
+        else
+          # dictionary has no words of this type, remove this index so it isn't checked in the future
+          valid_word_indices.delete word_index
+          nil
+        end
+      end
+    end
+
+    def complete_syllables(required_syllables)
+      while current_syllables < required_syllables
+        increased_syllable_index = increase_row_syllable
+        break if increased_syllable_index.nil?
+      end
+    end
+
+    def complete_plurality
+      obj_pluralities = []
+      @word_templates.each do |word_template|
+        if word_template.plurality == :any
+          # need to pick a plurality for this word
+          if word_template.obj_num > 0
+            # this word is referencing an object, and its plurality can be randomized
+            unless obj_pluralities[word_template.obj_num]
+              # this word's plurality has not already been determined via another word on this line
+              obj_pluralities[word_template.obj_num] = [:singular, :plural].sample
+            end
+            word_template.plurality = obj_pluralities[word_template.obj_num]
+          else
+            word_template.plurality = [:singular, :plural].sample
+          end
+        end
+      end
+    end
+
+    def real_words
+      words = []
+      @word_templates.each do |word_template|
+        if word_template.syllables > 0
+          word = word_template.word_type.get_word(
+            word_template.syllables,
+            word_template.plurality
+          )
+          words << word
+        end
+      end
+      LineTemplate.convert_a_to_an words
+      words
+    end
+
+    # where necessary, convert 'a' to 'an'
+    def self.convert_a_to_an(words)
+      words.each_index do |i|
+        if words[i] == 'a' && (i < (words.length - 1)) && %w(a e i o u).include?(words[i + 1].slice(0))
+          # current word is 'a', there are more words after this one, and the next one starts with a, e, i, o or u
+          words[i] = 'an'
+        end
+      end
+    end    
+
+  end
+
+end

data/lib/haiku_gadget/line_templates.rb

@@ -1,32 +1,40 @@
 require File.expand_path('word_template.rb', File.dirname(__FILE__))
+require File.expand_path('line_template.rb', File.dirname(__FILE__))
 
 module HaikuGadget
 
   module LineTemplates
 
     COMMON_LINES = [
-      [
-        # noun(s) act on mass/abstract noun
+
+      # noun(s) act on mass/abstract noun
+      LineTemplate.new(
         WordTemplate.new(:determiner, 0, :any, 1),
         WordTemplate.new(:noun, 1, :any, 1),
         WordTemplate.new(:verb, 1, :any, 1),
         WordTemplate.new(:mass_noun_determiner),
         WordTemplate.new(:mass_noun, 1)
-      ], [
-        # imperative action (command)
+      ),
+
+      # imperative action (command)
+      LineTemplate.new(
         WordTemplate.new(:adverb, 2),
         WordTemplate.new(:verb, 1, :plural),
         WordTemplate.new(:determiner, 0, :plural),
         WordTemplate.new(:adjective, 0, :plural),
         WordTemplate.new(:noun, 1, :plural)
-      ], [
+      ),
+
+      LineTemplate.new(
         # mass/abstract noun is adj
         WordTemplate.new(:mass_noun_determiner),
         WordTemplate.new(:adjective, 0, :common),
         WordTemplate.new(:mass_noun, 1),
         WordTemplate.new(:to_be, 1, :singular),
         WordTemplate.new(:adjective, 1, :any)
-      ], [
+      ),
+
+      LineTemplate.new(
         # noun(s) of mass/abstract noun acts
         WordTemplate.new(:determiner, 0, :any, 1),
         WordTemplate.new(:adjective, 0, :any, 1),
@@ -34,113 +42,135 @@ module HaikuGadget
         WordTemplate.custom('of', 1),
         WordTemplate.new(:mass_noun, 1),
         WordTemplate.new(:verb_self, 1, :any, 1)
-      ], [
+      ),
+
+      LineTemplate.new(
         # adj noun is adj
         WordTemplate.new(:adjective, 0, :any, 1),
         WordTemplate.new(:noun, 1, :any, 1),
         WordTemplate.new(:to_be, 1, :any, 1),
         WordTemplate.new(:adjective, 1, :any, 1)
-      ], [
-        # metaphors
-        [
+      ),
+
+      # metaphors
+      [
+        LineTemplate.new(
           WordTemplate.new(:adjective, 0, :common),
           WordTemplate.new(:mass_noun, 1),
           WordTemplate.custom('is like', 2),
           WordTemplate.new(:adjective, 0, :common),
           WordTemplate.new(:mass_noun, 1)
-        ], [
+        ),
+
+        LineTemplate.new(
           WordTemplate.new(:adjective, 0, :plural),
           WordTemplate.new(:noun, 1, :plural),
           WordTemplate.custom('are like', 2),
           WordTemplate.new(:adjective, 0, :common),
           WordTemplate.new(:mass_noun, 1)
-        ], [
-          WordTemplate.new(:determiner, 1, :singular, 1),
+        ),
+
+        LineTemplate.new(
+          WordTemplate.new(:determiner, 0, :singular, 1),
           WordTemplate.new(:adjective, 0, :singular, 1),
           WordTemplate.new(:noun, 1, :singular, 1),
           WordTemplate.custom('is like', 2),
           WordTemplate.new(:determiner, 1, :singular, 2),
           WordTemplate.new(:adjective, 0, :singular, 2),
           WordTemplate.new(:noun, 1, :singular, 2)
-        ], [
+        ),
+
+        LineTemplate.new(
           WordTemplate.new(:adjective, 0, :plural, 1),
           WordTemplate.new(:noun, 1, :plural, 1),
           WordTemplate.custom('are like', 2),
           WordTemplate.new(:adjective, 0, :plural, 2),
           WordTemplate.new(:noun, 1, :plural, 2)
-        ]
-      ], [
-        # i/we/they act on noun(s)
-        [
+        )
+      ],
+
+      # i/we/they act on noun(s)
+      [
+        LineTemplate.new(
           WordTemplate.custom(%w(i we they), 1),
           WordTemplate.new(:verb, 1, :plural),
           WordTemplate.new(:determiner, 1, :singular, 2),
           WordTemplate.new(:adjective, 0, :singular, 2),
           WordTemplate.new(:noun, 1, :singular, 2),
           WordTemplate.new(:adverb)
-        ], [
+        ),
+
+        LineTemplate.new(
           WordTemplate.custom(%w(i we they), 1),
           WordTemplate.new(:verb, 1, :plural),
           WordTemplate.new(:determiner, 0, :plural, 2),
           WordTemplate.new(:adjective, 0, :plural, 2),
           WordTemplate.new(:noun, 1, :plural, 2),
           WordTemplate.new(:adverb)
-        ]
-      ], [
-        # noun(s) act on noun(s)
-        [
+        )
+      ],
+
+      # noun(s) act on noun(s)
+      [
+        LineTemplate.new(
           WordTemplate.new(:determiner, 0, :any, 1),
           WordTemplate.new(:noun, 1, :any, 1),
           WordTemplate.new(:verb, 1, :any, 1),
           WordTemplate.new(:determiner, 1, :singular, 2),
           WordTemplate.new(:noun, 1, :singular, 2)
-        ], [
+        ),
+
+        LineTemplate.new(
           WordTemplate.new(:determiner, 0, :any, 1),
           WordTemplate.new(:noun, 1, :any, 1),
           WordTemplate.new(:verb, 1, :any, 1),
           WordTemplate.new(:determiner, 0, :plural, 2),
           WordTemplate.new(:noun, 1, :plural, 2)
-        ]
+        )
       ]
     ]
 
     MIDDLE_LINES = [
+      # (and) noun(s) act
       [
-        # (and) noun(s) act
-        [
+        LineTemplate.new(
           WordTemplate.new(:transition_join),
           WordTemplate.new(:determiner, 1, :singular, 1),
           WordTemplate.new(:adjective, 0, :singular, 1),
           WordTemplate.new(:noun, 1, :singular, 1),
           WordTemplate.new(:verb_self, 1, :singularß, 1),
           WordTemplate.new(:adverb)
-        ], [
+        ),
+
+        LineTemplate.new(  
           WordTemplate.new(:transition_join),
           WordTemplate.new(:determiner, 0, :plural, 1),
           WordTemplate.new(:adjective, 0, :plural, 1),
           WordTemplate.new(:noun, 1, :plural, 1),
           WordTemplate.new(:verb_self, 1, :plural, 1),
           WordTemplate.new(:adverb)
-        ]
+        )
       ]
     ]
 
     BOTTOM_LINES = [
+      # (and) noun(s) act
       [
-        # (and) noun(s) act
-        [
+        LineTemplate.new(
           WordTemplate.new(:transition_join),
           WordTemplate.new(:determiner, 1, :singular, 1),
           WordTemplate.new(:adjective, 0, :singular, 1),
           WordTemplate.new(:noun, 1, :singular, 1),
           WordTemplate.new(:verb_self, 1, :singular, 1)
-        ], [
+        ),
+
+        LineTemplate.new(
           WordTemplate.new(:transition_join),
           WordTemplate.new(:determiner, 0, :plural, 1),
           WordTemplate.new(:adjective, 0, :plural, 1),
           WordTemplate.new(:noun, 1, :plural, 1),
           WordTemplate.new(:verb_self, 1, :plural, 1)
-        ]
+        )
       ]
     ]
 

data/lib/haiku_gadget/version.rb

@@ -1,5 +1,5 @@
 module HaikuGadget
 
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 
 end

data/lib/words.yml

@@ -74,12 +74,12 @@
   ]
 :verb_singular: [
     [soothes],
-    [eases, nudges, uses, raises, slices, falls on, dreams of, jumps over, looks at, looks for, studies, tosses, touches, coaxes, pushes, reaches, punches, cares for, ties up, sticks to, goes to, swarms on, flails at, cooks for, kisses, smooches, speaks to, quests for, raves about, sits on, waves to, shines on, mixes, watches, copies, marries, senses, closes, sings to, smiles at, asks for, hopes for, toys with, plays with, floats on, lives with, steps on, jives with, hops on, washes, sounds like],
+    [eases, nudges, uses, raises, slices, falls on, dreams of, jumps over, looks at, looks for, studies, tosses, touches, coaxes, pushes, reaches, punches, cares for, ties up, sticks to, goes to, swarms on, flails at, cooks for, kisses, smooches, speaks to, quests for, raves about, sits on, waves to, shines on, mixes, watches, copies, marries, senses, closes, sings to, smiles at, asks for, hopes for, toys with, plays with, floats on, lives on, lives with, steps on, jives with, hops on, washes, sounds like],
     [amazes, cares about, notifies, objects to, condenses, beautifies, glorifies, liquefies, nullifies, occupies, purifies, satisfies, stupefies, wishes for, thinks about, writes about]
   ]
 :verb_plural: [
     [ease, nudge, use, raise, slice, study, toss, touch, coax, push, reach, punch, kiss, smooch, mix, watch, copy, sense, soothe, close, wash],
-    [amaze, fall on, dream of, jump over, look at, look for, finish, care for, approach, tie up, stick to, go to, swarm on, flail at, cook for, dance with, dance for, speak to, quest for, rave about, sit on, wave to, shine on, condense, marry, advise, sing to, smile at, ask for, hope for, wish for, toy with, play with, think about, float on, lives on, step on, jive with, hop on, sound like],
+    [amaze, fall on, dream of, jump over, look at, look for, finish, care for, approach, tie up, stick to, go to, swarm on, flail at, cook for, dance with, dance for, speak to, quest for, rave about, sit on, wave to, shine on, condense, marry, advise, sing to, smile at, ask for, hope for, wish for, toy with, play with, think about, float on, live on, live with, step on, jive with, hop on, sound like],
     [care about, notify, object to, beautify, glorify, liquefy, nullify, occupy, purify, satisfy, stupefy, vandalize, vaporize, minimize, maximize, encourage, equalize, pulverize, write about]
   ]
 

data/spec/haiku_gadget/haiku_gadget_spec.rb

@@ -58,20 +58,22 @@ module HaikuGadget
       dict_path = '../../spec/test_words_single.yml'
 
       haiku_template = HaikuTemplate.new [
-        [
+        LineTemplate.new(
           WordTemplate.new(:adjective, 1, :singular, 1),  # red
           WordTemplate.new(:noun, 1, :singular, 1),       # thing
           WordTemplate.new(:verb_self, 3, :singular, 1)   # meditates
-        ], [
+        ),
+        LineTemplate.new(
           WordTemplate.new(:determiner, 1, :plural, 1),   # the
           WordTemplate.new(:noun, 3, :plural, 1),         # samurais
           WordTemplate.new(:verb, 1, :plural, 1),         # see
           WordTemplate.new(:noun, 2, :singular, 2)        # zombie
-        ], [
+        ),
+        LineTemplate.new(
           WordTemplate.new(:adjective, 2, :any, 1),  # orange
           WordTemplate.new(:noun, 2, :any, 1),       # zombie(s)
           WordTemplate.new(:verb_self, 1, :any, 1)   # fight(s)
-        ]
+        )
       ]
 
       before(:each) do
@@ -127,9 +129,9 @@ module HaikuGadget
       it 'should return a haiku containing expected words' do
 
         haiku_template = HaikuTemplate.new [
-          [WordTemplate.new(:mass_noun, 5)],
-          [WordTemplate.new(:mass_noun, 7)],
-          [WordTemplate.new(:mass_noun, 5)]
+          LineTemplate.new(WordTemplate.new :mass_noun, 5),
+          LineTemplate.new(WordTemplate.new :mass_noun, 7),
+          LineTemplate.new(WordTemplate.new :mass_noun, 5)
         ]
 
         haiku = HaikuGadget.haiku nil, haiku_template
@@ -146,6 +148,31 @@ module HaikuGadget
       end
 
     end
+
+    describe 'with built-in line templates' do
+
+      it 'should not have invalid syllable defaults' do
+
+        template_pairs = [
+          [LineTemplates::ALL_TOP_LINES.flatten, 5],
+          [LineTemplates::ALL_MIDDLE_LINES.flatten, 7],
+          [LineTemplates::ALL_BOTTOM_LINES.flatten, 5]
+        ]
+
+        template_pairs.each do |pair|
+          line_templates, syllables = pair
+
+          line_templates.each do |line_template|
+
+            expect(line_template.current_syllables).to be <= syllables
+
+          end
+
+        end
+
+      end
+
+    end
      
   end
 

data/test_haiku.rb

@@ -1,8 +1,10 @@
 require File.expand_path('lib/haiku_gadget.rb', File.dirname(__FILE__))
 
-10.times do
-  
   puts HaikuGadget.haiku "\n"
+
   puts "\n"
 
-end
+  puts HaikuGadget.top_line
+  puts HaikuGadget.middle_line
+  puts HaikuGadget.bottom_line
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haiku_gadget
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Scott Balay
@@ -71,6 +71,7 @@ files:
 - lib/haiku_gadget/dictionary.rb
 - lib/haiku_gadget/haiku_gadget.rb
 - lib/haiku_gadget/haiku_template.rb
+- lib/haiku_gadget/line_template.rb
 - lib/haiku_gadget/line_templates.rb
 - lib/haiku_gadget/version.rb
 - lib/haiku_gadget/word_template.rb