fatty 0.99.0

data/lib/fatty/colors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "colors/color"
+require_relative "colors/pairs"
+require_relative "colors/palette"

data/lib/fatty/config.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Fatty
+  module Config
+    class << self
+      attr_reader :progname
+      attr_accessor :reader
+      attr_accessor :dir
+    end
+    @progname = 'fatty'
+    @config = {}
+    @reader = nil
+    @dir = nil
+
+    # Read in the general configuration for fatty in config.yml for certain
+    # user-adjustable features of fatty.  One of these is the logging,
+    # including the location of the log file.
+    def self.config
+      @reader ||= FatConfig::Reader.new(progname, user_dir: dir)
+      @config = reader.read('config')
+    end
+
+    def self.progname=(name)
+      @progname = name || 'fatty'
+      @reader = nil
+    end
+
+    def self.user_config_path
+      @reader ||= FatConfig::Reader.new(progname, user_dir: dir)
+      reader.config_paths[:user].first || default_user_path('config')
+    end
+
+    def self.user_keydefs_path
+      @reader ||= FatConfig::Reader.new(progname)
+      reader.config_paths('keydefs')[:user].first || default_user_path('keydefs')
+    end
+
+    def self.user_keybindings_path
+      self.reader ||= FatConfig::Reader.new(progname)
+      reader.config_paths('keybindings')[:user].first || default_user_path('keybindings')
+    end
+
+    # Read in the keydefs.yml config file that maps numeric keycodes returned
+    # by curses but not assigned a key name.
+    def self.keydefs
+      FatConfig::Reader.new(progname).read('keydefs')
+    end
+
+    # Read in the keybindings.yml config file that maps key names (together
+    # with any modifiers, shift, ctrl, meta) to action names to be triggered
+    # by the key chord.
+    def self.keybindings
+      kb_cfg = FatConfig::Reader.new(progname).read("keybindings")
+      return [] unless kb_cfg.is_a?(Hash)
+
+      bindings = kb_cfg[:keybindings]
+      Array(bindings)
+    end
+
+    def self.default_user_path(name = 'config')
+      "~/.config/#{progname}/#{name}.yml"
+    end
+
+    def self.sys_themes_dir
+      File.expand_path("config_files/themes", __dir__)
+    end
+
+    def self.user_config_dir
+      dir || File.join(ENV.fetch("XDG_CONFIG_HOME", File.expand_path("~/.config")), progname)
+    end
+
+    def self.user_themes_dir
+      File.join(user_config_dir, "themes")
+    end
+
+    def self.install_default_themes!
+      FileUtils.mkdir_p(user_themes_dir)
+
+      Dir.glob(File.join(sys_themes_dir, "*.yml")).each do |src|
+        dst = File.join(user_themes_dir, File.basename(src))
+        FileUtils.cp(src, dst) unless File.exist?(dst)
+      end
+      nil
+    end
+  end
+end

data/lib/fatty/config_files/config.yml

