charming 0.1.0 → 0.1.2

data/lib/charming/generators/templates/screen/spec_state.rb.template

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "__APP_SNAKE__"
+
+RSpec.describe __APP_CLASS__::__STATE_CLASS__ do
+  describe "#title" do
+    it "has the correct default string value" do
+      instance = described_class.new
+      expect(instance.title).to eq("__TITLE__")
+    end
+
+    it "accepts overridden title values" do
+      instance = described_class.new(title: "Alternative")
+      expect(instance.title).to eq("Alternative")
+    end
+  end
+end

data/lib/charming/generators/templates/screen/spec_view.rb.template

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "__APP_SNAKE__"
+
+RSpec.describe __APP_CLASS__::__RESOURCE_MODULE__::ShowView do
+  describe "#render" do
+    it "renders the state title" do
+      view = described_class.new(__SCREEN_NAME__: double(title: "__TITLE__"))
+
+      expect(view.render).to eq("__TITLE__")
+    end
+  end
+end

data/lib/charming/generators/templates/screen/state.rb.template

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module __APP_CLASS__
+  class __STATE_CLASS__ < ApplicationState
+    attribute :title, :string, default: "__TITLE__"
+  end
+end

data/lib/charming/generators/templates/screen/view.rb.template

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module __APP_CLASS__
+  module __RESOURCE_MODULE__
+    class ShowView < Charming::Presentation::View
+      def render
+        __SCREEN_NAME__.title
+      end
+    end
+  end
+end

data/lib/charming/generators/templates/view/view.rb.template

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module __APP_CLASS__
+  module __RESOURCE_MODULE__
+    class __ACTION_VIEW_CLASS__View < Charming::Presentation::View
+      def render
+        "__RESOURCE_NAME__"
+      end
+    end
+  end
+end

data/lib/charming/generators/view_generator.rb

@@ -2,32 +2,45 @@
 
 module Charming
   module Generators
+    # ViewGenerator implements `charming generate view NAME [ACTION]`. Writes a single
+    # view class file at `app/views/<name>/<action>_view.rb`. The *action* defaults to `show`.
     class ViewGenerator < AppFileGenerator
+      # *name* is the resource name. *args* may contain a single action name (defaults to "show").
+      def initialize(name, args, out:, destination:, force: false)
+        super
+        raise Error, "Usage: charming generate view NAME [ACTION]" if args.length > 1
+
+        @action = args.fetch(0, "show")
+      end
+
+      # Writes the view file to `app/views/<name>/<action>_view.rb`.
       def generate
-        create_file(app_path("app", "views"), view)
+        create_file(File.join("app", "views", name.snake_name, "#{action}_view.rb"), view)
       end
 
       private
 
+      # The action name (e.g., "show", "edit").
+      attr_reader :action
+
+      # The file-name suffix used by `app_path` (sets "view" so the file is
+      # `<name>_view.rb`). Not used directly by this generator but required by the parent.
       def suffix
         "view"
       end
 
+      # The full source of the generated view class.
       def view
-        %(# frozen_string_literal: true
-
-module #{app_name.class_name}
-  class #{name.view_class_name} < Charming::View
-#{view_body}
-  end
-end
-)
+        render_template("view/view.rb.template",
+          app_class: app_name.class_name,
+          resource_module: name.class_name,
+          resource_name: name.class_name,
+          action_view_class: action_class_name)
       end
 
-      def view_body
-        %(    def render
-      "#{name.class_name}"
-    end)
+      # CamelCase rendering of the action name (e.g., "user_settings" → "UserSettings").
+      def action_class_name
+        action.split("_").map(&:capitalize).join
       end
     end
   end

data/lib/charming/internal/renderer/differential.rb

@@ -3,13 +3,22 @@
 module Charming
   module Internal
     module Renderer
+      # Differential renders frame updates by emitting only the lines that changed since
+      # the previous frame. On the first frame it falls back to a full repaint; when no
+      # lines changed it returns without writing anything.
       class Differential
+        # *output* is the terminal backend (must support `write_lines` for the differential
+        # path or `write_frame` for the fallback). *full_renderer* is the FullRepaint used
+        # for the initial frame and as a fallback when *output* doesn't support partial writes.
         def initialize(output, full_renderer: FullRepaint.new(output))
           @output = output
           @full_renderer = full_renderer
           @previous_frame = nil
         end
 
+        # Renders *frame*. The first call performs a full repaint and stores the frame.
+        # Subsequent calls compute the per-line diff and emit only changed rows. Returns nil
+        # when the frame is identical to the previous one.
         def render(frame)
           frame = frame.to_s
           return render_initial(frame) unless @previous_frame
@@ -20,11 +29,15 @@ module Charming
 
         private
 
+        # Performs the initial full repaint and records the first frame.
         def render_initial(frame)
           @full_renderer.render(frame)
           @previous_frame = frame
         end
 
