tui_tui 0.3.0 → 0.4.0

data/lib/tui_tui/widget/text_view.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "../line"
+require_relative "../span"
+require_relative "scrollbar"
+
+module TuiTui
+  module Widget
+    # A scrolled read-only text window.
+    # Lines may be Strings, Lines, or Span arrays, supplied eagerly or lazily.
+    module TextView
+      module_function
+
+      def draw(canvas, rect, lines = nil, top: 0, style: nil, scrollbar: nil, total: nil, auto: false)
+        # With auto:, reserve the gutter only when the content overflows the rect.
+        # When the total is unknown (lazy block, no total:), the bar is kept.
+        count = total || lines&.length
+        show_bar = scrollbar && !(auto && count && count <= rect.rows)
+        body, gutter = show_bar ? rect.split_gutter : [rect, nil]
+        body.rows.times do |offset|
+          index = top + offset
+          content = lines ? lines[index] : yield(index)
+          next if content.nil?
+
+          canvas.line(body.row + offset, body.col, Line.coerce(content, style).truncate(body.cols))
+        end
+
+        draw_scrollbar(canvas, gutter, top, total || lines&.length, body.rows, scrollbar) if gutter
+        canvas
+      end
+
+      def draw_scrollbar(canvas, gutter, top, total, visible, theme)
+        return unless total
+
+        Scrollbar.draw(
+          canvas,
+          gutter,
+          top: top,
+          visible: visible,
+          total: total,
+          track_style: theme.scroll_track,
+          thumb_style: theme.scroll_thumb
+        )
+      end
+    end
+  end
+end

data/lib/tui_tui/widget/toast.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "../display_text"
+require_relative "../style"
+require_relative "../clock"
+
+module TuiTui
+  module Widget
+    # A transient notification overlay.
+    # The clock is injectable so expiry is testable without sleeping.
+    class Toast
+      DEFAULT_SECONDS = 2.0
+      DEFAULT_STYLE = Style.new(attrs: [:reverse])
+      DEFAULT_POSITION = :bottom_center
+      POSITIONS = {
+        top_left: [:top, :left],
+        top_center: [:top, :center],
+        top_right: [:top, :right],
+        middle_left: [:middle, :left],
+        middle_center: [:middle, :center],
+        middle_right: [:middle, :right],
+        bottom_left: [:bottom, :left],
+        bottom_center: [:bottom, :center],
+        bottom_right: [:bottom, :right],
+        center: [:middle, :center]
+      }.freeze
+      def initialize(message, seconds: DEFAULT_SECONDS, position: DEFAULT_POSITION, clock: Clock)
+        @message = DisplayText.new(message)
+        @position = position
+        @clock = clock
+        @expires_at = clock.monotonic + seconds
+        validate_position!
+      end
+
+      def expired? = @clock.monotonic >= @expires_at
+
+      def draw(canvas, size, style: DEFAULT_STYLE, position: @position)
+        return canvas if expired?
+
+        label = DisplayText.new(" #{@message} ").truncate(size.cols)
+        vertical, horizontal = position_parts(position)
+        row = row_for(size, vertical)
+        col = col_for(size, label.width, horizontal)
+        canvas.text(row, col, label, style)
+        canvas
+      end
+
+      private
+
+      def validate_position!
+        position_parts(@position)
+      end
+
+      def position_parts(position)
+        POSITIONS.fetch(position) do
+          raise ArgumentError, "unknown toast position: #{position.inspect}"
+        end
+      end
+
+      def row_for(size, vertical)
+        case vertical
+        when :top
+          1
+        when :middle
+          ((size.rows + 1) / 2).clamp(1, size.rows)
+        when :bottom
+          [size.rows - 2, 1].max
+        end
+      end
+
+      def col_for(size, width, horizontal)
+        case horizontal
+        when :left
+          1
+        when :center
+          [((size.cols - width) / 2) + 1, 1].max
+        when :right
+          [size.cols - width + 1, 1].max
+        end
+      end
+    end
+  end
+end

data/lib/tui_tui.rb

@@ -12,6 +12,7 @@ require_relative "tui_tui/ansi"
 require_relative "tui_tui/color_depth"
 require_relative "tui_tui/box_chrome"
 require_relative "tui_tui/box_prober"
+require_relative "tui_tui/box_chrome_resolver"
 require_relative "tui_tui/palette"
 require_relative "tui_tui/style"
 require_relative "tui_tui/theme"
@@ -20,29 +21,36 @@ require_relative "tui_tui/rect"
 require_relative "tui_tui/cell"
 require_relative "tui_tui/canvas"
 require_relative "tui_tui/render_context"
