whirled_peas 0.4.0 → 0.7.1

data/lib/whirled_peas/settings/debugger.rb

@@ -0,0 +1,96 @@
+require_relative 'border'
+require_relative 'container_settings'
+require_relative 'margin'
+require_relative 'padding'
+require_relative 'position'
+require_relative 'scrollbar'
+
+module WhirledPeas
+  module Settings
+    class Debugger
+      def initialize(settings)
+        @settings = settings
+      end
+
+      def debug(indent='')
+        values = non_default_values(indent + '  ')
+        details = values.length > 0 ? values.join("\n") : "#{indent}  <default>"
+        "#{indent}#{settings.class}\n#{details}"
+      end
+
+      private
+
+      attr_reader :settings
+
+      def non_default_values(indent)
+        settings.instance_variables.map do |ivar, values|
+          value = settings.instance_variable_get(ivar)
+          next if value.nil?
+          printable_value = debug_value(value)
+          "#{indent}#{ivar.to_s.sub(/^@?_?/, '')}: #{printable_value}" unless printable_value.nil?
+        end.compact
+      end
+
+      def debug_value(value)
+        return if value.nil?
+        case value
+        when Position
+          position_value(value)
+        when Margin
+          margin_value(value)
+        when Border
+          border_value(value)
+        when Padding
+          padding_value(value)
+        when Scrollbar
+          scrollbar_value(value)
+        else
+          value.inspect
+        end
+      end
+
+      def non_defaults(object, default_object, keys)
+        values = keys.map.with_object({}) do |key, hash|
+          unless object.send(key) == default_object.send(key)
+            hash[key] = object.send(key)
+          end
+        end
+        values.keys.map { |k| "#{k}: #{values[k]}"}.join(', ')
+      end
+
+      def position_value(position)
+        values = non_defaults(position, Position.new, %i[left top])
+        return if values == ''
+        "Position(#{values})"
+      end
+
+      def margin_value(margin)
+        values = non_defaults(margin, Margin.new, %i[left top right bottom])
+        return if values == ''
+        "Margin(#{values})"
+      end
+
+      def border_value(border)
+        values = non_defaults(
+          border,
+          Border.new,
+          %i[left? top? right? bottom? inner_horiz? inner_vert? style color]
+        )
+        return if values == ''
+        "Border(#{values})"
+      end
+
+      def padding_value(padding)
+        values = non_defaults(padding, Padding.new, %i[left top right bottom])
+        return if values == ''
+        "Padding(#{values})"
+      end
+
+      def scrollbar_value(scrollbar)
+        values = non_defaults(scrollbar, Scrollbar.new, %i[horiz? vert?])
+        return if values == ''
+        "Scrollbar(#{values})"
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/display_flow.rb

@@ -0,0 +1,27 @@
+module WhirledPeas
+  module Settings
+    module DisplayFlow
+      LEFT_TO_RIGHT = :l2r
+      RIGHT_TO_LEFT = :r2l
+      TOP_TO_BOTTOM = :t2b
+      BOTTOM_TO_TOP = :b2t
+
+      DEFAULT = LEFT_TO_RIGHT
+
+      VALID = [
+        DisplayFlow::LEFT_TO_RIGHT,
+        DisplayFlow::RIGHT_TO_LEFT,
+        DisplayFlow::TOP_TO_BOTTOM,
+        DisplayFlow::BOTTOM_TO_TOP
+      ]
+      private_constant :VALID
+
+      def self.validate!(flow)
+        return if flow.nil?
+        return flow if VALID.include?(flow)
+        raise ArgumentError, "Unsupported display flow: #{flow.inspect}"
+      end
+    end
+    private_constant :DisplayFlow
+  end
+end

data/lib/whirled_peas/settings/element_settings.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+require_relative 'alignment'
+require_relative 'bg_color'
+require_relative 'text_color'
+
+module WhirledPeas
+  module Settings
+    class ElementSettings
+      def self.inherit(parent)
+        child = self.new
+        child.inherit(parent)
+        child
+      end
+
+      def bg_color
+        @_bg_color || BgColor::DEFAULT
+      end
+
+      def bg_color=(color)
+        @_bg_color = BgColor.validate!(color)
+      end
+
+      def bold?
+        @_bold || false
+      end
+
+      def bold=(val)
+        @_bold = val
+      end
+
+      def color
+        @_color || TextColor::DEFAULT
+      end
+
+      def color=(color)
+        @_color = TextColor.validate!(color)
+      end
+
+      def underline?
+        @_underline || false
+      end
+
+      def underline=(val)
+        @_underline = val
+      end
+
+      def inherit(parent)
+        @_bg_color = parent._bg_color
+        @_bold = parent._bold
+        @_color = parent._color
+        @_underline = parent._underline
+      end
+
+      protected
+
+      attr_accessor :_bg_color, :_bold, :_color, :_underline
+    end
+    private_constant :ElementSettings
+  end
+end

