tty-prompt 0.21.0 → 0.22.0

data/lib/tty/prompt/slider.rb

@@ -7,9 +7,9 @@ module TTY
     #
     # @api public
     class Slider
-      HELP = '(Use arrow keys, press Enter to select)'.freeze
+      HELP = "(Use %s arrow keys, press Enter to select)"
 
-      FORMAT = ':slider %d'.freeze
+      FORMAT = ":slider %d"
 
       # Initailize a Slider
       #
@@ -33,6 +33,9 @@ module TTY
         @active_color = options.fetch(:active_color) { @prompt.active_color }
         @help_color   = options.fetch(:help_color) { @prompt.help_color }
         @format       = options.fetch(:format) { FORMAT }
+        @quiet        = options.fetch(:quiet) { @prompt.quiet }
+        @help         = options[:help]
+        @show_help    = options.fetch(:show_help) { :start }
         @symbols      = @prompt.symbols.merge(options.fetch(:symbols, {}))
         @first_render = true
         @done         = false
@@ -46,6 +49,7 @@ module TTY
       # @api public
       def symbols(new_symbols = (not_set = true))
         return @symbols if not_set
+
         @symbols.merge!(new_symbols)
       end
 
@@ -62,11 +66,39 @@ module TTY
         end
       end
 
+      # Default help text
+      #
+      # @api public
+      def default_help
+        arrows = @symbols[:arrow_left] + "/" + @symbols[:arrow_right]
+        sprintf(HELP, arrows)
+      end
+
+      # Set help text
+      #
+      # @param [String] text
+      #
+      # @api private
+      def help(text = (not_set = true))
+        return @help if !@help.nil? && not_set
+
+        @help = (@help.nil? && not_set) ? default_help : text
+      end
+
+      # Change when help is displayed
+      #
+      # @api public
+      def show_help(value = (not_set = true))
+        return @show_ehlp if not_set
+
+        @show_help = value
+      end
+
       # Range of numbers to render
       #
       # @return [Array[Integer]]
       #
-      # @apip private
+      # @api private
       def range
         (@min..@max).step(@step).to_a
       end
@@ -95,6 +127,13 @@ module TTY
         @format = value
       end
 
+      # Set quiet mode.
+      #
+      # @api public
+      def quiet(value)
+        @quiet = value
+      end
+
       # Call the slider by passing question
       #
       # @param [String] question
@@ -128,6 +167,20 @@ module TTY
 
       private
 
+      # Check if help is shown only on start
+      #
+      # @api private
+      def help_start?
+        @show_help =~ /start/i
+      end
+
+      # Check if help is always displayed
+      #
+      # @api private
+      def help_always?
+        @show_help =~ /always/i
+      end
+
       # Render an interactive range slider.
       #
       # @api private
@@ -139,7 +192,7 @@ module TTY
           @prompt.read_keypress
           refresh(question.lines.count)
         end
-        @prompt.print(render_question)
+        @prompt.print(render_question) unless @quiet
         answer
       ensure
         @prompt.print(@prompt.show)
@@ -175,8 +228,9 @@ module TTY
         else
           header << render_slider
         end
-        if @first_render
-          header << "\n" + @prompt.decorate(HELP, @help_color)
+        if @first_render && (help_start? || help_always?) ||
+            (help_always? && !@done)
+          header << "\n" + @prompt.decorate(help, @help_color)
           @first_render = false
         end
         header.join
@@ -191,8 +245,13 @@ module TTY
         slider = (@symbols[:line] * @active) +
                  @prompt.decorate(@symbols[:bullet], @active_color) +
                  (@symbols[:line] * (range.size - @active - 1))
-        value = " #{range[@active]}"
-        @format.gsub(':slider', slider) % [value]
+        value = range[@active]
+        case @format
+        when Proc
+          @format.call(slider, value)
+        else
+          @format.gsub(":slider", slider) % [value]
+        end
       end
     end # Slider
   end # Prompt

data/lib/tty/prompt/statement.rb

