fatty 0.99.0 → 0.99.3

data/lib/fatty/session/popup_session.rb

@@ -4,11 +4,11 @@ module Fatty
   class PopUpSession < ModalSession
     action_on :session
 
-    attr_reader :field, :filtered, :displayed, :selected, :title, :message
+    attr_reader :prompt, :items, :field, :filtered, :displayed, :title, :message
 
     MAX_WIDTH      = 120
     DEFAULT_HEIGHT = 12
-    MIN_LIST_H     = 3
+    MIN_LIST_H     = 1
     MAX_LIST_H     = 20
     MARGIN         = 2
 
@@ -19,21 +19,27 @@ module Fatty
     # - source: Proc that returns the candidate list. May accept (query) or be arity 0.
     # - matcher: Proc (item, query) -> truthy. Defaults to substring match.
     # - order: :as_given (default) or :reverse (presentation order).
-    # - selection: :preserve (default), :top, :bottom (how selection behaves after refresh).
+    # - current: :preserve (default), :top, :bottom (how the current behaves after refresh).
     def initialize(
-      source:,
-      title: nil,
-      message: nil,
-      prompt: "> ",
-      keymap: Keymaps.emacs,
-      matcher: nil,
-      order: :as_given,
-      kind: nil,
-      selection: :preserve,
-      initial_query: nil,
-      selection_mode: :single,
-      validate_unique_labels: false
-    )
+          source:,
+          title: nil,
+          message: nil,
+          prompt: "Narrow: ",
+          keymap: Keymaps.emacs,
+          matcher: nil,
+          order: :as_given,
+          kind: nil,
+          current: :preserve,
+          initial_query: nil,
+          show_counts: true,
+          show_filter: true,
+          selection_mode: :single,
+          history: nil,
+          history_kind: :popup_filter,
+          history_ctx: nil,
+          save_history: true,
+          validate_unique_labels: false
+        )
       super(keymap: keymap)
       @source = source
       @title = title&.to_s
@@ -42,64 +48,155 @@ module Fatty
       @matcher = matcher || method(:default_matcher)
       @order = order.to_sym
       @kind = kind&.to_sym
-      @selection = selection.to_sym
+      @current_policy = current.to_sym
+      @current = nil
       @selection_mode = selection_mode.to_sym
+      @show_counts = !!show_counts
+      @history = history
+      @save_history = !!save_history
+      @field = InputField.new(
+        prompt: @prompt,
+        history: @history,
+        history_kind: history_kind,
+        history_ctx: history_ctx,
+      )
+      @show_filter = !!show_filter
       @validate_unique_labels = !!validate_unique_labels
-
-      @field = InputField.new(prompt: @prompt)
       text = initial_query.to_s
       @field.buffer.replace(text) unless text.empty?
 
       @items = []
       @filtered = []
       @displayed = []
-      @selected = 0
       @selected_labels = {}
 
       @last_query = nil
       @scroll_start = 0
+      refresh_items
     end
 
     #########################################################################################
-    # Framework and Session Hooks
+    # Session Protocol
     #########################################################################################
 
     def init(terminal:)
+      commands = super
       refresh_items
       rebuild_windows!
-      notify_owner(:popup_changed)
+      commands.concat(notify_owner(:popup_changed))
     end
 
-    def keymap_contexts
-      contexts = [:popup, :text]
-      contexts.unshift(:popup_multi) if multi_select?
-      contexts
+    def update(command)
+      commands =
+        case command.action
+        when :key
+          ev = command.payload.fetch(:event)
+          action, args = resolve_action(ev)
+
+          if action
+            normalize_action_result(apply_action(action, args, event: ev))
+          else
+            []
+          end
+        when :terminal_paste
+          text = command.payload.fetch(:text, "").to_s
+          env = action_env(event: nil)
+          @field.act_on(:paste, text, env: env)
+          refresh_items
+          ensure_scroll_visible
+          []
+        else
+          []
+        end
+      Array(commands)
     end
 
-    def view(screen:, renderer:)
+    def view
       Fatty.debug("PopupSession#view: object_id=#{object_id} win_nil=#{@win.nil?}", tag: :session)
       return unless @win
 
       renderer.render_popup(session: self)
     end
 