+        # Computes the per-line diff against the previous frame, writes the changed lines,
+        # and records the new frame. Falls back to a full repaint when the output backend
+        # doesn't support partial writes.
         def render_changes(frame)
           changes = changed_lines(@previous_frame, frame)
           return @previous_frame = frame if changes.empty?
@@ -37,14 +50,15 @@ module Charming
           @previous_frame = frame
         end
 
+        # Returns an array of [1-based-row, line] tuples covering the larger of the two
+        # frames' line counts, with empty strings padding the shorter frame.
         def changed_lines(previous_frame, frame)
           previous_lines = previous_frame.lines(chomp: true)
           lines = frame.lines(chomp: true)
           line_count = [previous_lines.length, lines.length].max
 
-          line_count.times.filter_map do |index|
-            line = lines[index] || ""
-            [index + 1, line] unless previous_lines[index] == line
+          line_count.times.map do |index|
+            [index + 1, lines[index] || ""]
           end
         end
       end

data/lib/charming/internal/renderer/full_repaint.rb

@@ -3,11 +3,17 @@
 module Charming
   module Internal
     module Renderer
+      # FullRepaint clears the screen and rewrites the entire frame on every render. It is
+      # used as the initial render path by Differential and as a fallback for backends that
+      # don't support partial line writes.
       class FullRepaint
+        # *output* is the terminal backend (must support `clear`, `move_cursor`, and
+        # `write_frame` per the Adapter contract).
         def initialize(output)
           @output = output
         end
 
+        # Clears the screen, homes the cursor, and writes the entire *frame* string.
         def render(frame)
           @output.clear
           @output.move_cursor(1, 1)

data/lib/charming/internal/terminal/adapter.rb

@@ -3,46 +3,72 @@
 module Charming
   module Internal
     module Terminal
-      # Contract for terminal adapters used by Runtime and renderers.
-      # Concrete adapters provide input events, terminal dimensions, and output
-      # primitives for full or partial frame rendering.
+      # Adapter defines the duck-typed interface that terminal backends must implement.
+      # Concrete adapters (`TTYBackend`, `MemoryBackend`) mix this module in and provide
+      # the actual implementations; the methods below raise NotImplementedError to make
+      # missing implementations fail loudly.
+      #
+      # Input methods:
+      # - `read_event(timeout:)` returns the next event (KeyEvent, MouseEvent, or nil on timeout)
+      #
+      # Output methods:
+      # - `size` returns the [width, height] of the terminal
+      # - `enter_alt_screen` / `leave_alt_screen` switch to/from the alternate screen buffer
+      # - `hide_cursor` / `show_cursor` toggle the cursor
+      # - `clear` clears the screen
+      # - `move_cursor(row, column)` positions the cursor (1-based)
+      # - `write_frame(frame)` writes a full multi-line frame string
+      # - `write_lines(line_changes, frame: nil)` writes a partial frame of [row, line] changes
       module Adapter
+        # Reads the next event from the backend. Returns nil when no event is available
+        # within *timeout* seconds. Must be implemented by the including class.
         def read_event(timeout: nil)
           raise NotImplementedError, "#{self.class} must implement #read_event"
         end
 
+        # Returns the current terminal dimensions as [width, height] in cells.
         def size
           raise NotImplementedError, "#{self.class} must implement #size"
         end
 
+        # Switches the terminal into the alternate screen buffer (used to keep the host
+        # terminal scrollback untouched while a TUI app is running).
         def enter_alt_screen
           raise NotImplementedError, "#{self.class} must implement #enter_alt_screen"
         end
 
+        # Returns the terminal to the primary screen buffer (paired with `enter_alt_screen`).
         def leave_alt_screen
           raise NotImplementedError, "#{self.class} must implement #leave_alt_screen"
         end
 
+        # Hides the terminal cursor.
         def hide_cursor
           raise NotImplementedError, "#{self.class} must implement #hide_cursor"
         end
 
+        # Shows the terminal cursor.
         def show_cursor
           raise NotImplementedError, "#{self.class} must implement #show_cursor"
         end
 
+        # Clears the entire screen and homes the cursor.
         def clear
           raise NotImplementedError, "#{self.class} must implement #clear"
         end
 
+        # Moves the cursor to the given 1-based (row, column) position.
         def move_cursor(row, column)
           raise NotImplementedError, "#{self.class} must implement #move_cursor"
         end
 
+        # Writes a full multi-line frame string to the terminal in one operation.
         def write_frame(frame)
           raise NotImplementedError, "#{self.class} must implement #write_frame"
         end
 
+        # Writes a partial frame composed of [row, line] tuples. Optional *frame:* is the
+        # full frame string for backends that want to track it (e.g., the MemoryBackend).
         def write_lines(line_changes, frame: nil)
           raise NotImplementedError, "#{self.class} must implement #write_lines"
         end