+require_relative "tui_tui/canvas_renderer"
 require_relative "tui_tui/canvas_compositor"
-require_relative "tui_tui/event"
+require_relative "tui_tui/events"
+require_relative "tui_tui/command"
 require_relative "tui_tui/key_code"
+require_relative "tui_tui/text_input"
 require_relative "tui_tui/key_reader"
 require_relative "tui_tui/key_intent"
 require_relative "tui_tui/event_stream"
 require_relative "tui_tui/terminal_session"
-require_relative "tui_tui/scroll_list"
-require_relative "tui_tui/list"
-require_relative "tui_tui/text_view"
-require_relative "tui_tui/scrollbar"
-require_relative "tui_tui/status_bar"
-require_relative "tui_tui/toast"
+require_relative "tui_tui/widget/scroll_list"
+require_relative "tui_tui/widget/list"
+require_relative "tui_tui/widget/text_view"
+require_relative "tui_tui/widget/scrollbar"
+require_relative "tui_tui/widget/status_bar"
+require_relative "tui_tui/widget/toast"
+require_relative "tui_tui/widget/table"
+require_relative "tui_tui/widget/tabs"
+require_relative "tui_tui/widget/spinner"
+require_relative "tui_tui/widget/progress"
 require_relative "tui_tui/focus_ring"
 require_relative "tui_tui/fuzzy"
 require_relative "tui_tui/modal"
 require_relative "tui_tui/modal_host"
-require_relative "tui_tui/confirm"
-require_relative "tui_tui/select"
-require_relative "tui_tui/command_palette"
-require_relative "tui_tui/help"
-require_relative "tui_tui/prompt"
-require_relative "tui_tui/pager"
+require_relative "tui_tui/modal/confirm"
+require_relative "tui_tui/modal/select"
+require_relative "tui_tui/modal/command_palette"
+require_relative "tui_tui/modal/help"
+require_relative "tui_tui/modal/prompt"
+require_relative "tui_tui/modal/pager"
 require_relative "tui_tui/screen"
 require_relative "tui_tui/runtime"
 
@@ -51,7 +59,7 @@ require_relative "tui_tui/runtime"
 # pieces — width, color, style, layout — need nothing.
 #
 # The framework is application-agnostic. Build an app object responding to
-# `view(size) -> Canvas` and `update(event) -> app | :quit`, then drive it with
-# `TuiTui::Runtime`.
+# `view(size) -> Canvas` and `update(event) -> app | [app, *commands] | :quit`,
+# then drive it with `TuiTui::Runtime`.
 module TuiTui
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tui_tui
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - takahashim
@@ -23,60 +23,73 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/README.md
+- examples/breakout.rb
 - examples/clock.rb
 - examples/counter.rb
 - examples/csv_viewer.rb
+- examples/downloads.rb
 - examples/file_browser.rb
 - examples/form.rb
 - examples/life.rb
+- examples/log_viewer.rb
 - examples/paint.rb
 - examples/todo.rb
 - examples/widgets.rb
 - lib/tui_tui.rb
 - lib/tui_tui/ansi.rb
 - lib/tui_tui/box_chrome.rb
+- lib/tui_tui/box_chrome_resolver.rb
 - lib/tui_tui/box_prober.rb
 - lib/tui_tui/canvas.rb
 - lib/tui_tui/canvas_compositor.rb
+- lib/tui_tui/canvas_renderer.rb
 - lib/tui_tui/cell.rb
 - lib/tui_tui/clock.rb
 - lib/tui_tui/color_depth.rb
-- lib/tui_tui/command_palette.rb
-- lib/tui_tui/confirm.rb
+- lib/tui_tui/command.rb
 - lib/tui_tui/display_text.rb
-- lib/tui_tui/event.rb
 - lib/tui_tui/event_stream.rb
+- lib/tui_tui/events.rb
 - lib/tui_tui/focus_ring.rb
 - lib/tui_tui/fuzzy.rb
-- lib/tui_tui/help.rb
 - lib/tui_tui/key_code.rb
 - lib/tui_tui/key_intent.rb
 - lib/tui_tui/key_reader.rb
 - lib/tui_tui/line.rb
-- lib/tui_tui/list.rb
 - lib/tui_tui/modal.rb
+- lib/tui_tui/modal/command_palette.rb
+- lib/tui_tui/modal/confirm.rb
+- lib/tui_tui/modal/help.rb
+- lib/tui_tui/modal/pager.rb
+- lib/tui_tui/modal/prompt.rb
+- lib/tui_tui/modal/select.rb
 - lib/tui_tui/modal_host.rb
-- lib/tui_tui/pager.rb
 - lib/tui_tui/palette.rb
