highline_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0454ae57461089fa8b01bd5174e89e8eb71dc41c110a82bb86f4473f345bafdf
+  data.tar.gz: 34dba9a54d461b365da6de34bbd1c20611bec926df54699c2673306a9eb82828
+SHA512:
+  metadata.gz: 513c0869cf6ac26663fcab9e65cb01897875fcdd4a9d31ff9ff890728a9004a26f1503c94c374e363d99b6e1649931427c121f4a10638120cbec11e9efdd78a8
+  data.tar.gz: 85e805046f5d586303ea0286ab810d974d6a3466e57e0c794f3d61771e9a67cebf17039100490841c1716d16b79b9c88b1a0c62bea818ec73c6bdd660aaecc24

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in highline_wrapper.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+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/README.md

@@ -0,0 +1,113 @@
+# Highline Wrapper [![Main](https://github.com/emmahsax/highline_wrapper/actions/workflows/main.yml/badge.svg)](https://github.com/emmahsax/highline_wrapper/actions/workflows/main.yml)
+
+A little wrapper to help ask some easy questions via the command-line with Highline. The types of questions this wrapper supports is:
+
+* Open-ended question
+* Yes/No question
+* Multiple choice question where the user is allowed to select one answer
+* Multiple choice "checkbox" question where the user is allowed to select multiple answers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'highline_wrapper'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install highline_wrapper
+```
+
+### Usage
+
+Once this gem is installed, you can then initiate a new `HighlineWrapper` object:
+
+```ruby
+HighlineWrapper.new
+```
+
+Then, add this to the top of your file (or to your gem):
+
+```ruby
+require 'highline_wrapper'
+```
+
+Then, you can call its questions to receive answers:
+
+```ruby
+> HighlineWrapper.new.ask('What is your favorite number?')
+What is your favorite number?
+four
+=> "four"
+
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?')
+Do you like Ruby?
+no
+=> false
+
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?')
+Do you like Ruby?
+yes
+=> true
+
+HighlineWrapper.new.ask_multiple_choice('What is your favorite number of t
+hese?', ['one', 'two', 'three'])
+What is your favorite number of these?
+1. one
+2. two
+3. three
+2
+=> "two"
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?
+", ['one', 'two','three'])
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+1,3
+=> ["one", "three"]
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?
+", ['one', 'two','three'], with_indexes: true)
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+1, 3
+=> [{:choice=>"one", :index=>0}, {:choice=>"three", :index=>2}]
+```
+
+### Tests
+
+To run the tests, run `bundle exec rspec` from the command line. GitHub Actions will also run the tests upon every commit to make sure they're up to date and that everything is working correctly. Locally, you can also run `bundle exec guard` to automatically run tests as you develop!
+
+## Contributing
+
+To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmahsax/highline_wrapper/issues/new).
+
+To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmahsax/highline_wrapper/security/policy).
+
+When interacting with this repository, please follow [Contributor Covenant's Code of Conduct](https://contributor-covenant.org).
+
+## Releasing
+
+To make a new release of this gem:
+
+1. Merge the pull request via the big green button
+2. Run `git tag vX.X.X` and `git push --tag`
+3. Make a new release [here](https://github.com/emmahsax/highline_wrapper/releases/new)
+4. Run `gem build *.gemspec`
+5. Run `gem push *.gem` to push the new gem to RubyGems
+6. Run `rm *.gem` to clean up your local repository
+
+To set up your local machine to push to RubyGems via the API, see the [RubyGems documentation](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/lib/highline_wrapper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'highline'
+
+files = "#{File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'highline_wrapper'))}/**/*.rb"
+
+Dir[files].each do |file|
+  require_relative file
+end
+
+class HighlineWrapper
+  # Returns - string; the answer to the question
+  # prompt - string; the prompt for the question
+  def ask(prompt, secret: false)
+    client.ask(prompt, secret)
+  end
+
+  # Returns - boolean; yes for true, no for false
+  # prompt - string; the prompt for the question
+  # preference - boolean; whether skipping the question should return true or false
+  def ask_yes_no(prompt, preference: true)
+    client.ask_yes_no(prompt, preference)
+  end
+
+  # Returns - string OR hash; the selection
+  #   e.g. 'c'
+  # prompt - string; the prompt for the question
+  # choices - array; an array of string options
+  #   e.g. [ 'a', 'b', 'c' ]
+  # with_index - boolean; whether to return the index of the selection
+  #   e.g. { choice: 'c', index: 2 }
+  def ask_multiple_choice(prompt, choices, with_index: false)
+    client.ask_multiple_choice(prompt, choices, with_index)
+  end
+
+  # Returns - array; an array of selections
+  #   e.g. [ 'a', 'c' ]
+  # prompt - string; the prompt for the question
+  # choices - array; an array of string options
+  #   e.g. [ 'a', 'b', 'c' ]
+  # with_indexes - boolean; whether to return the indices of the selections
+  #   e.g. [ { choice: 'a', index: 0 }, { choice: 'c', index: 2 } ]
+  def ask_checkbox(prompt, choices, with_indexes: false)
+    client.ask_checkbox(prompt, choices, with_indexes)
+  end
+
+  private def client
+    @client ||= HighlineWrapper::Client.new
+  end
+end

data/lib/highline_wrapper/client.rb

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

data/lib/highline_wrapper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class HighlineWrapper
+  VERSION = '0.1.0'
+end

data/spec/highline_wrapper/client_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'highline_wrapper'
+
+describe HighlineWrapper::Client 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)
+  end
+
+  describe '#ask' do
+    it 'should ask the highline client ask' do
+      expect(highline).to receive(:ask)
+      subject.ask(Faker::Lorem.sentence, false)
+    end
+
+    it 'should return a string' do
+      expect(subject.ask(Faker::Lorem.sentence, true)).to be_a(String)
+    end
+  end
+
+  describe '#ask_yes_no' do
+    it 'should ask the highline client ask' do
+      expect(highline).to receive(:ask)
+      subject.ask_yes_no(Faker::Lorem.sentence, true)
+    end
+
+    it 'should return a boolean' do
+      expect(subject.ask_yes_no(Faker::Lorem.sentence, false)).to be_falsey
+    end
+
+    it 'should return true if we say yes' do
+      allow(response).to receive(:to_s).and_return('y')
+      expect(subject.ask_yes_no(Faker::Lorem.sentence, false)).to be_truthy
+    end
+
+    it 'should return false if we say yes' do
+      allow(response).to receive(:to_s).and_return('no')
+      expect(subject.ask_yes_no(Faker::Lorem.sentence, true)).to be_falsey
+    end
+
+    context 'when preferring true' do
+      it 'should return true if empty' do
+        allow(response).to receive(:to_s).and_return('')
+        expect(subject.ask_yes_no(Faker::Lorem.sentence, true)).to be_truthy
+      end
+
+      it 'should return false if empty' do
+        allow(response).to receive(:to_s).and_return('')
+        expect(subject.ask_yes_no(Faker::Lorem.sentence, false)).to be_falsey
+      end
+    end
+  end
+
+  describe '#ask_multiple_choice' do
+    it 'should ask the highline client ask' do
+      expect(highline).to receive(:ask)
+      subject.ask_multiple_choice(Faker::Lorem.sentence, %w[one two three], false)
+    end
+
+    context 'when not including the index' do
+      it 'should return an array of one from the options' do
+        resp = subject.ask_multiple_choice(Faker::Lorem.sentence, %w[one two three], false)
+        expect(resp).to be_a(String)
+        expect(resp).to eq('three')
+      end
+    end
+
+    context 'when including the index' do
+      it 'should return an array of two' do
+        resp = subject.ask_multiple_choice(Faker::Lorem.sentence, %w[one two three], true)
+        expect(resp).to be_a(Hash)
+        expect(resp[:choice]).to eq('three')
+        expect(resp[:index]).to eq(2)
+      end
+    end
+  end
+
+  describe '#ask_checkbox' do
+    it 'should ask the highline client ask' do
+      expect(highline).to receive(:ask).and_return('2')
+      subject.ask_checkbox(Faker::Lorem.sentence, %w[one two three], false)
+    end
+
+    context 'when not including the index' do
+      it 'should return an array of one from the options' do
+        allow(highline).to receive(:ask).and_return('1, 3')
+        resp = subject.ask_checkbox(Faker::Lorem.sentence, %w[one two three], false)
+        expect(resp).to be_a(Array)
+        expect(resp.count).to eq(2)
+        expect(resp).to include('one')
+      end
+    end
+
+    context 'when including the index' do
+      it 'should return an array of two' do
+        allow(highline).to receive(:ask).and_return('1, 3')
+        resp = subject.ask_checkbox(Faker::Lorem.sentence, %w[one two three], true)
+        expect(resp).to be_a(Array)
+        expect(resp.count).to eq(2)
+        expect(resp).to include({ choice: 'one', index: 0 })
+        expect(resp).to include({ choice: 'three', index: 2 })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'faker'
+require 'pry'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: highline_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emma Sax
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: Making it easier to ask simple questions, such as multiple choice questions,
+  yes/no questions, etc, using Highline
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/highline_wrapper.rb
+- lib/highline_wrapper/client.rb
+- lib/highline_wrapper/version.rb
+- spec/highline_wrapper/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/emmahsax/highline_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A little wrapper for Highline
+test_files:
+- spec/spec_helper.rb
+- spec/highline_wrapper/client_spec.rb