-    # Return the outer width and height of the window for this modal,
-    # including any padding and borders.
-    def geometry(cols:, rows:)
-      max_w = max_width(cols: cols, margin: MARGIN, min_width: 10)
-      max_h = max_height(rows: rows, margin: MARGIN, min_height: 5)
+    #########################################################################################
+    # Other public API methods
+    #########################################################################################
 
-      desired_list_h = @filtered.length.clamp(MIN_LIST_H, MAX_LIST_H)
-      height = clamp_height(
-        desired_list_h + popup_extra_rows,
-        max_height: max_h,
-        min_height: 6,
-      )
-      width = clamp_width(
-        MAX_WIDTH,
-        max_width: max_w,
-      )
-      [width, height]
+    def state
+      [
+        title.to_s.dup.freeze,
+        message.to_s.dup.freeze,
+        displayed.map { |item| item.to_s.dup.freeze }.freeze,
+        current,
+        field.buffer.text.to_s.dup.freeze,
+        field.buffer.cursor,
+        field.buffer.virtual_suffix.to_s.dup.freeze,
+        selected_labels.map { |label| label.to_s.dup.freeze }.sort.freeze,
+        counts&.dup&.freeze,
+        renderer.screen.rows,
+        renderer.screen.cols,
+      ]
+    end
+
+    def current
+      current_index
+    end
+
+    def counts
+      {
+        total: total_count,
+        selected: selected_count,
+        matching: matching_count,
+        showing: showing_count
+      }
+    end
+
+    def counts_present?
+      @show_counts
+    end
+
+    def filter_present?
+      @show_filter
+    end
+
+    # Renderer calls this to determine which slice of items to display.
+    def scroll_start(list_h:)
+      max_start = @displayed.length - list_h
+      max_start = 0 if max_start < 0
+
+      @scroll_start = 0 if @scroll_start < 0
+      @scroll_start = max_start if @scroll_start > max_start
+      @scroll_start
+    end
+
+    def gutter_for(item:, selected:)
+      if multi_select?
+        selected_item_label?(item) ? SELECTED_GUTTER : UNSELECTED_GUTTER
+      else
+        ' '
+      end
+    end
+
+    # During path completion update the popup's candidates.
+    def replace_query(text)
+      @field.buffer.replace(text.to_s)
+      refresh_items
+      ensure_scroll_visible
+      notify_owner(:popup_changed)
+    end
+
+    def replace_source(source:, title: nil, message: nil, query: "", current: :top)
+      @source = source
+      @title = title.to_s if title
+      @message = message.to_s if message
+      @current_policy = current.to_sym
+      @field.buffer.replace(query.to_s)
+      @last_query = nil
+      @scroll_start = 0
+
+      refresh_items
+      ensure_scroll_visible
+      notify_owner(:popup_changed)
     end
 
     ############################################################################################
@@ -107,7 +204,7 @@ module Fatty
     ############################################################################################
 
     action :popup_cancel do
-      notify_owner(:popup_cancelled) + [[:terminal, :pop_modal]]
+      notify_owner(:popup_cancelled) + [Command.terminal(:pop_modal)]
     end
 
     action :popup_accept do
@@ -115,32 +212,32 @@ module Fatty
     end
 
     action :popup_next do
-      move_selected_by(1)
+      move_current_by(1)
       ensure_scroll_visible
       notify_owner(:popup_changed)
     end
 
     action :popup_prev do
-      move_selected_by(-1)
+      move_current_by(-1)
       ensure_scroll_visible
       notify_owner(:popup_changed)
     end
 
     action :popup_page_down do
-      move_selected_by(popup_list_height)
+      move_current_by(popup_list_height)
       ensure_scroll_visible
       notify_owner(:popup_changed)
     end
 
     action :popup_page_up do
-      move_selected_by(-popup_list_height)
+      move_current_by(-popup_list_height)
       ensure_scroll_visible
       notify_owner(:popup_changed)
     end
 
     action :popup_top do
       unless @filtered.empty?
-        @selected = 0
+        @current = 0
         recenter_scroll
       end
       notify_owner(:popup_changed)
@@ -148,7 +245,7 @@ module Fatty
 
     action :popup_bottom do
       unless @filtered.empty?
-        @selected = [@filtered.length - 1, 0].max
+        @current = [@filtered.length - 1, 0].max
         recenter_scroll
       end
       notify_owner(:popup_changed)
@@ -169,7 +266,56 @@ module Fatty
       end
     end
 