-- lib/tui_tui/prompt.rb
 - lib/tui_tui/rect.rb
 - lib/tui_tui/render_context.rb
 - lib/tui_tui/runtime.rb
 - lib/tui_tui/screen.rb
-- lib/tui_tui/scroll_list.rb
-- lib/tui_tui/scrollbar.rb
-- lib/tui_tui/select.rb
 - lib/tui_tui/size.rb
 - lib/tui_tui/span.rb
-- lib/tui_tui/status_bar.rb
 - lib/tui_tui/style.rb
 - lib/tui_tui/terminal_session.rb
 - lib/tui_tui/terminal_size.rb
+- lib/tui_tui/test_runtime.rb
+- lib/tui_tui/text_input.rb
 - lib/tui_tui/text_sanitizer.rb
-- lib/tui_tui/text_view.rb
 - lib/tui_tui/theme.rb
-- lib/tui_tui/toast.rb
 - lib/tui_tui/version.rb
+- lib/tui_tui/widget/list.rb
+- lib/tui_tui/widget/progress.rb
+- lib/tui_tui/widget/scroll_list.rb
+- lib/tui_tui/widget/scrollbar.rb
+- lib/tui_tui/widget/spinner.rb
+- lib/tui_tui/widget/status_bar.rb
+- lib/tui_tui/widget/table.rb
+- lib/tui_tui/widget/tabs.rb
+- lib/tui_tui/widget/text_view.rb
+- lib/tui_tui/widget/toast.rb
 - lib/tui_tui/width.rb
 homepage: https://github.com/takahashim/tui_tui
 licenses:
@@ -100,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A tiny, dependency-free TUI runtime for modern terminals.
 test_files: []

data/lib/tui_tui/command_palette.rb

