highline_wrapper 0.1.0 → 1.2.2

data/spec/highline_wrapper/open_ended_question_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'highline_wrapper'
+
+describe HighlineWrapper::OpenEndedQuestion do
+  let(:response) { double(:response, readline: true, to_i: 3) }
+  let(:highline) { double(:highline_cli, ask: response) }
+
+  before do
+    allow(HighLine).to receive(:new).and_return(highline)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    HighlineWrapper::OpenEndedQuestion.instance_variable_set('@highline', nil)
+  end
+
+  subject { HighlineWrapper::OpenEndedQuestion }
+
+  context 'with the options as defaults' do
+    let(:options) do
+      {
+        indicate_default_message: true,
+        secret: false,
+        default: '',
+        required: false
+      }
+    end
+
+    it 'should ask the highline client ask' do
+      expect(highline).to receive(:ask)
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+
+    it 'should return the value the user selects' do
+      answer = Faker::Lorem.sentence
+      allow(highline).to receive(:ask).and_return(answer)
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(answer)
+    end
+
+    it 'should return empty string if the user skips' do
+      allow(highline).to receive(:ask).and_return('')
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq('')
+    end
+
+    it 'should call to print the default message' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject).to receive(:print_default_message)
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+  end
+
+  context 'with required set to true' do
+    let(:options) do
+      {
+        secret: false,
+        default: 'something-goes-here',
+        required: true
+      }
+    end
+
+    it 'should return the value the user selects' do
+      answer = Faker::Lorem.sentence
+      allow(highline).to receive(:ask).and_return(answer)
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(answer)
+    end
+
+    it 'should recurse multiple times if the user skips' do
+      allow(highline).to receive(:ask).and_return('', '', Faker::Lorem.sentence)
+      expect(subject).to receive(:ask).exactly(3).times.and_call_original
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+  end
+
+  context 'with the default set and the required set to false' do
+    let(:default_string) { Faker::Lorem.sentence }
+    let(:options) do
+      {
+        indicate_default_message: false,
+        secret: false,
+        default: default_string,
+        required: false
+      }
+    end
+
+    it 'should return the value the user selects' do
+      answer = Faker::Lorem.sentence
+      allow(highline).to receive(:ask).and_return(answer)
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(answer)
+    end
+
+    it 'should return the default value the user skips' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject.ask(Faker::Lorem.sentence, options)).to eq(default_string)
+    end
+
+    it 'should not call to print the default message' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject).not_to receive(:print_default_message)
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+  end
+end

data/spec/highline_wrapper/question_spec.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'highline_wrapper'
+
+describe HighlineWrapper::Question do
+  let(:response) { double(:response, readline: true, to_i: 3) }
+  let(:highline) { double(:highline_cli, ask: response) }
+
+  before do
+    allow(HighLine).to receive(:new).and_return(highline)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    HighlineWrapper::Question.instance_variable_set('@highline', nil)
+  end
+
+  subject { HighlineWrapper::Question }
+
+  describe '#highline' do
+    it 'should start a new highline client' do
+      expect(HighLine).to receive(:new)
+      subject.send(:highline)
+    end
+  end
+
+  describe '#ask_highline' do
+    it 'should ask the highline client a question' do
+      expect(HighLine).to receive(:new)
+      subject.send(:ask_highline, Faker::Lorem.sentence)
+    end
+
+    it 'should accept an optional secret parameter' do
+      expect(HighLine).to receive(:new)
+      subject.send(:ask_highline, Faker::Lorem.sentence, secret: true)
+    end
+  end
+
+  describe '#format_options' do
+    it 'should format the prompt and choices into a single string with new lines' do
+      response = "Prompt\n1. Choice 1\n2. Choice 2"
+      expect(subject.format_options('Prompt', ['Choice 1', 'Choice 2'])).to eq(response)
+    end
+  end
+
+  describe '#format_selection' do
+    let(:choices) { %w[one two three] }
+    let(:index) { 1 }
+
+    context 'with_index as false' do
+      it 'should format the selection based on the index into a hash' do
+        expect(subject.format_selection(choices, index, false)).to eq({ value: 'two' })
+      end
+    end
+
+    context 'with_index as true' do
+      it 'should format the selection based on the index into a hash' do
+        expect(subject.format_selection(choices, index, true)).to eq({ value: 'two', index: 1 })
+      end
+    end
+  end
+
+  describe '#should print out a message indicating EMPTY was selected, and return the defaults' do
+    context 'when default message is true' do
+      let(:options) do
+        {
+          defaults: :default,
+          indicate_default_message: true
+        }
+      end
+
+      it 'should return the default in the options' do
+        expect(subject.send(:return_empty_defaults, options)).to eq(:default)
+      end
+
+      it 'should puts a message' do
+        expect(subject).to receive(:puts)
+        expect(subject.send(:return_empty_defaults, options)).to eq(:default)
+      end
+    end
+
+    context 'when default message is false' do
+      let(:options) do
+        {
+          defaults: :default,
+          indicate_default_message: false
+        }
+      end
+
+      it 'should return the default in the options' do
+        expect(subject.send(:return_empty_defaults, options)).to eq(:default)
+      end
+
+      it 'should not puts a message' do
+        expect(subject).not_to receive(:puts)
+        expect(subject.send(:return_empty_defaults, options)).to eq(:default)
+      end
+    end
+
+    context 'when a singular default is present, but not plural' do
+      let(:options) do
+        {
+          default: :default,
+          indicate_default_message: false
+        }
+      end
+
+      it 'should return the default in the options' do
+        expect(subject.send(:return_empty_defaults, options)).to eq(:default)
+      end
+    end
+  end
+end

