tty-prompt 0.1.0

data/spec/unit/response/read_char_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read_char' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt) { TTY::Prompt.new(input, output) }
+
+  it 'reads single character' do
+    input << "abcde"
+    input.rewind
+    q = prompt.ask("What is your favourite letter?")
+    expect(q.read_char).to eql "a"
+  end
+end

data/spec/unit/response/read_date_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read_date' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt) { TTY::Prompt.new(input, output) }
+
+  it 'reads date' do
+    input << "20th April 1887"
+    input.rewind
+    q = prompt.ask("When were your born?")
+    answer = q.read_date
+    expect(answer).to be_kind_of Date
+    expect(answer.day).to eql 20
+    expect(answer.month).to eql 4
+    expect(answer.year).to eql 1887
+  end
+end

data/spec/unit/response/read_email_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read_email' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt) { TTY::Prompt.new(input, output) }
+
+  context 'with valid email' do
+    it 'reads empty' do
+      input << ""
+      input.rewind
+      q = prompt.ask("What is your email?")
+      expect(q.read_email).to eql(nil)
+    end
+
+    it 'reads valid email' do
+      input << "piotr@example.com"
+      input.rewind
+      q = prompt.ask("What is your email?")
+      expect(q.read_email).to eql "piotr@example.com"
+    end
+  end
+
+  context 'with invalid email' do
+    it 'fails to read invalid email' do
+      input << "this will@neverwork"
+      input.rewind
+      q = prompt.ask("What is your email?")
+      expect { q.read_email }.to raise_error(TTY::Prompt::InvalidArgument)
+    end
+
+    it 'reads invalid and asks again' do
+      input << "this will@neverwork\nthis.will@example.com"
+      input.rewind
+      q = prompt.ask("What is your email?").on_error(:retry)
+      expect(q.read_email).to eql "this.will@example.com"
+      expect(output.string).to eql "What is your email?\nWhat is your email?\n"
+    end
+  end
+end

data/spec/unit/response/read_multiple_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read_multiple' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt) { TTY::Prompt.new(input, output) }
+
+  it 'reads multiple lines' do
+    input << "First line\nSecond line\nThird line"
+    input.rewind
+    q = prompt.ask("Provide description?")
+    expect(q.read_multiple).to eq("First line\nSecond line\nThird line")
+  end
+
+  it 'terminates on empty lines' do
+    input << "First line\n\nSecond line"
+    input.rewind
+    q = prompt.ask("Provide description?")
+    expect(q.read_multiple).to eq("First line\n")
+  end
+end

data/spec/unit/response/read_number_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read_numbers' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt) { TTY::Prompt.new(input, output) }
+
+  it 'reads integer' do
+    input << 35
+    input.rewind
+    q = prompt.ask("What temperature?")
+    answer = q.read_int
+    expect(answer).to be_kind_of Integer
+    expect(answer).to eql 35
+  end
+
+  it 'reads float' do
+    number = 6.666
+    input << number
+    input.rewind
+    q = prompt.ask("How tall are you?")
+    answer = q.read_float
+    expect(answer).to be_kind_of Float
+    expect(answer).to eql number
+  end
+end

data/spec/unit/response/read_range_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read_range' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt)  { TTY::Prompt.new(input, output) }
+
+  it 'converts with valid range' do
+    input << "20-30"
+    input.rewind
+    response = prompt.ask("Which age group?").read_range
+
+    expect(response).to be_kind_of Range
+    expect(response).to eql (20..30)
+  end
+
+  it "fails to convert to range" do
+    input << "abcd"
+    input.rewind
+    expect {
+      prompt.ask("Which age group?").read_range
+    }.to raise_error(Necromancer::ConversionTypeError)
+  end
+end

data/spec/unit/response/read_spec.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#read' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt) { TTY::Prompt.new(input, output) }
+
+  context 'with no mask' do
+    it 'asks with echo on' do
+      input << "password"
+      input.rewind
+      q = prompt.ask("What is your password: ").echo(true)
+      expect(q.read).to eql("password")
+      expect(output.string).to eql('What is your password: ')
+      expect(q.mask?).to eq(false)
+    end
+
+    it 'asks with echo off' do
+      input << "password"
+      input.rewind
+      q = prompt.ask("What is your password: ").echo(false)
+      expect(q.read).to eql("password")
+      expect(output.string).to eql('What is your password: ')
+      expect(q.mask?).to eq(false)
+    end
+  end
+
+  context 'with mask' do
+    it 'masks output with character' do
+      input << "password\n"
+      input.rewind
+      q = prompt.ask("What is your password: ").mask('*')
+      expect(q.read).to eql("password")
+      expect(output.string).to eql('What is your password: ********')
+      expect(q.mask?).to eq(true)
+    end
+
+    it 'ignores mask if echo is off' do
+      input << "password"
+      input.rewind
+      q = prompt.ask("What is your password: ").echo(false).mask('*')
+      expect(q.read).to eql("password")
+      expect(output.string).to eql('What is your password: ')
+      expect(q.mask?).to eq(true)
+    end
+  end
+
+  context 'with mask and echo as options' do
+    it 'asks with options' do
+      input << "password"
+      input.rewind
+      q = prompt.ask("What is your password: ", echo: false, mask: '*')
+      expect(q.read).to eq("password")
+    end
+
+    it 'asks with block' do
+      input << "password"
+      input.rewind
+      q = prompt.ask "What is your password: " do
+        echo  false
+        mask '*'
+      end
+      expect(q.read).to eq("password")
+    end
+  end
+end