@@ -1,190 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "display_text"
-require_relative "text_sanitizer"
-require_relative "style"
-require_relative "scroll_list"
-require_relative "list"
-require_relative "line"
-require_relative "span"
-require_relative "rect"
-require_relative "modal"
-require_relative "fuzzy"
-require_relative "key_code"
-
-module TuiTui
-  # Fuzzy-filtered command palette modal (think Ctrl-P): type to narrow a list of
-  # commands, arrows or Ctrl-N/Ctrl-P to move, Enter to pick, Esc to cancel.
-  #
-  # Items are arbitrary objects; pass a block to derive each one's display label
-  # (defaults to #to_s). Resolves to the chosen item on Enter and :cancel on
-  # escape; stays open (nil) while the query has no matches.
-  #
-  #   host.open(CommandPalette.new(commands) { |c| c.title }) { |cmd| cmd.run; self }
-  class CommandPalette < Modal
-    MAX_ROWS = 10
-    MIN_INNER = 28
-    WHEEL = 3
-
-    def initialize(items, prompt: "> ", placeholder: "Type to search…", theme: Theme::DEFAULT, &label)
-      @items = items.to_a
-      @label = label || :to_s.to_proc
-      @prompt = DisplayText.new(prompt)
-      @placeholder = DisplayText.new(placeholder)
-      @theme = theme
-      @graphemes = []
-      @list = ScrollList.new(0)
-      refilter
-    end
-
-    def query = @graphemes.join
-
-    # The original item under the cursor, or nil when nothing matches.
-    def selection = @filtered[@list.cursor]&.first
-
-    def handle(key)
-      case key
-      when "\r"
-        selection
-      when :escape, KeyCode::CTRL_C
-        :cancel
-      when :up, KeyCode::CTRL_P
-        move(-1)
-      when :down, KeyCode::CTRL_N
-        move(1)
-      when :home
-        move_to(0)
-      when :end
-        move_to(@list.last)
-      when KeyCode::BACKSPACE, :backspace
-        edit { @graphemes.pop }
-      when String
-        edit { @graphemes.concat(key.grapheme_clusters) if TextSanitizer.printable?(key) }
-      end
-    end
-
-    # Wheel scrolls the highlight; a click on a row picks it (returns the item),
-    # otherwise nil to stay open.
-    def handle_mouse(event)
-      case event.action
-      when :wheel
-        move(event.button == :wheel_up ? -WHEEL : WHEEL)
-      when :press
-        click(event)
-      end
-    end
-
-    def draw(canvas, size)
-      rows = visible_rows(size)
-      inner = [MIN_INNER, *@filtered.map { |_item, label, _pos| label.width }].max
-      rect, col = panel(canvas, inner: inner, body_rows: rows + 2)
-
-      draw_query(canvas, rect.row + 1, col, inner)
-      draw_items(canvas, rect.row + 3, col, inner, rows)
-      canvas
-    end
-
-    private
-
-    def move(delta)
-      @list.move(delta)
-      nil
-    end
-
-    def move_to(index)
-      @list.go_to(index)
-      nil
-    end
-
-    # Apply a query edit, then refilter. Returns nil so the modal stays open.
-    def edit
-      yield
-      refilter
-      nil
-    end
-
-    # Recompute the visible list: fuzzy-ranked (best first, with matched positions
-    # for highlighting) while querying, otherwise the items in their given order.
-    # Each entry is [item, DisplayText(label), positions]; the cursor resets so a
-    # narrowed query always lands on the top match.
-    def refilter
-      @filtered =
-        if @graphemes.empty?
-          @items.map { |item| [item, label_text(item), []] }
-        else
-          Fuzzy.new(query).rank(@items) { |item| @label.call(item).to_s }
-               .map { |item, found| [item, label_text(item), found.positions] }
-        end
-      @list.count = @filtered.size
-      @list.go_to(0)
-    end
-
-    def label_text(item) = DisplayText.new(@label.call(item).to_s)
-
-    def visible_rows(size)
-      room = [size.rows - 4, 1].max
-      [[@filtered.size, 1].max, MAX_ROWS, room].min
-    end
-
-    def draw_query(canvas, row, col, inner)
-      canvas.text(row, col, @prompt, theme.accent)
-      text_col = col + @prompt.width
-      budget = inner - @prompt.width
-      if @graphemes.empty?
-        canvas.text(row, text_col, @placeholder.truncate(budget), theme.muted)
-      else
-        canvas.text(row, text_col, DisplayText.new(query).truncate(budget), theme.text)
-      end
-    end
-
-    def draw_items(canvas, row, col, inner, rows)
-      @items_rect = Rect.new(row: row, col: col, rows: rows, cols: inner)
-      if @filtered.empty?
-        canvas.text(row, col, DisplayText.new("No matches").truncate(inner), theme.muted)
-        return
-      end
-
-      List.new(@list).draw(canvas, @items_rect, highlight: theme.selection) do |index, focused|
-        _item, label, positions = @filtered[index]
-        base = focused ? theme.selection : theme.text
-        # Keep the focused row a single style; highlight matches with accent only
-        # on unfocused rows so the selection bar stays legible.
-        match = focused ? base : theme.accent
-        styled_line(label.to_s, positions, base, match)
-      end
-    end
-
-    # The label as a Line with matched graphemes in `match` and the rest in `base`;
-    # runs of the same style coalesce into one Span (grapheme indices line up with
-    # Fuzzy#positions).
-    def styled_line(label, positions, base, match)
-      return Line[Span[label, base]] if positions.empty?
-
-      spans = []
-      run = +""
-      run_style = nil
-      label.grapheme_clusters.each_with_index do |grapheme, i|
-        style = positions.include?(i) ? match : base
-        if style != run_style && !run.empty?
-          spans << Span[run, run_style]
-          run = +""
-        end
-        run_style = style
-        run << grapheme
-      end
-      spans << Span[run, run_style] unless run.empty?
-      Line.new(spans)
-    end
-
-    # The item under a click, picked, or nil if the click missed the list.
-    def click(event)
-      return nil unless @items_rect
-
-      index = List.new(@list).index_at(@items_rect, event)
-      return nil if index.nil?
-
-      @list.go_to(index)
-      selection
-    end
-  end
-end

data/lib/tui_tui/confirm.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "display_text"
-require_relative "style"
-require_relative "modal"
-require_relative "key_code"
-
-module TuiTui
-  # OK / Cancel confirmation modal.
-  class Confirm < Modal
-    GAP = 2
-
-    attr_reader :focus
-
-    def initialize(message, ok: "OK", cancel: "Cancel", default: :cancel, theme: Theme::DEFAULT)
-      @message = DisplayText.new(message)
-      @ok = button_text(ok)
-      @cancel = button_text(cancel)
-      @focus = default
-      @theme = theme
-    end
-
-    def handle(key)
-      case key
-      when :left, :right, "\t", "h", "l"
-        toggle
-      when "\r", " "
-        @focus
-      when "y", "Y"
-        :ok
-      when "n", "N", :escape, KeyCode::CTRL_C
-        :cancel
-      end
-    end
-
-    def handle_mouse(event)
-      return nil unless event.action == :press && @buttons_row == event.row
-
-      return :ok if hit?(event.col, @ok_at, @ok.width)
-      return :cancel if hit?(event.col, @cancel_at, @cancel.width)
-
-      nil
-    end
-
-    def draw(canvas, size)
-      inner = [@message.width, buttons_width].max
-      rect, col = panel(canvas, inner: inner, body_rows: 3)
-      canvas.text(rect.row + 1, col, @message.center(inner), theme.text)
-      draw_buttons(canvas, rect.row + 3, col, inner)
-      canvas
-    end
-
-    private
-
-    def hit?(col, start, width) = col.between?(start, start + width - 1)
-
-    def toggle
-      @focus = @focus == :ok ? :cancel : :ok
-      nil
-    end
-
-    def draw_buttons(canvas, row, col, inner)
-      start = col + [(inner - buttons_width) / 2, 0].max
-      @buttons_row = row
-      @ok_at = start
-      @cancel_at = start + @ok.width + GAP
-      canvas.text(row, @ok_at, @ok, @focus == :ok ? theme.selection : theme.text)
-      canvas.text(row, @cancel_at, @cancel, @focus == :cancel ? theme.selection : theme.text)
-    end
-
-    def buttons_width = @ok.width + GAP + @cancel.width
-    def button_text(label) = DisplayText.new("[ #{label} ]")
-  end
-end