data/lib/whirled_peas/settings/grid_settings.rb

@@ -0,0 +1,19 @@
+require 'whirled_peas/utils/title_font'
+
+require_relative 'container_settings'
+
+module WhirledPeas
+  module Settings
+    class GridSettings < ContainerSettings
+      attr_accessor :num_cols
+
+      def set_scrollbar(*)
+        raise NotImplementedError, 'Grids do not support scrollbars'
+      end
+
+      def sizing=(*)
+        raise NotImplementedError, 'Grids only support the default sizing model'
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/margin.rb

@@ -0,0 +1,8 @@
+require_relative 'spacing'
+
+module WhirledPeas
+  module Settings
+    class Margin < Spacing
+    end
+  end
+end

data/lib/whirled_peas/settings/padding.rb

@@ -0,0 +1,8 @@
+require_relative 'spacing'
+
+module WhirledPeas
+  module Settings
+    class Padding < Spacing
+    end
+  end
+end

data/lib/whirled_peas/settings/position.rb

@@ -0,0 +1,15 @@
+module WhirledPeas
+  module Settings
+    class Position
+      attr_writer :left, :top
+
+      def left
+        @left || 0
+      end
+
+      def top
+        @top || 0
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/scrollbar.rb

@@ -0,0 +1,15 @@
+module WhirledPeas
+  module Settings
+    class Scrollbar
+      attr_writer :horiz, :vert
+
+      def horiz?
+        @horiz == true
+      end
+
+      def vert?
+        @vert == true
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/sizing.rb

@@ -0,0 +1,19 @@
+module WhirledPeas
+  module Settings
+    class Sizing
+      CONTENT = :content
+      BORDER = :border
+
+      DEFAULT = CONTENT
+
+      VALID = [CONTENT, BORDER]
+      private_constant :VALID
+
+      def self.validate!(sizing)
+        return if sizing.nil?
+        return sizing if VALID.include?(sizing)
+        raise ArgumentError, "Unsupported sizing model: #{sizing.inspect}"
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/spacing.rb

@@ -0,0 +1,58 @@
+module WhirledPeas
+  module Settings
+    class Spacing
+      attr_writer :left, :top, :right, :bottom
+
+      def left=(value)
+        @left = validate!(value)
+      end
+
+      def left
+        @left || 0
+      end
+
+      def top=(value)
+        @top = validate!(value)
+      end
+
+      def top
+        @top || 0
+      end
+
+      def right=(value)
+        @right = validate!(value)
+      end
+
+      def right
+        @right || 0
+      end
+
+      def bottom=(value)
+        @bottom = validate!(value)
+      end
+
+      def bottom
+        @bottom || 0
+      end
+
+      def horiz=(value)
+        self.left = self.right = value
+      end
+
+      def vert=(value)
+        self.top = self.bottom = value
+      end
+
+      private
+
+      def validate!(value)
+        if value && value < 0
+          raise ArgumentError, "Negative values for #{self.class.name.split('::').last.downcase} are not allowed"
+        else
+          value
+        end
+      end
+    end
+    private_constant :Spacing
+  end
+end

data/lib/whirled_peas/settings/text_color.rb

@@ -0,0 +1,21 @@
+require 'whirled_peas/utils/ansi'
+
+require_relative 'color'
+
+module WhirledPeas
+  module Settings
+    class TextColor < Color
+      BLACK = new(Utils::Ansi::BLACK)
+      RED = new(Utils::Ansi::RED)
+      GREEN = new(Utils::Ansi::GREEN)
+      YELLOW = new(Utils::Ansi::YELLOW)
+      BLUE = new(Utils::Ansi::BLUE)
+      MAGENTA = new(Utils::Ansi::MAGENTA)
+      CYAN = new(Utils::Ansi::CYAN)
+      WHITE = new(Utils::Ansi::WHITE)
+      GRAY = BLACK.bright
+
+      DEFAULT = nil  # Use system defined default
+    end
+  end
+end

