fatty 0.99.0 → 0.99.3

data/lib/fatty/colors/pairs.rb

@@ -29,6 +29,7 @@ module Fatty
       SEARCH_HIGHLIGHT = 21
       SEARCH_HIGHLIGHT_SECONDARY = 22
       PAGER_STATUS = 23
+      LINE_NUMBER = 24
 
       POPUP           = 30
       POPUP_SELECTION = 31
@@ -61,6 +62,7 @@ module Fatty
         search_input: SEARCH,
 
         pager_status: PAGER_STATUS,
+        line_number: LINE_NUMBER,
 
         popup: POPUP,
         popup_selection: POPUP_SELECTION,

data/lib/fatty/command.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Fatty
+  class Command
+    attr_reader :target, :action, :payload
+
+    def initialize(target:, action:, payload: {})
+      @target = target.to_sym
+      @action = action.to_sym
+      @payload = payload || {}
+    end
+
+    def inspect
+      "Command: @target=#{@target}, @action=#{@action} @payload keys=#{@payload.keys}"
+    end
+
+    def self.terminal(action, **payload)
+      new(target: :terminal, action: action, payload: payload)
+    end
+
+    def self.session(id, action, **payload)
+      new(target: id, action: action, payload: payload)
+    end
+
+    def self.coerce(value)
+      case value
+      when Command
+        value
+      when Array
+        coerce_array(value)
+      else
+        raise ArgumentError, "expected command, got #{value.inspect}"
+      end
+    end
+
+    def self.normalize_list(value)
+      result =
+        case value
+        when nil
+          []
+        when Command
+          [value]
+        when Array
+          value.grep(Command)
+        else
+          []
+        end
+
+      result
+    end
+
+    def terminal?
+      target == :terminal
+    end
+
+    def session?
+      !terminal?
+    end
+
+    def id
+      target unless terminal?
+    end
+
+    def self.coerce_array(value)
+      domain, name, *rest = value
+      case domain
+      when :terminal
+        new(target: :terminal, action: name, payload: { args: rest })
+      when :send
+        id, action_name, payload = name, *rest
+        new(target: id, action: action_name, payload: payload || {})
+      else
+        raise ArgumentError, "unknown command domain #{domain.inspect}"
+      end
+    end
+    private_class_method :coerce_array
+  end
+end

data/lib/fatty/config.rb

@@ -1,86 +1,274 @@
 # frozen_string_literal: true
 
+using Fatty::CoreExt::Hash
+
 module Fatty
   module Config
     class << self
-      attr_reader :progname
+      attr_reader :progname, :app_name, :app_config_dir
       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.
+    # Read in the general configuration for fatty for certain user-adjustable
+    # features of fatty in the per-user config.yml with the per-app config.yml
+    # merged.  One of the config value sets up logging, including the location
+    # of the log file.
     def self.config
