whirled_peas 0.3.0 → 0.7.0

data/lib/whirled_peas/settings/box_settings.rb

@@ -0,0 +1,8 @@
+require_relative 'container_settings'
+
+module WhirledPeas
+  module Settings
+    class BoxSettings < ContainerSettings
+    end
+  end
+end

data/lib/whirled_peas/settings/color.rb

@@ -0,0 +1,68 @@
+require 'whirled_peas/utils/ansi'
+
+module WhirledPeas
+  module Settings
+    # An abstract class that encapsulates colors for a specific use case
+    class Color
+      # Validate the `color` argument is either (1) nil, (2) a valid Color constant in
+      # this class or (3) a symbol that maps to valid Color constant. E.g. if there
+      # is a RED constant in an implementing class, then :red or :bright_red are
+      # valid values for `color`
+      #
+      # @param color [Color|Symbol]
+      # @return [Color|Symbol] the value passed in if valid, otherwise an ArgumentError
+      #   is raised.
+      def self.validate!(color)
+        return if color.nil?
+        return color if color.is_a?(self)
+        if color.is_a?(Symbol)
+          match = color.to_s.match(/^(bright_)?(\w+)$/)
+          color_class = self.const_get(match[2].upcase)
+          if color_class.is_a?(self)
+            if !match[1]
+              return color_class
+            elsif !color_class.bright?
+              return color_class.bright
+            end
+          end
+        end
+        error_message = "Unsupported #{self.name.split('::').last}: #{color.inspect}"
+        raise ArgumentError, error_message
+      rescue NameError
+        error_message = "Unsupported #{self.name.split('::').last}: #{color.inspect}"
+        raise ArgumentError, error_message
+      end
+
+      def initialize(code, bright=false)
+        @code = code
+        @bright = bright
+      end
+
+      def bright?
+        @bright
+      end
+
+      def bright
+        bright? ? self : self.class.new(@code + Utils::Ansi::BRIGHT_OFFSET, true)
+      end
+
+      def hash
+        [@code, @bright].hash
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && self.hash == other.hash
+      end
+      alias_method :eq?, :==
+
+      def to_s
+        @code.to_s
+      end
+
+      def inspect
+        "#{self.class.name.split('::').last}(code=#{@code}, bright=#{@bright})"
+      end
+    end
+    private_constant :Color
+  end
+end

data/lib/whirled_peas/settings/container_settings.rb

