austb-tty-prompt 0.13.0

data/lib/tty/prompt/symbols.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    # Cross platform common Unicode symbols.
+    #
+    # @api public
+    module Symbols
+      KEYS = {
+        tick: '✓',
+        cross: '✘',
+        star: '★',
+        dot: '•',
+        pointer: '‣',
+        line: '─',
+        pipe: '|',
+        handle: 'O',
+        ellipsis: '…',
+        radio_on: '⬢',
+        radio_off: '⬡',
+        checkbox_on: '☒',
+        checkbox_off: '☐',
+        circle_on: 'ⓧ',
+        circle_off: 'Ⓘ'
+      }.freeze
+
+      WIN_KEYS = {
+        tick: '√',
+        cross: '×',
+        star: '*',
+        dot: '.',
+        pointer: '>',
+        line: '-',
+        pipe: '|',
+        handle: 'O',
+        ellipsis: '...',
+        radio_on: '(*)',
+        radio_off: '( )',
+        checkbox_on: '[×]',
+        checkbox_off: '[ ]',
+        circle_on: '(x)',
+        circle_off: '( )'
+      }.freeze
+
+      def symbols
+        @symbols ||= windows? ? WIN_KEYS : KEYS
+      end
+      module_function :symbols
+
+      # Check if Windowz
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def windows?
+        ::File::ALT_SEPARATOR == "\\"
+      end
+      module_function :windows?
+    end # Symbols
+  end # Prompt
+end # TTY

data/lib/tty/prompt/timeout.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require 'timers'
+
+module TTY
+  class Prompt
+    class Timeout
+      Error = Class.new(RuntimeError)
+
+      TIMEOUT_HANDLER = proc { |t| t.raise Error, 'timeout expired' }
+
+      def initialize(options = {})
+        @timeout_handler  = options.fetch(:timeout_handler) { TIMEOUT_HANDLER }
+        @interval_handler = options.fetch(:interval_handler) { proc {} }
+        @lock    = Mutex.new
+        @running = true
+        @timers  = Timers::Group.new
+      end
+
+      def self.timeout(time, interval, &block)
+        (@scheduler ||= new).timeout(time, interval, &block)
+      end
+
+      # Evalute block and time it
+      #
+      # @param [Float] time
+      #   the time by which to stop
+      # @param [Float] interval
+      #   the interval time for each tick
+      #
+      # @api public
+      def timeout(time, interval, &block)
+        @runner = async_run(time, interval)
+        @running = block.()
+        @runner.join
+      end
+
+      def async_run(time, interval)
+        Thread.new do
+          Thread.current.abort_on_exception = true
+          start = Time.now
+
+          interval_timer = @timers.every(interval) do
+            runtime = Time.now - start
+            delta = time - runtime
+            if delta.round >= 0
+              @interval_handler.(delta.round)
+            end
+          end
+
+          while @running
+            @lock.synchronize {
+              @timers.wait
+              runtime = Time.now - start
+              delta = time - runtime
+
+              if delta <= 0.0
+                @timeout_handler.(Thread.current)
+                break
+              end
+            }
+          end
+
+          interval_timer.cancel
+        end
+      end
+    end # Scheduler
+  end # Prompt
+end # TTY

data/lib/tty/prompt/utils.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module TTY
+  module Utils
+    module_function
+
+    BLANK_REGEX = /\A[[:space:]]*\z/o.freeze
+
+    # Extract options hash from array argument
+    #
+    # @param [Array[Object]] args
+    #
+    # @api public
+    def extract_options(args)
+      options = args.last
+      options.respond_to?(:to_hash) ? options.to_hash.dup : {}
+    end
+
+    def extract_options!(args)
+      args.last.respond_to?(:to_hash) ? args.pop : {}
+    end
+
+    # Check if value is nil or an empty string
+    #
+    # @param [Object] value
+    #   the value to check
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def blank?(value)
+      value.nil? ||
+      value.respond_to?(:empty?) && value.empty? ||
+      BLANK_REGEX === value
+    end
+
+    # Deep copy object
+    #
+    # @api public
+    def deep_copy(object)
+      Marshal.load(Marshal.dump(object))
+    end
+  end # Utils
+end # TTY

data/lib/tty/prompt/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    VERSION = "0.13.0"
+  end # Prompt
+end # TTY

data/lib/tty/test_prompt.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require_relative 'prompt'
+
+module TTY
+  # Used for initializing test cases
+  class TestPrompt < Prompt
+    def initialize(options = {})
+      @input  = StringIO.new
+      @output = StringIO.new
+      options.merge!({
+        input: @input,
+        output: @output,
+        env: { "TTY_TEST" => true },
+        enable_color: options.fetch(:enable_color) { true }
+      })
+      super(options)
+    end
+  end # TestPrompt
+end # TTY

data/tasks/console.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-prompt')
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-prompt.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tty/prompt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "austb-tty-prompt"
+  spec.version       = TTY::Prompt::VERSION
+  spec.authors       = ["Piotr Murach", "Austin Blatt"]
+  spec.email         = ["austinblatt@gmail.com"]
+  spec.summary       = %q{A beautiful and powerful interactive command line prompt.}
+  spec.description   = %q{A beautiful and powerful interactive command line prompt with a robust API for getting and validating complex inputs.}
+  spec.homepage      = "https://github.com/austb/tty-prompt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|spec|features)/})
+                        end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'necromancer',  '~> 0.4.0'
+  spec.add_dependency 'pastel',       '~> 0.7.0'
+  spec.add_dependency 'tty-cursor',   '~> 0.5.0'
+  spec.add_dependency 'wisper',       '~> 2.0.0'
+  spec.add_dependency 'timers',       '~> 4.1.2'
+
+  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: austb-tty-prompt
+version: !ruby/object:Gem::Version
+  version: 0.13.0
+platform: ruby
+authors:
+- Piotr Murach
+- Austin Blatt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-04 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  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: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: A beautiful and powerful interactive command line prompt with a robust
+  API for getting and validating complex inputs.
+email:
+- austinblatt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- benchmarks/speed.rb
+- examples/ask.rb
+- examples/collect.rb
+- examples/echo.rb
+- examples/enum.rb
+- examples/enum_paged.rb
+- examples/enum_select.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_paged.rb
+- examples/multiline.rb
+- examples/pause.rb
+- examples/select.rb
+- examples/select_paginated.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/choice.rb
+- lib/tty/prompt/choices.rb
+- lib/tty/prompt/confirm_question.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/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/multi_list.rb
+- lib/tty/prompt/multiline.rb
+- lib/tty/prompt/paginator.rb
+- lib/tty/prompt/question.rb
+- lib/tty/prompt/question/checks.rb
+- lib/tty/prompt/question/modifier.rb
+- lib/tty/prompt/question/validation.rb
+- lib/tty/prompt/reader.rb
+- lib/tty/prompt/reader/codes.rb
+- lib/tty/prompt/reader/console.rb
+- lib/tty/prompt/reader/history.rb
+- lib/tty/prompt/reader/key_event.rb
+- lib/tty/prompt/reader/line.rb
+- lib/tty/prompt/reader/mode.rb
+- lib/tty/prompt/reader/win_api.rb
+- lib/tty/prompt/reader/win_console.rb
+- lib/tty/prompt/result.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/utils.rb
+- lib/tty/prompt/version.rb
+- lib/tty/test_prompt.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-prompt.gemspec
+homepage: https://github.com/austb/tty-prompt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A beautiful and powerful interactive command line prompt.
+test_files: []
+has_rdoc: