tui_tui 0.1.0

data/lib/tui_tui/theme.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative "style"
+
+module TuiTui
+  # Semantic Style roles shared by the built-in widgets.
+  # Themes combine a background surface with an accent hue.
+  Theme = Data.define(
+    # box borders / dividers
+    :frame,
+    :title,
+    :text,
+    # de-emphasized text (descriptions, body)
+    :muted,
+    # highlighted detail (e.g. key names)
+    :accent,
+    # the focused/selected item or button
+    :selection,
+    # a selected item in an unfocused pane (de-emphasized)
+    :selection_dim,
+    # status / footer bar background
+    :bar,
+    :cursor,
+    :scroll_track,
+    :scroll_thumb
+  )
+
+  class Theme
+    # Background-dependent neutral roles.
+    SURFACES = {
+      dark: {
+        text: Style.new,
+        muted: Style.new(fg: 245),
+        bar: Style.new(fg: 252, bg: 238),
+        selection_dim: Style.new(fg: 247, bg: 238)
+      },
+      light: {
+        text: Style.new,
+        muted: Style.new(fg: 240),
+        bar: Style.new(fg: 16, bg: 252),
+        selection_dim: Style.new(fg: 240, bg: 252)
+      }
+    }.freeze
+
+    # Accent roles per hue and background.
+    ACCENTS = {
+      cool: {
+        dark: {line: 66, title: 109, accent: 73, sel: [231, 60]},
+        light: {line: 30, title: 25, accent: 30, sel: [16, 152]}
+      },
+      warm: {
+        dark: {line: 95, title: 137, accent: 173, sel: [231, 95]},
+        light: {line: 95, title: 94, accent: 130, sel: [16, 180]}
+      },
+      mono: {
+        dark: {line: 240, title: 252, accent: 252, sel: [16, 250]},
+        light: {line: 240, title: 236, accent: 236, sel: [16, 250]}
+      }
+    }.freeze
+
+    # COLORFGBG background values meaning "light".
+    LIGHT_FGBG = %w[7 15].freeze
+
+    def self.bold(fg) = Style.new(fg: fg, attrs: [:bold])
+
+    # Build the palette for a (background, hue) pair.
+    def self.compose(background, hue)
+      surface = SURFACES.fetch(background)
+      a = ACCENTS.fetch(hue).fetch(background)
+      selection = Style.new(fg: a[:sel][0], bg: a[:sel][1])
+      new(
+        frame: Style.new(fg: a[:line]),
+        title: bold(a[:title]),
+        text: surface[:text],
+        muted: surface[:muted],
+        accent: bold(a[:accent]),
+        selection: selection,
+        selection_dim: surface[:selection_dim],
+        bar: surface[:bar],
+        cursor: selection,
+        scroll_track: Style.new(fg: a[:line]),
+        scroll_thumb: Style.new(bg: a[:sel][1])
+      )
+    end
+
+    # Shared palettes for every surface/hue pair.
+    TABLE = SURFACES.keys.product(ACCENTS.keys).to_h { |bg, hue| [[bg, hue], compose(bg, hue)] }.freeze
+
+    def self.build(background: :dark, hue: :cool) = TABLE.fetch([background, hue])
+
+    # Best-effort terminal background (:light/:dark).
+    def self.detect_background(env: ENV)
+      case env["TUITUI_BACKGROUND"]&.downcase
+      when "light"
+        :light
+      when "dark"
+        :dark
+      else
+        bg = env["COLORFGBG"]&.split(";")&.last
+        bg && LIGHT_FGBG.include?(bg) ? :light : :dark
+      end
+    end
+
+    # The hue palette tuned for the detected background.
+    def self.auto(hue: :cool, env: ENV) = build(background: detect_background(env: env), hue: hue)
+
+    # Fetch a preset by name (Symbol/String); unknown names fall back to DEFAULT.
+    def self.named(name) = PRESETS.fetch(name&.to_sym, DEFAULT)
+  end
+
+  Theme::DARK = Theme.build(background: :dark, hue: :cool)
+  Theme::LIGHT = Theme.build(background: :light, hue: :cool)
+  Theme::DEFAULT = Theme::DARK
+  Theme::WARM = Theme.build(background: :dark, hue: :warm)
+  Theme::MONO = Theme.build(background: :dark, hue: :mono)
+
+  class Theme
+    PRESETS = {
+      default: DEFAULT,
+      cool: DEFAULT,
+      dark: DARK,
+      light: LIGHT,
+      warm: WARM,
+      mono: MONO
+    }.freeze
+  end
+end

data/lib/tui_tui/toast.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "display_text"
+require_relative "style"
+
+module TuiTui
+  # 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
+    MONOTONIC = -> { Process.clock_gettime(Process::CLOCK_MONOTONIC) }
+
+    def initialize(message, seconds: DEFAULT_SECONDS, position: DEFAULT_POSITION, clock: MONOTONIC)
+      @message = DisplayText.new(message)
+      @position = position
+      @clock = clock
+      @expires_at = clock.call + seconds
+      validate_position!
+    end
+
+    def expired? = @clock.call >= @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

data/lib/tui_tui/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TuiTui
+  VERSION = "0.1.0"
+end