@@ -28,10 +28,10 @@ module TTY
       #   change the message display to color
       #
       # @api public
-      def initialize(prompt, options = {})
+      def initialize(prompt, newline: true, color: false)
         @prompt  = prompt
-        @newline = options.fetch(:newline) { true }
-        @color   = options.fetch(:color) { false }
+        @newline = newline
+        @color   = color
       end
 
       # Output the message to the prompt

data/lib/tty/prompt/suggestion.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'distance'
+require_relative "distance"
 
 module TTY
   # A class responsible for terminal prompt interactions.
@@ -11,9 +11,9 @@ module TTY
     class Suggestion
       DEFAULT_INDENT = 8
 
-      SINGLE_TEXT    = 'Did you mean this?'
+      SINGLE_TEXT    = "Did you mean this?"
 
-      PLURAL_TEXT    = 'Did you mean one of these?'
+      PLURAL_TEXT    = "Did you mean one of these?"
 
       # Number of spaces
       #
@@ -97,14 +97,14 @@ module TTY
 
       # @api private
       def build_single_suggestion
-        single_text + "\n" + (' ' * indent) + @suggestions.first
+        single_text + "\n" + (" " * indent) + @suggestions.first
       end
 
       # @api private
       def build_multiple_suggestions
         plural_text + "\n" +
         @suggestions.map do |sugest|
-          ' ' * indent + sugest
+          " " * indent + sugest
         end.join("\n")
       end
     end # Suggestion

data/lib/tty/prompt/symbols.rb

@@ -7,67 +7,67 @@ module TTY
     # @api public
     module Symbols
       KEYS = {
-        tick: '✓',
-        cross: '✘',
-        star: '★',
-        square: '◼',
-        square_empty: '◻',
-        dot: '•',
-        bullet: '●',
-        bullet_empty: '○',
-        marker: '‣',
-        line: '─',
-        pipe: '|',
-        ellipsis: '…',
-        radio_on: '⬢',
-        radio_off: '⬡',
-        checkbox_on: '☒',
-        checkbox_off: '☐',
-        circle: '◯',
-        circle_on: 'ⓧ',
-        circle_off: 'Ⓘ',
-        arrow_up: '↑',
-        arrow_down: '↓',
-        arrow_up_down: '↕',
-        arrow_left: '←',
-        arrow_right: '→',
-        arrow_left_right: '↔',
-        heart: '♥',
-        diamond: '♦',
-        club: '♣',
-        spade: '♠'
+        tick: "✓",
+        cross: "✘",
+        star: "★",
+        square: "◼",
+        square_empty: "◻",
+        dot: "•",
+        bullet: "●",
+        bullet_empty: "○",
+        marker: "‣",
+        line: "─",
+        pipe: "|",
+        ellipsis: "…",
+        radio_on: "⬢",
+        radio_off: "⬡",
+        checkbox_on: "☒",
+        checkbox_off: "☐",
+        circle: "◯",
+        circle_on: "ⓧ",
+        circle_off: "Ⓘ",
+        arrow_up: "↑",
+        arrow_down: "↓",
+        arrow_up_down: "↕",
+        arrow_left: "←",
+        arrow_right: "→",
+        arrow_left_right: "↔",
+        heart: "♥",
+        diamond: "♦",
+        club: "♣",
+        spade: "♠"
       }.freeze
 
       WIN_KEYS = {
-        tick: '√',
-        cross: 'x',
-        star: '*',
-        square: '[█]',
-        square_empty: '[ ]',
-        dot: '.',
-        bullet: 'O',
-        bullet_empty: '○',
-        marker: '>',
-        line: '-',
-        pipe: '|',
-        ellipsis: '...',
-        radio_on: '(*)',
-        radio_off: '( )',
-        checkbox_on: '[×]',
-        checkbox_off: '[ ]',
-        circle: '( )',
-        circle_on: '(x)',
-        circle_off: '( )',
-        arrow_up: '↑',
-        arrow_down: '↓',
-        arrow_up_down: '↕',
-        arrow_left: '←',
-        arrow_right: '→',
-        arrow_left_right: '↔',
-        heart: '♥',
-        diamond: '♦',
-        club: '♣',
-        spade: '♠'
+        tick: "√",
+        cross: "x",
+        star: "*",
+        square: "[█]",
+        square_empty: "[ ]",
+        dot: ".",
+        bullet: "O",
+        bullet_empty: "○",
+        marker: ">",
+        line: "-",
+        pipe: "|",
+        ellipsis: "...",
+        radio_on: "(*)",
+        radio_off: "( )",
+        checkbox_on: "[×]",
+        checkbox_off: "[ ]",
+        circle: "( )",
+        circle_on: "(x)",
+        circle_off: "( )",
+        arrow_up: "↑",
+        arrow_down: "↓",
+        arrow_up_down: "↕",
+        arrow_left: "←",
+        arrow_right: "→",
+        arrow_left_right: "↔",
+        heart: "♥",
+        diamond: "♦",
+        club: "♣",
+        spade: "♠"
       }.freeze
 
       def symbols

