tty-prompt 0.4.0 → 0.5.0

data/lib/tty/prompt/question.rb

@@ -24,8 +24,6 @@ module TTY
 
       attr_reader :modifier
 
-      attr_reader :prompt
-
       attr_reader :validation
 
       # Initialize a Question
@@ -33,6 +31,7 @@ module TTY
       # @api public
       def initialize(prompt, options = {})
         @prompt     = prompt
+        @prefix     = options.fetch(:prefix) { @prompt.prefix }
         @default    = options.fetch(:default) { UndefinedSetting }
         @required   = options.fetch(:required) { false }
         @echo       = options.fetch(:echo) { true }
@@ -41,7 +40,8 @@ module TTY
         @validation = options.fetch(:validation) { UndefinedSetting }
         @read       = options.fetch(:read) { UndefinedSetting }
         @convert    = options.fetch(:convert) { UndefinedSetting }
-        @color      = options.fetch(:color) { :green }
+        @active_color = options.fetch(:active_color) { @prompt.active_color }
+        @help_color = options.fetch(:help_color) { @prompt.help_color }
         @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
         @done       = false
         @input      = nil
@@ -115,15 +115,13 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{prompt.prefix}#{message} "
-        if @convert == :bool && !@done
-          header += @prompt.decorate('(Y/n)', :bright_black) + ' '
-        elsif !echo?
+        header = "#{@prefix}#{message} "
+        if !echo?
           header
         elsif @done
-          header += @prompt.decorate("#{@input}", @color)
-        elsif default?
-          header += @prompt.decorate("(#{default})", :bright_black) + ' '
+          header += @prompt.decorate("#{@input}", @active_color)
+        elsif default? && !Utils.blank?(@default)
+          header += @prompt.decorate("(#{default})", @help_color) + ' '
         end
         @prompt.print(header)
         @prompt.print("\n") if @done

data/lib/tty/prompt/slider.rb

@@ -14,13 +14,15 @@ module TTY
       # @api public
       def initialize(prompt, options = {})
         @prompt       = prompt
-        @first_render = true
-        @done         = false
-        @color        = options.fetch(:color) { :green }
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
         @min          = options.fetch(:min) { 0 }
         @max          = options.fetch(:max) { 10 }
         @step         = options.fetch(:step) { 1 }
         @default      = options[:default]
+        @active_color = options.fetch(:active_color) { @prompt.active_color }
+        @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @first_render = true
+        @done         = false
 
         @prompt.subscribe(self)
       end
@@ -133,7 +135,7 @@ module TTY
       #
       # @api private
       def render_question
-        header = "#{@prompt.prefix}#{@question} #{render_header}"
+        header = "#{@prefix}#{@question} #{render_header}"
         @prompt.puts(header)
         @first_render = false
         @prompt.print(render_slider) unless @done
@@ -144,9 +146,9 @@ module TTY
       # @api private
       def render_header
         if @done
-          @prompt.decorate(render_answer.to_s, @color)
+          @prompt.decorate(render_answer.to_s, @active_color)
         elsif @first_render
-          @prompt.decorate(HELP, :bright_black)
+          @prompt.decorate(HELP, @help_color)
         end
       end
 
@@ -159,7 +161,7 @@ module TTY
         output = ''
         output << Symbols::SLIDER_END
         output << '-' * @active
-        output << @prompt.decorate(Symbols::SLIDER_HANDLE, @color)
+        output << @prompt.decorate(Symbols::SLIDER_HANDLE, @active_color)
         output << '-' * (range.size - @active - 1)
         output << Symbols::SLIDER_END
         output << " #{range[@active]}"

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end # Prompt
 end # TTY

data/spec/unit/ask_spec.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt, '#ask' do
+
   subject(:prompt) { TTY::TestPrompt.new }
 
   it 'asks question' do
@@ -54,4 +55,71 @@ RSpec.describe TTY::Prompt, '#ask' do
       "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[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "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[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "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[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "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[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      "[?] What is your name? \e[36mPiotr\e[0m\n",
+      ":-) What is your name? ",
+      "\e[1000D\e[K\e[1A",
+      "\e[1000D\e[K",
+      ":-) What is your name? \e[34mPiotr\e[0m\n"
+    ].join)
+  end
 end

data/spec/unit/choice/from_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 RSpec.describe TTY::Prompt::Choice, '#from' do
-  it "creates choice from choice" do
+  it "skips Choice instance" do
     choice = described_class.new(:large, 1)
     expect(described_class.from(choice)).to eq(choice)
   end
