whirled_peas 0.4.0 → 0.7.1

data/lib/whirled_peas/utils/formatted_string.rb

@@ -0,0 +1,64 @@
+require_relative 'ansi'
+
+module WhirledPeas
+  module Utils
+    class FormattedString
+      def self.blank
+        new('')
+      end
+
+      def initialize(raw, formatting=nil)
+        @raw = raw
+        @formatting = [*formatting]
+      end
+
+      def length
+        raw.length
+      end
+
+      def [](index_or_range)
+        self.class.new(raw[index_or_range], foramtting)
+      end
+
+      def blank?
+        raw.empty?
+      end
+
+      def hash
+        [raw, formatting].hash
+      end
+
+      def ==(other)
+        case other
+        when self.class
+          hash == other.hash
+        when String
+          formatting.empty? && raw == other
+        else
+          false
+        end
+      end
+
+      def to_s
+        if raw.empty? || formatting.length == 0
+          raw
+        else
+          start_formatting = formatting.map { |code| Ansi.esc_seq(code) }.join
+          "#{start_formatting}#{raw}#{Ansi.clear}"
+        end
+      end
+
+      def inspect
+        if raw.empty? || formatting.length == 0
+          raw.inspect
+        else
+          "<#{formatting.join(', ')}>#{raw}<0>".inspect
+        end
+      end
+
+      private
+
+      attr_reader :raw, :formatting
+    end
+  end
+end

data/lib/whirled_peas/utils/title_font.rb

@@ -6,7 +6,7 @@ module WhirledPeas
 
       class << self
         def validate!(font_key)
-          return unless font_key
+          return if font_key.nil?
           return font_key if fonts.key?(font_key)
           allowed = fonts.keys.map(&:inspect).sort
           message = "Unrecognized font: '#{font_key.inspect}', expecting one of #{allowed.join(', ')}"

data/lib/whirled_peas/version.rb

@@ -1,3 +1,3 @@
 module WhirledPeas
-  VERSION = '0.4.0'
+  VERSION = '0.7.1'
 end

data/screen_test/elements/box.frame

