whirled_peas 0.1.1 → 0.5.0

data/lib/whirled_peas/template/element.rb

@@ -0,0 +1,13 @@
+module WhirledPeas
+  module Template
+    class Element
+      attr_reader :name, :settings
+
+      def initialize(name, settings)
+        @name = name
+        @settings = settings
+      end
+    end
+    private_constant :Element
+  end
+end

data/lib/whirled_peas/template/grid_element.rb

@@ -0,0 +1,8 @@
+require_relative 'container'
+
+module WhirledPeas
+  module Template
+    class GridElement < Container
+    end
+  end
+end

data/lib/whirled_peas/template/text_element.rb

@@ -0,0 +1,24 @@
+require_relative 'element'
+
+module WhirledPeas
+  module Template
+    class TextElement < Element
+      # List of classes that convert nicely to a string
+      STRINGALBE_CLASSES = [FalseClass, Float, Integer, NilClass, String, Symbol, TrueClass]
+      private_constant :STRINGALBE_CLASSES
+
+      def self.stringable?(value)
+        STRINGALBE_CLASSES.include?(value.class)
+      end
+
+      attr_reader :content
+
+      def content=(val)
+        unless self.class.stringable?(val)
+          raise ArgumentError, "Unsupported type for TextElement: #{val.class}"
+        end
+        @content = val.to_s
+      end
+    end
+  end
+end

data/lib/whirled_peas/utils.rb

@@ -0,0 +1,5 @@
+module WhirledPeas
+  module Utils
+  end
+  private_constant :Utils
+end

data/lib/whirled_peas/utils/ansi.rb

@@ -0,0 +1,53 @@
+module WhirledPeas
+  module Utils
+    # Helper module for working with ANSI escape codes. The most useful ANSI escape codes
+    # relate to text formatting.
+    #
+    # @see https://en.wikipedia.org/wiki/ANSI_escape_code
+    module Ansi
+      ESC = "\033"
+
+      END_FORMATTING = 0
+      private_constant :END_FORMATTING
+
+      # Text formatting constants
+      BOLD = 1
+      UNDERLINE = 4
+
+      # Text and background color constants
+      BLACK = 30
+      RED = 31
+      GREEN = 32
+      YELLOW = 33
+      BLUE = 34
+      MAGENTA = 35
+      CYAN = 36
+      WHITE = 37
+
+      # Bright colors are offset by this much from their standard versions
+      BRIGHT_OFFSET = 60
+
+      class << self
+        def cursor_pos(top: 0, left: 0)
+          "#{ESC}[#{top + 1};#{left + 1}H"
+        end
+
+        def cursor_visible(visible)
+          visible ? "#{ESC}[?25h" : "#{ESC}[?25l"
+        end
+
+        def clear_down
+          "#{ESC}[J"
+        end
+
+        def clear
+          esc_seq(END_FORMATTING)
+        end
+
+        def esc_seq(code)
+          "#{ESC}[#{code}m"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module WhirledPeas
+  module Utils
+    module TitleFont
+      PREFERRED_DEFAULT_FONT = :ansishadow
+      FONT_CACHE = File.join(ENV['HOME'] || '.', '.whirled_peas.fonts')
+
+      class << self
+        def validate!(font_key)
+          return unless font_key
+          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(', ')}"
+          raise ArgumentError, message
+        end
+
+        def to_s(string, font_key)
+          require 'ruby_figlet'
+          RubyFiglet::Figlet.new(string, fonts[font_key]).to_s
+        end
+
+        def fonts
+          return @fonts if @fonts
+          File.exist?(FONT_CACHE) ? load_fonts_from_cache : load_fonts_from_figlet
+          @fonts
+        end
+
+        def load_fonts_from_cache
+          require 'json'
+          @fonts = {}
+          File.open(FONT_CACHE, 'r') do |fp|
+            JSON.parse(fp.read).each do |key, value|
+              @fonts[key.to_sym] = value
+            end
+          end
+          @fonts
+        end
+
+        def load_fonts_from_figlet
+          require 'ruby_figlet'
+          require 'json'
+          @fonts = {}
+          RubyFiglet::Figlet.available.strip.split("\n").each do |font|
+            # Load the font to be sure it exists on the system
+            next unless available?(font)
+            string_key = font.downcase.gsub(/\W/, '')
+            string_key = "_#{string_key}" if string_key[0] !~ /[a-z]/
+            string_key.gsub!(/\d+$/, '')
+            next if @fonts.key?(string_key)
+            @fonts[string_key.to_sym] = font
+          end
+          @fonts[:default] ||= @fonts[PREFERRED_DEFAULT_FONT] || @fonts.values.first
+          File.open(FONT_CACHE, 'w') { |fp| fp.write(JSON.generate(@fonts)) }
+          @fonts
+        end
+
+        private
+
+        def available?(font)
+          # Figlet's font loader prints to STDOUT if the font file is not found.
+          # Temporarily redirect STDOUT to /dev/null while the font file is loaded
+          # then remove the redirect in an ensure block. Also, if a font file is
+          # not available, a SystemExit is raise :/
+          original_stdout = $stdout.clone
+          $stdout.reopen(File.new('/dev/null', 'w'))
+          RubyFiglet::Figlet.new('Text', font)
+          true
+        rescue SystemExit, NoMethodError
+          false
+        ensure
+          $stdout.reopen(original_stdout)
+        end
+      end
+    end
+  end
+end