@@ -20,4 +20,10 @@ RSpec.describe TTY::Prompt::Choice, '#from' do
     choice = described_class.new('large', 1)
     expect(described_class.from({large: 1})).to eq(choice)
   end
+
+  it "create choice from hash with key property" do
+    default = {key: 'h', name: 'Help', value: :help}
+    choice = described_class.new('Help', :help)
+    expect(described_class.from(default)).to eq(choice)
+  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/pluck_spec.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-RSpec.describe TTY::Prompt::Choices, '.pluck' do
-  it "plucks choice from collection by name" do
-    collection = %w(large medium small)
+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('medium').name).to eq('medium')
+    expect(choices.pluck(:name)).to eq(['large', 'medium', 'small'])
   end
 end

data/spec/unit/collect_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, '#collect' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  it "collects more than one answer" do
+    prompt.input << "Piotr\r30\rStreet\rCity\r123\r"
+    prompt.input.rewind
+
+    result = prompt.collect do
+      key(:name).ask('Name?')
+
+      key(:age).ask('Age?', convert: :int)
+
+      key(:address) do
+        key(:street).ask('Street?', required: true)
+        key(:city).ask('City?')
+        key(:zip).ask('Zip?', validate: /\A\d{3}\Z/)
+      end
+    end
+
+    expect(result).to include({
+      name: 'Piotr',
+      age: 30,
+      address: {
+        street: 'Street',
+        city: 'City',
+        zip: '123'
+      }
+    })
+  end
+end

data/spec/unit/converters/convert_bool_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe TTY::Prompt::Question, 'convert bool' do
     response = prompt.ask('Do you read books?', convert: :bool, default: true)
     expect(response).to eql(true)
     expect(prompt.output.string).to eq([
-      "Do you read books? \e[90m(Y/n)\e[0m ",
+      "Do you read books? \e[90m(true)\e[0m ",
       "\e[1000D\e[K\e[1A",
       "\e[1000D\e[K",
       "Do you read books? \e[32mtrue\e[0m\n"

data/spec/unit/enum_select_spec.rb

@@ -16,7 +16,8 @@ RSpec.describe TTY::Prompt do
       "  2) /usr/bin/vim.basic\n",
       "  3) /usr/bin/vim.tiny\n",
       "  Choose 1-3 [1]: ",
-      "\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[1A\e[1000D\e[K\e[J",
+      "\e[1000D\e[K\e[1A" * 4,
+      "\e[1000D\e[K\e[J",
       "Select an editor? \e[32m/bin/nano\e[0m\n"
     ].join)
   end
@@ -90,4 +91,22 @@ RSpec.describe TTY::Prompt do
       "Select an editor? \e[32mvim\e[0m\n"
     ].join)
   end
+
+  it "changes colors for selection, hint and error" do
+    choices = %w(/bin/nano /usr/bin/vim.basic /usr/bin/vim.tiny)
+    prompt.input << "\n"
+    prompt.input.rewind
+    options = {active_color: :red, help_color: :blue, error_color: :green}
+    expect(prompt.enum_select("Select an editor?", choices, options)).to eq('/bin/nano')
+    expect(prompt.output.string).to eq([
+      "Select an editor? \n",
+      "\e[31m  1) /bin/nano\e[0m\n",
+      "  2) /usr/bin/vim.basic\n",
+      "  3) /usr/bin/vim.tiny\n",
+      "  Choose 1-3 [1]: ",
+      "\e[1000D\e[K\e[1A" * 4,
+      "\e[1000D\e[K\e[J",
+      "Select an editor? \e[31m/bin/nano\e[0m\n"
+    ].join)
+  end
 end

data/spec/unit/expand_spec.rb

