clack 0.4.6 → 0.6.0

data/lib/clack/prompts/multiselect.rb

@@ -29,6 +29,7 @@ module Clack
     #
     class Multiselect < Core::Prompt
       include Core::OptionsHelper
+      include Core::SelectionManager
 
       # @param message [String] the prompt message
       # @param options [Array<Hash, String>] list of options
@@ -38,15 +39,18 @@ module Clack
       # @param cursor_at [Object, nil] value to position cursor at initially
       # @param opts [Hash] additional options passed to {Core::Prompt}
       def initialize(message:, options:, initial_values: [], required: true, max_items: nil, cursor_at: nil, **opts)
+        if opts.key?(:initial_value)
+          raise ArgumentError, "Multiselect uses initial_values: (plural), not initial_value:"
+        end
         super(message:, **opts)
         @options = normalize_options(options)
-        valid_values = Set.new(@options.map { |o| o[:value] })
+        valid_values = Set.new(@options.map { |o| o.value })
         @selected = Set.new(initial_values) & valid_values
         @required = required
         @max_items = max_items
         @scroll_offset = 0
-        @cursor = find_initial_cursor(cursor_at)
-        update_value
+        @option_index = find_initial_cursor(cursor_at)
+        update_selection_value
       end
 
       protected
@@ -74,11 +78,8 @@ module Clack
       end
 
       def submit
-        if @required && @selected.empty?
-          @error_message = "Please select at least one option. Press #{Colors.cyan("space")} to select, #{Colors.cyan("enter")} to submit"
-          @state = :error
-          return
-        end
+        return unless validate_selection
+
         super
       end
 
@@ -103,49 +104,37 @@ module Clack
         lines.join
       end
 
-      def final_display
-        @options.select { |o| @selected.include?(o[:value]) }.map { |o| o[:label] }.join(", ")
-      end
+      def final_display = selected_labels(@options)
 
       private
 
       def toggle_current
-        opt = @options[@cursor]
-        return if opt[:disabled]
+        opt = @options[@option_index]
+        return if opt.disabled
 
-        if @selected.include?(opt[:value])
-          @selected.delete(opt[:value])
-        else
-          @selected.add(opt[:value])
-        end
-        update_value
+        toggle_value(opt.value)
+        update_selection_value
       end
 
       def toggle_all
-        enabled = @options.reject { |o| o[:disabled] }.map { |o| o[:value] }
+        enabled = @options.reject { |o| o.disabled }.map { |o| o.value }
         if enabled.all? { |v| @selected.include?(v) }
           @selected.clear
         else
           @selected.merge(enabled)
         end
-        update_value
+        update_selection_value
       end
 
       def invert_selection
         @options.each do |opt|
-          next if opt[:disabled]
+          next if opt.disabled
 
-          if @selected.include?(opt[:value])
-            @selected.delete(opt[:value])
-          else
-            @selected.add(opt[:value])
-          end
+          toggle_value(opt.value)
         end
-        update_value
+        update_selection_value
       end
 
-      def update_value = @value = @selected.to_a
-
       def keyboard_hints
         hints = [
           "#{Colors.dim("space")} select",
@@ -156,23 +145,23 @@ module Clack
       end
 
       def option_display(opt, idx)
-        active = idx == @cursor
-        selected = @selected.include?(opt[:value])
+        active = idx == @option_index
+        selected = @selected.include?(opt.value)
 
         symbol, label = option_parts(opt, active, selected)
         "#{symbol} #{label}"
       end
 
       def option_parts(opt, active, selected)
-        if opt[:disabled]
+        if opt.disabled
           return [Colors.dim(Symbols::S_CHECKBOX_INACTIVE),
-            Colors.strikethrough(Colors.dim(opt[:label]))]
+            Colors.strikethrough(Colors.dim(opt.label))]
         end
-        return [Colors.green(Symbols::S_CHECKBOX_SELECTED), opt[:label]] if active && selected
-        return [Colors.cyan(Symbols::S_CHECKBOX_ACTIVE), opt[:label]] if active
-        return [Colors.green(Symbols::S_CHECKBOX_SELECTED), Colors.dim(opt[:label])] if selected
+        return [Colors.green(Symbols::S_CHECKBOX_SELECTED), opt.label] if active && selected
+        return [Colors.cyan(Symbols::S_CHECKBOX_ACTIVE), opt.label] if active
+        return [Colors.green(Symbols::S_CHECKBOX_SELECTED), Colors.dim(opt.label)] if selected
 
