charming 0.1.4 → 0.2.1

data/lib/charming/presentation/components/viewport.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "unicode/display_width"
-
 module Charming
   module Components
     # Viewport is a scrollable region over multi-line content. Supports keyboard scrolling
@@ -12,9 +10,6 @@ module Charming
     class Viewport < Component
       include KeyboardHandler
 
-      # Matches an ANSI SGR escape sequence (e.g., "\e[31m" for red foreground).
-      ANSI_PATTERN = /\e\[[0-9;]*m/
-
       # Maps scroll keys to the instance methods that perform them via KeyboardHandler.
       KEY_ACTIONS = {
         up: :scroll_up,
@@ -27,9 +22,6 @@ module Charming
         right: :scroll_right
       }.freeze
 
-      # The current top-visible row and left-visible column, respectively.
-      attr_reader :offset, :column
-
       # *content* may be a string, an array of lines, or any object responding to `render`.
       # *width* and *height* constrain the visible window; *offset* is the top-visible row
       # and *column* is the left-visible column. *wrap* enables soft-wrapping of long lines.
@@ -38,11 +30,10 @@ module Charming
         @content = content
         @width = width
         @height = height
-        @offset = offset
-        @column = column
+        @position = Position.new(offset: offset, column: column)
         @wrap = wrap
         @keymap = keymap
-        clamp_position
+        position.clamp(bounds)
       end
 
       # Renders the visible window of content as a multi-line string.
@@ -50,6 +41,16 @@ module Charming
         visible_lines.map { |line| render_line(line) }.join("\n")
       end
 
+      # The current top-visible row.
+      def offset
+        @position.offset
+      end
+
+      # The current left-visible column.
+      def column
+        @position.column
+      end
+
       # Handles mouse events: scroll wheel adjusts the row offset, click moves the top
       # visible row to the clicked position. Returns :handled on success.
       def handle_mouse(event)
@@ -57,77 +58,61 @@ module Charming
 
         if event.scroll?
           scroll_delta = (event.button_name == :scroll_up) ? -1 : 1
-          @offset += scroll_delta
-          clamp_position
+          position.move_to(offset + scroll_delta, bounds)
           return :handled
         end
 
         return nil unless event.click?
 
         clicked_row = event.y
-        return nil if clicked_row < offset || clicked_row >= offset + viewport_height
+        return nil if clicked_row < 0 || clicked_row >= viewport_height
 
-        @offset = clicked_row
-        clamp_position
+        position.move_to(offset + clicked_row, bounds)
         :handled
       end
 
       private
 
-      attr_reader :content, :width, :height
+      attr_reader :content, :width, :height, :position
 
       # Scrolls the viewport up by one row.
       def scroll_up
-        @offset -= 1
-        clamp_position
+        position.scroll_up(bounds)
       end
 
       # Scrolls the viewport down by one row.
       def scroll_down
-        @offset += 1
-        clamp_position
+        position.scroll_down(bounds)
       end
 
       # Scrolls up by one viewport page.
       def page_up
-        @offset -= page_size
-        clamp_position
+        position.page_up(page_size, bounds)
       end
 
       # Scrolls down by one viewport page.
       def page_down
-        @offset += page_size
-        clamp_position
+        position.page_down(page_size, bounds)
       end
 
       # Scrolls to the top-left of the content.
       def scroll_home
-        @offset = 0
-        @column = 0
+        position.home
       end
 
       # Scrolls to the bottom-right of the content.
       def scroll_end
-        @offset = max_offset
-        @column = max_column
+        position.end_at(bounds)
       end
 
       # Scrolls one column left.
       def scroll_left
-        @column -= 1
-        clamp_position
+        position.scroll_left(bounds)
       end
 
       # Scrolls one column right.
       def scroll_right
-        @column += 1
-        clamp_position
-      end
-
-      # Clamps both the row offset and the column to their valid ranges.
-      def clamp_position
-        @offset = offset.clamp(0, max_offset)
-        @column = column.clamp(0, max_column)
+        position.scroll_right(bounds)
       end
 
       # Returns the slice of content lines visible in the current viewport, padded to *height*.
@@ -141,89 +126,12 @@ module Charming
       # Renders a single line according to the configured width and wrap mode: clips to the
       # visible column window when not wrapping, otherwise wraps the line to the width.
       def render_line(line)
-        return line unless width
-        return pad_line(line, width) if wrap?
-
-        pad_line(clip_line(line), width)
-      end
-
-      # Clips *line* to the visible column window while preserving active ANSI styling.
-      def clip_line(line)
-        clipped = clip_tokens(line.to_s)
-        needs_reset?(clipped) ? "#{clipped}\e[0m" : clipped
-      end
-
-      # Walks *line* token-by-token, copying ANSI escapes through and emitting only the
-      # characters that fall inside the visible column window.
-      def clip_tokens(line)
-        state = {cursor: 0, output: +""}
-        line.scan(/#{ANSI_PATTERN}|./mo) do |token|
-          ansi?(token) ? append_ansi(state, token) : append_character(state, token)
-        end
-        state.fetch(:output)
-      end
-
-      # Appends an ANSI escape token to the output buffer unchanged.
-      def append_ansi(state, token)
-        state.fetch(:output) << token
-      end
-
-      # Appends a single character token to the output buffer when it falls inside the
-      # visible column window, advancing the visual cursor.
-      def append_character(state, char)
-        char_width = Unicode::DisplayWidth.of(char)
-        cursor = state.fetch(:cursor)
-        state.fetch(:output) << char if visible?(cursor, char_width)
-        state[:cursor] = cursor + char_width
-      end
-
-      # True when the character at *cursor* (with the given display *char_width*) is within
-      # the visible column window.
-      def visible?(cursor, char_width)
-        cursor >= column && cursor + char_width <= column + width
-      end
-
-      # True when *value* contains ANSI codes but does not end with a reset — needed because
-      # the clip may truncate styling in the middle of a styled run.
-      def needs_reset?(value)
-        value.match?(ANSI_PATTERN) && !value.end_with?("\e[0m")
-      end
-
-      # Pads *line* to *target_width* with trailing spaces, leaving the line itself unchanged.
-      def pad_line(line, target_width)
-        line + (" " * [target_width - UI::Width.measure(line), 0].max)
+        line_window.render(line)
       end
 
       # Returns the content lines, wrapped to *width* when wrap is enabled.
       def content_lines
-        return wrapped_content_lines if wrap?
-
-        rendered_content.lines(chomp: true)
-      end
-
-      # Wraps the content to *width* via UI::visible_slice, returning an array of wrapped lines.
-      def wrapped_content_lines
-        rendered_content.lines(chomp: true).flat_map { |line| wrap_line(line) }
-      end
-
-      # Wraps a single *line* into chunks of *width* display columns.
-      def wrap_line(line)
-        line_width = UI::Width.measure(line)
-        return [""] if line_width.zero?
-
-        start_column = 0
-        out = []
-        while start_column < line_width
-          out << UI.visible_slice(line, start_column, width)
-          start_column += width
-        end
-        out
-      end
-
-      # Returns the rendered content string, calling `render.to_s` on the content object when
-      # it responds to render.
-      def rendered_content
-        content.respond_to?(:render) ? content.render.to_s : content.to_s
+        content_source.lines
       end
 
       # Returns the visible row count (the configured *height* or the content's line count).
@@ -253,18 +161,25 @@ module Charming
 
       # Returns the maximum display width across all content lines.
       def content_width
-        content_lines.map { |line| UI::Width.measure(line) }.max || 0
+        content_source.display_width
       end
 
-      # True when *token* is an ANSI escape sequence.
-      def ansi?(token)
-        token.match?(ANSI_PATTERN)
+      def bounds
+        {max_offset: max_offset, max_column: max_column}
       end
 
       # True when soft-wrapping is enabled and a positive width is configured.
       def wrap?
         @wrap && width&.positive?
       end
+
+      def line_window
+        LineWindow.new(width: width, column: column, wrap: wrap?)
+      end
+
+      def content_source
+        ContentLines.new(content: content, width: width, wrap: @wrap)
+      end
     end
   end
 end

data/lib/charming/presentation/layout/builder.rb

@@ -36,9 +36,18 @@ module Charming
       end
 
       # Adds a Pane leaf node to the current scope. *name* (optional) is the focus slot name;
-      # *content* (or a *block*) is the body. *options* are forwarded to Pane.
+      # *content* (or a *block*) is the body. *options* are split into PaneGeometry,
+      # PaneStyle, and PaneBehavior keyword args.
       def pane(name = nil, content = nil, **options, &block)
-        node = Pane.new(name: name, content: content, block: block, view: view, **options)
+        node = Pane.new(
+          name: name, content: content, block: block, view: view,
+          geometry: PaneGeometry.build(**options.slice(
+            :width, :height, :grow, :border, :padding,
+            :min_width, :max_width, :min_height, :max_height
+          )),
+          style: PaneStyle.build(**options.slice(:style, :focused_style)),
+          behavior: PaneBehavior.build(**options.slice(:focus, :scroll, :clip, :wrap))
+        )
         append(node)
         node
       end

data/lib/charming/presentation/layout/overlay.rb

@@ -8,13 +8,14 @@ module Charming
     # with an outer *style*.
     class Overlay
       # The vertical and horizontal offset (cell count or `:center`) of the overlay
-      # within the parent canvas.
-      attr_reader :top, :left
+      # within the parent canvas, and its stacking order (higher paints later/on top).
+      attr_reader :top, :left, :z_index
 
       # *content* (or a *block*) provides the body. *top*/*left* default to :center.
       # *width*/*height* fix the overlay's dimensions; when unset, the content's natural
-      # size is used. *style* wraps the rendered content in a UI::Style.
-      def initialize(content: nil, block: nil, view: nil, top: :center, left: :center, width: nil, height: nil, style: nil)
+      # size is used. *style* wraps the rendered content in a UI::Style. *z_index*
+      # controls stacking: higher values composite on top (ties keep registration order).
+      def initialize(content: nil, block: nil, view: nil, top: :center, left: :center, width: nil, height: nil, style: nil, z_index: 0)
         @content = content
         @block = block
         @view = view
@@ -23,6 +24,7 @@ module Charming
         @width = width
         @height = height
         @style = style
+        @z_index = z_index
       end
 
       # Renders the overlay's content; when *width* or *height* is set, places the rendered

data/lib/charming/presentation/layout/pane.rb

@@ -4,34 +4,21 @@ module Charming
   module Layout
     # Pane is a leaf layout node: a single rectangle with optional border, padding, and
     # styling, containing a piece of content (a string, a View, or a block evaluated in the
-    # view's context). Panes with a `name` and `focus: true` are registered as focusable
-    # slots in the controller's focus ring.
+    # view's context). Panes with a `name` and `behavior.focus: true` are registered as
+    # focusable slots in the controller's focus ring.
     class Pane
-      # The pane's focus slot name, fixed width, fixed height, and grow weight.
-      attr_reader :name, :width, :height, :grow
-
-      # *name* is the focus slot identifier (optional). *content* or *block* provides the body.
-      # *width*/*height*/*grow* control sizing. *border* may be `true` (normal border) or a
-      # border name symbol. *padding* may be 1, 2, or 4 values (CSS-style shorthand).
-      # *style* sets the base style; *focused_style* overrides it when the pane is focused.
-      # *focus: true* marks the pane as focusable. *scroll*/*clip*/*wrap* control how
-      # overflow content is rendered (via the embedded Viewport).
-      def initialize(name: nil, content: nil, block: nil, view: nil, width: nil, height: nil, grow: nil, border: nil, padding: nil, style: nil, focused_style: nil, focus: false, scroll: false, clip: true, wrap: false)
-        @name = name
-        @content = content
-        @block = block
-        @view = view
-        @width = width
-        @height = height
-        @grow = grow
-        @border = border
-        @padding = padding
-        @style = style
-        @focused_style = focused_style
-        @focus = focus
-        @scroll = scroll
-        @clip = clip
-        @wrap = wrap
+      attr_reader :name
+      delegate :width, :height, :grow,
+        :min_width, :max_width, :min_height, :max_height, to: :geometry
+
+      # *name* is the focus slot identifier. *content* (or a *block*) is the body; *view*
+      # is the view used for instance_exec when the block is given. *geometry*, *style*, and
+      # *behavior* are value objects that own sizing, styling, and render-time flags.
+      def initialize(name: nil, content: nil, block: nil, view: nil,
+        geometry: PaneGeometry.new, style: PaneStyle.new,
+        behavior: PaneBehavior.new)
+        @name, @content, @block, @view = name, content, block, view
+        @geometry, @style, @behavior = geometry, style, behavior
       end
 
       # Raises ArgumentError — panes are leaves and cannot contain layout children.
@@ -39,117 +26,56 @@ module Charming
         raise ArgumentError, "pane cannot contain layout children"
       end
 
-      # Returns [name] when the pane is marked focusable and has a name, otherwise [].
+      # Returns [name] when the pane is focusable and named, otherwise [].
       def focusable_names
-        (focus && name) ? [name] : []
+        (@behavior.focus && name) ? [name] : []
       end
 
       # Returns the mouse target represented by this pane, if it has a name.
       def mouse_targets(rect)
         return [] unless name
 
-        [{name: name, rect: rect, inner_rect: inner_rect(rect)}]
+        [{name: name, rect: rect, inner_rect: @geometry.inset(rect)}]
       end
 
       # Renders the pane into *rect*, applying the configured style, border, and padding
       # around the evaluated content.
       def render(rect)
-        outer_style(rect).render(rendered_content(rect))
+        inner = @geometry.inset(rect)
+        outer_style(inner).render(rendered_content(inner))
       end
 
       private
 
-      # The raw content, the body block, the view used for instance_exec, and styling options.
-      attr_reader :content, :block, :view, :border, :padding, :style, :focused_style, :focus, :scroll, :clip, :wrap
-
-      # Returns the content string for *rect*, optionally clipped/scrolled by an embedded Viewport.
-      def rendered_content(rect)
-        content_rect = inner_rect(rect)
-        value = evaluate_content(content_rect)
-        return value unless clip || scroll
-
-        Components::Viewport.new(content: value, width: content_rect.width, height: content_rect.height, wrap: wrap).render
-      end
+      attr_reader :content, :block, :view, :geometry, :style, :behavior
 
-      # Evaluates the configured content (block or constant) and renders it to a string.
-      # Pane blocks may accept the inner content Rect when they need exact available dimensions.
-      def evaluate_content(content_rect)
+      # Returns the content string for *content_rect*, optionally clipped/scrolled by an
+      # embedded Viewport when *behavior.should_viewport?* is true.
+      def rendered_content(content_rect)
         value = if block
           block.arity.zero? ? view.instance_exec(&block) : view.instance_exec(content_rect, &block)
         else
           content
         end
-        value.respond_to?(:render) ? value.render.to_s : value.to_s
+        return value.to_s unless value.respond_to?(:render)
+        return value.render.to_s unless @behavior.should_viewport?
+
+        Components::Viewport.new(content: value.render, width: content_rect.width,
+          height: content_rect.height, wrap: @behavior.wrap).render.to_s
       end
 
       # Builds the outer style object with optional border and padding, sized to the
       # inner rect of the pane.
-      def outer_style(rect)
-        styled = current_style
-        styled = styled.border(border_style) if border
-        styled = styled.padding(*padding_values) if padding
-        styled.width(inner_rect(rect).width).height(inner_rect(rect).height)
+      def outer_style(inner)
+        styled = @style.resolve(view, focused: focused?)
+        styled = styled.border(@geometry.border_style) if @geometry.border
+        styled = styled.padding(*@geometry.padding_values) if @geometry.padding
+        styled.width(inner.width).height(inner.height)
       end
 
-      # Returns the active style: the focused variant when the pane is focused, otherwise
-      # the configured style or a default UI::Style.
-      def current_style
-        return focused_pane_style if focused?
-
-        style || UI.style
-      end
-
-      # Returns the focused-pane style: the focused_style override, or the theme's title style.
-      def focused_pane_style
-        focused_style || view.__send__(:theme).title
-      end
-
-      # True when the pane is configured for focus and the view reports it as currently focused.
+      # True when the pane is configured for focus and the view reports it as focused.
       def focused?
-        focus && name && view.focused?(name)
-      end
-
-      # Returns the inner Rect after border and padding insets are applied.
-      def inner_rect(rect)
-        rect.inset(
-          top: border_top + padding_top,
-          right: border_right + padding_right,
-          bottom: border_bottom + padding_bottom,
-          left: border_left + padding_left
-        )
-      end
-
-      # Resolves the border style symbol: :normal when border is `true`, otherwise the configured value.
-      def border_style
-        (border == true) ? :normal : border
-      end
-
-      # Border thickness on each side (1 when a border is configured, 0 otherwise).
-      def border_top = border ? 1 : 0
-      def border_right = border ? 1 : 0
-      def border_bottom = border ? 1 : 0
-      def border_left = border ? 1 : 0
-
-      # The padding values normalized to [top, right, bottom, left] form.
-      def padding_values
-        @padding_values ||= expand_padding(Array(padding))
-      end
-
-      # Per-side padding values (0 when no padding is configured).
-      def padding_top = padding ? padding_values[0] : 0
-      def padding_right = padding ? padding_values[1] : 0
-      def padding_bottom = padding ? padding_values[2] : 0
-      def padding_left = padding ? padding_values[3] : 0
-
-      # Normalizes 1/2/4 padding arguments to [top, right, bottom, left].
-      def expand_padding(values)
-        case values.length
-        when 1 then [values[0], values[0], values[0], values[0]]
-        when 2 then [values[0], values[1], values[0], values[1]]
-        when 4 then values
-        else
-          raise ArgumentError, "padding expects 1, 2, or 4 values"
-        end
+        @behavior.focus && name && view.focused?(name)
       end
     end
   end

data/lib/charming/presentation/layout/pane_behavior.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Charming
+  module Layout
+    # PaneBehavior holds the render-time options that control a Pane's
+    # interaction with the focus ring and the embedded Viewport.
+    class PaneBehavior
+      attr_reader :focus, :scroll, :clip, :wrap
+
+      def self.build(focus: false, scroll: false, clip: true, wrap: false)
+        new(focus: focus, scroll: scroll, clip: clip, wrap: wrap)
+      end
+
+      def initialize(focus:, scroll:, clip:, wrap:)
+        @focus, @scroll, @clip, @wrap = focus, scroll, clip, wrap
+        freeze
+      end
+
+      def ==(other)
+        other.is_a?(PaneBehavior) &&
+          focus == other.focus && scroll == other.scroll &&
+          clip == other.clip && wrap == other.wrap
+      end
+      alias_method :eql?, :==
+
+      def hash
+        [focus, scroll, clip, wrap].hash
+      end
+
+      def focusable?
+        focus
+      end
+
+      def should_viewport?
+        clip || scroll
+      end
+    end
+  end
+end

data/lib/charming/presentation/layout/pane_geometry.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Charming
+  module Layout
+    # PaneGeometry holds a Pane's sizing (width, height, grow, min/max constraints)
+    # and inset configuration (border + padding). It knows how to inset a Rect for the
+    # content area and how to expand CSS-style 1/2/4-value padding.
+    class PaneGeometry
+      attr_reader :width, :height, :grow, :border, :padding,
+        :min_width, :max_width, :min_height, :max_height
+
+      def self.build(width: nil, height: nil, grow: nil, border: nil, padding: nil,
+        min_width: nil, max_width: nil, min_height: nil, max_height: nil)
+        new(width: width, height: height, grow: grow,
+          border: (border == true) ? :normal : border, padding: padding,
+          min_width: min_width, max_width: max_width,
+          min_height: min_height, max_height: max_height)
+      end
+
+      def initialize(width:, height:, grow:, border:, padding:,
+        min_width: nil, max_width: nil, min_height: nil, max_height: nil)
+        @width, @height, @grow, @border, @padding = width, height, grow, border, padding
+        @min_width, @max_width, @min_height, @max_height = min_width, max_width, min_height, max_height
+        @padding_values = padding ? expand_padding(Array(padding)) : [0, 0, 0, 0]
+        freeze
+      end
+
+      def ==(other)
+        other.is_a?(PaneGeometry) &&
+          width == other.width && height == other.height && grow == other.grow &&
+          border == other.border && padding == other.padding &&
+          min_width == other.min_width && max_width == other.max_width &&
+          min_height == other.min_height && max_height == other.max_height
+      end
+      alias_method :eql?, :==
+
+      def hash
+        [width, height, grow, border, padding, min_width, max_width, min_height, max_height].hash
+      end
+
+      def border_top = border ? 1 : 0
+      def border_right = border ? 1 : 0
+      def border_bottom = border ? 1 : 0
+      def border_left = border ? 1 : 0
+
+      attr_reader :padding_values
+
+      def padding_top = padding ? @padding_values[0] : 0
+      def padding_right = padding ? @padding_values[1] : 0
+      def padding_bottom = padding ? @padding_values[2] : 0
+      def padding_left = padding ? @padding_values[3] : 0
+
+      def inset(rect)
+        rect.inset(
+          top: border_top + padding_top,
+          right: border_right + padding_right,
+          bottom: border_bottom + padding_bottom,
+          left: border_left + padding_left
+        )
+      end
+
+      def border_style
+        (border == true) ? :normal : border
+      end
+
+      private
+
+      def expand_padding(values)
+        case values.length
+        when 1 then [values[0], values[0], values[0], values[0]]
+        when 2 then [values[0], values[1], values[0], values[1]]
+        when 4 then values
+        else
+          raise ArgumentError, "padding expects 1, 2, or 4 values"
+        end
+      end
+    end
+  end
+end

data/lib/charming/presentation/layout/pane_style.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Charming
+  module Layout
+    # PaneStyle holds a Pane's base style and the focused-state override.
+    # It resolves which style to use at render time given the pane's current
+    # focus state and the view's theme.
+    class PaneStyle
+      attr_reader :style, :focused_style
+
+      def self.build(style: nil, focused_style: nil)
+        new(style: style, focused_style: focused_style)
+      end
+
+      def initialize(style:, focused_style:)
+        @style, @focused_style = style, focused_style
+        freeze
+      end
+
+      def ==(other)
+        other.is_a?(PaneStyle) &&
+          style == other.style && focused_style == other.focused_style
+      end
+      alias_method :eql?, :==
+
+      def hash
+        [style, focused_style].hash
+      end
+
+      # Returns the active style for *focused*: the focused override when the
+      # pane is focused, otherwise the configured *style* or a default UI::Style.
+      def resolve(view, focused:)
+        return focused_style || view.__send__(:theme).title if focused
+
+        style || UI.style
+      end
+    end
+  end
+end