-      @reader ||= FatConfig::Reader.new(progname, user_dir: dir)
-      @config = reader.read('config')
+      @config = read_layered("config")
+    end
+
+    # Read in the keydefs.yml config file that maps numeric keycodes returned
+    # by curses but not assigned a key name.  This merges in the per-app
+    # keydefs.yml as well.
+    def self.keydefs
+      read_layered("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. This merges in the per-app keybindings.yml as well.
+    def self.keybindings
+      base = Array(global_reader.read("keybindings")[:keybindings])
+      overlay = Array(read_app("keybindings"))
+      base + overlay
     end
 
+    def self.install_defaults!
+      FileUtils.mkdir_p(user_config_dir)
+
+      Dir.glob(File.join(dist_config_dir, "*")).each do |src|
+        next unless File.file?(src)
+
+        dst = File.join(user_config_dir, File.basename(src))
+        Fatty.info("Copying config file #{src} to #{dst}", tag: :config)
+        FileUtils.cp(src, dst) unless File.exist?(dst)
+      end
+
+      install_default_themes!
+      nil
+    end
+
+    def self.install_default_themes!
+      FileUtils.mkdir_p(user_themes_dir)
+
+      Dir.glob(File.join(dist_themes_dir, "*.yml")).each do |src|
+        dst = File.join(user_themes_dir, File.basename(src))
+        unless File.exist?(dst)
+          Fatty.info("Copying theme file #{src} to #{dst}", tag: :theme)
+          FileUtils.cp(src, dst)
+        end
+      end
+      nil
+    end
+
+    ###########################################################################
+    # Accessors
+    ###########################################################################
+
+    # The name used for 'fatty' in forming directories such as
+    # ~/.config/<progname>
     def self.progname=(name)
       @progname = name || 'fatty'
-      @reader = nil
+      reset_reader!
+    end
+
+    # The directory for user's fatty configuration, by default ~/.config/fatty
+    def self.dir
+      @dir
+    end
+
+    # And its setter
+    def self.dir=(path)
+      @dir = path
+      reset_reader!
+    end
+
+    # Invoke both app-specific setters.
+    def self.configure_app(app_name: nil, app_config_dir: nil)
+      self.app_name = app_name
+      self.app_config_dir = app_config_dir
+      nil
+    end
+
+    # The name used by the consuming application to add app-specific
+    # configuration.  If you use fatty for 10 different REPL-like apps, they
+    # can each have independent configuration on top of fatty's global the
+    # user configuration.
+    def self.app_name=(name)
+      @app_name = normalize_app_name(name)
+      reset_reader!
     end
 
+    # By default, the per-app configuration lives in
+    # ~/.config/fatty/apps/<app_name>/ but the consuming app may want fatty's
+    # config to live in its own config directory.  This allows the per-app
+    # config directory to be placed elsewhere.
+    def self.app_config_dir=(path)
+      @app_config_dir = path && File.expand_path(path)
+      reset_reader!
+    end
+
+    # The per-user config pathname, normally ~/.config/fatty/config.yml
     def self.user_config_path
-      @reader ||= FatConfig::Reader.new(progname, user_dir: dir)
+      @reader ||= FatConfig::Reader.new(progname, user_dir: user_config_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')
+    # The per-user config directory, which falls back to XDG conventions if
+    # dir is not set.
+    def self.user_config_dir
+      dir || File.join(
+        ENV.fetch("XDG_CONFIG_HOME", File.expand_path("~/.config")),
+        progname,
+      )
     end
 
-    def self.user_keybindings_path
-      self.reader ||= FatConfig::Reader.new(progname)
-      reader.config_paths('keybindings')[:user].first || default_user_path('keybindings')
+    # The per-user themes directory, installed below the config directory.
+    def self.user_themes_dir
+      File.join(user_config_dir, "themes")
     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')
+    # The per-app config directory, either under ~/.config/fatty/apps/<app_name> (by
+    # default) or the directory the library consumer sets in app_config_dir.
+    def self.app_user_config_dir
+      if app_config_dir
+        app_config_dir
+      elsif app_name
+        File.join(user_config_dir, "apps", app_name)
+      end
     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)
+    def self.app_config_path(name = "config")
+      return unless app_user_config_dir
+
+      File.join(app_user_config_dir, "#{name}.yml")
+    end
+
+    # The per-app themes directory, either under
+    # ~/.config/fatty/apps/<app_name>/themes (by default) or under the themes
+    # directory in the config directory the library consumer sets in
+    # app_config_dir.
+    def self.app_themes_dir
+      return unless app_user_config_dir
+
+      File.join(app_user_config_dir, "themes")
+    end
+
+    # The per-user keydefs path name, normally ~/.config/fatty/keydefs.yml
+    def self.user_keydefs_path
+      @reader ||= FatConfig::Reader.new(progname, user_dir: user_config_dir)
+      reader.config_paths("keydefs")[:user].first || default_user_path("keydefs")
+    end
 
-      bindings = kb_cfg[:keybindings]
-      Array(bindings)
+    # The per-user keybindings path name, normally ~/.config/fatty/keybindings.yml
+    def self.user_keybindings_path
+      self.reader ||= FatConfig::Reader.new(progname, user_dir: user_config_dir)
+      reader.config_paths("keybindings")[:user].first || default_user_path("keybindings")
     end
 
+    # The default per-user config pathname for any of the config files, normally
+    # ~/.config/fatty/config.yml, ~/.config/fatty/keydefs.yml, etc.
     def self.default_user_path(name = 'config')
       "~/.config/#{progname}/#{name}.yml"
     end
 
-    def self.sys_themes_dir
-      File.expand_path("config_files/themes", __dir__)
+    # The directory where the fatty gem stores the distributed sample config
+    # and theme files.
+    def self.dist_config_dir
+      File.expand_path("config_files", __dir__)
     end
 
-    def self.user_config_dir
-      dir || File.join(ENV.fetch("XDG_CONFIG_HOME", File.expand_path("~/.config")), progname)
+    # The directory where the fatty gem stores the distributed distributed theme
+    # files.
+    def self.dist_themes_dir
+      File.join(dist_config_dir, "themes")
     end
 
-    def self.user_themes_dir
-      File.join(user_config_dir, "themes")
+    ###########################################################################
+    # Helpers
+    ###########################################################################
+
+    def self.reset_reader!
+      @reader = nil
+      @config = {}
     end
 
-    def self.install_default_themes!
-      FileUtils.mkdir_p(user_themes_dir)
+    def self.global_reader
+      @reader ||= FatConfig::Reader.new(progname, user_dir: user_config_dir)
+    end
 
-      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)
+    def self.reader_for_dir(path)
+      FatConfig::Reader.new(progname, user_dir: path)
+    end
+
+    def self.read_layered(name)
+      base = global_reader.read(name)
+      overlay = read_app(name)
+      merge_config(base, overlay)
+    end
+
+    def self.read_app(name)
+      path = app_config_path(name)
+      return {} unless path
+      return {} unless File.exist?(path)
+
+      YAML.load_file(path, symbolize_names: true) || {}
+    end
+
+    def self.merge_config(base, overlay)
+      return normalize_config_value(overlay) if blank_config?(base)
+      return normalize_config_value(base) if blank_config?(overlay)
+
+      if base.is_a?(Hash) && overlay.is_a?(Hash)
+        base.deep_merge(overlay)
+      elsif base.is_a?(Array) && overlay.is_a?(Array)
+        base + overlay
+      else
+        overlay
       end
