tty-prompt 0.18.1 → 0.23.0

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
       #
@@ -33,7 +33,7 @@ module TTY
       # Initialize a Suggestion
       #
       # @api public
-      def initialize(options = {})
+      def initialize(**options)
         @indent      = options.fetch(:indent) { DEFAULT_INDENT }
         @single_text = options.fetch(:single_text) { SINGLE_TEXT }
         @plural_text = options.fetch(:plural_text) { PLURAL_TEXT }
@@ -88,6 +88,7 @@ module TTY
       # @api private
       def evaluate
         return @suggestions if @suggestions.empty?
+
         if @suggestions.one?
           build_single_suggestion
         else
@@ -97,14 +98,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,43 +7,67 @@ module TTY
     # @api public
     module Symbols
       KEYS = {
-        tick: '✓',
-        cross: '✘',
-        star: '★',
-        square: '◼',
-        square_empty: '◻',
-        dot: '•',
-        pointer: '‣',
-        line: '─',
-        pipe: '|',
-        handle: 'O',
-        ellipsis: '…',
-        radio_on: '⬢',
-        radio_off: '⬡',
-        checkbox_on: '☒',
-        checkbox_off: '☐',
-        circle_on: 'ⓧ',
-        circle_off: 'Ⓘ'
+        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: '.',
-        pointer: '>',
-        line: '-',
-        pipe: '|',
-        handle: 'O',
-        ellipsis: '...',
-        radio_on: '(*)',
-        radio_off: '( )',
-        checkbox_on: '[×]',
-        checkbox_off: '[ ]',
-        circle_on: '(x)',
-        circle_off: '( )'
+        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/timer.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module TTY
+  class Prompt
+    class Timer
+      attr_reader :duration
+
+      attr_reader :total
+
+      attr_reader :interval
+
+      def initialize(duration, interval)
+        @duration = duration
+        @interval = interval
+        @total = 0.0
+        @current = nil
+        @events = []
+      end
+
+      def start
+        return if @current
+
+        @current = time_now
+      end
+
+      def stop
+        return unless @current
+
+        @current = nil
+      end
+
+      def runtime
+        time_now - @current
+      end
+
+      def on_tick(&block)
+        @events << block
+      end
+
+      def while_remaining
+        start
+        remaining = duration
+
+        if @duration
+          while remaining >= 0.0
+            if runtime >= total
+              tick = duration - @total
+              @events.each { |block| block.(tick) }
+              @total += @interval
+            end
+
+            yield(remaining)
+            remaining = duration - runtime
+          end
+        else
+          loop { yield }
+        end
+      ensure
+        stop
+      end
+
+      if defined?(Process::CLOCK_MONOTONIC)
+        # Object representing current time
+        def time_now
+          ::Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+      else
+        # Object represeting current time
+        def time_now
+          ::Time.now
+        end
+      end
+    end # Timer
+  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.18.1'
+    VERSION = "0.23.0"
   end # Prompt
 end # TTY

metadata

@@ -1,105 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-29 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: necromancer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.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
-- !ruby/object:Gem::Dependency
-  name: timers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: tty-cursor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: tty-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -118,75 +56,49 @@ 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
   API for getting and validating complex inputs.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/ask.rb
-- examples/ask_valid.rb
-- examples/collect.rb
-- examples/echo.rb
-- examples/enum_select.rb
-- examples/enum_select_disabled.rb
-- examples/enum_select_paged.rb
-- examples/enum_select_wrapped.rb
-- examples/expand.rb
-- examples/in.rb
-- examples/inputs.rb
-- examples/key_events.rb
-- examples/keypress.rb
-- examples/mask.rb
-- examples/multi_select.rb
-- examples/multi_select_disabled.rb
-- examples/multi_select_paged.rb
-- examples/multi_select_wrapped.rb
-- examples/multiline.rb
-- examples/pause.rb
-- examples/select.rb
-- examples/select_disabled.rb
-- examples/select_enum.rb
-- examples/select_filtered.rb
-- examples/select_paginated.rb
-- examples/select_wrapped.rb
-- examples/slider.rb
-- examples/validation.rb
-- examples/yes_no.rb
 - lib/tty-prompt.rb
 - lib/tty/prompt.rb
 - lib/tty/prompt/answers_collector.rb
+- lib/tty/prompt/block_paginator.rb
 - 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/enum_paginator.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
@@ -195,78 +107,25 @@ 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/timeout.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
-- spec/spec_helper.rb
-- spec/unit/ask_spec.rb
-- spec/unit/choice/eql_spec.rb
-- spec/unit/choice/from_spec.rb
-- spec/unit/choices/add_spec.rb
-- spec/unit/choices/each_spec.rb
-- spec/unit/choices/find_by_spec.rb
-- spec/unit/choices/new_spec.rb
-- spec/unit/choices/pluck_spec.rb
-- spec/unit/collect_spec.rb
-- spec/unit/converters/convert_bool_spec.rb
-- spec/unit/converters/convert_char_spec.rb
-- spec/unit/converters/convert_custom_spec.rb
-- spec/unit/converters/convert_date_spec.rb
-- spec/unit/converters/convert_file_spec.rb
-- spec/unit/converters/convert_number_spec.rb
-- spec/unit/converters/convert_path_spec.rb
-- spec/unit/converters/convert_range_spec.rb
-- spec/unit/converters/convert_regex_spec.rb
-- spec/unit/converters/convert_string_spec.rb
-- spec/unit/converters/on_error_spec.rb
-- spec/unit/distance/distance_spec.rb
-- spec/unit/enum_paginator_spec.rb
-- spec/unit/enum_select_spec.rb
-- spec/unit/error_spec.rb
-- spec/unit/evaluator_spec.rb
-- spec/unit/expand_spec.rb
-- spec/unit/keypress_spec.rb
-- spec/unit/mask_spec.rb
-- spec/unit/multi_select_spec.rb
-- spec/unit/multiline_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/ok_spec.rb
-- spec/unit/paginator_spec.rb
-- spec/unit/question/checks_spec.rb
-- spec/unit/question/default_spec.rb
-- spec/unit/question/echo_spec.rb
-- spec/unit/question/in_spec.rb
-- spec/unit/question/initialize_spec.rb
-- spec/unit/question/modifier/apply_to_spec.rb
-- spec/unit/question/modifier/letter_case_spec.rb
-- spec/unit/question/modifier/whitespace_spec.rb
-- spec/unit/question/modify_spec.rb
-- spec/unit/question/required_spec.rb
-- spec/unit/question/validate_spec.rb
-- spec/unit/question/validation/call_spec.rb
-- spec/unit/question/validation/coerce_spec.rb
-- spec/unit/result_spec.rb
-- spec/unit/say_spec.rb
-- spec/unit/select_spec.rb
-- spec/unit/slider_spec.rb
-- spec/unit/statement/initialize_spec.rb
-- spec/unit/subscribe_spec.rb
-- spec/unit/suggest_spec.rb
-- spec/unit/warn_spec.rb
-- spec/unit/yes_no_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-prompt.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-prompt/issues
+  changelog_uri: https://github.com/piotrmurach/tty-prompt/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-prompt
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-prompt
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -282,65 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A beautiful and powerful interactive command line prompt.
-test_files:
-- spec/spec_helper.rb
-- spec/unit/ask_spec.rb
-- spec/unit/choice/eql_spec.rb
-- spec/unit/choice/from_spec.rb
-- spec/unit/choices/add_spec.rb
-- spec/unit/choices/each_spec.rb
-- spec/unit/choices/find_by_spec.rb
-- spec/unit/choices/new_spec.rb
-- spec/unit/choices/pluck_spec.rb
-- spec/unit/collect_spec.rb
-- spec/unit/converters/convert_bool_spec.rb
-- spec/unit/converters/convert_char_spec.rb
-- spec/unit/converters/convert_custom_spec.rb
-- spec/unit/converters/convert_date_spec.rb
-- spec/unit/converters/convert_file_spec.rb
-- spec/unit/converters/convert_number_spec.rb
-- spec/unit/converters/convert_path_spec.rb
-- spec/unit/converters/convert_range_spec.rb
-- spec/unit/converters/convert_regex_spec.rb
-- spec/unit/converters/convert_string_spec.rb
-- spec/unit/converters/on_error_spec.rb
-- spec/unit/distance/distance_spec.rb
-- spec/unit/enum_paginator_spec.rb
-- spec/unit/enum_select_spec.rb
-- spec/unit/error_spec.rb
-- spec/unit/evaluator_spec.rb
-- spec/unit/expand_spec.rb
-- spec/unit/keypress_spec.rb
-- spec/unit/mask_spec.rb
-- spec/unit/multi_select_spec.rb
-- spec/unit/multiline_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/ok_spec.rb
-- spec/unit/paginator_spec.rb
-- spec/unit/question/checks_spec.rb
-- spec/unit/question/default_spec.rb
-- spec/unit/question/echo_spec.rb
-- spec/unit/question/in_spec.rb
-- spec/unit/question/initialize_spec.rb
-- spec/unit/question/modifier/apply_to_spec.rb
-- spec/unit/question/modifier/letter_case_spec.rb
-- spec/unit/question/modifier/whitespace_spec.rb
-- spec/unit/question/modify_spec.rb
-- spec/unit/question/required_spec.rb
-- spec/unit/question/validate_spec.rb
-- spec/unit/question/validation/call_spec.rb
-- spec/unit/question/validation/coerce_spec.rb
-- spec/unit/result_spec.rb
-- spec/unit/say_spec.rb
-- spec/unit/select_spec.rb
-- spec/unit/slider_spec.rb
-- spec/unit/statement/initialize_spec.rb
-- spec/unit/subscribe_spec.rb
-- spec/unit/suggest_spec.rb
-- spec/unit/warn_spec.rb
-- spec/unit/yes_no_spec.rb
+test_files: []