data/lib/tty/prompt/test.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+require_relative "../prompt"
+
+module TTY
+  # Used for initializing test cases
+  class Prompt
+    module StringIOExtensions
+      def wait_readable(*)
+        true
+      end
+
+      def ioctl(*)
+        80
+      end
+    end
+
+    class Test < TTY::Prompt
+      def initialize(**options)
+        @input  = StringIO.new
+        @input.extend(StringIOExtensions)
+        @output = StringIO.new
+
+        options.merge!({
+          input: @input,
+          output: @output,
+          env: { "TTY_TEST" => true },
+          enable_color: options.fetch(:enable_color) { true }
+        })
+        super(**options)
+      end
+    end # Test
+  end # Prompt
+end # TTY

data/lib/tty/prompt/utils.rb

@@ -29,9 +29,7 @@ module TTY
     #
     # @api public
     def blank?(value)
-      value.nil? ||
-      value.respond_to?(:empty?) && value.empty? ||
-      BLANK_REGEX === value
+      value.nil? || BLANK_REGEX === value
     end
 
     # Deep copy object

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.21.0"
+    VERSION = "0.22.0"
   end # Prompt
 end # TTY

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: necromancer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tty-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +56,14 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: A beautiful and powerful interactive command line prompt with a robust
@@ -101,17 +87,18 @@ files:
 - lib/tty/prompt/choice.rb
 - lib/tty/prompt/choices.rb
 - lib/tty/prompt/confirm_question.rb
+- lib/tty/prompt/const.rb
 - lib/tty/prompt/converter_dsl.rb
 - lib/tty/prompt/converter_registry.rb
 - lib/tty/prompt/converters.rb
 - lib/tty/prompt/distance.rb
 - lib/tty/prompt/enum_list.rb
+- lib/tty/prompt/errors.rb
 - lib/tty/prompt/evaluator.rb
 - lib/tty/prompt/expander.rb
 - lib/tty/prompt/keypress.rb
 - lib/tty/prompt/list.rb
 - lib/tty/prompt/mask_question.rb
-- lib/tty/prompt/messages.rb
 - lib/tty/prompt/multi_list.rb
 - lib/tty/prompt/multiline.rb
 - lib/tty/prompt/paginator.rb
@@ -120,14 +107,15 @@ files:
 - lib/tty/prompt/question/modifier.rb
 - lib/tty/prompt/question/validation.rb
 - lib/tty/prompt/result.rb
+- lib/tty/prompt/selected_choices.rb
 - lib/tty/prompt/slider.rb
 - lib/tty/prompt/statement.rb
 - lib/tty/prompt/suggestion.rb
 - lib/tty/prompt/symbols.rb
+- lib/tty/prompt/test.rb
 - lib/tty/prompt/timer.rb
 - lib/tty/prompt/utils.rb
 - lib/tty/prompt/version.rb
-- lib/tty/test_prompt.rb
 homepage: https://ttytoolkit.org
 licenses:
 - MIT