@@ -0,0 +1,198 @@
+# encoding: utf-8
+
+RSpec.describe TTY::Prompt, '#expand' do
+
+  subject(:prompt) { TTY::TestPrompt.new }
+
+  let(:choices) {
+    [{
+      key: 'y',
+      name: 'Overwrite',
+      value: :yes
+    }, {
+      key: 'n',
+      name: 'Skip',
+      value: :no
+    }, {
+      key: 'a',
+      name: 'Overwrite all',
+      value: :all
+    }, {
+      key: 'd',
+      name: 'Show diff',
+      value: :diff
+    }, {
+      key: 'q',
+      name: 'Quit',
+      value: :quit
+    }]
+  }
+
+  it "expands default option" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices)
+    expect(result).to eq(:yes)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? \e[32mOverwrite\e[0m\n"
+    ].join)
+  end
+
+  it "changes default option" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices, default: 3)
+    expect(result).to eq(:all)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,\e[32ma\e[0m,d,q,h] ",
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? \e[32mOverwrite all\e[0m\n"
+    ].join)
+  end
+
+  it "expands chosen option with extra information" do
+    prompt.input << "a\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices)
+    expect(result).to eq(:all)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,\e[32ma\e[0m,d,q,h] ",
+      "a\n",
+      "\e[32m>> \e[0mOverwrite all",
+      "\e[F\e[55C",
+      "\e[1000D\e[K",
+      "\e[1B",
+      "\e[1000D\e[K",
+      "\e[F",
+      "Overwrite Gemfile? \e[32mOverwrite all\e[0m\n"
+    ].join)
+  end
+
+  it "expands help option and then defaults" do
+    prompt.input << "h\nd\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?', choices)
+    expect(result).to eq(:diff)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,d,q,\e[32mh\e[0m] h\n",
+      "\e[32m>> \e[0mprint help",
+      "\e[F\e[55C",
+      "\e[1000D\e[K",
+      "\e[1B",
+      "\e[1000D\e[K",
+      "\e[F",
+      "Overwrite Gemfile? \n",
+      "  y - Overwrite\n",
+      "  n - Skip\n",
+      "  a - Overwrite all\n",
+      "  d - Show diff\n",
+      "  q - Quit\n",
+      "  h - print help\n",
+      "  Choice [y]: ",
+      "\e[1000D\e[K\e[1A" * 7,
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? \n",
+      "  y - Overwrite\n",
+      "  n - Skip\n",
+      "  a - Overwrite all\n",
+      "  \e[32md - Show diff\e[0m\n",
+      "  q - Quit\n",
+      "  h - print help\n",
+      "  Choice [y]: d",
+      "\e[1000D\e[K\e[1A" * 7,
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? \e[32mShow diff\e[0m\n",
+    ].join)
+  end
+
+  it "specifies options through DSL" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?') do |q|
+      q.default 4
+
+      q.choice key: 'y', name: 'Overwrite',     value: :yes
+      q.choice key: 'n', name: 'Skip',          value: :no
+      q.choice key: 'a', name: 'Overwrite all', value: :all
+      q.choice key: 'd', name: 'Show diff',     value: :diff
+      q.choice key: 'q', name: 'Quit',          value: :quit
+    end
+
+    expect(result).to eq(:diff)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [y,n,a,\e[32md\e[0m,q,h] ",
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? \e[32mShow diff\e[0m\n"
+    ].join)
+  end
+
+  it "specifies options through DSL and executes value" do
+    prompt.input << "\n"
+    prompt.input.rewind
+
+    result = prompt.expand('Overwrite Gemfile?') do |q|
+      q.choice key: 'y', name: 'Overwrite'      do :ok end
+      q.choice key: 'n', name: 'Skip',          value: :no
+      q.choice key: 'a', name: 'Overwrite all', value: :all
+      q.choice key: 'd', name: 'Show diff',     value: :diff
+      q.choice key: 'q', name: 'Quit',          value: :quit
+    end
+
+    expect(result).to eq(:ok)
+
+    expect(prompt.output.string).to eq([
+      "Overwrite Gemfile? (enter \"h\" for help) [\e[32my\e[0m,n,a,d,q,h] ",
+      "\e[1000D\e[K",
+      "Overwrite Gemfile? \e[32mOverwrite\e[0m\n"
+    ].join)
+  end
+
+  it "fails to expand due to lack of key attribute" do
+    choices = [{ name: 'Overwrite', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice Overwrite is missing a :key attribute/)
+  end
+
+  it "fails to expand due to wrong key length" do
+    choices = [{ key: 'long', name: 'Overwrite', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice key `long` is more than one character long/)
+  end
+
+  it "fails to expand due to reserve key" do
+    choices = [{ key: 'h', name: 'Overwrite', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice key `h` is reserved for help menu/)
+  end
+
+  it "fails to expand due to duplicate key" do
+    choices = [{ key: 'y', name: 'Overwrite', value: :yes },
+               { key: 'y', name: 'Change', value: :yes }]
+
+    expect {
+      prompt.expand('Overwrite Gemfile?', choices)
+    }.to raise_error(TTY::Prompt::ConfigurationError, /Choice key `y` is a duplicate/)
+  end
+end