highline_wrapper 0.1.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0454ae57461089fa8b01bd5174e89e8eb71dc41c110a82bb86f4473f345bafdf
-  data.tar.gz: 34dba9a54d461b365da6de34bbd1c20611bec926df54699c2673306a9eb82828
+  metadata.gz: d0386ba9a8b59066ee480db64c43883461107598bc2305c524c0cbe4e5f036f9
+  data.tar.gz: 4aced242f9477147f29bf870f04caf1573eafc707ccd97be87282381713e8831
 SHA512:
-  metadata.gz: 513c0869cf6ac26663fcab9e65cb01897875fcdd4a9d31ff9ff890728a9004a26f1503c94c374e363d99b6e1649931427c121f4a10638120cbec11e9efdd78a8
-  data.tar.gz: 85e805046f5d586303ea0286ab810d974d6a3466e57e0c794f3d61771e9a67cebf17039100490841c1716d16b79b9c88b1a0c62bea818ec73c6bdd660aaecc24
+  metadata.gz: d756e947239db890942a54cc1ea1cbecc71e7149ee247f6ae58e6f3345a5f2adc32320433b99f68d3911cad59b9590742c67c0d1b3b9cb02787a28f98ca424f0
+  data.tar.gz: dbe4663597f917865b9ad062a646d9d46302024a365efc578d7438b8b081f4cafc6f79c45fe9db188c91acbb5d2af853fd31b1316caded14663934117d59eced

data/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright (c) 2021 Emma Sax. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 gem install highline_wrapper
 ```
 
-### Usage
+## Usage
 
 Once this gem is installed, you can then initiate a new `HighlineWrapper` object:
 
@@ -41,7 +41,25 @@ Then, add this to the top of your file (or to your gem):
 require 'highline_wrapper'
 ```
 