@@ -0,0 +1,223 @@
+require_relative 'alignment'
+require_relative 'border'
+require_relative 'display_flow'
+require_relative 'element_settings'
+require_relative 'margin'
+require_relative 'padding'
+require_relative 'position'
+require_relative 'scrollbar'
+require_relative 'sizing'
+require_relative 'vert_alignment'
+
+module WhirledPeas
+  module Settings
+    class ContainerSettings < ElementSettings
+      attr_accessor :width, :height
+
+      def align
+        @_align || Alignment::DEFAULT
+      end
+
+      def align_left?
+        align == Alignment::LEFT
+      end
+
+      def align_center?
+        align == Alignment::CENTER
+      end
+
+      def align_right?
+        align == Alignment::RIGHT
+      end
+
+      def align_between?
+        align == Alignment::BETWEEN
+      end
+
+      def align_around?
+        align == Alignment::AROUND
+      end
+
+      def align_evenly?
+        align == Alignment::EVENLY
+      end
+
+      def align=(align)
+        @_align = Alignment.validate!(align)
+      end
+
+      def valign
+        @_valign || VertAlignment::DEFAULT
+      end
+
+      def valign_top?
+        valign == VertAlignment::TOP
+      end
+
+      def valign_middle?
+        valign == VertAlignment::MIDDLE
+      end
+
+      def valign_bottom?
+        valign == VertAlignment::BOTTOM
+      end
+
+      def valign_between?
+        valign == VertAlignment::BETWEEN
+      end
+
+      def valign_around?
+        valign == VertAlignment::AROUND
+      end
+
+      def valign_evenly?
+        valign == VertAlignment::EVENLY
+      end
+
+      def valign=(valign)
+        @_valign = VertAlignment.validate!(valign)
+      end
+
+      def set_border(
+        left: nil, top: nil, right: nil, bottom: nil, inner_horiz: nil, inner_vert: nil, style: nil, color: nil
+      )
+        border.left = left unless left.nil?
+        border.top = top unless top.nil?
+        border.right = right unless right.nil?
+        border.bottom = bottom unless bottom.nil?
+        border.inner_horiz = inner_horiz unless inner_horiz.nil?
+        border.inner_vert = inner_vert unless inner_vert.nil?
+        border.style = style unless style.nil?
+        border.color = color unless color.nil?
+      end
+
+      def full_border(style: nil, color: nil)
+        set_border(
+          left: true, top: true, right: true, bottom: true, inner_horiz: true, inner_vert: true, style: style, color: color
+        )
+      end
+
+      def border
+        @_border ||= Border.new
+      end
+
+      def flow=(flow)
+        @_flow = DisplayFlow.validate!(flow)
+      end
+
+      def flow
+        @_flow || DisplayFlow::DEFAULT
+      end
+
+      def horizontal_flow?
+        %i[l2r r2l].include?(flow)
+      end
+
+      def vertical_flow?
+        !horizontal_flow?
+      end
+
+      def forward_flow?
+        %i[l2r t2b].include?(flow)
+      end
+
+      def reverse_flow?
+        !forward_flow?
+      end
+
+      def set_margin(left: nil, top: nil, right: nil, bottom: nil, horiz: nil, vert: nil)
+        if horiz && (left || right)
+          raise ArgumentError, 'Cannot set horizontal margin when setting left/right'
+        elsif vert && (top || bottom)
+          raise ArgumentError, 'Cannot set vertical margin when setting top/bottom'
+        end
+
+        if horiz
+          margin.horiz = horiz
+        else
+          margin.left = left if left
+          margin.right = right if right
+        end
+
+        if vert
+          margin.vert = vert
+        else
+          margin.top = top if top
+          margin.bottom = bottom if bottom
+        end
+      end
+
+      def margin
+        @_margin ||= Margin.new
+      end
+
+      def set_padding(left: nil, top: nil, right: nil, bottom: nil, horiz: nil, vert: nil)
+        if horiz && (left || right)
+          raise ArgumentError, 'Cannot set horizontal padding when setting left/right'
+        elsif vert && (top || bottom)
+          raise ArgumentError, 'Cannot set vertical padding when setting top/bottom'
+        end
+
+        if horiz
+          padding.horiz = horiz
+        else
+          padding.left = left if left
+          padding.right = right if right
+        end
+
+        if vert
+          padding.vert = vert
+        else
+          padding.top = top if top
+          padding.bottom = bottom if bottom
+        end
+      end
+
+      def padding
+        @_padding ||= Padding.new
+      end
+
+      def set_position(left: nil, top: nil)
+        position.left = left if left
+        position.top = top if top
+      end
+
+      def position
+        @_position ||= Position.new
+      end
+
+      def set_scrollbar(horiz: nil, vert: nil)
+        scrollbar.horiz = horiz unless horiz.nil?
+        scrollbar.vert = vert unless vert.nil?
+      end
+
+      def scrollbar
+        @_scrollbar ||= Scrollbar.new
+      end
+
+      def sizing
+        @_sizing || Sizing::DEFAULT
+      end
+
+      def border_sizing?
+        @_sizing == Sizing::BORDER
+      end
+
+      def content_sizing?
+        @_sizing == Sizing::CONTENT
+      end
+
+      def sizing=(sizing)
+        @_sizing = Sizing.validate!(sizing)
+      end
+
+      def inherit(parent)
+        super
+        return unless parent.is_a?(ContainerSettings)
+        set_border(color: parent.border.color, style: parent.border.style)
+      end
+
+      protected
+    end
+  end
+end

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