data/lib/charming/internal/terminal/key_normalizer.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Charming
+  module Internal
+    module Terminal
+      # KeyNormalizer turns raw keypress strings (from tty-reader) into normalized
+      # KeyEvent objects with a semantic key symbol and the printable character (when
+      # applicable). Handles ctrl-modifier naming, special keys (return, tab, space),
+      # and the back-tab (Shift+Tab) variant.
+      class KeyNormalizer
+        # Matches key names like "ctrl_a" → captures "a" so the modifier can be split out.
+        CTRL_KEY_PATTERN = /\Actrl_(?<key>.+)\z/
+
+        # *reader* is a TTY::Reader used to look up canonical key names from raw keypresses.
+        def initialize(reader)
+          @reader = reader
+        end
+
+        # Converts a raw *keypress* string into a KeyEvent. Returns nil when *keypress* is nil.
+        def normalize(keypress)
+          return nil unless keypress
+
+          key_name = @reader.console.keys[keypress]
+          return character_event(keypress) unless key_name
+
+          named_event(key_name)
+        end
+
+        private
+
+        # Builds a KeyEvent for a raw character keypress (no semantic name was matched).
+        def character_event(keypress)
+          Events::KeyEvent.new(key: keypress.to_sym, char: keypress)
+        end
+
+        # Builds a KeyEvent for a named key, splitting out modifiers and the printable char.
+        def named_event(key_name)
+          normalized = normalize_key_name(key_name)
+          Events::KeyEvent.new(
+            key: normalized.fetch(:key),
+            char: normalized.fetch(:char, nil),
+            ctrl: normalized.fetch(:ctrl, false),
+            alt: normalized.fetch(:alt, false),
+            shift: normalized.fetch(:shift, false)
+          )
+        end
+
+        # Splits a key name into its semantic key, printable char, and modifier flags.
+        def normalize_key_name(key_name)
+          name = key_name.to_s
+          return ctrl_key(name) if name.match?(CTRL_KEY_PATTERN)
+          return {key: :tab, shift: true} if name == "back_tab"
+
+          {key: normalized_key(name), char: printable_char(name)}
+        end
+
+        # Returns the semantic key symbol for *name* (e.g., "return" → :enter).
+        def normalized_key(name)
+          return :enter if name == "return"
+
+          name.to_sym
+        end
+
+        # Returns a key/ctrl-modifier pair for a `ctrl_*` key name.
+        def ctrl_key(name)
+          match = name.match(CTRL_KEY_PATTERN)
+          {key: match[:key].to_sym, ctrl: true}
+        end
+
+        # Returns the printable character for *name* (e.g., "space" → " "), or nil when the
+        # name has no single-character printable form.
+        def printable_char(name)
+          case name
+          when "space" then " "
+          when "enter", "return" then "\n"
+          when "tab" then "\t"
+          else
+            name if name.length == 1 && !name.match?(/[[:cntrl:]]/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/charming/internal/terminal/memory_backend.rb

@@ -3,11 +3,21 @@
 module Charming
   module Internal
     module Terminal
+      # MemoryBackend is an in-memory implementation of the terminal Adapter used by
+      # RSpec specs. It serves events from a fixed `events:` list and records every
+      # output operation in `frames` (rendered output) and `operations` (every method
+      # call with its arguments), so tests can assert against observed output.
       class MemoryBackend
         include Adapter
 
-        attr_reader :frames, :operations
+        # The array of rendered frame strings (one per `write_frame` or `write_lines` call).
+        attr_reader :frames
 
+        # The array of recorded operation tuples: [:method_name, *args].
+        attr_reader :operations
+
+        # *events* is the queue of pre-seeded events to return from `read_event`.
+        # *width*/*height* set the initial terminal dimensions reported by `size`.
         def initialize(events: [], width: 80, height: 24)
           @events = events.dup
           @width = width
@@ -17,67 +27,84 @@ module Charming
           @mouse_enabled = false
         end
 
+        # Pops the next pre-seeded event from the queue. Returns nil when the queue is empty.
         def read_event(timeout: nil)
           @operations << [:read_event, timeout]
           @events.shift
         end
 
+        # Stores *frame* as the current frame and appends it to `frames`.
         def write_frame(frame)
           @current_frame = frame
           @frames << frame
           @operations << [:write_frame, frame]
         end
 
+        # Applies the [row, line] *line_changes* to the current frame, then stores and
+        # records the result. The full frame is taken from the optional *frame:* argument
+        # (when provided) or built by overlaying the changes on the previous frame.
         def write_lines(line_changes, frame: nil)
           @current_frame = frame || apply_line_changes(line_changes)
           @frames << @current_frame
           @operations << [:write_lines, line_changes]
         end
 
+        # Records an enter-alt-screen operation.
         def enter_alt_screen
           @operations << :enter_alt_screen
         end
 
+        # Records a leave-alt-screen operation.
         def leave_alt_screen
           @operations << :leave_alt_screen
         end
 
+        # Records a show-cursor operation.
         def show_cursor
           @operations << :show_cursor
         end
 
+        # Records a hide-cursor operation.
         def hide_cursor
           @operations << :hide_cursor
         end
 
+        # Records a clear-screen operation.
         def clear
           @operations << :clear
         end
 
+        # Records a move-cursor operation at the given (row, column) (1-based).
         def move_cursor(row, column)
           @operations << [:move_cursor, row, column]
         end
 
+        # Returns the configured terminal dimensions as [width, height].
         def size
           [@width, @height]
         end
 
+        # Marks the backend as having mouse tracking enabled and records the operation.
         def enable_mouse_tracking
           @mouse_enabled = true
           @operations << :enable_mouse_tracking
         end
 
+        # Marks the backend as having mouse tracking disabled and records the operation.
         def disable_mouse_tracking
           @mouse_enabled = false
           @operations << :disable_mouse_tracking
         end
 
+        # Returns whether mouse tracking is currently enabled.
         def mouse_enabled?
           @mouse_enabled
         end
 
         private
 
+        # Overlays each [row, line] from *line_changes* onto a copy of the current frame
+        # (1-based row indexing). Used when `write_lines` is called without a *frame:* argument.
         def apply_line_changes(line_changes)
           lines = @current_frame.to_s.lines(chomp: true)
           line_changes.each do |row, line|

data/lib/charming/internal/terminal/mouse_parser.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Charming
+  module Internal
+    module Terminal
+      # MouseParser parses raw terminal escape sequences into MouseEvent objects.
+      # Supports both modern SGR sequences (the most common, used by current terminals)
+      # and the older 3-byte legacy sequences. The public API is class methods; no
+      # instance state is required.
+      class MouseParser
+        # Matches an SGR-encoded mouse sequence: "\e[<button;col;row[mode]M"
+        SGR_PATTERN = /\e\[<(\d+);(\d+);(\d+)([HmMhCc]?)(M|m)/
+
+        # Matches the legacy 3-byte mouse sequence: "\e[M" followed by 3 bytes.
+        LEGACY_PATTERN = /\e\[M(.{3})/
+
+        # Maps raw button codes to semantic symbols used by MouseEvent#button_name.
+        BUTTON_MAP = {
+          0 => :left, 1 => :middle, 2 => :right, 3 => :release,
+          64 => :scroll_up, 65 => :scroll_down,
+          66 => :scroll_up, 67 => :scroll_down
+        }.freeze
+
+        # Returns true when *raw* looks like a recognizable mouse sequence (SGR or legacy).
+        # Lets the TTYBackend short-circuit and dispatch to MouseParser without allocation.
+        def self.sequence?(raw)
+          return false unless raw.is_a?(String)
+          return true if raw.match?(SGR_PATTERN)
+          return true if raw.start_with?("\e[M")
+
+          false
+        end
+
+        # Parses *raw* into a MouseEvent, or returns nil when the string is not a mouse
+        # sequence or cannot be decoded.
+        def self.parse(raw)
+          return nil unless raw.is_a?(String)
+          return parse_sgr(raw) if raw.match?(SGR_PATTERN)
+          return parse_legacy(raw) if raw.start_with?("\e[M")
+
+          nil
+        end
+
+        # Parses an SGR-format mouse sequence. Decodes button code, 1-based (col, row),
+        # the modifier "C" (ctrl) and "M" (shift) suffix, and the highlight alt (256-color)
+        # sequence as a heuristic for the alt modifier.
+        def self.parse_sgr(raw)
+          match = raw.match(SGR_PATTERN)
+          return nil unless match
+
+          button_code = match[1].to_i
+          col = match[2].to_i - 1
+          row = match[3].to_i - 1
+          mode = match[4]
+
+          ctrl = mode == "C"
+          alt = raw.include?("\e[38;5;")
+          shift = mode == "M"
+
+          Events::MouseEvent.new(button: button_code, x: col, y: row, ctrl: ctrl, alt: alt, shift: shift)
+        end
+
+        # Parses a legacy 3-byte mouse sequence. Each of the 3 bytes has 32 subtracted
+        # to recover the (button, col, row) values.
+        def self.parse_legacy(raw)
+          match = raw.match(LEGACY_PATTERN)
+          return nil unless match
+
+          bytes = match[1].bytes
+          return nil unless bytes.length == 3
+
+          button_code = bytes[0] - 32
+          col = bytes[1] - 32
+          row = bytes[2] - 32
+
+          Events::MouseEvent.new(button: button_code, x: col, y: row)
+        end
+      end
+    end
+  end
+end