-        [Colors.dim(Symbols::S_CHECKBOX_INACTIVE), Colors.dim(opt[:label])]
+        [Colors.dim(Symbols::S_CHECKBOX_INACTIVE), Colors.dim(opt.label)]
       end
     end
   end

data/lib/clack/prompts/password.rb

@@ -35,20 +35,7 @@ module Clack
       end
 
       def build_frame
-        lines = []
-        lines << "#{bar}\n"
-        lines << "#{symbol_for_state}  #{@message}\n"
-        lines << help_line
-        lines << "#{active_bar}  #{masked_display}\n"
-        lines << "#{bar_end}\n"
-
-        validation_lines = validation_message_lines
-        if validation_lines.any?
-          lines[-1] = validation_lines.first
-          lines.concat(validation_lines[1..])
-        end
-
-        lines.join
+        "#{frame_header}#{active_bar}  #{masked_display}\n#{frame_footer}"
       end
 
       def final_display = @mask * @value.grapheme_clusters.length

data/lib/clack/prompts/path.rb

@@ -25,8 +25,8 @@ module Clack
     #   )
     #
     class Path < Core::Prompt
+      include Core::OptionsHelper
       include Core::TextInputHelper
-      include Core::ScrollHelper
 
       # @param message [String] the prompt message
       # @param root [String] starting/base directory (default: ".")
@@ -41,7 +41,7 @@ module Clack
         @max_items = max_items
         @value = ""
         @cursor = 0
-        @selected_index = 0
+        @option_index = 0
         @scroll_offset = 0
         @suggestions = []
         @dir_cache = {}     # directory path => sorted entries array
@@ -69,7 +69,7 @@ module Clack
       def handle_text_input(key)
         return unless super
 
-        @selected_index = 0
+        @option_index = 0
         @scroll_offset = 0
         update_suggestions
       end
@@ -77,7 +77,7 @@ module Clack
       def autocomplete_selection
         return if @suggestions.empty?
 
-        @value = @suggestions[@selected_index]
+        @value = @suggestions[@option_index]
         @cursor = @value.length
         update_suggestions
       end
@@ -102,26 +102,12 @@ module Clack
       end
 
       def build_frame
-        lines = []
-        lines << "#{bar}\n"
-        lines << "#{symbol_for_state}  #{@message}\n"
-        lines << help_line
-        lines << "#{active_bar}  #{input_display}\n"
-
-        visible_items.each_with_index do |path, idx|
+        suggestion_lines = visible_options.each_with_index.map do |path, idx|
           actual_idx = @scroll_offset + idx
-          lines << "#{bar}  #{suggestion_display(path, actual_idx == @selected_index)}\n"
-        end
-
-        lines << "#{bar_end}\n"
-
-        validation_lines = validation_message_lines
-        if validation_lines.any?
-          lines[-1] = validation_lines.first
-          lines.concat(validation_lines[1..])
-        end
+          "#{bar}  #{suggestion_display(path, actual_idx == @option_index)}\n"
+        end.join
 
-        lines.join
+        "#{frame_header}#{active_bar}  #{input_display}\n#{suggestion_lines}#{frame_footer}"
       end
 
       private
@@ -202,7 +188,7 @@ module Clack
         expanded == @root || expanded.start_with?("#{@root}/")
       end
 
-      def scroll_items = @suggestions
+      def navigable_items = @suggestions
 
       # Override to use @root as placeholder
       def placeholder_display

data/lib/clack/prompts/progress.rb

@@ -36,6 +36,7 @@ module Clack
         @output = output
         @started = false
         @width = 40
+        @last_frame = nil
       end
 
       # Start displaying the progress bar.
@@ -105,8 +106,11 @@ module Clack
       def render
         return unless @started
 
-        @output.print "\r\e[2K"  # Return to start of line and clear it
-        @output.print "#{symbol}  #{progress_bar} #{percentage}#{message_text}"
+        frame = "#{symbol}  #{progress_bar} #{percentage}#{message_text}"
+        return if frame == @last_frame
+
+        @last_frame = frame
+        @output.print "\r\e[2K#{frame}"
         @output.flush
       end
 