@@ -0,0 +1,50 @@
+# What fatty considers a "word" in the input buffer
+
+# # treat dash as part of a word (good for CLI flags / kebab-case)
+# input_buffer:
+#   word_chars: "[[:alnum:]_-]"
+
+# # treat '.' as part of a word (good for fqdn / ruby constants / filenames)
+# input_buffer:
+#   word_chars: "[[:alnum:]_.:-]"
+
+input_buffer:
+  # A Ruby regexp fragment used *inside* /.../ (not including the slashes).
+  # Default if omitted: "[[:alnum:]_]"
+  word_chars: "[[:alnum:]_]"
+
+# This controls how long (in milliseconds) curses waits after receiving ESC
+# for a second key to interpret it as a meta-key sequence.  ncurses defaults
+# to 1000, i.e., a full second, which can make response to a bare ESC key feel
+# really laggy.  You can set it to something more reasonable here or by
+# setting the environment variable ESCDELAY in you shell setup.
+esc_delay: 25
+
+# file: sets the location of the log file, by default at
+# $XDG_STATE_HOME/fatty/fatty.log
+#
+# level: whether to log at the debug level or info.
+#
+# tags: when at the debug level, what categories of events to log. The special
+# tag 'all' logs all levels, and is the default when the level is debug.
+log:
+  file: "~/log/fatty.log"
+  level: debug   # debug or info
+  tags:
+    - keycode    # raw curses input / bytes / ESC buffering
+    - keyevent   # constructed KeyEvent normalization (ctrl/meta mapping)
+    - keybinding # – KeyMap#resolve hits/misses, contexts used
+    - action     # Actions.call, target selection, unknown action
+    - command    # Terminal.apply_command / :send dispatches
+    - session    # session update calls, mode/context stack changes
+    - render     # viewports, layout sizes, redraw triggers
+    - perf       # timings, frame time, slow paths
+    # - all        # All of the above
+history:
+  file: "~/.fatty_history"
+  max: 10_000
+
+# By default the theme is 'terminal'
+theme: wordperfect
+
+truecolor: auto

data/lib/fatty/config_files/help.md