data/lib/tui_tui/help.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "display_text"
-require_relative "style"
-require_relative "modal"
-
-module TuiTui
-  # Key-binding cheat sheet modal.
-  class Help < Modal
-    COLGAP = 2
-
-    def initialize(title, entries, theme: Theme::DEFAULT)
-      @title = DisplayText.new(title)
-      @entries = entries.map { |keys, desc| [DisplayText.new(keys), DisplayText.new(desc)] }
-      @theme = theme
-    end
-
-    def handle(_key) = :close
-
-    # Any click dismisses the sheet, like any key does.
-    def handle_mouse(event) = event.action == :press ? :close : nil
-
-    def draw(canvas, size)
-      key_w = @entries.map { |keys, _| keys.width }.max || 0
-      body_w = @entries.map { |keys, desc| keys.width + COLGAP + desc.width }.max || 0
-      inner = [@title.width, body_w].max
-
-      rect, col = panel(canvas, inner: inner, body_rows: @entries.size + 2)
-
-      canvas.text(rect.row + 1, col, @title.truncate(inner), theme.title)
-      draw_entries(canvas, rect.row + 3, col, key_w)
-      canvas
-    end
-
-    private
-
-    def draw_entries(canvas, row, col, key_w)
-      @entries.each_with_index do |(keys, desc), index|
-        canvas.text(row + index, col, keys, theme.accent)
-        canvas.text(row + index, col + key_w + COLGAP, desc, theme.muted)
-      end
-    end
-  end
-end

data/lib/tui_tui/list.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rect"
-require_relative "line"
-require_relative "scrollbar"
-
-module TuiTui
-  # Drawing companion for ScrollList.
-  # Row content comes from the caller, keeping the list domain-agnostic.
-  class List
-    def initialize(scroll)
-      @scroll = scroll
-    end
-
-    def draw(canvas, rect, highlight: nil, scrollbar: nil, auto: false)
-      # With auto:, reserve the gutter only when the content overflows the rect.
-      show_bar = scrollbar && !(auto && @scroll.count <= rect.rows)
-      body, gutter = show_bar ? rect.split_gutter : [rect, nil]
-      @scroll.ensure_visible(body.rows)
-      @scroll.each_visible(body.rows) do |index, offset|
-        row = body.row + offset
-        selected = index == @scroll.cursor
-        canvas.fill(Rect.new(row: row, col: body.col, rows: 1, cols: body.cols), highlight) if highlight && selected
-        canvas.line(row, body.col, Line.coerce(yield(index, selected)).truncate(body.cols))
-      end
-
-      draw_scrollbar(canvas, gutter, scrollbar) if gutter
-      canvas
-    end
-
-    # Map a MouseEvent to the list index under it, or nil. Pass the same `rect`
-    # and `scrollbar:` used for `draw` so the gutter column is excluded and the
-    # scroll offset matches what was rendered. Returns nil for clicks outside the
-    # body or below the last item.
-    def index_at(rect, event, scrollbar: nil)
-      body = scrollbar ? rect.split_gutter.first : rect
-      return nil unless body.hit?(event)
-
-      index = @scroll.top + (event.row - body.row)
-      index < @scroll.count ? index : nil
-    end
-
-    private
-
-    def draw_scrollbar(canvas, gutter, theme)
-      Scrollbar.draw(
-        canvas,
-        gutter,
-        top: @scroll.top,
-        visible: gutter.rows,
-        total: @scroll.count,
-        track_style: theme.scroll_track,
-        thumb_style: theme.scroll_thumb
-      )
-    end
-  end
-end