data/lib/clack/prompts/range.rb

@@ -51,20 +51,7 @@ module Clack
       end
 
       def build_frame
-        lines = []
-        lines << "#{bar}\n"
-        lines << "#{symbol_for_state}  #{@message}\n"
-        lines << help_line
-        lines << "#{active_bar}  #{slider_display}\n"
-        lines << "#{bar_end}\n" if %i[active initial].include?(@state)
-
-        validation_lines = validation_message_lines
-        if validation_lines.any?
-          lines[-1] = validation_lines.first
-          lines.concat(validation_lines[1..])
-        end
-
-        lines.join
+        "#{frame_header}#{active_bar}  #{slider_display}\n#{frame_footer}"
       end
 
       def final_display = format_value(@value)

data/lib/clack/prompts/select.rb

@@ -40,47 +40,33 @@ module Clack
       def initialize(message:, options:, initial_value: nil, max_items: nil, **opts)
         super(message:, **opts)
         @options = normalize_options(options)
-        @cursor = find_initial_cursor(initial_value)
         @max_items = max_items
         @scroll_offset = 0
+        @option_index = find_initial_cursor(initial_value)
         update_value
       end
 
       protected
 
-      def handle_key(key)
-        return if terminal_state?
-
-        action = Core::Settings.action?(key)
-
+      def handle_input(_key, action)
         case action
-        when :cancel
-          @state = :cancel
-        when :enter
-          submit unless current_option[:disabled]
-        when :up, :left
-          move_cursor(-1)
-        when :down, :right
-          move_cursor(1)
+        when :up, :left then move_cursor(-1)
+        when :down, :right then move_cursor(1)
         end
       end
 
-      def build_frame
-        lines = []
-        lines << "#{bar}\n"
-        lines << "#{symbol_for_state}  #{@message}\n"
-        lines << help_line
+      def can_submit? = !current_option.disabled
 
-        visible_options.each_with_index do |opt, idx|
+      def build_frame
+        option_lines = visible_options.each_with_index.map do |opt, idx|
           actual_idx = @scroll_offset + idx
-          lines << "#{bar}  #{option_display(opt, actual_idx == @cursor)}\n"
-        end
+          "#{bar}  #{option_display(opt, actual_idx == @option_index)}\n"
+        end.join
 
-        lines << "#{Colors.gray(Symbols::S_BAR_END)}\n"
-        lines.join
+        "#{frame_header}#{option_lines}#{frame_footer}"
       end
 
-      def final_display = current_option[:label]
+      def final_display = current_option.label
 
       private
 
@@ -89,12 +75,12 @@ module Clack
         update_value
       end
 
-      def update_value = @value = current_option[:value]
+      def update_value = @value = current_option.value
 
-      def current_option = @options[@cursor]
+      def current_option = @options[@option_index]
 
       def option_display(opt, active)
-        return disabled_option_display(opt) if opt[:disabled]
+        return disabled_option_display(opt) if opt.disabled
         return active_option_display(opt) if active
 
         inactive_option_display(opt)
@@ -102,19 +88,19 @@ module Clack
 
       def disabled_option_display(opt)
         symbol = Colors.dim(Symbols::S_RADIO_INACTIVE)
-        label = Colors.strikethrough(Colors.dim(opt[:label]))
+        label = Colors.strikethrough(Colors.dim(opt.label))
         "#{symbol} #{label}"
       end
 
       def active_option_display(opt)
         symbol = Colors.green(Symbols::S_RADIO_ACTIVE)