data/lib/tui_tui/width.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module TuiTui
+  # Terminal column width for the Unicode ranges this renderer needs.
+  # Wide/fullwidth clusters are 2, combining/control clusters are 0.
+  module Width
+    WIDE = [
+      # Hangul Jamo
+      [0x1100, 0x115F],
+      # CJK radicals, Kangxi, CJK symbols & punctuation
+      [0x2E80, 0x303E],
+      # Hiragana, Katakana, CJK symbols, enclosed CJK, ...
+      [0x3041, 0x33FF],
+      # CJK Unified Ext A
+      [0x3400, 0x4DBF],
+      # CJK Unified Ideographs
+      [0x4E00, 0x9FFF],
+      # Yi
+      [0xA000, 0xA4CF],
+      # Hangul Jamo Ext A
+      [0xA960, 0xA97F],
+      # Hangul Syllables
+      [0xAC00, 0xD7A3],
+      # CJK Compatibility Ideographs
+      [0xF900, 0xFAFF],
+      # Vertical forms
+      [0xFE10, 0xFE19],
+      # CJK Compatibility / small forms
+      [0xFE30, 0xFE6F],
+      # Fullwidth forms
+      [0xFF00, 0xFF60],
+      # Fullwidth signs
+      [0xFFE0, 0xFFE6],
+      # Kana supplement / extended
+      [0x1B000, 0x1B16F],
+      # Regional indicator symbols (flag letters)
+      [0x1F1E6, 0x1F1FF],
+      # Enclosed ideographic supplement
+      [0x1F200, 0x1F251],
+      # Misc symbols & pictographs + emoticons
+      [0x1F300, 0x1F64F],
+      # Transport & map symbols
+      [0x1F680, 0x1F6FF],
+      # Supplemental symbols & pictographs
+      [0x1F900, 0x1F9FF],
+      # Symbols & pictographs extended-A
+      [0x1FA70, 0x1FAFF],
+      # CJK Unified Ext B and beyond
+      [0x20000, 0x3FFFD]
+    ].freeze
+
+    ZERO = [
+      # Combining diacritical marks
+      [0x0300, 0x036F],
+      [0x0483, 0x0489],
+      [0x0591, 0x05BD],
+      [0x0610, 0x061A],
+      [0x064B, 0x065F],
+      [0x06D6, 0x06DC],
+      # Zero-width space / joiners / marks
+      [0x200B, 0x200F],
+      # Variation selectors
+      [0xFE00, 0xFE0F],
+      # Zero-width no-break space (BOM)
+      [0xFEFF, 0xFEFF],
+      # Emoji skin-tone modifiers (combine onto the base)
+      [0x1F3FB, 0x1F3FF]
+    ].freeze
+
+    class << self
+
+      def cluster(grapheme)
+        # A cluster's base codepoint determines its terminal width.
+        base = grapheme[0]
+        return 1 if control?(base.ord)
+
+        char(base)
+      end
+
+      def char(char)
+        cp = char.ord
+        return 0 if control?(cp)
+        return 0 if in?(cp, ZERO)
+
+        in?(cp, WIDE) ? 2 : 1
+      end
+
+      def control?(cp)
+        cp < 0x20 || cp == 0x7F || cp.between?(0x80, 0x9F)
+      end
+
+      private
+
+      def in?(cp, ranges)
+        # Ranges are sorted and non-overlapping, so one binary search is enough.
+        index = ranges.bsearch_index { |_lo, hi| hi >= cp }
+        !index.nil? && ranges[index][0] <= cp
+      end
+    end
+  end
+end

data/lib/tui_tui.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "tui_tui/version"
+
+require_relative "tui_tui/width"
+require_relative "tui_tui/text_sanitizer"
+require_relative "tui_tui/display_text"
+require_relative "tui_tui/span"
+require_relative "tui_tui/line"
+require_relative "tui_tui/ansi"
+require_relative "tui_tui/color_depth"
+require_relative "tui_tui/palette"
+require_relative "tui_tui/style"
+require_relative "tui_tui/theme"
+require_relative "tui_tui/size"
+require_relative "tui_tui/rect"
+require_relative "tui_tui/cell"
+require_relative "tui_tui/canvas"
+require_relative "tui_tui/canvas_compositor"
+require_relative "tui_tui/event"
+require_relative "tui_tui/key_code"
+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/focus_ring"
+require_relative "tui_tui/fuzzy"
+require_relative "tui_tui/modal"
+require_relative "tui_tui/confirm"
+require_relative "tui_tui/select"
+require_relative "tui_tui/help"
+require_relative "tui_tui/prompt"
+require_relative "tui_tui/pager"
+require_relative "tui_tui/screen"
+require_relative "tui_tui/runtime"
+
+# A tiny, owned TUI runtime for rendering in modern graphical terminals. Its only
+# dependency is `io/console` (a default gem, used by the Screen driver); the pure
+# 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`.
+module TuiTui
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: tui_tui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- takahashim
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'TuiTui is a small terminal-UI framework: a width-aware canvas, a diffing
+  renderer, an Elm-style runtime loop, and composable widgets (modals, lists, prompts).
+  Its only dependency is io/console.'
+email:
+- takahashimm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/clock.rb
+- examples/counter.rb
+- examples/csv_viewer.rb
+- examples/file_browser.rb
+- examples/form.rb
+- examples/life.rb
+- examples/paint.rb
+- examples/todo.rb
+- examples/widgets.rb
+- lib/tui_tui.rb
+- lib/tui_tui/ansi.rb
+- lib/tui_tui/canvas.rb
+- lib/tui_tui/canvas_compositor.rb
+- lib/tui_tui/cell.rb
+- lib/tui_tui/color_depth.rb
+- lib/tui_tui/confirm.rb
+- lib/tui_tui/display_text.rb
+- lib/tui_tui/event.rb
+- lib/tui_tui/event_stream.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/pager.rb
+- lib/tui_tui/palette.rb
+- lib/tui_tui/prompt.rb
+- lib/tui_tui/rect.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/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/width.rb
+homepage: https://github.com/takahashim/tui_tui
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/takahashim/tui_tui
+  source_code_uri: https://github.com/takahashim/tui_tui
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: A tiny, dependency-free TUI runtime for modern terminals.
+test_files: []