charming 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63a0e6137fddcdcd90ebeb7f64a4a5d8b7d24bce082a87f27273eadc3d20a3e7
-  data.tar.gz: 925a673a508c582bb259da12794653b65ac30d6184e9b48f586db0ae3d0de7ba
+  metadata.gz: b3edeedc6b7d09bb964b5f3e6ba7306ced50355bfffb93c049c9cc7415cab4d2
+  data.tar.gz: 3944a4cef79f57035ac08d5dbeba1fef7e96504c5ea34c3237e2dad08dcdde31
 SHA512:
-  metadata.gz: 18cc22164930e56efe5c768fd947c7dd23009b49d2266b5d849b71dedae30202a4b32540a9c595ec5490ae4b5ee7a6f0bf167796fcbd5fb41e674db312696840
-  data.tar.gz: 4b2ed08745f24cc99082d604247e1cf1e501f2188f217ed70ced49065c22587e59c335ce11aede01a47ba2626de78b9cccb2fafa50abea8273b86eda779f0736
+  metadata.gz: ea1881f3bf0d3517cc2a0f20b8ae15fcd452c091d71f6535bc632a7dd66be6abaf97fa3ca76aef567be068be41a374c11e263529cc43dad931ac7fe344847061
+  data.tar.gz: 6b396f225bdb25bf3cd1f5ff569d4907a9e2e0be8bbfc4ad500021251f1bc39ba65b270b80d28b7dd9fc087294fc9a91d4fb4da5dfbdfbdced19040074093c0a

data/README.md

@@ -29,20 +29,7 @@ Charming can also be added to an existing Ruby project with Bundler, but the pri
 
 ## Documentation
 
-| Guide | Purpose |
-|-------|---------|
-| [Docs Index](docs/README.md) | Suggested reading paths and all documentation links. |
-| [Getting Started](docs/getting_started.md) | Build and run a generated Charming app. |
-| [Core Concepts](docs/core_concepts.md) | App architecture, runtime flow, ephemeral controllers, and state. |
-| [Routing](docs/routing.md) | `root`, `screen`, dynamic params, route titles, and route order. |
-| [Controllers & Templates](docs/controllers_and_templates.md) | Actions, `render :show`, `render_template`, key bindings, commands, timers, and tasks. |
-| [Layouts](docs/layouts.md) | Template layouts, `yield_content`, split panes, overlays, responsive layouts, and styles. |
-| [State](docs/state.md) | `ApplicationState`, typed attributes, validations, and session-backed state. |
-| [Database](docs/database.md) | Optional SQLite persistence with Active Record models and migrations. |
-| [Components](docs/components.md) | Built-in components, custom components, and interaction return values. |
-| [Themes](docs/themes.md) | Theme registration, tokens, and runtime theme switching. |
-| [API Reference](docs/api.md) | Compact public API reference. |
-| [Testing](docs/testing.md) | Controller, template, component, runtime, timer, and task tests. |
+- [Docs](https://charming.sh)
 
 ## Generated App Structure
 

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

@@ -36,9 +36,15 @@ 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)),
+          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/pane.rb

@@ -4,34 +4,20 @@ 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, 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 +25,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,71 @@
+# frozen_string_literal: true
+
+module Charming
+  module Layout
+    # PaneGeometry holds a Pane's sizing (width, height, grow) 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
+
+      def self.build(width: nil, height: nil, grow: nil, border: nil, padding: nil)
+        new(width: width, height: height, grow: grow,
+          border: (border == true) ? :normal : border, padding: padding)
+      end
+
+      def initialize(width:, height:, grow:, border:, padding:)
+        @width, @height, @grow, @border, @padding = width, height, grow, border, padding
+        @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
+      end
+      alias_method :eql?, :==
+
+      def hash
+        [width, height, grow, border, padding].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

data/lib/charming/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Charming
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: charming
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - pando
@@ -335,6 +335,9 @@ files:
 - lib/charming/presentation/layout/builder.rb
 - lib/charming/presentation/layout/overlay.rb
 - lib/charming/presentation/layout/pane.rb
+- lib/charming/presentation/layout/pane_behavior.rb
+- lib/charming/presentation/layout/pane_geometry.rb
+- lib/charming/presentation/layout/pane_style.rb
 - lib/charming/presentation/layout/rect.rb
 - lib/charming/presentation/layout/screen_layout.rb
 - lib/charming/presentation/layout/split.rb