@@ -0,0 +1,120 @@
+# Fatty Help
+
+## The `fatty` demo command
+
+When you run `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                                |
+
+
+## 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 |
+|       |                           |

data/lib/fatty/config_files/help.org

@@ -0,0 +1,124 @@
+* 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 |
+|       |                           |
+
+
+** fatty on the Web

data/lib/fatty/config_files/keybindings.yml

@@ -0,0 +1,49 @@
+# This file is for user-defined keybindings.  Each binding can look like this:
+#
+# - key: <KEYNAME>
+#   context: input/paging/popup (input)
+#   ctrl: true/false (false)
+#   meta: true/false (false)
+#   shift: true/false (false)
+#   action: <Fatty action> (noop)
+
+- key: left
+  meta: true
+  action: move_word_left
+
+- key: right
+  meta: true
+  action: move_word_right
+
+- key: space
+  context: paging
+  action: page_down
+
+- key: backspace
+  context: paging
+  action: page_up
+
+# Or, for mouse events:
+# - button: <BUTTONNAME>
+#   context: input/paging/popup (input)
+#   ctrl: true/false (false)
+#   meta: true/false (false)
+#   shift: true/false (false)
+#   action: <Fatty action> (noop)
+
+# Where <BUTTONNAME> is one of:
+# left_pressed,
+# left_released,
+# left_clicked,
+# left_double_clicked,
+# left_triple_clicked,
+# middle_pressed,
+# middle_released,
+# middle_clicked,
+# middle_double_clicked,
+# middle_triple_clicked,
+# right_pressed,
+# right_released,
+# right_clicked,
+# right_double_clicked,
+# right_triple_clicked

data/lib/fatty/config_files/keydefs.yml

@@ -0,0 +1,23 @@
+terminal:
+  konsole:
+    map:
+      556: ...
+
+  kitty:
+    map:
+      577: ...
+
+  tmux:
+    map:
+      555:
+        key: left
+        meta: true
+      570:
+        key: right
+        meta: true
+      557:
+        key: left
+        ctrl: true
+      572:
+        key: right
+        ctrl: true

data/lib/fatty/config_files/themes/mono.yml

@@ -0,0 +1,76 @@
+name: mono
+inherit: null
+
+output:
+  fg: black
+  bg: white
+
+input:
+   fg: white
+   bg: black
+
+input_suggestion:
+  fg: gray
+  bg: white
+
+cursor:
+  fg: black
+  bg: white
+
+region:
+  fg: black
+  bg: white
+
+match_current:
+  fg: black
+  bg: yellow
+
+match_other:
+  fg: black
+  bg: lightgray
+
+search:
+  fg: black
+  bg: cyan
+
+pager_status:
+  fg: black
+  bg: white
+
+good:
+  fg: "green"
+  bg: "white"
+
+info:
+  fg: black
+  bg: white
+
+warn:
+  fg: default
+  bg: default
+
+error:
+  fg: default
+  bg: default
+
+popup:
+  fg: black
+  bg: white
+
+popup_selection:
+  fg: white
+  bg: black
+
+popup_input:
+  fg: white
+  bg: black
+
+popup_counts:
+  fg: white
+  bg: gray
+
+popup_frame:
+  fg: black
+  bg: white
+  corners: square
+  border: ascii

data/lib/fatty/config_files/themes/nordic.yml

@@ -0,0 +1,77 @@
+name: nordic
+inherit: null
+
+output:
+  fg: "#d8dee9"
+  bg: "#2e3440"
+
+input:
+  fg: "#eceff4"
+  bg: "#3b4252"
+  attrs: [bold]
+
+input_suggestion:
+  fg: "#81a1c1"
+  bg: "#3b4252"
+
+cursor:
+  fg: "#2e3440"
+  bg: "#88c0d0"
+
+region:
+  fg: "#2e3440"
+  bg: "#88c0d0"
+
+good:
+  fg: "green"
+  bg: "#2e3440"
+
+info:
+  fg: "#d8dee9"
+  bg: "#2e3440"
+
+warn:
+  fg: "#2e3440"
+  bg: "#ebcb8b"
+
+error:
+  fg: "#eceff4"
+  bg: "#bf616a"
+
+pager_status:
+  fg: "black"
+  bg: "lightgreen"
+
+search_input:
+  fg: "black"
+  bg: "cyan"
+
+match_current:
+  fg: "black"
+  bg: "yellow"
+
+match_other:
+  fg: "black"
+  bg: "lightgray"
+
+popup:
+  fg: "#d8dee9"
+  bg: "#3b4252"
+
+popup_input:
+  fg: "#eceff4"
+  bg: "#434c5e"
+
+popup_counts:
+  fg: "#2e3440"
+  bg: "white"
+
+popup_selection:
+  fg: "#2e3440"
+  bg: "#88c0d0"
+
+popup_frame:
+  fg: "#81a1c1"
+  bg: "#3b4252"
+  border: single
+  corners: rounded

data/lib/fatty/config_files/themes/solarized_dark.yml

@@ -0,0 +1,77 @@
+name: solarized_dark
+inherit: null
+
+output:
+  fg: "#839496"
+  bg: "#002b36"
+
+input:
+  fg: "#93a1a1"
+  bg: "#073642"
+  attrs: [bold]
+
+input_suggestion:
+  fg: "#657b83"
+  bg: "#073642"
+
+cursor:
+  fg: "#002b36"
+  bg: "#b58900"
+
+region:
+  fg: "#002b36"
+  bg: "#b58900"
+
+good:
+  fg: "green"
+  bg: "#002b36"
+
+info:
+  fg: "#839496"
+  bg: "#002b36"
+
+warn:
+  fg: "#002b36"
+  bg: "#cb4b16"
+
+error:
+  fg: "#fdf6e3"
+  bg: "red"
+
+pager_status:
+  fg: "black"
+  bg: "lightgreen"
+
+search_input:
+  fg: "black"
+  bg: "cyan"
+
+match_current:
+  fg: "black"
+  bg: "yellow"
+
+match_other:
+  fg: "black"
+  bg: "lightgray"
+
+popup:
+  fg: "#839496"
+  bg: "#073642"
+
+popup_input:
+  fg: "#93a1a1"
+  bg: "#002b36"
+
+popup_counts:
+  fg: "#002b36"
+  bg: "white"
+
+popup_selection:
+  fg: "#002b36"
+  bg: "#b58900"
+
+popup_frame:
+  fg: "#268bd2"
+  bg: "#073642"
+  border: single
+  corners: rounded