hiq 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feffecaed3b4b0269c1959d10fd992c44f9f8b14bc2cdfad0fa07a674a501d86
-  data.tar.gz: c3f59d4b20a0cec63a28a78ff4b388cccd8ad7ba3d9a1d27e45563674064b67f
+  metadata.gz: 01f5f0694196e980cd36d86d7c3995d05a72548230a37b513570ee0c5faed998
+  data.tar.gz: b67a7324ae0deb31451a7797ba27af9127ef743669259743a7c7e4a6ef0553ef
 SHA512:
-  metadata.gz: 9e50c6cbcbfd02943102b71cfd7a5cbc31e4cd6f9670c99cfdecf9f4c53dcdcbb21267019d0bd9f584401ee7fa040ca12f1b165d5bae90dbc52d32e17c33f583
-  data.tar.gz: 8f7a7f1d867ad5b5492244ff2f3b9ac398f0ad0b9480827e1a14ca7479d7f0d8aba772a3649c8b2e6df82360bf60190fb5cd455eb8931a74b49ad534e4be689e
+  metadata.gz: '0803d7976ba63d812f742c4d400cce9e1b61e182ea93c925023d08ed3b1dad520e653f808ddac05056ac89de994701f0c921f999d8fb2edb607005c19fa77b9b'
+  data.tar.gz: 62b8b18edca28bec99356dfc502c904f9dcb1c9aa125ca4d0fdd3e8e0e8abf0f9117db13a822cf892a926d42b7b8caa876920bfd69faf1a9b8d7902fc51884f7

data/lib/hiq/domain/filler_library.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Hiq
+  # Provided of filler for lines of haiku
+  class FillerLibrary
+    def self.interpolated_fillers
+      {
+        1 => ['the X', 'a X'],
+        2 => ['ghastly X', 'the pale X'],
+        3 => ['shadow of X', 'X in silence'],
+        4 => ['X of my joy fade', 'X ends the autumn'],
+        5 => ['A spark of X above'],
+        6 => ['the sad facade of X torn']
+      }
+    end
+
+    def self.fillers
+      {
+        5 => ['empty riverside', 'tears flow in the rain', 'cheerful summer\'s charm'],
+        7 => ['the vain wind of summer blows', 'gentle breeze upon a mountain', 'a frog jumps into a well']
+      }
+    end
+
+    attr_reader :ifillers, :cfillers
+
+    def initialize
+      @ifillers = FillerLibrary.interpolated_fillers
+      @cfillers = FillerLibrary.fillers
+    end
+
+    def get_const_filler(filler_length)
+      cfillers[filler_length].delete(cfillers[filler_length].sample)
+    end
+
+    def get_interpolated_filler(filler_length)
+      ifillers[filler_length].delete(ifillers[filler_length].sample)
+    end
+  end
+end

data/lib/hiq/domain/line_composer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Hiq
+  # service responsible for composing a single line of Haiku
+  class LineComposer
+    include Syllabizable
+
+    attr_reader :line, :target_syllable_length, :library
+
+    def self.call(line, target_syllable_length:, library:)
+      new(line, target_syllable_length: target_syllable_length, library: library).call
+    end
+
+    def initialize(line, target_syllable_length:, library:)
+      @line = line
+      @target_syllable_length = target_syllable_length
+      @library = library
+    end
+
+    def call
+      return line if syllable_gap_size.zero?
+
+      filled_line
+    end
+
+    private
+
+    def syllable_gap_size
+      target_syllable_length - line.map { |word| syllables(word) }.sum
+    end
+
+    def filled_line
+      return [library.get_const_filler(target_syllable_length)] if line.empty?
+
+      [library.get_interpolated_filler(syllable_gap_size).gsub('X', line.first)]
+    end
+  end
+end