-    def handle_action(action, args, event:)
+    action :popup_tab do
+      if @kind == :completion
+        notify_owner(:popup_tab)
+      else
+        accept_selection
+      end
+    end
+
+    action :popup_backtab do
+      if @kind == :completion
+        notify_owner(:popup_backtab)
+      else
+        []
+      end
+    end
+
+    private
+
+    # simplecov:disable
+
+    def selected_labels
+      @selected_labels.keys
+    end
+
+    def keymap_contexts
+      contexts = [:popup, :text, :terminal]
+      contexts.unshift(:popup_multi) if multi_select?
+      contexts
+    end
+
+    # Return the outer width and height of the window for this modal,
+    # including any padding and borders.
+    def geometry(cols:, rows:)
+      max_w = max_width(cols: cols, margin: MARGIN, min_width: 10)
+      max_h = max_height(rows: rows, margin: MARGIN, min_height: 5)
+
+      desired_list_h = @filtered.length.clamp(MIN_LIST_H, MAX_LIST_H)
+      height = clamp_height(
+        desired_list_h + popup_extra_rows,
+        max_height: max_h,
+        min_height: 6,
+      )
+      width = clamp_width(
+        MAX_WIDTH,
+        max_width: max_w,
+      )
+      [width, height]
+    end
+
+    def apply_action(action, args, event:)
       env = action_env(event: event)
 
       if Fatty::Actions.lookup(action)&.fetch(:on) == :session
@@ -181,53 +327,52 @@ module Fatty
         notify_owner(:popup_changed)
       end
     rescue ActionError => e
-      Fatty.error("PopUpSession#handle_action: ActionError #{e.message}", tag: :session)
+      Fatty.error("PopUpSession#apply_action: ActionError #{e.message}", tag: :session)
       []
     end
 
-    def move_selected_by(delta)
+    def move_current_by(delta)
       return if @displayed.empty?
 
-      msg = "PopUpSession#move_selected_by before: selected=#{@selected.inspect} delta=#{delta} len=#{@displayed.length}"
+      msg = "PopUpSession#move_current_by before: current=#{@current.inspect} delta=#{delta} len=#{@displayed.length}"
       Fatty.debug(msg)
-      @selected = ((@selected || 0) + delta) % @displayed.length
-      Fatty.debug("PopUpSession#move_selected_by after: selected=#{@selected.inspect}")
+      @current = ((@current || 0) + delta) % @displayed.length
+      Fatty.debug("PopUpSession#move_current_by after: selected=#{@current.inspect}")
     end
 
     def accept_selection
+      query = @field.buffer.text.to_s
+      @field.accept_line(save_history: @save_history) unless query.empty?
       if multi_select?
-        payload = popup_payload(selected_result_hash)
+        items = selected_result_hash
+        if items.empty? && selected_item
+          items[item_label(selected_item)] = item_value(selected_item)
+        end
+        payload = popup_payload(items)
       else
         item = selected_item
-        query = @field.buffer.text.to_s
-
         return [] if item.nil? && query.empty?
 
         item = query if item.nil?
         payload = popup_payload(item)
       end
       [
-        [:terminal, :send_modal_owner, [:cmd, :popup_result, payload]],
-        [:terminal, :pop_modal]
+        Command.terminal(
+          :send_modal_owner,
+          command: Command.session(:self, :popup_result, **payload),
+        ),
+        Command.terminal(:pop_modal),
       ]
     end
 
     def selected_item
-      @displayed[@selected]
+      @displayed[@current]
     end
 
     def selected_item_label?(item)
       selected_label?(item_label(item))
     end
 
-    def gutter_for(item:, selected:)
-      if multi_select?
-        selected_item_label?(item) ? SELECTED_GUTTER : UNSELECTED_GUTTER
-      else
-        ' '
-      end
-    end
-
     def refresh_items_if_query_changed
       q = @field.buffer.text.to_s
       return if q == @last_query
@@ -258,28 +403,16 @@ module Fatty
       validate_unique_labels!(@items) if @validate_unique_labels
 
       matcher = @matcher || method(:default_matcher)
-
       @filtered =
         if q.empty?
           @items
         else
           @items.select { |e| matcher.call(e, q) }
         end
-
       refresh_displayed_items
       apply_selection_policy!
     end
 