-      nil
     end
+
+    def self.merge_keybindings(base, overlay)
+      return normalize_config_value(overlay) if blank_config?(base)
+      return normalize_config_value(base) if blank_config?(overlay)
+
+      if base.is_a?(Hash) && overlay.is_a?(Hash)
+        merged = base.deep_merge(overlay)
+        merged[:keybindings] =
+          Array(base[:keybindings]) + Array(overlay[:keybindings])
+        merged
+      elsif base.is_a?(Array) && overlay.is_a?(Array)
+        base + overlay
+      else
+        overlay
+      end
+    end
+
+    def self.blank_config?(value)
+      value.nil? || value == {} || value == []
+    end
+
+    def self.normalize_config_value(value)
+      value || {}
+    end
+
+    def self.normalize_app_name(name)
+      text = name.to_s.strip
+      text.empty? ? nil : text
+    end
+
+    private_class_method :reset_reader!
+    private_class_method :global_reader
+    private_class_method :reader_for_dir
+    private_class_method :read_layered
+    private_class_method :read_app
+    private_class_method :merge_config
+    private_class_method :blank_config?
+    private_class_method :normalize_config_value
+    private_class_method :normalize_app_name
   end
 end

data/lib/fatty/config_files/config.yml

@@ -1,24 +1,16 @@
 # 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:]_-]"
+# A Ruby regexp fragment used *inside* /.../ (not including the slashes).
+# Default if omitted: "[[:alnum:]_]"
+word_char_re: "[[: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
+esc_delay: 0
 
 # file: sets the location of the log file, by default at
 # $XDG_STATE_HOME/fatty/fatty.log

data/lib/fatty/config_files/keydefs.yml

@@ -1,23 +1,13 @@
-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
+tmux:
+  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/capuchin_monk.yml

@@ -0,0 +1,140 @@
+name: capuchin_monk
+inherit: null
+markdown_code_theme: gruvbox_dark
+
+output:
+  fg: "#e8d8b8"
+  bg: "#24160f"
+
+input:
+  fg: "#f5e6c8"
+  bg: "#3a261a"
+  attrs: [bold]
+
+input_suggestion:
+  fg: "#9d8063"
+  bg: "#3a261a"
+  attrs: [dim]
+
+cursor:
+  fg: "#24160f"
+  bg: "#d8a657"
+
+region:
+  fg: "#24160f"
+  bg: "#c98a4a"
+
+good:
+  fg: "#a9b665"
+  bg: "#24160f"
+
+info:
+  fg: "#e8d8b8"
+  bg: "#24160f"
+
+warn:
+  fg: "#24160f"
+  bg: "#d8a657"
+
+error:
+  fg: "#f5e6c8"
+  bg: "#9d3f35"
+
+pager_status:
+  fg: "#24160f"
+  bg: "#a9b665"
+
+search_input:
+  fg: "#24160f"
+  bg: "#d8a657"
+
+match_current:
+  fg: "#24160f"
+  bg: "#d8a657"
+
+match_other:
+  fg: "#24160f"
+  bg: "#b07a4f"
+
+popup:
+  fg: "#e8d8b8"
+  bg: "#3a261a"
+
+popup_input:
+  fg: "#f5e6c8"
+  bg: "#1b100b"
+
+popup_counts:
+  fg: "#24160f"
+  bg: "#e8d8b8"
+
+popup_selection:
+  fg: "#24160f"
+  bg: "#d8a657"
+
+popup_frame:
+  fg: "#c98a4a"
+  bg: "#3a261a"
+  border: single
+  corners: rounded
+
+markdown_h1:
+  fg: "#d8a657"
+  bg: "#24160f"
+  attrs: [bold]
+
+markdown_h2:
+  fg: "#c98a4a"
+  bg: "#24160f"
+  attrs: [bold]
+
+markdown_h3:
+  fg: "#a9b665"
+  bg: "#24160f"
+  attrs: [bold]
+
+markdown_code:
+  fg: "#a9b665"
+  bg: "#3a261a"
+
+markdown_code_gutter:
+  fg: "#9d8063"
+  bg: "#3a261a"
+  attrs: [dim]
+
+markdown_strong:
+  fg: "#f5e6c8"
+  bg: "#24160f"
+  attrs: [bold]
+
+markdown_emphasis:
+  fg: "#e8d8b8"
+  bg: "#24160f"
+  attrs: [italic]
+
+markdown_link:
+  fg: "#d8a657"
+  bg: "#24160f"
+  attrs: [underline]
+
+markdown_url:
+  fg: "#c98a4a"
+  bg: "#24160f"
+
+markdown_quote_gutter:
+  fg: "#9d8063"
+  bg: "#24160f"
+
+markdown_highlight:
+  fg: "#24160f"
+  bg: "#d8a657"
+
+markdown_table_header:
+  fg: "#f5e6c8"
+  bg: "#3a261a"
+  attrs: [bold]
+
+markdown_hrule:
+  fg: "#6f4e37"
+  bg: "#24160f"
+  attrs: [dim]