fatty 0.99.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a0bfc64f40dcca4bf86300fc22de71e6947b4f9abbc616604c6e5a24a6636a2c
+  data.tar.gz: 4dc3d290ce33c14c17603272b16134dd88ced0cb2889286ad64da4b512b3f2e0
+SHA512:
+  metadata.gz: 93f7710ce74df70a16b2abdc63456a4efb117089bc83ab4c17f138bd9081fb8a1d028ea14a15c5647cdcd344bb37b3b7747dab4b2aefb1b36cfce20aa1a69e63
+  data.tar.gz: 29c0d4b081c7189c953f4e7fd38eda394a76ec43359d607e488a726cd5b6084f69e64248d021e0e6e3704a5b9b36ab5274142e4046d5f8edadb0e827500a3ff3

data/.envrc

@@ -0,0 +1,2 @@
+PATH_add .bundle/bin
+PATH_add ./scripts

data/.simplecov

@@ -0,0 +1,23 @@
+SimpleCov.start do
+  track_files "lib/**/*.rb"
+
+  # any custom configs like groups and filters can be here at a central place
+  add_filter %r{^/spec/}
+  add_filter %r{^/bin/}
+  add_filter %r{^/doc/}
+  add_filter %r{^/sig/}
+  add_filter %r{^/coverage/}
+  add_filter %r{^/\.yardoc/}
+  add_filter %r{^/\.ruby-lsp/}
+  add_filter %r{^/\.git/}
+  add_filter %r{^/\.githib/}
+
+  add_group "Core", %r{^/lib/fatty/[^/]*\.rb}
+  add_group "Views", %r{^/lib/fatty/view/[^/]*\.rb}
+  add_group "Sessions", %r{^/lib/fatty/session/[^/]*\.rb}
+  add_group "Curses", %r{^/lib/fatty/backends/curses/[^/]*\.rb}
+  merge_timeout 3600
+  # Make this true to merge rspec and cucumber coverage together
+  use_merging false
+  # enable_coverage :branch
+end

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--output-dir doc
+--readme README.md
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+- [Version 0.5.0 <span class="timestamp-wrapper"><span class="timestamp">[2026-05-03 Sun]</span></span>](#orgb0bc550)
+- [Version 0.4.0 <span class="timestamp-wrapper"><span class="timestamp">[2026-04-30 Thu]</span></span>](#org805c7ee)
+- [Version 0.3.0 <span class="timestamp-wrapper"><span class="timestamp">[2025-04-26 Sat]</span></span>](#org2c7a225)
+
+
+<a id="orgb0bc550"></a>
+
+# Version 0.5.0 <span class="timestamp-wrapper"><span class="timestamp">[2026-05-03 Sun]</span></span>
+
+-   Implemented YAML-driven theme system with inheritance, both for themes and for roles within a theme.
+-   Themes allow popup frames to be styled now with single or double lines and square or rounded corners.
+-   Use the default multi-term matcher for popups
+-   Fix auto-completion regression on input line to trigger on self-insert.
+
+
+<a id="org805c7ee"></a>
+
+# Version 0.4.0 <span class="timestamp-wrapper"><span class="timestamp">[2026-04-30 Thu]</span></span>
+
+-   Add \`keytest\` interactive keybinding inspector
+-   Add markdown rendering support in demo
+-   Internal: unified action dispatch system (actionize)
+
+
+<a id="org2c7a225"></a>
+
+# Version 0.3.0 <span class="timestamp-wrapper"><span class="timestamp">[2025-04-26 Sat]</span></span>
+
+-   Change name from fat\_term to fatty: it was too tempting to resist
+-   Add widgets for \`choose\` \`choosevals\` \`progress\` \`prompt\` \`menu\` \`choose\_multi\` \`choosevals\_multi\`
+-   Add status line
+-   Improve scroll speed
+-   Add completions and predictive completions
+-   Many, many internal improvements

data/CHANGELOG.org

@@ -0,0 +1,38 @@
+* COMMENT CHANGELOG tips:
+1. Don't dump your git change logs into this file, write them yourself.
+2. Keep entries short and user-focused,
+3. Use non-technical language, but do speak in the vocabulary of your gem.
+4. Don't document changes only of interest to the programmers, just those the
+   user would find useful.
+5. Give each heading a version number and an inactive date (C-c ! is useful here).
+
+* Version 0.99.0 [2026-05-23 Sat]
+- Rewrite the rendering to allow Truecolor writing to screen instead of just
+  Curses writing based on config truecolor setting, with auto detection of
+  truecolor terminal capability.
+- Duplicates removed from history popup.
+- Integrate markdown output into the theme system such that markdown elements
+  can be styled within a theme's YAML file.
+- Ready to try to integrate into an actual app before version 1.0.0.
+
+* Version 0.5.0 [2026-05-03 Sun]
+- Implemented YAML-driven theme system with inheritance, both for themes and
+  for roles within a theme.
+- Themes allow popup frames to be styled now with single or double lines and
+  square or rounded corners.
+- Use the default multi-term matcher for popups
+- Fix auto-completion regression on input line to trigger on self-insert.
+
+* Version 0.4.0 [2026-04-30 Thu]
+- Add `keytest` interactive keybinding inspector
+- Add markdown rendering support in demo
+- Internal: unified action dispatch system (actionize)
+
+* Version 0.3.0 [2025-04-26 Sat]
+- Change name from fat_term to fatty: it was too tempting to resist
+- Add widgets for `choose` `choosevals` `progress` `prompt` `menu`
+  `choose_multi` `choosevals_multi`
+- Add status line
+- Improve scroll speed
+- Add completions and predictive completions
+- Many, many internal improvements

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Daniel E. Doherty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+- [Introduction](#orga462d10)
+- [Reading Keys](#org64156e4)
+- [Alerts](#org38ad970)
+
+#+PROPERTY: header-args:ruby :results value :colnames no :hlines yes :exports both :dir "./"
+#+PROPERTY: header-args:ruby+ :wrap example :session fatty_session :eval yes
+#+PROPERTY: header-args:ruby+ :prologue "$:.unshift('./lib') unless $:.first == './lib'; require 'fatty'"
+#+PROPERTY: header-args:ruby+ :ruby "bundle exec irb"
+#+PROPERTY: header-args:sh :exports code :eval no
+#+PROPERTY: header-args:bash :exports code :eval no
+
+[![CI](https://github.com/ddoherty03/fatty/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/ddoherty03/fatty/actions/workflows/main.yml)
+
+
+<a id="orga462d10"></a>
+
+# Introduction
+
+
+<a id="org64156e4"></a>
+
+# Reading Keys
+
+Shift/Ctrl/Meta F-keys are normalized when ncurses provides distinct constants.
+
+
+<a id="org38ad970"></a>
+
+# Alerts
+
+Alerts are short-lived, non-scrolling messages shown below the input line. They are intended for user-visible conditions that require attention.

data/README.org

@@ -0,0 +1,166 @@
+#+BEGIN_EXPORT markdown
+#+PROPERTY: header-args:ruby :results value :colnames no :hlines yes :exports both :dir "./"
+#+PROPERTY: header-args:ruby+ :wrap example :session fatty_session :eval yes
+#+PROPERTY: header-args:ruby+ :prologue "$:.unshift('./lib') unless $:.first == './lib'; require 'fatty'"
+#+PROPERTY: header-args:ruby+ :ruby "bundle exec irb"
+#+PROPERTY: header-args:sh :exports code :eval no
+#+PROPERTY: header-args:bash :exports code :eval no
+
+[![CI](https://github.com/ddoherty03/fatty/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/ddoherty03/fatty/actions/workflows/main.yml)
+#+END_EXPORT
+
+
+#+PROPERTY: header-args:ruby :results value :colnames no :hlines yes :exports both :dir "./"
+#+PROPERTY: header-args:ruby+ :wrap example :session fatty_session :eval yes
+#+PROPERTY: header-args:ruby+ :prologue "$:.unshift('./lib') unless $:.first == './lib'; require 'fatty'"
+#+PROPERTY: header-args:ruby+ :ruby "bundle exec irb"
+#+PROPERTY: header-args:sh :exports code :eval no
+#+PROPERTY: header-args:bash :exports code :eval no
+
+* Introduction
+
+* Reading Keys
+
+Shift/Ctrl/Meta F-keys are normalized when ncurses provides distinct constants.
+
+* Fatty Help
+** The =fatty= demo command
+
+When you =fatty=, it operates as a simple demo of the =fatty= gem by
+presenting an editable command-line using emacs key bindings.  It has several
+builtin commands to demonstrate =fatty= features, and any command it does not
+recognized is handed off to the shell.
+
+** Builtin commands
+
+Here are the commands builtin to =fatty=
+
+| Command                     | Description                                                             |
+|-----------------------------+-------------------------------------------------------------------------|
+| help                        | Display this file on the output pane                                    |
+| cd                          | Change the current directory used by the shell                          |
+| choose                      | Present a series of choices in a popup window                           |
+| choosevals                  | Also present choices in a popup window but return an associated value   |
+| choose_multi                | Present choices with a "checkbox" for selecting multiple values         |
+| choosevals_multi            | Also present a checkbox but return associated values                    |
+| menu                        | Present a menu of labeled routines to run                               |
+| info                        | Display an "info" message on the status line                            |
+| good                        | Display a "good" message colored to indicate success                    |
+| warn                        | Display a "warn" message colored to indicate caution                    |
+| oops                        | Display an "oops" message colored to indicate failure                   |
+| prompt                      | Popup a text box for entering a value in response to a prompt           |
+| progress count <N>          | Display an animated progress indicator counting up to 40 or the given N |
+| progress percent <N>        | Same but also show the percent complete                                 |
+| progress simple_percent <N> | Same but show only the percent complete                                 |
+| progress trail              | Show progress by displaying an "indicator" character for each step      |
+| progress bar                | Show progress by a filling bar using ASCII characters                   |
+| progress unicode_bar        | Same, but using unicode characters                                      |
+| progress braille_bar        | Same, but using braille characters                                      |
+| progress spinner            | Animate a "spinner" showing a busy state                                |
+| markdown <file.md>          | Render the markdown file to the output pane; defaults to a demo file    |
+| keytest                     | Enter key diagnostic mode report keycodes, key names, and bindings      |
+
+
+** Keybindings
+
+The following tables explain the keybindings available in `fatty` in different
+contexts.  Named keys are indicated by `:name` and key categories, such as
+`<digits>` are indicated with brackets.
+
+*** Input Context
+
+When editing the input line or text input for widgets like the `prompt`,
+`fatty` provides emacs-like editing keybindings by default.  Many of these
+commands can take a count prefix argument to repeat the command count times.
+For example, `M-8 M-0 #` will insert 80 '#' characters at the cursor.
+
+| Key        | Description                                           |
+|------------+-------------------------------------------------------|
+| C-a        | move to the beginning of the line                     |
+| :home      | move to the beginning of the line                     |
+| C-e        | move to the end of the line                           |
+| :end       | move to the end of the line                           |
+| C-f        | move cursor right one character                       |
+| :right     | move cursor right one character                       |
+| C-b        | move cursor left one character                        |
+| :left      | move cursor left one character                        |
+| M-f        | move cursor right one word                            |
+| M-:right   | move cursor right one word                            |
+| C-:right   | move cursor right one word                            |
+| M-b        | move cursor left one word                             |
+| M-:left    | move cursor left one word                             |
+| C-:left    | move cursor left one word                             |
+| C-t        | transpose characters                                  |
+| M-t        | transpose words                                       |
+|            |                                                       |
+| C-d        | delete character at cursor                            |
+| :delete    | delete character at cursor                            |
+| :backspace | delete character before cursor                        |
+| M-d        | kill word at cursor                                   |
+| C-w        | kill word before cursor                               |
+| C-k        | kill to end of line                                   |
+|            |                                                       |
+| C-/        | undo                                                  |
+| C-_        | undo                                                  |
+| C-M-/      | redo                                                  |
+| M-/        | redo                                                  |
+|            |                                                       |
+| C-:space   | set the mark at the current cursor position           |
+| C-@        | set the mark at the current cursor position           |
+| C-g        | clear the mark                                        |
+| C-w        | kill the region                                       |
+| M-w        | copy the region                                       |
+|            |                                                       |
+| C-y        | yank last kill at cursor                              |
+| M-y        | replace last yank with next in kill ring              |
+|            |                                                       |
+| C-u        | universal count argument (time 4 each press)          |
+| M-<digit>  | accumulate count argument                             |
+|            |                                                       |
+| C-p        | replace the line with the prior history item          |
+| :up        | replace the line with the prior history item          |
+| C-n        | replace the line with the next history item           |
+| :down      | replace the line with the prior history item          |
+| C-r        | search the history in a popup                         |
+|            |                                                       |
+| :enter     | feed the line to the on_accept proc and page output   |
+| M-:enter   | feed the line to the on_accept proc and scroll output |
+| C-c        | quit `fatty`                                          |
+| C-d        | quit `fatty` only if the input line is empty          |
+| C-l        | clear the output pane                                 |
+|            |                                                       |
+
+
+*** Paging Context
+
+By default, `fatty` sends output to the large output pane, and if the output
+is more than one screen long presents a paging environment for viewing and
+searching the environment.
+
+| Key   | Description               |
+|-------+---------------------------|
+| :up   | move output one line up   |
+| k     | move output one line up   |
+| :down | move output one line down |
+| j     | move output one line down |
+|       |                           |
+
+
+* Alerts
+Alerts are short-lived, non-scrolling messages shown below the input line.
+They are intended for user-visible conditions that require attention.
+
+* Markdown
+** Forced line breaks
+Use ~<br>~ to force a line break.
+
+#+begin_example
+This line has a forced line break <br> and this should appear on the next line.
+#+end_example
+
+will render as
+
+#+begin_example
+This line has a forced line break
+and this should appear on the next line.
+#+end_example

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require 'gem_docs'
+GemDocs.install
+
+task default: %i[spec rubocop]

data/TODO.org

@@ -0,0 +1,163 @@
+* TODO Horizontal Scrolling
+* TODO Add modes for vi-like keybindings
+- will require changing keybindongs.yml format to include a mode qualifier
+- for advanced two-step actions, e.g. dw, will require an action-pending
+  capability
+* DONE Theming
+CLOSED: [2026-05-22 Fri 09:28]
+** Add attributes (like bold to themes)
+So, in themes, this would be possible:
+#+begin_src ruby
+  status_info: { fg: "white", bg: "navy", attrs: [:bold] }
+#+end_src
+** Develop a ruby DSL for defining themes
+** Develop more builtin themes
+* DONE Truecolor Support
+CLOSED: [2026-05-22 Fri 09:28]
+Remember this from ChatGPT:
+
+#+begin_quote
+1. Can you detect truecolor support?
+
+Yes—best practice is a combination of environment hints:
+
+def truecolor_supported?
+  ct = ENV["COLORTERM"]&.downcase
+  return true if ct&.include?("truecolor") || ct&.include?("24bit")
+
+  term = ENV["TERM"]&.downcase
+  return true if term&.include?("direct")  # e.g. xterm-direct
+
+  false
+end
+
+This catches most modern terminals:
+
+COLORTERM=truecolor (very common)
+TERM=xterm-direct (less common but explicit)
+
+You can also sanity-check:
+
+ENV["TERM_PROGRAM"] # iTerm, Apple_Terminal, etc.
+
+…but COLORTERM is the main signal.
+
+2. The real blocker: ncurses
+
+Even if truecolor is available, ncurses color pairs:
+
+Curses.init_pair(...)
+
+are limited to:
+
+256 colors (best case)
+often fewer
+
+So your current renderer cannot display truecolor, even if the terminal supports it.
+
+3. What it would take to use truecolor
+
+You’d need to bypass color pairs and emit ANSI directly:
+
+\e[38;2;R;G;Bm   # foreground
+\e[48;2;R;G;Bm   # background
+
+Example:
+
+"\e[48;2;135;206;250m"
+
+That means:
+
+no color_pair
+renderer writes ANSI sequences inline
+you manage resets (\e[0m or partial resets)
+4. Can you mix curses + truecolor?
+
+Sort of—but awkwardly:
+
+keep curses for cursor/window management
+use ANSI for colors
+don’t rely on attrset / color pairs
+
+This is doable, but:
+
+you lose some curses conveniences
+you must be careful about redraws and state
+5. Recommended path (incremental)
+
+Don’t rewrite everything yet. Do this:
+
+Step 1 — detect capability
+Fatty.truecolor? = truecolor_supported?
+Step 2 — extend color model
+
+Your Color object should carry:
+
+{ r: 135, g: 206, b: 250 }
+
+in addition to (or instead of) pair indices.
+
+Step 3 — dual rendering path (later)
+
+In renderer:
+
+if truecolor?
+  emit ANSI
+else
+  use color_pair
+end
+6. Why this is worth it
+
+Your theme system is now perfectly positioned for truecolor:
+
+you already use semantic roles
+you already parse X11 names
+you already separate rendering
+
+So switching later is contained.
+
+Bottom line
+✅ You can detect truecolor
+❌ You cannot use it with curses color pairs
+✅ Your architecture is ready to support it later
+
+#+end_quote
+
+* DONE Change to Fatty?
+CLOSED: [2026-04-30 Thu 03:39]
+and change the name of the demo to fatty for user testing.
+
+* DONE Additional UI components
+CLOSED: [2026-04-30 Thu 03:39]
+- [X] prompt :: ask the user for an arbitrary string
+- [X] notice, warn, error :: put messages in the status line
+- [X] choose_many :: present a list of choices that a user can pick many items
+  from
+- [X] menu :: user picks an action by name attached to a proc
+
+* DONE In demo, add `help` and `keytest` commands
+CLOSED: [2026-04-30 Thu 03:39]
+- help :: would explain what commands are available for the demo
+- keytest :: would echo to the output information about pressed keys, including
+  - the detected terminal type
+  - the keycode returned by the keyboard/terminal
+  - the keyname that the key is mapped to
+  - the bindings for the keyname in all contexts
+  - if no keyname, a suggested keydef entry to give it a name in the config
+  - if not bound, a suggested keybinding entry to add to config
+
+* DONE Add cut and paste
+CLOSED: [2026-04-13 Mon 07:48]
+* DONE Add history
+CLOSED: [2026-01-27 Tue 05:44]
+* DONE Add completion
+CLOSED: [2026-04-13 Mon 07:48]
+* DONE Add undo
+CLOSED: [2026-01-27 Tue 05:44]
+* DONE Scrollback Navigation (PgUp/PgDn)
+CLOSED: [2026-04-13 Mon 07:48]
+
+* DONE Add Output Search
+CLOSED: [2026-04-13 Mon 07:48]
+* CNCL SIGINT forwarding to child process
+CLOSED: [2026-05-22 Fri 09:28]