data/lib/hiq/domain/word_checker.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Hiq
+  # service for checking whether haiku can be constructed out of those words
+  class WordChecker
+    include Syllabizable
+
+    attr_reader :words
+
+    def self.validate!(words)
+      new(words).validate!
+    end
+
+    def initialize(words)
+      @words = words
+    end
+
+    def validate!
+      ensure_word_length
+      ensure_word_composition
+    end
+
+    private
+
+    def ensure_word_composition
+      raise WordsCompositionError if syllable_count.select { |count| count > 5 }.size > 1
+      raise WordsCompositionError if syllable_count.select { |count| count == 5 }.size > 3
+    end
+
+    def ensure_word_length
+      raise TooManyWordsError if words.size > 3
+      raise WordTooLongError if syllable_count.any? { |count| count > 7 }
+      raise WordsTooLongError if syllable_count.sum > 22
+    end
+
+    def syllable_count
+      @syllable_count ||= words.map { |word| syllables(word) }
+    end
+  end
+end

data/lib/hiq/exceptions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Hiq
+  # Basic haiku error
+  class WordLengthError < StandardError
+  end
+
+  # limiting number of words to 3
+  class TooManyWordsError < StandardError
+    def failure_message
+      'The API is currently limited to 3 words'
+    end
+  end
+
+  # Exception for when one of the words is too long to fit into haiku
+  class WordTooLongError < WordLengthError
+    def failure_message
+      'At least one of the words provided exceeds 7 syllables - haiku with such word is impossible'
+    end
+  end
+
+  # Exception for when word composition is unattainable
+  class WordsCompositionError < WordLengthError
+    def failure_message
+      'The words provided cannot meet the haiku composition requirement due to their length'
+    end
+  end
+
+  # Exception for when too many syllables are provided by the user
+  class WordsTooLongError < WordLengthError
+    def failure_message
+      'Words provided exceed 22 syllables - haiku needs to be 22 syllables long'
+    end
+  end
+end

data/lib/hiq/haiku.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Hiq
+  # Haiku generating object
+  class Haiku
+    include Syllabizable
+
+    attr_reader :words
+
+    def initialize(words)
+      @words = words.sort_by(&:size)
+    end
+
+    def to_s
+      haiku_lines.map { |l| l.join(' ') }.join("\n")
+    end
+
+    private
+
+    def haiku_lines
+      WordChecker.validate!(words)
+
+      library = FillerLibrary.new
+
+      [5, 7, 5].zip(line_templates).map do |syllabes, line|
+        LineComposer.call(line, target_syllable_length: syllabes, library: library)
+      end
+    end
+
+    def line_templates
+      lines = [[], [], []]
+      words.each do |word|
+        lines.detect { |l| l.size == lines.map(&:size).min } << word
+      end
+      lines
+    end
+  end
+end

data/lib/hiq/syllabizable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Hiq
+  # syllabization functionality
+  module Syllabizable
+    def syllables(word)
+      word.downcase.scan(/[aeiouy]/).size - diphtongs(word) - triphtongs(word) - silent_e_count(word)
+    end
+
+    def diphtongs(word)
+      word.downcase.scan(/(?:[^aeiouy]|^)([aeiouy][aeiouy])(?:[^aeiouy]|$)/).size
+    end
+
+    def triphtongs(word)
+      word.downcase.scan(/(?:[^aeiouy]|^)([aeiouy][aeiouy][aeiouy])([^aeiouy]|$)/).size
+    end
+
+    def silent_e_count(word)
+      return 0 if word == 'the'
+
+      word.downcase[-1] == 'e' ? 1 : 0
+    end
+  end
+end

data/lib/hiq/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hiq
+  VERSION = '0.2.3'
+end

data/lib/hiq.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require 'version'
-require 'syllabizable'
-require 'exceptions'
-require 'domain/word_checker'
-require 'domain/line_composer'
-require 'haiku'
+require 'hiq/version'
+require 'hiq/syllabizable'
+require 'hiq/exceptions'
+require 'hiq/domain/word_checker'
+require 'hiq/domain/filler_library'
+require 'hiq/domain/line_composer'
+require 'hiq/haiku'
 
 # haiku main module
 module Hiq

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Jan Taras
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-20 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -87,11 +87,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hiq.rb
+- lib/hiq/domain/filler_library.rb
+- lib/hiq/domain/line_composer.rb
+- lib/hiq/domain/word_checker.rb
+- lib/hiq/exceptions.rb
+- lib/hiq/haiku.rb
+- lib/hiq/syllabizable.rb
+- lib/hiq/version.rb
 homepage: https://github.com/TarasJan/hiq
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Hiq - a Haiku generator
 test_files: []