data/spec/highline_wrapper/yes_no_question_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'highline_wrapper'
+
+describe HighlineWrapper::YesNoQuestion do
+  let(:response) { double(:response, readline: true, to_i: 3) }
+  let(:highline) { double(:highline_cli, ask: response) }
+
+  before do
+    allow(HighLine).to receive(:new).and_return(highline)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    HighlineWrapper::YesNoQuestion.instance_variable_set('@highline', nil)
+  end
+
+  subject { HighlineWrapper::YesNoQuestion }
+
+  context 'with the options as defaults' do
+    let(:options) do
+      {
+        indicate_default_message: true,
+        default: true,
+        required: false
+      }
+    end
+
+    it 'should ask the highline client ask' do
+      expect(highline).to receive(:ask).and_return('Y')
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+
+    it 'should return the value the user selects' do
+      allow(highline).to receive(:ask).and_return('n')
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(false)
+    end
+
+    it 'should return true if the user skips' do
+      allow(highline).to receive(:ask).and_return('')
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(true)
+    end
+
+    it 'should call to print the default message' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject).to receive(:print_default_message)
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+
+    it 'should recurse if the answer given is unparseable' do
+      allow(highline).to receive(:ask).and_return('yep', 'yessss', 'yes')
+      expect(subject).to receive(:recurse).exactly(2).times.and_call_original
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+  end
+
+  context 'with required set to true' do
+    let(:options) do
+      {
+        default: false,
+        required: true
+      }
+    end
+
+    it 'should return the value the user selects' do
+      allow(highline).to receive(:ask).and_return('y')
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(true)
+    end
+
+    it 'should recurse multiple times if the user skips' do
+      allow(highline).to receive(:ask).and_return('', '', 'y')
+      expect(subject).to receive(:ask).exactly(3).times.and_call_original
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+  end
+
+  context 'with required set to false' do
+    let(:options) do
+      {
+        indicate_default_message: false,
+        default: false,
+        required: false
+      }
+    end
+
+    it 'should return the value the user selects' do
+      allow(highline).to receive(:ask).and_return('y')
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(true)
+    end
+
+    it 'should return the default if the user skips' do
+      allow(highline).to receive(:ask).and_return('')
+      resp = subject.ask(Faker::Lorem.sentence, options)
+      expect(resp).to eq(false)
+    end
+
+    it 'should not call to print the default message' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject).not_to receive(:print_default_message)
+      subject.ask(Faker::Lorem.sentence, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highline_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -112,18 +112,18 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
 description: Making it easier to ask simple questions, such as multiple choice questions,
-  yes/no questions, etc, using Highline
+  yes/no questions, etc, using HighLine
 email:
 executables: []
 extensions: []
@@ -131,17 +131,25 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Guardfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/highline_wrapper.rb
-- lib/highline_wrapper/client.rb
+- lib/highline_wrapper/checkbox_question.rb
+- lib/highline_wrapper/multiple_choice_question.rb
+- lib/highline_wrapper/open_ended_question.rb
+- lib/highline_wrapper/question.rb
 - lib/highline_wrapper/version.rb
-- spec/highline_wrapper/client_spec.rb
+- lib/highline_wrapper/yes_no_question.rb
+- spec/highline_wrapper/checkbox_question_spec.rb
+- spec/highline_wrapper/multiple_choice_question_spec.rb
+- spec/highline_wrapper/open_ended_question_spec.rb
+- spec/highline_wrapper/question_spec.rb
+- spec/highline_wrapper/yes_no_question_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/emmahsax/highline_wrapper
 licenses:
-- MIT
+- BSD-3-Clause
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -158,10 +166,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: A little wrapper for Highline
+summary: A little wrapper for HighLine
 test_files:
 - spec/spec_helper.rb
-- spec/highline_wrapper/client_spec.rb
+- spec/highline_wrapper/checkbox_question_spec.rb
+- spec/highline_wrapper/multiple_choice_question_spec.rb
+- spec/highline_wrapper/open_ended_question_spec.rb
+- spec/highline_wrapper/question_spec.rb
+- spec/highline_wrapper/yes_no_question_spec.rb

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2021 Emma Sax
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/highline_wrapper/client.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-class HighlineWrapper
-  class Client
-    def ask(prompt, secret)
-      highline.ask(prompt) do |conf|
-        conf.readline = true
-        if secret
-          conf.echo = false
-          conf.echo = '*'
-        end
-      end.to_s
-    end
-
-    def ask_yes_no(prompt, preference)
-      answer = highline.ask(prompt) do |conf|
-        conf.readline = true
-      end.to_s
-
-      answer.empty? ? preference : !!(answer =~ /^y/i)
-    end
-
-    def ask_multiple_choice(prompt, choices, with_index)
-      index = highline.ask(format_options(prompt, choices)) do |conf|
-        conf.readline = true
-      end.to_i - 1
-
-      if with_index
-        { choice: choices[index], index: index }
-      else
-        choices[index]
-      end
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
-    def ask_checkbox(prompt, choices, provide_indices)
-      indices = []
-      selected = []
-
-      answer = highline.ask(format_options(prompt, choices)) do |conf|
-        conf.readline = true
-      end
-
-      answer.split(',').each { |i| indices << i.strip.to_i - 1 }
-
-      if provide_indices
-        indices.each { |index| selected << { choice: choices[index], index: index } }
-      else
-        indices.each { |index| selected << choices[index] }
-      end
-
-      selected
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-
-    private def format_options(prompt, choices)
-      choices_as_string_options = ''.dup
-      choices.each_with_index { |choice, index| choices_as_string_options << "#{index + 1}. #{choice}\n" }
-      "#{prompt}\n#{choices_as_string_options.strip}"
-    end
-
-    private def highline
-      @highline ||= HighLine.new
-    end
-  end
-end