tty-prompt 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aec759d54706c89726d2a7a9b5ec7d7dd14c773c0cb1240e1ecf51c2a0b734c6
-  data.tar.gz: af25b5b8fe122644232e5e02fd2aea203bad75901d7dfa1d2c0605c4181035ab
+  metadata.gz: c1c688ca710d4099ceda4afec8d6e7dcbd2b20db56a94162348366dbfa15a33e
+  data.tar.gz: 58d8588967168ce881cd0b4da632d1bff7d67e735ad5debf906bf415d6c00ec6
 SHA512:
-  metadata.gz: a44c4754daf0cabddbcce1a3863988603150df18364075ad0b9d2bef8193d16b3e0d67804f7553ace2f68c907cbcf9ad708f28442b5bd66c088400732bfa8101
-  data.tar.gz: 4253e5b3e30113775138f233c28a020291d3d20a70ed8f7e37c68407c62ebda1f09788909274c66c8e8e88cb4c855dd0085a13a89a9e42b7fc5174dabc05051c
+  metadata.gz: e7037f42befaf3ebec087e72a17f1aeaf208e459952c6682a4f05cfc7ac753a081fc15e1524b8c286a2819872f8d75f3d669907a0244c49ccd520982b7c4e5fb
+  data.tar.gz: 39a6c809245322fd7a7d083343d2c6109ca9a28f8cdfc82ed0844eceb110704add7eccc0f1d5b4fd93f990f1c6a4a3b045ba0101f6bd71a8f967afe7c3d96f2a

data/README.md

@@ -758,7 +758,7 @@ After the user presses "k":
 #   Kitana
 ```
 
-After the user presse "ka":
+After the user presses "ka":
 
 ```ruby
 # =>
@@ -1186,7 +1186,7 @@ The slider provides easy visual way of picking a value marked by `O` marker. You
 prompt.slider('Volume', max: 100, step: 5)
 # =>
 # Volume ──────────O────────── 50