-Then, you can call its questions to receive answers:
+Then, you can call its questions to receive answers. There's several configuration options for each type of question. Look below for the different options for each type of question, and what they each return.
+
+### Open-ended questions
+
+Question configuration options:
+* `indicate_default_message`: defaults to `true`
+* `secret`: defaults to `false`
+* `default`: defaults to `''`
+* `required`: defaults to `false`
+
+Notes:
+* If `indicate_default_message` is `true`, then the wrapper will tell us what the default value returned is _if_ the user skips the question
+  * If `secret` is `true`, then the wrapper _may_ automatically add a newline after a skipped answer... this is automatic from HighLine and is, unfortunately, out of the wrapper's control
+* If `required` is `true`, the question will repeat until the user answers the question
+* If `required` is `true`, then the `default` value will be ignored (defaults to `''`, but could be set to whatever and the code won't care... the question is required)
+* If `default` is `''` and `required` is `false`, and the user skips the question, the answer will be `''`
+* If `secret` is `true`, then the command-line will hide the user's answer behind `*`
+
+<details><summary>Examples</summary>
 
 ```ruby
 > HighlineWrapper.new.ask('What is your favorite number?')
@@ -49,57 +67,374 @@ What is your favorite number?
 four
 => "four"
 
+> HighlineWrapper.new.ask('What is your favorite number?', {required: true})
+What is your favorite number?
+--- This question is required ---
+What is your favorite number?
+--- This question is required ---
+What is your favorite number?
+--- This question is required ---
+What is your favorite number?
+2
+=> "2"
+
+> HighlineWrapper.new.ask('What is your favorite number?', {required: true, indicate_default_message: false})
+What is your favorite number?
+--- This question is required ---
+What is your favorite number?
+--- This question is required ---
+What is your favorite number?
+5
+=> "5"
+
+> HighlineWrapper.new.ask('What is your favorite number?', {indicate_default_message: false})
+What is your favorite number?
+=> ""
+
+> HighlineWrapper.new.ask('What is your favorite color?')
+What is your favorite color?
+--- Default selected: EMPTY ---
+=> ""
+
+> HighlineWrapper.new.ask('What is your favorite color?', {default: 'orange'})
+What is your favorite color?
+--- Default selected: orange ---
+=> "orange"
+
+> HighlineWrapper.new.ask('Please type your private token:', {secret: true})
+Please type your private token?
+****************
+=> "MY-PRIVATE-TOKEN"
+
+> HighlineWrapper.new.ask('Please type your private token:', {secret: true, indicate_default_message: false})
+Please type your private token:
+
+=> ""
+
+> HighlineWrapper.new.ask('Please type your private token:', {secret: true, required: true})
+Please type your private token:
+
+--- This question is required ---
+Please type your private token:
+
+--- This question is required ---
+Please type your private token:
+****************
+=> "MY-PRIVATE-TOKEN"
+
+> HighlineWrapper.new.ask('Please type your private token:', {secret: true})
+Please type your private token:
+
+--- Default selected: HIDDEN ---
+=> ""
+```
+
+</details>
+
+### Yes/No questions
+
+Question configuration options:
+* `indicate_default_message`: defaults to `true`
+* `default`: defaults to `true` (aka 'yes')
+* `required`: defaults to `false`
+
+Notes:
+* If `indicate_default_message` is `true`, then the wrapper will tell us what the default value returned is _if_ the user skips the question
+* If `required` is `true`, the question will repeat until the user answers the question
+* If `required` is `true`, then the `default` value will be ignored (defaults to `true`, but could be set to whatever and the code won't care... the question is required)
+* If `default` is `true` and `required` is `false`, and the user skips the question, the answer will be `true`
+* The response to the question MUST be given either as `y`/`n`/`yes`/`no` or with any capitalization... anything else given as a response will be unparseable
+
+<details><summary>Examples</summary>
+
+```ruby
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?')
+Do you like Ruby?
+--- Default selected: YES ---
+=> true
+
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?', {indicate_default_message: false})
+Do you like Ruby?
+=> true
+
 > HighlineWrapper.new.ask_yes_no('Do you like Ruby?')
 Do you like Ruby?
 no
 => false
 
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?', {default: false})
+Do you like Ruby?
+--- Default selected: NO ---
+=> false
+
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?', {required: true})
+Do you like Ruby?
+--- This question is required ---
+Do you like Ruby?
+--- This question is required ---
+Do you like Ruby?
+--- This question is required ---
+Do you like Ruby?
+N
+=> false
+
 > HighlineWrapper.new.ask_yes_no('Do you like Ruby?')
 Do you like Ruby?
+uh-huh
+--- This question is required ---
+Do you like Ruby?
+YES
+=> true
+
+> HighlineWrapper.new.ask_yes_no('Do you like Ruby?')
+Do you like Ruby?
+yep
+--- This question is required ---
+Do you like Ruby?
 yes
 => true
+```
+
+</details>
+
+### Multiple choice questions
+
+Question configuration options:
+* `indicate_default_message`: defaults to `true`
+* `with_index`: defaults to `false` (particularly handy when there may be duplicate-named but different items in the list—think Sally with ID 45 and Sally with ID 72)
+* `default`: defaults to `nil`
+* `required`: defaults to `false`
+
+Notes:
+* If `indicate_default_message` is `true`, then the wrapper will tell us what the default value returned is _if_ the user skips the question
+* If `required` is `true`, the question will repeat until the user answers the question
+* If `required` is `true`, then the `default` value will be ignored (defaults to `nil`, but could be set to whatever and the code won't care... the question is required)
+* If `default` is `nil` and `required` is `false`, and the user skips the question, the answer will be `nil`
+* If `with_index` is `true`, a hash will be returned with the choice AND the index of the selection in the original `choices` array
+  * e.g. `{ value: 'c', index: 2 }`
+* If `with_index` is `false`, then a hash of one item will be returned
+  * e.g. `{ value: 'c' }`
+
+<details><summary>Examples</summary>
+
+```ruby
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'])
+What is your favorite number of these?
+1. one
+2. two
+3. three
+2
+=> {:value=>"two"}
 
-HighlineWrapper.new.ask_multiple_choice('What is your favorite number of t
-hese?', ['one', 'two', 'three'])
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {with_index: true})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+2
+=> {:value=>"two", :index=>1}
+
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {default: 'three', required: true, indicate_default_message: false})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- This question is required ---
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- This question is required ---
 What is your favorite number of these?
 1. one
 2. two
 3. three
 2
-=> "two"
+=> {:value=>"two"}
 
-> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?
-", ['one', 'two','three'])
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {with_index: true, default: 'one'})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- Default selected: 1. one ---
+=> {:value=>"one", :index=>0}
+
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {with_index: true, default: 'one', indicate_default_message: false})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+=> {:value=>"one", :index=>0}
+
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {default: 'three', required: true})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- This question is required ---
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- This question is required ---
+What is your favorite number of these?
+1. one
+2. two
+3. three
+1
+=> {:value=>"one"}
+
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {default: nil})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- Default selected: EMPTY ---
+=> nil
+
+>  HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {default: nil, with_index: true})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+--- Default selected: EMPTY ---
+=> nil
+
+> HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {default: nil, with_index: true, indicate_default_message: false})
+What is your favorite number of these?
+1. one
+2. two
+3. three
+=> nil
+```
+
+</details>
+
+### Multiple choice "checkbox" questions
+
+Question configuration options:
+* `indicate_default_message`: defaults to `true`
+* `with_indexes`: defaults to `false` (particularly handy when there may be duplicate-named but different items in the list—think Sally with ID 45 and Sally with ID 72)
+* `defaults`: defaults to `[]`
+* `required`: defaults to `false`
+
+Notes:
+* If `indicate_default_message` is `true`, then the wrapper will tell us what the default value returned is _if_ the user skips the question
+* If `required` is `true`, the question will repeat until the user answers the question
+* If `required` is `true`, then the `defaults` value will be ignored (this value is defaulting to `[]`, but could be set to whatever and the code won't care... the question is required)
+* If `defaults` is `[]` and `required` is `false`, then the method will return an empty array
+* If `with_indexes` is `true`, an array of hashes will be returned with the choice AND the index (of the selection in the original `choices` array) in each hash
+  * e.g. `[{ value: 'a', index: 0 }, { value: 'c', index: 2 }]`
+* If `with_indexes` is `false`, then an hashes will be returned where each hash only has a value
+  * e.g. `[{ value: 'a' }, { value: 'c' }]`
+
+<details><summary>Examples</summary>
+
+```ruby
+> 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"]
+1, 3
+=> [{:value=>"one"}, {:value=>"three"}]
 
-> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?
-", ['one', 'two','three'], with_indexes: true)
+> 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}]
+=> [{:value=>"one", :index=>0}, {:value=>"three", :index=>2}]
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {with_indexes: true, indicate_default_message: false})
+What are your favorite numbers of these?
+1. one
+2. two
+3. 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
+--- Defaults selected: EMPTY ---
+=> []
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {defaults: ['two', 'three']})
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+--- Defaults selected: 2. two, 3. three ---
+=> [{:value=>"two"}, {:value=>"three"}]
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {required: true, with_indexes: true})
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+--- This question is required ---
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+--- This question is required ---
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+2
+=> [{:value=>"two", :index=>1}]
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {required: true, with_indexes: false})
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+--- This question is required ---
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+1
+=> [{:value=>"one"}]
+
+> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {defaults: ['two', 'three'], with_indexes: true, indicate_default_message: false})
+What are your favorite numbers of these?
+1. one
+2. two
+3. three
+=> [{:value=>"two", :index=>1}, {:value=>"three", :index=>2}]
 ```
 
-### Tests
+</details>
+
+## 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!
+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
+---
+
+### 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).
+### Security Policy
+
+To report any security vulnerabilities, please view this repository's [Security Policy](https://github.com/emmahsax/highline_wrapper/security/policy).
+
+### Licensing
+
+For information on licensing, please see [LICENSE.md](https://github.com/emmahsax/highline_wrapper/blob/main/LICENSE.md).
+
+### Code of Conduct
 
 When interacting with this repository, please follow [Contributor Covenant's Code of Conduct](https://contributor-covenant.org).
 
-## Releasing
+### Releasing
 
 To make a new release of this gem:
 

data/lib/highline_wrapper.rb

@@ -9,42 +9,87 @@ Dir[files].each do |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)
+  # Returns: the answer to the question (string)
+  #
+  # prompt: the prompt for the question (string)
+  # options: various options to pass to the questions (hash)
+  #   indicate_default_message: whether to tell the terminal what the default value selected is if the question
+  #     is skipped (boolean - defaults to true)
+  #   secret: whether the terminal should hide the typed value (boolean - defaults to false)
+  #   default: the default selection (string - defaults to '')
+  #   required: whether the question is required or not (boolean - defaults to false)
+  def ask(prompt, options = {})
+    defaults = {
+      indicate_default_message: true,
+      secret: false,
+      default: '',
+      required: false
+    }
+    options = defaults.merge(options)
+    HighlineWrapper::OpenEndedQuestion.ask(prompt, options)
   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)
+  # Returns: yes for true, no for false (boolean)
+  #
+  # prompt: the prompt for the question (string)
+  # options: various options to pass to the questions (hash)
+  #   indicate_default_message: whether to tell the terminal what the default value selected is if the question
+  #     is skipped (boolean - defaults to true)
+  #   default: the default selection (boolean - defaults to true)
+  #   required: whether the question is required or not (boolean - defaults to false)
+  def ask_yes_no(prompt, options = {})
+    defaults = {
+      indicate_default_message: true,
+      default: true,
+      required: false
+    }
+    options = defaults.merge(options)
+    HighlineWrapper::YesNoQuestion.ask(prompt, options)
   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)
+  # Returns: the selection in a hash (hash)
+  #   e.g. { value: 'c' }
+  #   e.g. { value: 'c', index: 2 }
+  #
+  # prompt: the prompt for the question (string)
+  # choices: a list of string options (array) (e.g. [ 'a', 'b', 'c' ])
+  # options: various options to pass to the questions (hash)
+  #   indicate_default_message: whether to tell the terminal what the default value selected is if the question
+  #     is skipped (boolean - defaults to true)
+  #   with_index: whether to return the index of the selection (boolean - defaults to false)
+  #   default: the default selection if the user skips the question (string - defaults to nil)
+  #   required: whether the question is required or not (boolean - defaults to false)
+  def ask_multiple_choice(prompt, choices, options = {})
+    defaults = {
+      indicate_default_message: true,
+      with_index: false,
+      default: nil,
+      required: false
+    }
+    options = defaults.merge(options)
+    HighlineWrapper::MultipleChoiceQuestion.ask(prompt, choices, options)
   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
+  # Returns: the selections chosen as an array of hashes (array)
+  #   e.g. [{ value: 'a' }, { value: 'c' }]
+  #   e.g. [{ value: 'a', index: 0 }, { value: 'c', index: 2 }])
+  #
+  # prompt: the prompt for the question (string)
+  # choices: a list of string options (array) (e.g. [ 'a', 'b', 'c' ])
+  # options: various options to pass to the questions (hash)
+  #   indicate_default_message: whether to tell the terminal what the default value selected is if the question
+  #     is skipped (boolean - defaults to true)
+  #   with_indexes: whether to return the indexes of the selections (boolean - defaults to false)
+  #   defaults: the default selections if the user skips the question (array - defaults to [])
+  #   required: whether the question is required or not (boolean - defaults to false)
+  def ask_checkbox(prompt, choices, options = {})
+    defaults = {
+      indicate_default_message: true,
+      with_indexes: false,
+      defaults: [],
+      required: false
+    }
+    options = defaults.merge(options)
+    HighlineWrapper::CheckboxQuestion.ask(prompt, choices, options)
   end
 end