fatty 0.99.0

data/examples/markdown/ox-gfm-markdown.org

@@ -0,0 +1,376 @@
+#+TITLE: Markdown Demonstration
+#+OPTIONS: toc:0
+
+* H1 heading should be red on yellow and bold
+
+** H2 heading should be black on pink and bold
+
+*** H3 heading should be magenta on lightyellow and underlined
+
+This paragraph has *strong text*, /emphasized text/, ~inline code~,
+==highlighted text==, and [fatty on github](https://github.com/ddoherty03/fatty).
+
+Autolink: https://github.com/ddoherty03/fat_config
+
+#+begin_quote
+This block quote should have a red quote gutter.
+The quoted text itself can stay normal output for now.
+#+end_quote
+
+#+begin_src ruby
+# This ruby block. Has comments.
+# Two lines, in fact.
+def hello(name)
+  puts "hello #{name}"
+end
+#+end_src
+
+| Feature      | Expected style      |
+|--------------+---------------------|
+| Header cells | black on lightgreen |
+| Body cells   | normal output       |
+
+* Carnival of Constructs
+These are samples of the kinds of constructs the ANSI renderer for =fatty= are
+capable of.
+
+** Unordered Lists
+
+- builtin commands are handled by the =fatty= demo, Four score and seven years
+  ago our fathers brought forth on this continent, a new nation, conceived in
+  Liberty, and dedicated to the proposition that all men are created equal.
+- other commands are handled by =/bin/sh=
+- keybindings are listed below
+
+** Ordered Lists
+
+1. builtin commands are handled by the =fatty= demo, Four score and seven years
+   ago our fathers brought forth on this continent, a new nation, conceived in
+   Liberty, and dedicated to the proposition that all men are created equal.
+2. other commands are handled by =/bin/sh=
+3. keybindings are listed below
+
+Some regular text to break things up.
+
+1. Parent ordered item
+   1. Child ordered item
+   2. Another child ordered item
+2. Back to parent ordered item
+
+** Description Lists
+
+- bold :: *this text is bold*
+- italic :: /this text is italic/
+- code :: ~this text is code~
+- verbatim :: =this text is verbatim=
+- strike :: +this text is strike-through+
+- underline :: _this text is underlined_
+
+** A Code Block
+#+begin_src ruby
+    def wrap(text, first_prefix: "", rest_prefix: first_prefix)
+      width = [@width.to_i, 20].max
+
+      words = text.to_s.split(/\s+/)
+      lines = []
+      line = +""
+
+      words.each do |word|
+        prefix = lines.empty? ? first_prefix : rest_prefix
+        available = width - Fatty::Ansi.visible_length(prefix)
+        available = 20 if available < 20
+
+        candidate = line.empty? ? word : "#{line} #{word}"
+
+        if Fatty::Ansi.visible_length(candidate) > available && !line.empty?
+          lines << "#{prefix}#{line}"
+          line = word.dup
+        else
+          line = candidate
+        end
+      end
+
+      unless line.empty?
+        prefix = lines.empty? ? first_prefix : rest_prefix
+        lines << "#{prefix}#{line}"
+      end
+
+      lines.join("\n")
+    end
+#+end_src
+
+** Nested lists
+
+- Parent item
+  + Child item
+  + Another child
+- Back to parent
+
+** Links
+
+[Fatty on GitHub](https://github.com/ddoherty03/fatty)
+
+** Block quotes
+
+#+begin_quote
+Four score and seven years ago our fathers brought forth on this continent,
+a new nation, conceived in Liberty, and dedicated to the proposition that
+all men are created equal.
+
+Now we are engaged in a great civil war, testing whether that nation, or any
+nation so conceived and so dedicated, can long endure.  We are met on a
+great battle-field of that war.  We have come to dedicate a portion of that
+field, as a final resting place for those who here gave their lives that
+that nation might live.  It is altogether fitting and proper that we should
+do this.
+
+But, in a larger sense, we can not dedicate---we can not consecrate---we can
+not hallow---this ground.  The brave men, living and dead, who struggled
+here, have consecrated it, far above our poor power to add or detract.  The
+world will little note, nor long remember what we say here, but it can never
+forget what they did here.  It is for us the living, rather, to be dedicated
+here to the unfinished work which they who fought here have thus far so
+nobly advanced.  It is rather for us to be here dedicated to the great task
+remaining before us---that from these honored dead we take increased
+devotion to that cause for which they gave the last full measure of
+devotion---that we here highly resolve that these dead shall not have died
+in vain---that this nation, under God, shall have a new birth of
+freedom---and that government of the people, by the people, for the people,
+shall not perish from the earth.
+#+end_quote
+
+** Tables with styled cells
+
+| Feature | Example       |
+|---------+---------------|
+| bold    | *bold cell*   |
+| code    | ~code cell~   |
+| strike  | +strike cell+ |
+
+** Horizontal Rule
+This should be a horizontal rule, but YMMV.
+
+-----
+
+** Forced Line Break
+
+This line has a forced line break<br>
+and this should appear on the next line.
+
+** Fenced code with various languages
+
+Here is the Fibonacci number computed recursively in various languages.
+
+*** Ruby
+
+#+begin_src ruby
+def fib(n)
+  return n if n < 2
+
+  fib(n - 1) + fib(n - 2)
+end
+puts fib(10)
+#+end_src
+
+*** Python
+
+#+begin_src python
+def fib(n):
+    if n < 2:
+        return n
+
+    return fib(n - 1) + fib(n - 2)
+
+print(fib(10))
+
+#+end_src
+
+*** C
+
+#+begin_src c
+#include <stdio.h>
+
+int fib(int n)
+{
+  if (n < 2) {
+    return n;
+  }
+
+  return fib(n - 1) + fib(n - 2);
+}
+
+int main(void)
+{
+  printf("%d\n", fib(10));
+  return 0;
+}
+#+end_src
+
+*** C++
+
+#+begin_src cpp
+#include <iostream>
+
+int fib(int n)
+{
+  if (n < 2) {
+    return n;
+  }
+
+  return fib(n - 1) + fib(n - 2);
+}
+
+int main()
+{
+  std::cout << fib(10) << std::endl;
+}
+#+end_src
+
+*** Go
+
+#+begin_src go
+package main
+
+import "fmt"
+
+func fib(n int) int {
+	if n < 2 {
+		return n
+	}
+
+	return fib(n-1) + fib(n-2)
+}
+
+func main() {
+	fmt.Println(fib(10))
+}
+#+end_src
+
+*** Rust
+
+#+begin_src rust
+fn fib(n: u32) -> u32 {
+    if n < 2 {
+        n
+    } else {
+        fib(n - 1) + fib(n - 2)
+    }
+}
+
+fn main() {
+    println!("{}", fib(10));
+}
+#+end_src
+
+*** PHP
+
+#+begin_src php
+<?php
+
+function fib($n)
+{
+    if ($n < 2) {
+        return $n;
+    }
+
+    return fib($n - 1) + fib($n - 2);
+}
+
+echo fib(10) . PHP_EOL;
+#+end_src
+
+*** JavaScript
+
+#+begin_src javascript
+function fib(n) {
+  if (n < 2) {
+    return n;
+  }
+
+  return fib(n - 1) + fib(n - 2);
+}
+
+console.log(fib(10));
+#+end_src
+
+*** TypeScript
+
+#+begin_src typescript
+function fib(n: number): number {
+  if (n < 2) {
+    return n;
+  }
+
+  return fib(n - 1) + fib(n - 2);
+}
+
+console.log(fib(10));
+#+end_src
+
+*** Java
+
+#+begin_src java
+public class Fib {
+  static int fib(int n) {
+    if (n < 2) {
+      return n;
+    }
+
+    return fib(n - 1) + fib(n - 2);
+  }
+
+  public static void main(String[] args) {
+    System.out.println(fib(10));
+  }
+}
+#+end_src
+
+*** Shell
+
+#+begin_src bash
+fib() {
+  if [ "$1" -lt 2 ]; then
+    echo "$1"
+  else
+    a=$(fib $(($1 - 1)))
+    b=$(fib $(($1 - 2)))
+    echo $((a + b))
+  fi
+}
+
+fib 10
+#+end_src
+
+*** Haskell
+
+#+begin_src haskell
+fib :: Int -> Int
+fib n
+  | n < 2     = n
+  | otherwise = fib (n - 1) + fib (n - 2)
+
+main :: IO ()
+main = print (fib 10)
+#+end_src
+
+*** SQL (Recursive CTE)
+
+#+begin_src sql
+WITH RECURSIVE fib(n, a, b) AS (
+  SELECT 0, 0, 1
+  UNION ALL
+  SELECT n + 1, b, a + b
+  FROM fib
+  WHERE n < 10
+)
+SELECT a
+FROM fib
+ORDER BY n DESC
+LIMIT 1;
+#+end_src
+
+*** Nonsense Language
+
+#+begin_src madeuplang
+this should still render as plain text
+#+end_src

data/exe/fatty

@@ -0,0 +1,275 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/fatty"
+require "open3"
+require "shellwords"
+
+require "rainbow/refinement"
+using Rainbow
+
+prompt = Fatty::Prompt.new { "#{Dir.pwd}> " }
+history_ctx_proc = -> { { pwd: Dir.pwd } }
+
+on_accept_proc = lambda do |line, env|
+  session = env.session
+  terminal = env.terminal
+
+  cmd, *args = Shellwords.split(line)
+
+  case cmd
+  when "cd"
+    dir = args.first || ENV["HOME"]
+    dir = File.expand_path(dir)
+    Dir.chdir(dir)
+  when "choose"
+    choices =
+      if args.empty?
+        ["Choice A", "Choice B", "Choice C"]
+      else
+        args
+      end
+
+    choice = terminal.choose(
+      "Select one",
+      choices: choices,
+      initial_choice_idx: 0,
+      quit_value: nil,
+    )
+
+    if choice.nil?
+      session.append_output("choose: cancelled\n")
+    else
+      session.append_output("choose: selected #{choice.inspect}\n")
+    end
+  when "choosevals"
+    pairs =
+      if args.empty?
+        [["Choice A", 55], ["Choice B", 3.14159], ["Choice C", :done]]
+      elsif args.length.odd?
+        session.append_output("choosevals: needs even number of args\n")
+        next
+      else
+        args.each_slice(2).map { |label, value| [label, value] }
+      end
+
+    choice = terminal.choose(
+      "Select one",
+      choices: pairs,
+      initial_choice_idx: 1,
+      quit_value: nil,
+    )
+
+    if choice.nil?
+      session.append_output("choosevals: cancelled\n")
+    else
+      session.append_output("choosevals: selected #{choice.inspect}\n")
+    end
+  when "choose_multi"
+    choices =
+      if args.empty?
+        ["Choice A", "Choice B", "Choice C"]
+      else
+        args
+      end
+
+    choices = terminal.choose_multi(
+      "Select one or more",
+      choices: choices,
+      quit_value: nil,
+    )
+
+    if choices.nil?
+      session.append_output("choose_multi: cancelled\n")
+    else
+      session.append_output("choose_multi: selected #{choices.inspect}\n")
+    end
+  when "choosevals_multi"
+    pairs =
+      if args.empty?
+        pairs = [["Choice A", 55], ["Choice B", 3.14159], ["Choice C", :done]]
+      elsif args.length.odd?
+        session.append_output("choosevals_multi: needs even number of args\n")
+        next
+      else
+        pairs = args.each_slice(2).map { |label, value| [label, value] }
+      end
+
+    choices = terminal.choose_multi(
+      "Select one or more",
+      choices: pairs,
+      quit_value: nil,
+    )
+
+    if choices.nil?
+      session.append_output("choosevals_multi: cancelled\n")
+    else
+      session.append_output("choosevals_multi: selected #{choices.inspect}\n")
+    end
+  when "menu"
+    result = terminal.menu(
+      "Demo menu",
+      choices: {
+        "Write to output pane" => proc { |env|
+      env.output("menu: wrote this from MenuEnv#output\n")
+      :output_written
+    },
+
+        "Show status message" => proc { |env|
+      env.status("menu: status set from MenuEnv#status")
+      :status_written
+    },
+
+        "Return plain value" => :plain_value,
+      },
+      initial_choice_idx: 0,
+      quit_value: nil,
+    )
+    if result.nil?
+      session.append_output("menu: cancelled\n")
+    else
+      session.append_output("menu: result #{result.inspect}\n")
+    end
+  when "info"
+    message = args.empty? ? "Information message" : args.join(" ")
+    message = message.gsub(/ ?~~ ?/, "\n")
+    terminal.info(message)
+    session.append_output("info: #{message}\n")
+  when "good"
+    message = args.empty? ? "Success message" : args.join(" ")
+    message = message.gsub(/ ?~~ ?/, "\n")
+    terminal.good(message)
+    session.append_output("good: #{message}\n")
+  when "warn"
+    message = args.empty? ? "Danger Will Robinson!" : args.join(" ")
+    message = message.gsub(/ ?~~ ?/, "\n")
+    terminal.warn(message)
+    session.append_output("warn: #{message}\n")
+  when "oops"
+    message = args.empty? ? "Something went wrong" : args.join(" ")
+    message = message.gsub(/ ?~~ ?/, "\n")
+    terminal.oops(message)
+    session.append_output("oops: #{message}\n")
+  when "prompt"
+    question = args.empty? ? "Enter value:" : args.join(" ")
+    value = terminal.prompt(question, initial: "demo")
+    session.append_output("prompt: #{value.inspect}\n")
+  when "progress"
+    styles = %w[count percent simple_percent trail bar unicode_bar braille_bar spinner]
+    style_name = args.first
+    style =
+      if style_name && styles.include?(style_name)
+        args.shift.to_sym
+      else
+        :trail
+      end
+
+    total =
+      begin
+        args.first ? Integer(args.first) : nil
+      rescue StandardError
+        nil
+      end
+
+    if style != :spinner
+      total ||= 40
+      total = 1 if total < 1
+    elsif total && total < 1
+      total = 1
+    end
+
+    prog = env.progress(
+      label: "Demo progress",
+      total: total,
+      style: style,
+    )
+
+    if style == :spinner && total.nil?
+      40.times do
+        prog.update(render: true)
+        sleep 0.1
+      end
+
+      prog.finish("Demo progress complete.", render: true)
+      session.append_output("progress: style=#{style} completed indeterminate demo\n")
+    else
+      total.times do |i|
+        indicator =
+          case i % 4
+          when 0 then "+".fatty_good
+          when 1 then "-".fatty_error
+          when 2 then "^".fatty_warn
+          else "."
+          end
+
+        prog.update(current: i + 1, indicator: indicator, render: true)
+        sleep 0.1
+      end
+      prog.finish("Demo progress complete.".green, render: true)
+      session.append_output("progress: style=#{style} completed #{total} steps\n")
+    end
+  when "keytest"
+    return [[:terminal, :push_modal, Fatty::KeyTestSession.new(owner: session)], [:send, :alert, :clear, {}]]
+  when 'markdown'
+    file = args.first || File.expand_path("../examples/markdown/native-markdown.md", __dir__)
+    text = File.read(File.expand_path(file))
+    env.markdown(text)
+  when 'markdown_org'
+    file = File.expand_path("../examples/markdown/ox-gfm-markdown.md", __dir__)
+    text = File.read(File.expand_path(file))
+    env.markdown(text)
+  when 'help'
+    env.markdown(Fatty::Help.text)
+  else
+    out, _ = Open3.capture2e(line)
+    session.append_output(out)
+  end
+  [[:send, :alert, :clear, {}]]
+rescue Errno::ENOENT
+  [[:send, :alert, :show, { level: :error, message: "Command not found (#{line})" }]]
+rescue SystemCallError => ex
+  [[:send, :alert, :show, { level: :error, message: ex.message }]]
+end
+
+cutes = []
+ENV['PATH'].split(':').each do |dir|
+  next unless Dir.exist?(dir)
+
+  Dir.children(dir).each do |name|
+    next if name.match?(/\A\./)
+
+    path = File.join(dir, name)
+    cutes << name if File.file?(path) && File.executable?(path)
+  end
+end
+cutes = cutes.compact.sort_by(&:downcase).uniq
+
+builtins = %w[
+  cd
+  choose
+  choosevals
+  choose_multi
+  choosevals_multi
+  help
+  info
+  good
+  keytest
+  markdown
+  markdown_org
+  menu
+  oops
+  progress
+  prompt
+  warn
+]
+commands = (builtins + cutes).uniq
+completion_proc = lambda do |_buffer|
+  commands.to_a
+end
+
+Fatty::Terminal.new(
+  prompt: prompt,
+  history_ctx: history_ctx_proc,
+  on_accept: on_accept_proc,
+  completion_proc: completion_proc,
+).go

data/fatty.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/fatty/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fatty"
+  spec.version = Fatty::VERSION
+  spec.authors = ["Daniel E. Doherty"]
+  spec.email = ["ded@ddoherty.net"]
+
+  spec.summary     = "Stateful terminal UI with editable input and scrollback"
+  spec.description = <<~DESC
+    fatty is a pure Ruby curses-backed terminal interaction library with editable single-line input, scrollable output, and
+    programmable keybindings, inspired by modern shells like fish.
+  DESC
+  spec.homepage = "https://github.com/ddoherty03/fatty"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ddoherty03/fatty"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      f.start_with?(*%w[bin/ Gemfile .gitignore .rspec spec/ .github/ .rubocop.yml])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "curses", "~> 1.4"
+  spec.add_dependency "fat_config", ">=0.8.0"
+  spec.add_dependency "unicode-display_width", "~> 2.5"
+  spec.add_dependency "yaml"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "redcarpet"
+  spec.add_dependency "rouge"
+end

data/lib/fatty/accept_env.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# This class provides a wrapper around components that can be handed off to
+# Terminal's on_accept method for access to the terminal, the session, and a
+# Progress widget.
+module Fatty
+  class AcceptEnv
+    attr_reader :session
+
+    def initialize(session:)
+      @session = session
+      @progress = nil
+    end
+
+    def terminal
+      session.terminal
+    end
+
+    def progress(**opts)
+      @progress ||= Fatty::Terminal::Progress.new(terminal: terminal, **opts)
+    end
+
+    def markdown(text)
+      md = Fatty::Markdown.render(
+        text,
+        width: terminal.screen.cols,
+        palette: terminal.renderer.palette,
+      )
+      session.append_output(md)
+    end
+  end
+end