fatty 0.99.0 → 0.99.3

data/lib/fatty/themes/loader.rb

@@ -5,7 +5,7 @@ require "yaml"
 module Fatty
   module Themes
     module Loader
-      RESERVED_KEYS = %i[name inherit markdown].freeze
+      RESERVED_KEYS = %i[name inherit markdown markdown_code_theme].freeze
 
       ROLE_ALIASES = {
         status_good: :good,
@@ -19,6 +19,7 @@ module Fatty
       }.freeze
 
       def self.load_dir(path, registry:)
+        Fatty.info("Loading theme directory #{path}", tag: :theme)
         Dir.glob(File.join(path.to_s, "*.{yml,yaml}")).sort.each do |file|
           load_file(file, registry: registry)
         end
@@ -26,6 +27,7 @@ module Fatty
       end
 
       def self.load_file(path, registry:)
+        Fatty.info("Loading theme #{path}", tag: :theme)
         data = YAML.safe_load_file(
           path,
           permitted_classes: [Symbol],
@@ -55,9 +57,9 @@ module Fatty
         out = {
           name: normalize_optional_symbol(data[:name]),
           inherit: normalize_optional_symbol(data[:inherit]),
+          markdown_code_theme: normalize_optional_symbol(data[:markdown_code_theme]),
           roles: {},
         }
-
         data.each do |key, value|
           k = key.to_sym
           next if RESERVED_KEYS.include?(k)

data/lib/fatty/themes/manager.rb

@@ -10,6 +10,7 @@ module Fatty
           begin
             reg = Registry.new
             Loader.load_dir(Fatty::Config.user_themes_dir, registry: reg)
+            Loader.load_dir(Fatty::Config.app_themes_dir, registry: reg) if Fatty::Config.app_themes_dir
             reg
           end
       end
@@ -17,6 +18,7 @@ module Fatty
       def self.load!
         registry.clear
         Loader.load_dir(Fatty::Config.user_themes_dir, registry: registry)
+        Loader.load_dir(Fatty::Config.app_themes_dir, registry: registry) if Fatty::Config.app_themes_dir
         registry
       end
 
@@ -38,6 +40,8 @@ module Fatty
       end
 
       def self.set(theme)
+        return current unless theme
+
         t = theme.to_sym
         if theme_names.include?(t)
           @current = t

data/lib/fatty/themes/registry.rb

@@ -44,6 +44,8 @@ module Fatty
 
       private
 
+      # simplecov:disable
+
       def normalize_name(name)
         return if name.nil?
 

data/lib/fatty/themes/resolver.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+using Fatty::CoreExt::Hash
+
 module Fatty
   module Themes
     class ResolveError < StandardError; end
@@ -32,193 +34,204 @@ module Fatty
     # directly on the theme_spec.
     # module Resolver
     module Resolver
-      DEFAULT_ROLE_SPECS = {
-        region: { attrs: [:reverse] },
-        cursor: { attrs: [:reverse] },
-        input_suggestion: { attrs: [:dim] },
-        pager_status: { attrs: [:reverse] },
-        search_input: { attrs: [:reverse] },
-        match_current: { attrs: [:reverse] },
-        match_other: { attrs: [:underline] },
-        popup_counts: { attrs: [:bold] },
-        alert: { attrs: [:bold] },
-        markdown_table_cell: {},
-        markdown_underline: { attrs: [:underline] },
-        markdown_hrule: { attrs: [:dim] },
-      }.freeze
-
-      ROLE_PARENTS = {
-        input: :output,
-        input_suggestion: :input,
-
-        region: :output,
-        cursor: :input,
-
-        popup: :output,
-        popup_frame: :popup,
-        popup_input: :input,
-        popup_selection: :region,
-        popup_counts: :popup,
-
-        search_input: :popup,
-
-        match_current: :region,
-        match_other: :region,
-
-        status: :output,
-        alert: :output,
-        info: :output,
-        good: :info,
-        warn: :info,
-        error: :warn,
-
-        pager_status: :status,
-
-        markdown_h1: :output,
-        markdown_h2: :markdown_h1,
-        markdown_h3: :markdown_h2,
-
-        markdown_code: :output,
-        markdown_code_gutter: :markdown_code,
-
-        markdown_strong: :output,
-        markdown_emphasis: :output,
-
-        markdown_link: :output,
-        markdown_url: :markdown_link,
-
-        markdown_quote_gutter: :output,
-        markdown_highlight: :output,
-        markdown_table_header: :markdown_strong,
-        markdown_table_cell: :output,
-        markdown_underline: :output,
-        markdown_hrule: :output,
-      }.freeze
-
-      def self.empty_theme
-        {
-          name: nil,
-          inherit: nil,
-          roles: {},
-          source: nil,
-        }
-      end
+      class << self
+        DEFAULT_ROLE_SPECS = {
+          region: { attrs: [:reverse] },
+          cursor: { attrs: [:reverse] },
+          input_suggestion: { attrs: [:dim] },
+          pager_status: { attrs: [:reverse] },
+          search_input: { attrs: [:reverse] },
+          match_current: { attrs: [:reverse] },
+          match_other: { attrs: [:underline] },
+          popup_counts: { attrs: [:bold] },
+          alert: { attrs: [:bold] },
+          markdown_table_cell: {},
+          markdown_underline: { attrs: [:underline] },
+          markdown_hrule: { attrs: [:dim] },
+          line_number: { attrs: [:dim] },
+        }.freeze
+
+        ROLE_PARENTS = {
+          input: :output,
+          input_suggestion: :input,
+
+          region: :output,
+          cursor: :input,
+
+          popup: :output,
+          popup_frame: :popup,
+          popup_input: :input,
+          popup_selection: :region,
+          popup_counts: :popup,
+
+          search_input: :popup,
+
+          match_current: :region,
+          match_other: :region,
+
+          status: :output,
+          alert: :output,
+          info: :output,
+          good: :info,
+          warn: :info,
+          error: :warn,
+
+          pager_status: :status,
+          line_number: :output,
+
+          markdown_h1: :output,
+          markdown_h2: :markdown_h1,
+          markdown_h3: :markdown_h2,
+
+          markdown_code: :output,
+          markdown_code_block: :markdown_code,
+          markdown_code_gutter: :markdown_code_block,
+
+          markdown_strong: :output,
+          markdown_emphasis: :output,
+
+          markdown_link: :output,
+          markdown_url: :markdown_link,
+
+          markdown_quote_gutter: :output,
+          markdown_highlight: :output,
+          markdown_table_header: :markdown_strong,
+          markdown_table_cell: :output,
+          markdown_underline: :output,
+          markdown_hrule: :output,
+        }.freeze
+
+        def resolve(registry, name)
+          raw = merge_theme_chain(registry, name.to_sym, stack: [])
+          raw[:roles] = resolve_role_inheritance(raw[:roles])
+          raw[:roles] = add_composite_roles(raw[:roles])
+          raw[:name] = name.to_sym
+          raw
+        end
 
-      def self.resolve(registry, name)
-        raw = merge_theme_chain(registry, name.to_sym, stack: [])
-        raw[:roles] = resolve_role_inheritance(raw[:roles])
-        raw[:roles] = add_composite_roles(raw[:roles])
-        raw[:name] = name.to_sym
-        raw
-      end
+        private
 
-      def self.merge_theme_chain(registry, name, stack:)
-        defn = registry.fetch(name)
-        raise MissingThemeError, "Theme not found: #{name}" unless defn
+        # simplecov:disable
 
-        if stack.include?(name)
-          cycle = (stack + [name]).join(" -> ")
-          raise InheritanceCycleError, "Theme inheritance cycle: #{cycle}"
+        def empty_theme
+          {
+            name: nil,
+            inherit: nil,
+            roles: {},
+            source: nil,
+          }
         end
 
-        parent =
-          if defn[:inherit]
-            merge_theme_chain(registry, defn[:inherit], stack: stack + [name])
-          else
-            empty_theme
-          end
+        def merge_theme_chain(registry, name, stack:)
+          defn = registry.fetch(name)
+          raise MissingThemeError, "Theme not found: #{name}" unless defn
 
-        merged = deep_merge(parent, defn)
-        merged[:name] = name
-        merged[:inherit] = defn[:inherit]
-        merged[:source] = defn[:source]
-        merged
-      end
+          if stack.include?(name)
+            cycle = (stack + [name]).join(" -> ")
+            raise InheritanceCycleError, "Theme inheritance cycle: #{cycle}"
+          end
 
-      def self.resolve_role_inheritance(roles)
-        resolved = {}
-        names = (
-          ROLE_PARENTS.keys +
-          ROLE_PARENTS.values +
-          DEFAULT_ROLE_SPECS.keys +
-          roles.keys
-        ).compact.uniq
-
-        names.each do |name|
-          resolve_role(name, roles, resolved, stack: [])
+          parent =
+            if defn[:inherit]
+              merge_theme_chain(registry, defn[:inherit], stack: stack + [name])
+            else
+              empty_theme
+            end
+
+          merged = merge_theme(parent, defn)
+          merged[:name] = name
+          merged[:inherit] = defn[:inherit]
+          merged[:source] = defn[:source]
+          merged
         end
 
-        resolved
-      end
-
-      def self.resolve_role(name, roles, resolved, stack:)
-        return resolved[name] if resolved.key?(name)
+        def resolve_role_inheritance(roles)
+          resolved = {}
+          names = (
+            ROLE_PARENTS.keys +
+            ROLE_PARENTS.values +
+            DEFAULT_ROLE_SPECS.keys +
+            roles.keys
+          ).compact.uniq
+
+          names.each do |name|
+            resolve_role(name, roles, resolved, stack: [])
+          end
 
-        if stack.include?(name)
-          raise InheritanceCycleError, "Role inheritance cycle: #{(stack + [name]).join(' -> ')}"
+          resolved
         end
 
-        spec = roles[name] || DEFAULT_ROLE_SPECS.fetch(name, {})
-        parent_name =
-          if spec.key?(:inherit)
-            spec[:inherit]&.to_sym
-          else
-            ROLE_PARENTS[name]
-          end
+        def resolve_role(name, roles, resolved, stack:)
+          return resolved[name] if resolved.key?(name)
 
-        parent_spec =
-          if parent_name
-            resolve_role(parent_name, roles, resolved, stack: stack + [name])
-          else
-            {}
+          if stack.include?(name)
+            raise InheritanceCycleError, "Role inheritance cycle: #{(stack + [name]).join(' -> ')}"
           end
 
-        resolved[name] = deep_merge_hash(parent_spec, spec.reject { |k, _| k == :inherit })
-      end
-
-      def self.deep_merge(parent, child)
-        out = parent.dup
+          spec = roles[name] || DEFAULT_ROLE_SPECS.fetch(name, {})
+          parent_name =
+            if spec.key?(:inherit)
+              spec[:inherit]&.to_sym
+            else
+              ROLE_PARENTS[name]
+            end
+
+          parent_spec =
+            if parent_name
+              resolve_role(parent_name, roles, resolved, stack: stack + [name])
+            else
+              {}
+            end
+
+          resolved[name] = parent_spec.deep_merge(spec).reject { |k, _| k == :inherit }
+        end
 
-        out[:roles] = deep_merge_hash(parent[:roles] || {}, child[:roles] || {})
+        def merge_theme(parent, child)
+          out = parent.dup
+          out[:roles] = (parent[:roles] || {}).deep_merge(child[:roles] || {})
+          child.each do |key, value|
+            next if key == :roles
 
-        child.each do |key, value|
-          next if key == :roles
+            out[key] = value
+          end
+          out
+        end
 
-          out[key] = value
+        def deep_merge_hash(parent, child)
+          parent.merge(child) do |_key, old_value, new_value|
+            if old_value.is_a?(Hash) && new_value.is_a?(Hash)
+              deep_merge_hash(old_value, new_value)
+            else
+              new_value
+            end
+          end
         end
 
-        out
-      end
+        def add_composite_roles(roles)
+          roles = roles.dup
 
-      def self.deep_merge_hash(parent, child)
-        parent.merge(child) do |_key, old_value, new_value|
-          if old_value.is_a?(Hash) && new_value.is_a?(Hash)
-            deep_merge_hash(old_value, new_value)
-          else
-            new_value
-          end
+          roles[:alert_info]  = composite_role(roles[:alert] || {}, roles[:info]  || {})
+          roles[:alert_good]  = composite_role(roles[:alert] || {}, roles[:good]  || {})
+          roles[:alert_warn]  = composite_role(roles[:alert] || {}, roles[:warn]  || {})
+          roles[:alert_error] = composite_role(roles[:alert] || {}, roles[:error] || {})
+          roles
         end
-      end
 
-      def self.add_composite_roles(roles)
-        roles = roles.dup
+        def composite_role(base, accent)
+          {
+            fg: accent[:fg] || accent["fg"] || base[:fg] || base["fg"],
+            bg: accent[:bg] || accent["bg"] || base[:bg] || base["bg"],
+            attrs: combine_attrs(base, accent),
+          }.compact
+        end
 
-        roles[:alert_info]  = composite_role(roles[:alert] || {}, roles[:info]  || {})
-        roles[:alert_good]  = composite_role(roles[:alert] || {}, roles[:good]  || {})
-        roles[:alert_warn]  = composite_role(roles[:alert] || {}, roles[:warn]  || {})
-        roles[:alert_error] = composite_role(roles[:alert] || {}, roles[:error] || {})
-        roles
-      end
-      private_class_method :add_composite_roles
-
-      def self.composite_role(base, accent)
-        {
-          fg: accent[:fg] || accent["fg"] || base[:fg] || base["fg"],
-          bg: base[:bg] || base["bg"] || accent[:bg] || accent["bg"],
-          attrs: accent[:attrs] || accent["attrs"] || base[:attrs] || base["attrs"],
-        }.compact
+        def combine_attrs(base, accent)
+          (
+            Array(base[:attrs] || base["attrs"]) +
+            Array(accent[:attrs] || accent["attrs"])
+          ).uniq
+        end
       end
-      private_class_method :composite_role
     end
   end
 end

data/lib/fatty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fatty
-  VERSION = "0.99.0"
+  VERSION = "0.99.3"
 end

data/lib/fatty/viewport.rb

@@ -5,11 +5,18 @@ module Fatty
     attr_accessor :top
     attr_accessor :height
 
-    def initialize(top: 0, height:)
+    def initialize(top: 0, height: 10)
       @top    = top
       @height = height
     end
 
+    def state
+      [
+        top,
+        height,
+      ]
+    end
+
     def adjust_for_trim(n)
       @top = [@top - n, 0].max
     end

data/lib/fatty.rb

@@ -14,7 +14,33 @@ require 'debug'
 # Gem Overview (extracted from README.org by gem_docs)
 #
 # * Introduction
+# ~Fatty~ aims to provide a full-featured command-line environment that provides:
 #
+# 1. an editing command-line input,
+# 2. a history facility,
+# 3. command completion,
+# 4. completion of partially-typed file path names,
+# 5. output into a paging environment,
+# 6. searching within the paged output,
+# 7. issuing messages to a "status" area separate from the output pane,
+# 8. binding keys to pre-defined actions,
+# 9. defining unrecognized key-codes as named keys,
+# 10. color themes that can be selected in real time,
+# 11. a way to define new themes,
+# 12. processes completed command-lines with a callback procedure of your
+#     choosing,
+# 13. several user-interface widgets such a selection popups, prompt for input, etc.,
+# 14. a set of progress indicators you can use to display to the end user,
+# 15. a way to render markdown to the output pane,
+#
+# In other words, fatty allows you to write a terminal-based REPL of your choosing but takes
+# care of all the difficult parts.
+#
+# ~Fatty~ is written entirely in Ruby and was born from my frustrations at the
+# limitations of libraries like ~readline~ and ~reline~.  It relies on ~curses~
+# and ~truecolor~ for low-level rendering and is surprisingly snappy.
+#
+# ~Fatty~ is /not/ a terminal emulator but runs on top of one.
 module Fatty
   require_relative "fatty/version"
   require_relative "fatty/core_ext"
@@ -22,10 +48,9 @@ module Fatty
   require_relative "fatty/config"
   require_relative "fatty/logger"
   require_relative "fatty/counter"
-  require_relative "fatty/action_environment"
-  require_relative "fatty/accept_env"
   require_relative "fatty/action"
   require_relative "fatty/actionable"
+  require_relative "fatty/command"
   require_relative "fatty/history"
   require_relative "fatty/search"
   require_relative "fatty/input_buffer"
@@ -36,20 +61,23 @@ module Fatty
   require_relative "fatty/key_event"
   require_relative "fatty/mouse_event"
   require_relative "fatty/key_map"
-  require_relative "fatty/themes"
-  require_relative "fatty/ansi"
   require_relative "fatty/colors"
+  require_relative "fatty/ansi"
   require_relative "fatty/curses"
   require_relative "fatty/renderer"
+  require_relative "fatty/themes"
   require_relative "fatty/prompt"
-  require_relative "fatty/menu_env"
+  require_relative "fatty/progress"
   require_relative "fatty/screen"
   require_relative "fatty/viewport"
-  require_relative "fatty/views"
-  require_relative "fatty/sessions"
+  require_relative "fatty/session"
+  require_relative "fatty/api"
   require_relative "fatty/terminal"
   require_relative "fatty/markdown"
   require_relative "fatty/help"
+  require_relative "fatty/action_environment"
+  require_relative "fatty/callback_environment"
 
   class Error < StandardError; end
+  class Interrupt < StandardError; end
 end