-    # Renderer calls this to determine which slice of items to display.
-    def scroll_start(list_h:)
-      max_start = @displayed.length - list_h
-      max_start = 0 if max_start < 0
-
-      @scroll_start = 0 if @scroll_start < 0
-      @scroll_start = max_start if @scroll_start > max_start
-      @scroll_start
-    end
-
     def toggle_selected_current!
       item = selected_item
       return unless item
@@ -295,7 +428,6 @@ module Fatty
       else
         @selected_labels[label] = true
       end
-
       refresh_displayed_items
       item
     end
@@ -322,21 +454,6 @@ module Fatty
       [@displayed.length - scroll_start(list_h: popup_list_height), popup_list_height].min
     end
 
-    def counts
-      {
-        total: total_count,
-        selected: selected_count,
-        matching: matching_count,
-        showing: showing_count
-      }
-    end
-
-    def selected_labels
-      @selected_labels.keys
-    end
-
-    private
-
     def validate_unique_labels!(items)
       counts = Hash.new(0)
       items.each do |item|
@@ -350,29 +467,20 @@ module Fatty
       raise ArgumentError, "duplicate chooser labels: #{shown}"
     end
 
-    def popup_payload(item = selected_item)
-      {
-        kind: @kind,
-        item: item,
-        query: @field.buffer.text.to_s,
-        index: @selected
-      }
-    end
-
     def popup_payload(item = selected_item)
       if multi_select?
         {
           kind: @kind,
           items: item,
           query: @field.buffer.text.to_s,
-          index: @selected
+          index: @current
         }
       else
         {
           kind: @kind,
           item: item,
           query: @field.buffer.text.to_s,
-          index: @selected
+          index: @current
         }
       end
     end
@@ -382,15 +490,20 @@ module Fatty
     end
 
     def popup_extra_rows
-      rows = 4
+      rows = 2 # border rows
       rows += 1 if popup_has_message?
+      rows += 1 if counts_present?
+      rows += 1 if filter_present?
       rows
     end
 
     def notify_owner(name)
-      return [] unless @kind
-
-      [[:terminal, :send_modal_owner, [:cmd, name, popup_payload]]]
+      [
+        Command.terminal(
+          :send_modal_owner,
+          command: Command.session(:self, name, **popup_payload, session: self),
+        ),
+      ]
     end
 
     def popup_list_height
@@ -422,10 +535,10 @@ module Fatty
       top_zone = @scroll_start + band
       bot_zone = (@scroll_start + list_h - 1) - band
 
-      if @selected < top_zone
-        @scroll_start = @selected - band
-      elsif @selected > bot_zone
-        @scroll_start = @selected - (list_h - 1) + band
+      if @current < top_zone
+        @scroll_start = @current - band
+      elsif @current > bot_zone
+        @scroll_start = @current - (list_h - 1) + band
       end
 
       max_start = @displayed.length - list_h
@@ -437,7 +550,7 @@ module Fatty
 
     def recenter_scroll
       list_h = popup_list_height
-      @scroll_start = @selected - (list_h / 2)
+      @scroll_start = @current - (list_h / 2)
 
       max_start = @displayed.length - list_h
       max_start = 0 if max_start < 0
@@ -469,32 +582,36 @@ module Fatty
       end
     end
 
+    def current_index
+      return 0 if @displayed.empty?
+
+      @current = 0 unless @current.is_a?(Integer)
+      @current.clamp(0, @displayed.length - 1)
+    end
+
     def apply_selection_policy!
-      prior = @selected
+      prior = @current
       last_idx = [@displayed.length - 1, 0].max
-
-      @selected = if @displayed.empty?
-        0
-      else
-        case @selection
-        when :top
+      @current =
+        if @displayed.empty?
           0
-        when :bottom
-          last_idx
         else
-          @selected.clamp(0, last_idx)
+          case @current_policy
+          when :top
+            0
+          when :bottom
+            last_idx
+          else
+            @current.is_a?(Integer) ? @current.clamp(0, last_idx) : 0
+          end
         end
-      end
-
-      if @selection == :top || @selection == :bottom
-        recenter_scroll
-      elsif @selected != prior
+      if @current != prior
         ensure_scroll_visible
       end
     end
 
     def default_matcher(item, query)
-      match_all_query_terms?(item, query)
+      Fatty::Search.match_all_terms?(item, query)
     end
 
     def action_env(event:)