data/lib/whirled_peas/version.rb

@@ -1,3 +1,3 @@
 module WhirledPeas
-  VERSION = '0.1.1'
+  VERSION = '0.5.0'
 end

data/screen_test/rendered/elements/box.frame

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

data/screen_test/rendered/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/rendered/elements/grid.frame

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

data/screen_test/rendered/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/rendered/elements/screen_overflow.rb

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

data/screen_test/rendered/elements/text.frame

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

data/screen_test/rendered/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/rendered/elements/text_multiline.frame

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

data/screen_test/rendered/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/rendered/settings/align/box.frame

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

data/screen_test/rendered/settings/align/box.rb

@@ -0,0 +1,20 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      [nil, :left, :center, :right].each do |align|
+        composer.add_box("Alignment-#{align || :default}") do |composer, settings|
+          settings.flow = :t2b
+          settings.full_border
+          settings.align = align
+          # 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') { align || :default }
+        end
+      end
+    end
+  end
+end

data/screen_test/rendered/settings/align/children_center.frame

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

data/screen_test/rendered/settings/align/children_center.rb

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

data/screen_test/rendered/settings/align/children_left.frame

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

data/screen_test/rendered/settings/align/children_left.rb

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

data/screen_test/rendered/settings/align/children_right.frame

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

data/screen_test/rendered/settings/align/children_right.rb

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

data/screen_test/rendered/settings/align/grid.frame

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

data/screen_test/rendered/settings/align/grid.rb

@@ -0,0 +1,20 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      [nil, :left, :center, :right].each do |align|
+        composer.add_grid("Alignment-#{align || :default}") do |composer, settings|
+          settings.num_cols = 1
+          settings.full_border
+          settings.align = align
+          # 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') { align || :default }
+        end
+      end
+    end
+  end
+end

data/screen_test/rendered/settings/ansi/bold.frame

@@ -0,0 +1 @@
+[?25lThis is boldThis is not bold[?25h

data/screen_test/rendered/settings/ansi/bold.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas'
+
+class TemplateFactory
+  def build(*)
+    WhirledPeas.template do |composer|
+      composer.add_text('Bold') do |_, settings|
+        settings.bold = true
+        "This is bold"
+      end
+      composer.add_text('NotBold') do |_, settings|
+        "This is not bold"
+      end
+    end
+  end
+end