-        hint = opt[:hint] ? " #{Colors.dim("(#{opt[:hint]})")}" : ""
-        "#{symbol} #{opt[:label]}#{hint}"
+        hint = opt.hint ? " #{Colors.dim("(#{opt.hint})")}" : ""
+        "#{symbol} #{opt.label}#{hint}"
       end
 
       def inactive_option_display(opt)
         symbol = Colors.dim(Symbols::S_RADIO_INACTIVE)
-        "#{symbol} #{Colors.dim(opt[:label])}"
+        "#{symbol} #{Colors.dim(opt.label)}"
       end
     end
   end

data/lib/clack/prompts/select_key.rb

@@ -41,10 +41,10 @@ module Clack
         when :cancel
           @state = :cancel
         else
-          opt = @options.find { |o| o[:key]&.downcase == key&.downcase }
+          opt = @options.find { |o| o.key&.downcase == key&.downcase }
           return unless opt
 
-          @value = opt[:value]
+          @value = opt.value
           @state = :submit
         end
       end
@@ -63,25 +63,25 @@ module Clack
         lines.join
       end
 
-      def final_display = @options.find { |o| o[:value] == @value }&.dig(:label).to_s
+      def final_display = @options.find { |o| o.value == @value }&.label.to_s
 
       private
 
       def normalize_options(options)
         options.map do |opt|
-          {
+          Clack::Core::SelectKeyOption.new(
             value: opt[:value],
             label: opt[:label] || opt[:value].to_s,
             key: opt[:key] || opt[:value].to_s[0],
             hint: opt[:hint]
-          }
+          )
         end
       end
 
       def option_display(opt)
-        key_display = Colors.cyan("[#{opt[:key]}]")
-        hint = opt[:hint] ? " #{Colors.dim("(#{opt[:hint]})")}" : ""
-        "#{key_display} #{opt[:label]}#{hint}"
+        key_display = Colors.cyan("[#{opt.key}]")
+        hint = opt.hint ? " #{Colors.dim("(#{opt.hint})")}" : ""
+        "#{key_display} #{opt.label}#{hint}"
       end
     end
   end

data/lib/clack/prompts/spinner.rb

@@ -49,9 +49,7 @@ module Clack
         @frames = frames || Symbols::SPINNER_FRAMES
         @delay = delay || Symbols::SPINNER_DELAY
         @style_frame = style_frame || ->(frame) { Colors.magenta(frame) }
-        @running = false
-        @cancelled = false
-        @finished = false
+        @state = :idle
         @message = ""
         @thread = nil
         @frame_idx = 0
@@ -66,12 +64,10 @@ module Clack
       # @return [self] for method chaining
       def start(message = nil)
         @mutex.synchronize do
-          return if @running
+          return unless @state == :idle
 
           @message = remove_trailing_dots(message || "")
-          @running = true
-          @cancelled = false
-          @finished = false
+          @state = :running
           @prev_frame = nil
           @frame_idx = 0
           @start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -102,7 +98,7 @@ module Clack
       #
       # @param message [String, nil] cancellation message
       def cancel(message = nil)
-        finish(:cancel, message)
+        finish(:cancelled, message)
       end
 
       # Update the spinner message while running.
@@ -116,7 +112,7 @@ module Clack
       # Clear the spinner without showing a final message.
       def clear
         @mutex.synchronize do
-          @running = false
+          @state = :idle
         end
         @thread&.join
         restore_cursor
@@ -124,7 +120,7 @@ module Clack
         @output.print Core::Cursor.show
       end
 
-      def cancelled? = @mutex.synchronize { @cancelled }
+      def cancelled? = @mutex.synchronize { @state == :cancelled }
 
       private
 
@@ -139,7 +135,8 @@ module Clack
 
       def spin_loop
         frame_count = 0
-        while @mutex.synchronize { @running }
+        while @mutex.synchronize { @state == :running }
+          break if @output.closed?
           frame = @style_frame.call(@frames[@frame_idx])
           msg = @mutex.synchronize { @message }
           render_frame(frame, msg, frame_count)
@@ -171,28 +168,26 @@ module Clack
         end
       end
 
-      def finish(state, message)
+      def finish(end_state, message)
         thread_to_join = nil
         msg, timer_suffix = @mutex.synchronize do
-          return if @finished
+          return unless @state == :running
 
-          @finished = true
-          @running = false
+          @state = end_state
           thread_to_join = @thread
           suffix = (@indicator == :timer && @start_time) ? " #{format_timer}" : ""
           [message || @message, suffix]
         end
 
-        thread_to_join&.join
+        thread_to_join&.join(5)
+        thread_to_join&.kill if thread_to_join&.alive?
 
         @output.print "\r#{Core::Cursor.clear_to_end}"
 
-        symbol = case state
+        symbol = case end_state
         when :success then Colors.green(Symbols::S_STEP_SUBMIT)
         when :error then Colors.red(Symbols::S_STEP_ERROR)
-        when :cancel
-          @mutex.synchronize { @cancelled = true }
-          Colors.red(Symbols::S_STEP_CANCEL)
+        when :cancelled then Colors.red(Symbols::S_STEP_CANCEL)
         end
 
         @output.print "#{symbol}  #{msg}#{timer_suffix}\n"

data/lib/clack/prompts/tasks.rb

@@ -87,8 +87,13 @@ module Clack
 
           run_task(task)
         end
-        @output.print Core::Cursor.show
         @results
+      ensure
+        begin
+          @output.print Core::Cursor.show
+        rescue IOError, SystemCallError
+          # output stream already closed
+        end
       end
 
       private

data/lib/clack/prompts/text.rb

@@ -88,20 +88,7 @@ module Clack
       end
 
       def build_frame
-        lines = []
-        lines << "#{bar}\n"
-        lines << "#{symbol_for_state}  #{@message}\n"
-        lines << help_line
-        lines << "#{active_bar}  #{input_display}\n"
-        lines << "#{bar_end}\n" if @state in :active | :initial
-
-        validation_lines = validation_message_lines
-        if validation_lines.any?
-          lines[-1] = validation_lines.first
-          lines.concat(validation_lines[1..])
-        end
-
-        lines.join
+        "#{frame_header}#{active_bar}  #{input_display}\n#{frame_footer}"
       end
 
       private

data/lib/clack/testing.rb

@@ -105,6 +105,25 @@ module Clack
       end
     end
 
+    # A StringIO-like object that feeds keys from a queue.
+    # Passed as the +input:+ parameter to prompts for testing.
+    class KeyQueue
+      def initialize(keys)
+        @keys = keys
+        @read_count = 0
+      end
+
+      def getc
+        @read_count += 1
+        raise "Too many reads (#{@read_count}) - possible infinite loop in test" if @read_count > 100
+
+        @keys.shift || KEYS[:enter]
+      end
+
+      # Not a real TTY
+      def tty? = false
+    end
+
     class << self
       # Simulate a prompt interaction by feeding a predefined key sequence.
       #
@@ -113,9 +132,13 @@ module Clack
       # @yield [PromptDriver] block to define the interaction
       # @return [Object] the prompt result
       def simulate(prompt_method, **kwargs, &block)
-        with_stubbed_input(block) do |output|
-          prompt_method.call(**kwargs, output: output)
-        end
+        driver = PromptDriver.new
+        block.call(driver)
+
+        input = KeyQueue.new(driver.keys.dup)
+        output = StringIO.new
+
+        prompt_method.call(**kwargs, input: input, output: output)
       end
 
       # Capture the rendered output of a prompt simulation.
@@ -126,43 +149,14 @@ module Clack
       # @yield [PromptDriver] block to define the interaction
       # @return [Array(Object, String)] [result, output_string]
       def simulate_with_output(prompt_method, **kwargs, &block)
-        output_io = nil
-        result = with_stubbed_input(block) do |output|
-          output_io = output
-          prompt_method.call(**kwargs, output: output)
-        end
-        [result, output_io.string]
-      end
-
-      private
-
-      def with_stubbed_input(driver_block)
         driver = PromptDriver.new
-        driver_block.call(driver)
+        block.call(driver)
 
-        queue = driver.keys.dup
+        input = KeyQueue.new(driver.keys.dup)
         output = StringIO.new
-        read_count = 0
-
-        verbose, $VERBOSE = $VERBOSE, nil
-        Core::KeyReader.singleton_class.alias_method(:_original_read, :read)
-
-        Core::KeyReader.define_singleton_method(:read) do
-          read_count += 1
-          raise "Too many reads (#{read_count}) - possible infinite loop in test" if read_count > 100
-
-          queue.shift || KEYS[:enter]
-        end
-        $VERBOSE = verbose
-
-        yield output
-      ensure
-        if Core::KeyReader.singleton_class.method_defined?(:_original_read)
-          verbose, $VERBOSE = $VERBOSE, nil
-          Core::KeyReader.singleton_class.alias_method(:read, :_original_read)
-          Core::KeyReader.singleton_class.remove_method(:_original_read)
-          $VERBOSE = verbose
-        end
+
+        result = prompt_method.call(**kwargs, input: input, output: output)
+        [result, output.string]
       end
     end
   end