@@ -0,0 +1 @@
+[?25lTOP LEFTBOTTOM LEFT TOP RIGHT    BOTTOM RIGHT[?25h

data/screen_test/elements/box.rb

@@ -0,0 +1,20 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box('Container') do |composer, settings|
+        composer.add_box do |composer, settings|
+          settings.flow = :t2b
+          composer.add_box('TopLeft') { "TOP LEFT" }
+          composer.add_box('BottomLeft') { "BOTTOM LEFT" }
+        end
+        composer.add_box do |composer, settings|
+          settings.flow = :t2b
+          composer.add_box('TopRight') { " TOP RIGHT   " }
+          composer.add_box('BottomRight') { " BOTTOM RIGHT" }
+        end
+      end
+    end
+  end
+end

data/screen_test/elements/grid.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━┳━━━━━━┳━━━━━━┓┃      ┃      ┃      ┃┣━━━━━━╋━━━━━━╋━━━━━━┫┃      ┃      ┃      ┃┣━━━━━━╋━━━━━━╋━━━━━━┫┃      ┃      ┃      ┃┗━━━━━━┻━━━━━━┻━━━━━━┛Item 0Item 1Item 2Item 3Item 4Item 5Item 6[?25h

data/screen_test/elements/grid.rb

@@ -0,0 +1,13 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid('Grid') do |_, settings|
+        settings.num_cols = 3
+        settings.full_border
+        7.times.map { |i| "Item #{i}" }
+      end
+    end
+  end
+end

data/screen_test/elements/screen_overflow_x.frame

@@ -0,0 +1 @@
+[?25l--------------------------------[?25h

data/screen_test/elements/screen_overflow_x.rb

@@ -0,0 +1,9 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do
+      '-' * 1000
+    end
+  end
+end

data/screen_test/elements/screen_overflow_y.frame

@@ -0,0 +1 @@
+[?25l||||||||||||||||||||||||[?25h

data/screen_test/elements/screen_overflow_y.rb

@@ -0,0 +1,9 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do
+      "|\n" * 1000
+    end
+  end
+end

data/screen_test/elements/text.frame

@@ -0,0 +1 @@
+[?25lHello, World![?25h

data/screen_test/elements/text.rb

@@ -0,0 +1,9 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      "Hello, World!"
+    end
+  end
+end

data/screen_test/elements/text_multiline.frame

@@ -0,0 +1 @@
+[?25lLine 1Line 2Line 3[?25h

data/screen_test/elements/text_multiline.rb

@@ -0,0 +1,9 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      "Line 1\nLine 2\nLine 3"
+    end
+  end
+end

data/screen_test/settings/align/box_around.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━┓┃               ┃┗━━━━━━━━━━━━━━━┛ABC[?25h

data/screen_test/settings/align/box_around.rb

@@ -0,0 +1,16 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.full_border
+        settings.align = :around
+        settings.width = 15
+        composer.add_text { 'A' }
+        composer.add_text { 'B' }
+        composer.add_text { 'C' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/box_between.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━┓┃               ┃┗━━━━━━━━━━━━━━━┛ABC[?25h

data/screen_test/settings/align/box_between.rb

@@ -0,0 +1,16 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.full_border
+        settings.align = :between
+        settings.width = 15
+        composer.add_text { 'A' }
+        composer.add_text { 'B' }
+        composer.add_text { 'C' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/box_center.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━┓┃                      ┃┃                      ┃┗━━━━━━━━━━━━━━━━━━━━━━┛This is an aligned boxCenter[?25h

data/screen_test/settings/align/box_center.rb

@@ -0,0 +1,21 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        composer.add_box('Alignment') do |composer, settings|
+          settings.flow = :t2b
+          settings.full_border
+          settings.align = :center
+          # Keep the title long so grids below will be wide enough to use the
+          # alignment attribute. Don't rely on the `width` attribute to keep
+          # `align` isolated in this test.
+          composer.add_text('Title') { 'This is an aligned box' }
+          composer.add_text('Content') { 'Center' }
+        end
+      end
+    end
+  end
+end

data/screen_test/settings/align/box_default.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━┓┃                      ┃┃                      ┃┗━━━━━━━━━━━━━━━━━━━━━━┛This is an aligned boxDefault[?25h

data/screen_test/settings/align/box_default.rb

@@ -0,0 +1,20 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        composer.add_box('Alignment') do |composer, settings|
+          settings.flow = :t2b
+          settings.full_border
+          # Keep the title long so grids below will be wide enough to use the
+          # alignment attribute. Don't rely on the `width` attribute to keep
+          # `align` isolated in this test.
+          composer.add_text('Title') { 'This is an aligned box' }
+          composer.add_text('Content') { 'Default' }
+        end
+      end
+    end
+  end
+end

data/screen_test/settings/align/box_evenly.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━┓┃               ┃┗━━━━━━━━━━━━━━━┛ABC[?25h

data/screen_test/settings/align/box_evenly.rb

@@ -0,0 +1,16 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.full_border
+        settings.align = :evenly
+        settings.width = 15
+        composer.add_text { 'A' }
+        composer.add_text { 'B' }
+        composer.add_text { 'C' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/box_left.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━┓┃                      ┃┃                      ┃┗━━━━━━━━━━━━━━━━━━━━━━┛This is an aligned boxLeft[?25h

data/screen_test/settings/align/box_left.rb

@@ -0,0 +1,21 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        composer.add_box('Alignment') do |composer, settings|
+          settings.flow = :t2b
+          settings.full_border
+          settings.align = :left
+          # Keep the title long so grids below will be wide enough to use the
+          # alignment attribute. Don't rely on the `width` attribute to keep
+          # `align` isolated in this test.
+          composer.add_text('Title') { 'This is an aligned box' }
+          composer.add_text('Content') { 'Left' }
+        end
+      end
+    end
+  end
+end

data/screen_test/settings/align/box_right.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━┓┃                      ┃┃                      ┃┗━━━━━━━━━━━━━━━━━━━━━━┛This is an aligned boxRight[?25h

data/screen_test/settings/align/box_right.rb

@@ -0,0 +1,21 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid do |composer, settings|
+        settings.num_cols = 2
+        composer.add_box('Alignment') do |composer, settings|
+          settings.flow = :t2b
+          settings.full_border
+          settings.align = :right
+          # Keep the title long so grids below will be wide enough to use the
+          # alignment attribute. Don't rely on the `width` attribute to keep
+          # `align` isolated in this test.
+          composer.add_text('Title') { 'This is an aligned box' }
+          composer.add_text('Content') { 'Right' }
+        end
+      end
+    end
+  end
+end

data/screen_test/settings/align/children_center.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓┃                            ┃┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛Thing 1Thing 2[?25h

data/screen_test/settings/align/children_center.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.align = :center
+        settings.width = 28
+        settings.full_border
+        composer.add_text('Text1') { 'Thing 1' }
+        composer.add_text('Text2') { 'Thing 2' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/children_left.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓┃                            ┃┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛Thing 1Thing 2[?25h

data/screen_test/settings/align/children_left.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.align = :left
+        settings.width = 28
+        settings.full_border
+        composer.add_text('Text1') { 'Thing 1' }
+        composer.add_text('Text2') { 'Thing 2' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/children_right.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓┃                            ┃┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛Thing 1Thing 2[?25h

data/screen_test/settings/align/children_right.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_box do |composer, settings|
+        settings.align = :right
+        settings.width = 28
+        settings.full_border
+        composer.add_text('Text1') { 'Thing 1' }
+        composer.add_text('Text2') { 'Thing 2' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/grid_center.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━━┓┃                       ┃┣━━━━━━━━━━━━━━━━━━━━━━━┫┃                       ┃┗━━━━━━━━━━━━━━━━━━━━━━━┛This is an aligned gridCenter[?25h

data/screen_test/settings/align/grid_center.rb

@@ -0,0 +1,18 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid('Alignment') do |composer, settings|
+        settings.num_cols = 1
+        settings.full_border
+        settings.align = :center
+        # Keep the title long so grids below will be wide enough to use the
+        # alignment attribute. Don't rely on the `width` attribute to keep
+        # `align` isolated in this test.
+        composer.add_text('Title') { 'This is an aligned grid' }
+        composer.add_text('Content') { 'Center' }
+      end
+    end
+  end
+end

data/screen_test/settings/align/grid_default.frame

@@ -0,0 +1 @@
+[?25l┏━━━━━━━━━━━━━━━━━━━━━━━┓┃                       ┃┣━━━━━━━━━━━━━━━━━━━━━━━┫┃                       ┃┗━━━━━━━━━━━━━━━━━━━━━━━┛This is an aligned gridDefault[?25h

data/screen_test/settings/align/grid_default.rb

@@ -0,0 +1,17 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_grid('Alignment') do |composer, settings|
+        settings.num_cols = 1
+        settings.full_border
+        # Keep the title long so grids below will be wide enough to use the
+        # alignment attribute. Don't rely on the `width` attribute to keep
+        # `align` isolated in this test.
+        composer.add_text('Title') { 'This is an aligned grid' }
+        composer.add_text('Content') { 'Default' }
+      end
+    end
+  end
+end