-# (User arrow keys, press Enter to select)
+# (Use arrow keys, press Enter to select)
 ```
 
 By default the slider is configured to pick middle of the range as a start value, you can change this by using the `:default` option:

data/lib/tty/prompt/messages.rb

@@ -0,0 +1,49 @@
+module TTY
+  class Prompt
+    class Messages
+
+      def setup_messages
+        @messages = {
+          range?: 'Value %{value} must be within the range %{in}',
+          valid?: 'Your answer is invalid (must match %{valid})',
+          required?: 'Value must be provided'
+        }
+      end
+
+      def initialize
+        setup_messages
+      end
+
+      # Stores all the error messages displayed to user
+      # The currently supported messages are:
+      #  * :range?
+      #  * :required?
+      #  * :valid?
+      attr_reader :messages
+
+      def get(key)
+        
+      end
+
+      # Retrieve message based on the key
+      #
+      # @param [Symbol] name
+      #   the name of message key
+      #
+      # @param [Hash] tokens
+      #   the tokens to evaluate
+      #
+      # @return [Array[String]]
+      #
+      # @api private
+      def message_for(name, tokens = nil)
+        template = @messages[name]
+        if !template.match(/\%\{/).nil?
+          [template % tokens]
+        else
+          [template]
+        end
+      end
+    end
+  end
+end

data/lib/tty/prompt/version.rb

@@ -1,7 +1,5 @@
-# encoding: utf-8
-
 module TTY
   class Prompt
-    VERSION = '0.16.1'.freeze
+    VERSION = '0.17.0'.freeze
   end # Prompt
 end # TTY

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require 'tty-prompt'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 2
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/unit/ask_spec.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, '#ask' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it 'asks question' do
+    prompt.ask('What is your name?')
+    expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \n"
+    ].join)
+  end
+
+  it 'asks an empty question ' do
+    prompt.ask('')
+    expect(prompt.output.string).to eql('')
+  end
+
+  it 'asks an empty question and returns nil if EOF is sent to stdin' do
+    prompt.input << nil
+    prompt.input.rewind
+    answer = prompt.ask('')
+    expect(answer).to eql(nil)
+    expect(prompt.output.string).to eq('')
+  end
+
+  it "asks a question with a prefix [?]" do
+    prompt = TTY::TestPrompt.new(prefix: "[?] ")
+    prompt.input << "\r"
+    prompt.input.rewind
+    answer = prompt.ask 'Are you Polish?'
+    expect(answer).to eq(nil)
+    expect(prompt.output.string).to eq([
+      "[?] Are you Polish? ",
+      "\e[2K\e[1G[?] Are you Polish? \n",
+      "\e[1A\e[2K\e[1G",
+      "[?] Are you Polish? \n"
+    ].join)
+  end
+
+  it 'asks a question with block' do
+    prompt.input << ''
+    prompt.input.rewind
+    answer = prompt.ask "What is your name?" do |q|
+      q.default 'Piotr'
+    end
+    expect(answer).to eq('Piotr')
+    expect(prompt.output.string).to eq([
+      "What is your name? \e[90m(Piotr)\e[0m ",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \e[32mPiotr\e[0m\n"
+    ].join)
+  end
+
+  it "changes question color" do
+    prompt.input << ''
+    prompt.input.rewind
+    options = {default: 'Piotr', help_color: :red, active_color: :cyan}
+    answer = prompt.ask("What is your name?", options)
+    expect(answer).to eq('Piotr')
+    expect(prompt.output.string).to eq([
+      "What is your name? \e[31m(Piotr)\e[0m ",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \e[36mPiotr\e[0m\n"
+    ].join)
+  end
+
+  it "permits empty default parameter" do
+    prompt.input << "\r"
+    prompt.input.rewind
+
+    answer = prompt.ask("What is your name?", default: '')
+    expect(answer).to eq('')
+    expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[2K\e[1GWhat is your name? \n",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \n"
+    ].join)
+  end
+
+  it "permits nil default parameter" do
+    prompt.input << "\r"
+    prompt.input.rewind
+
+    answer = prompt.ask("What is your name?", default: nil)
+    expect(answer).to eq(nil)
+    expect(prompt.output.string).to eq([
+      "What is your name? ",
+      "\e[2K\e[1GWhat is your name? \n",
+      "\e[1A\e[2K\e[1G",
+      "What is your name? \n"
+    ].join)
+  end
+
+  it "overwrites global settings" do
+    global_settings = {prefix: "[?] ", active_color: :cyan, help_color: :red}
+    prompt = TTY::TestPrompt.new(global_settings)
+
+    prompt.input << "Piotr\r"
+    prompt.input.rewind
+    prompt.ask('What is your name?')
+
+    prompt.input << "Piotr\r"
+    prompt.input.rewind
+    local_settings = {prefix: ':-) ', active_color: :blue, help_color: :magenta}
+    prompt.ask('What is your name?', local_settings)
+
+    expect(prompt.output.string).to eq([
+      "[?] What is your name? ",
+      "\e[2K\e[1G[?] What is your name? P",
+      "\e[2K\e[1G[?] What is your name? Pi",
+      "\e[2K\e[1G[?] What is your name? Pio",
+      "\e[2K\e[1G[?] What is your name? Piot",
+      "\e[2K\e[1G[?] What is your name? Piotr",
+      "\e[2K\e[1G[?] What is your name? Piotr\n",
+      "\e[1A\e[2K\e[1G",
+      "[?] What is your name? \e[36mPiotr\e[0m\n",
+      ":-) What is your name? ",
+      "\e[2K\e[1G:-) What is your name? P",
+      "\e[2K\e[1G:-) What is your name? Pi",
+      "\e[2K\e[1G:-) What is your name? Pio",
+      "\e[2K\e[1G:-) What is your name? Piot",
+      "\e[2K\e[1G:-) What is your name? Piotr",
+      "\e[2K\e[1G:-) What is your name? Piotr\n",
+      "\e[1A\e[2K\e[1G",
+      ":-) What is your name? \e[34mPiotr\e[0m\n"
+    ].join)
+  end
+end

data/spec/unit/choice/eql_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choice, '#==' do
+  it "is true with the same name and value attributes" do
+    expect(described_class.new(:large, 1)).
+      to eq(described_class.new(:large, 1))
+  end
+
+  it "is false with different name attribute" do
+    expect(described_class.new(:large, 1)).
+      not_to eq(described_class.new(:medium, 1))
+  end
+
+  it "is false with different value attribute" do
+    expect(described_class.new(:large, 1)).
+      not_to eq(described_class.new(:large, 2))
+  end
+
+  it "is false with non-choice object" do
+    expect(described_class.new(:large, 1)).not_to eq(:other)
+  end
+end

data/spec/unit/choice/from_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choice, '#from' do
+  it "skips Choice instance" do
+    choice = described_class.new(:large, 1)
+
+    expect(described_class.from(choice)).to eq(choice)
+  end
+
+  it "creates choice from string" do
+    expected_choice = described_class.new('large', 'large')
+    choice = described_class.from('large')
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq('large')
+  end
+
+  it "creates choice from array with one element" do
+    expected_choice = described_class.new('large', 'large')
+    choice = described_class.from([:large])
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq('large')
+  end
+
+  it "creates choice from array with more than one element" do
+    expected_choice = described_class.new('large', 1)
+    choice = described_class.from([:large, 1])
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq(1)
+  end
+
+  it "creates choice from hash value" do
+    expected_choice = described_class.new('large', 1)
+    choice = described_class.from({large: 1})
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq(1)
+  end
+
+  it "creats choice from array with key value pair" do
+    expected_choice = described_class.new('large', 1)
+    choice = described_class.from([{'large' => 1}])
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq(1)
+  end
+
+  it "creats choice from array with hash elements" do
+    expected_choice = described_class.new('large', 1)
+    choice = described_class.from([{name: 'large', value: 1}])
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq(1)
+  end
+
+  it "creats choice from array with hash elements without value" do
+    expected_choice = described_class.new('large', 'large')
+    choice = described_class.from([{name: 'large'}])
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('large')
+    expect(choice.value).to eq('large')
+  end
+
+  it "creates choice from hash with key property" do
+    default = {key: 'h', name: 'Help', value: :help}
+    expected_choice = described_class.new('Help', :help, key: 'h')
+    choice = described_class.from(default) 
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('Help')
+    expect(choice.value).to eq(:help)
+    expect(choice.disabled?).to eq(false)
+  end
+
+  it "creates disabled choice" do
+    expected_choice = described_class.new('Disabled', :none, disabled: true)
+    choice = described_class.from({
+      name: 'Disabled',
+      value: :none,
+      disabled: 'unavailable'})
+
+    expect(choice).to eq(expected_choice)
+    expect(choice.name).to eq('Disabled')
+    expect(choice.value).to eq(:none)
+    expect(choice.disabled?).to eq(true)
+  end
+end

data/spec/unit/choices/add_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choices, '#<<' do
+  it "adds choice to collection" do
+    choices = described_class.new
+    expect(choices).to be_empty
+    choice = TTY::Prompt::Choice.from([:label, 1])
+    choices << [:label, 1]
+    expect(choices.size).to eq(1)
+    expect(choices.to_ary).to eq([choice])
+  end
+end

data/spec/unit/choices/each_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choices, '.each' do
+  it "iterates over collection" do
+    choices = described_class[:large, :medium, :small]
+    actual = []
+    choices.each do |choice|
+      actual << choice.name
+    end
+    expect(actual).to eq([:large, :medium, :small])
+    expect(choices.each).to be_kind_of(Enumerator)
+  end
+end

data/spec/unit/choices/find_by_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choices, '#find_by' do
+  it "finds a matching choice by key name" do
+    collection = [{name: 'large'},{name: 'medium'},{name: 'small'}]
+    choice = TTY::Prompt::Choice.from(name: 'small')
+    choices = described_class[*collection]
+    expect(choices.find_by(:name, 'small')).to eq(choice)
+  end
+end

data/spec/unit/choices/new_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choices, '.new' do
+  it "creates choices collection" do
+    choice_1 = TTY::Prompt::Choice.from(:label1)
+    choice_2 = TTY::Prompt::Choice.from(:label2)
+    collection = described_class[:label1, :label2]
+    expect(collection.choices).to eq([choice_1, choice_2])
+  end
+end

data/spec/unit/choices/pluck_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt::Choices, '#pluck' do
+  it "plucks choice by key name" do
+    collection = [{name: 'large'},{name: 'medium'},{name: 'small'}]
+    choices = described_class[*collection]
+    expect(choices.pluck(:name)).to eq(['large', 'medium', 'small'])
+  end
+end