data/spec/unit/response/read_string_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Question, '#initialize' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:prompt)  { TTY::Prompt.new(input, output) }
+
+  it 'reads string' do
+    name = "Piotr"
+    input << name
+    input.rewind
+    q = prompt.ask("What is your name?")
+    answer = q.read_string
+    expect(answer).to be_kind_of String
+    expect(answer).to eql name
+  end
+end

data/spec/unit/say_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt, '#say' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:color)  { Pastel.new(enabled: true) }
+
+  subject(:prompt) { described_class.new(input, output) }
+
+  before { allow(Pastel).to receive(:new).and_return(color) }
+
+  after { output.rewind }
+
+  it 'prints an empty message' do
+    prompt.say ""
+    expect(output.string).to eql ""
+  end
+
+  context 'with new line' do
+    it 'prints a message with newline' do
+      prompt.say "Hell yeah!\n"
+      expect(output.string).to eql "Hell yeah!\n"
+    end
+
+    it 'prints a message with implicit newline' do
+      prompt.say "Hell yeah!\n"
+      expect(output.string).to eql "Hell yeah!\n"
+    end
+
+    it 'prints a message with newline within text' do
+      prompt.say "Hell\n yeah!"
+      expect(output.string).to eql "Hell\n yeah!\n"
+    end
+
+    it 'prints a message with newline within text and blank space' do
+      prompt.say "Hell\n yeah! "
+      expect(output.string).to eql "Hell\n yeah! "
+    end
+
+    it 'prints a message without newline' do
+      prompt.say "Hell yeah!", newline: false
+      expect(output.string).to eql "Hell yeah!"
+    end
+  end
+
+  context 'with tab or space' do
+    it 'prints ' do
+      prompt.say "Hell yeah!\t"
+      expect(output.string).to eql "Hell yeah!\t"
+    end
+  end
+
+  context 'with color' do
+    it 'prints message with ansi color' do
+      prompt.say "Hell yeah!", color: :green
+      expect(output.string).to eql "\e[32mHell yeah!\e[0m\n"
+    end
+
+    it 'prints message with ansi color without newline' do
+      prompt.say "Hell yeah! ", color: :green
+      expect(output.string).to eql "\e[32mHell yeah! \e[0m"
+    end
+  end
+end

data/spec/unit/statement/initialize_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt::Statement, '#new' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:shell) { TTY::Prompt.new(input, output) }
+
+  it "forces newline after the prompt message" do
+    statement = described_class.new
+    expect(statement.newline).to eq(true)
+  end
+
+  it "displays prompt message in color" do
+    statement = described_class.new
+    expect(statement.color).to eq(false)
+  end
+end

data/spec/unit/suggest_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt, '#suggest' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:possible) { %w(status stage stash commit branch blame) }
+
+  subject(:prompt) { described_class.new(input, output) }
+
+  after { output.rewind }
+
+  it 'suggests few matches' do
+    prompt.suggest('sta', possible)
+    expect(output.string).to eql("Did you mean one of these?\n        stage\n        stash\n")
+  end
+
+  it 'suggests a single match for one character' do
+    prompt.suggest('b', possible)
+    expect(output.string).to eql("Did you mean this?\n        blame\n")
+  end
+
+  it 'suggests a single match for two characters' do
+    prompt.suggest('co', possible)
+    expect(output.string).to eql("Did you mean this?\n        commit\n")
+  end
+
+  it 'suggests with different text and indentation' do
+    prompt.suggest('b', possible, indent: 4, single_text: 'Perhaps you meant?')
+    expect(output.string).to eql("Perhaps you meant?\n    blame\n")
+  end
+end

data/spec/unit/warn_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::Prompt, '#warn' do
+  let(:input)  { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:color)  { Pastel.new(enabled: true) }
+
+  subject(:prompt) { TTY::Prompt.new(input, output) }
+
+  before { allow(Pastel).to receive(:new).and_return(color) }
+
+  after { output.rewind }
+
+  it 'displays one message' do
+    prompt.warn "Careful young apprentice!"
+    expect(output.string).to eql "\e[33mCareful young apprentice!\e[0m\n"
+  end
+
+  it 'displays many messages' do
+    prompt.warn "Careful there!", "It's dangerous!"
+    expect(output.string).to eql "\e[33mCareful there!\e[0m\n\e[33mIt's dangerous!\e[0m\n"
+  end
+
+  it 'displays message with option' do
+    prompt.warn "Careful young apprentice!", newline: false
+    expect(output.string).to eql "\e[33mCareful young apprentice!\e[0m"
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,10 @@
+# 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

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