data/lib/whirled_peas/settings/text_settings.rb

@@ -0,0 +1,15 @@
+require 'whirled_peas/utils/title_font'
+
+require_relative 'element_settings'
+
+module WhirledPeas
+  module Settings
+    class TextSettings < ElementSettings
+      attr_reader :title_font
+
+      def title_font=(font)
+        @title_font = Utils::TitleFont.validate!(font)
+      end
+    end
+  end
+end

data/lib/whirled_peas/settings/vert_alignment.rb

@@ -0,0 +1,24 @@
+module WhirledPeas
+  module Settings
+    module VertAlignment
+      TOP = :top
+      MIDDLE = :middle
+      BOTTOM = :bottom
+      BETWEEN = :between
+      AROUND = :around
+      EVENLY = :evenly
+
+      DEFAULT = TOP
+
+      VALID = [TOP, MIDDLE, BOTTOM, BETWEEN, AROUND, EVENLY]
+      private_constant :VALID
+
+      def self.validate!(valign)
+        return if valign.nil?
+        return valign if VALID.include?(valign)
+        raise ArgumentError, "Unsupported vertical alignment: #{valign.inspect}"
+      end
+    end
+    private_constant :VertAlignment
+  end
+end

data/lib/whirled_peas/utils/ansi.rb

@@ -1,5 +1,5 @@
 module WhirledPeas
-  module UI
+  module Utils
     # Helper module for working with ANSI escape codes. The most useful ANSI escape codes
     # relate to text formatting.
     #
@@ -7,6 +7,9 @@ module WhirledPeas
     module Ansi
       ESC = "\033"
 
+      END_FORMATTING = 0
+      private_constant :END_FORMATTING
+
       # Text formatting constants
       BOLD = 1
       UNDERLINE = 4
@@ -21,8 +24,8 @@ module WhirledPeas
       CYAN = 36
       WHITE = 37
 
-      END_FORMATTING = 0
-      private_constant :END_FORMATTING
+      # Bright colors are offset by this much from their standard versions
+      BRIGHT_OFFSET = 60
 
       class << self
         def cursor_pos(top: 0, left: 0)
@@ -37,63 +40,10 @@ module WhirledPeas
           "#{ESC}[J"
         end
 
-        # Format the string with the ANSI escapes codes for the given integer codes
-        #
-        # @param str [String] the string to format
-        # @param codes [Array<Integer>] the integer part of the ANSI escape code (see
-        #   constants in this module for codes and meanings)
-        def format(str, codes)
-          if str.empty? || codes.length == 0
-            str
-          else
-            start_formatting = codes.map(&method(:esc_seq)).join
-            "#{start_formatting}#{str}#{esc_seq(END_FORMATTING)}"
-          end
-        end
-
         def clear
           esc_seq(END_FORMATTING)
         end
 
-        # If the string has unclosed formatting, add the end formatting characters to
-        # the end of the string
-        def close_formatting(str)
-          codes = str.scan(/#{ESC}\[(\d+)m/)
-          if codes.length > 0 && codes.last[0] != END_FORMATTING.to_s
-            "#{str}#{esc_seq(END_FORMATTING)}"
-          else
-            str
-          end
-        end
-
-        # Return a substring of the input string that preservse the formatting
-        #
-        # @param str [String] the (possibly formatted) string
-        # @param first_visible_character [Integer] the index of the first character to
-        #   include in the substring (ignoring all hidden formatting characters)
-        # @param num_visible_chars [Integer] the maximum number of visible characters to
-        #   include in the substring (ignoring all hidden formatting characters)
-        def substring(str, first_visible_character, num_visible_chars)
-          substr = ''
-          is_visible = true
-          visible_index = 0
-          substr_visible_len = 0
-          str.chars.each do |char|
-            in_substring = (visible_index >= first_visible_character)
-            is_visible = false if is_visible && char == ESC
-            visible_index += 1 if is_visible
-            if !is_visible || in_substring
-              substr += char
-              substr_visible_len += 1 if is_visible
-            end
-            is_visible = true if !is_visible && char == 'm'
-            break if substr_visible_len == num_visible_chars
-          end
-          close_formatting(substr)
-        end
-
-        private
-
         def esc_seq(code)
           "#{ESC}[#{code}m"
         end