highline_wrapper 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ce70d5eeb141d2b2440550b66335dc2e94a69acd4a0a214fea5dd78506b0bf8
-  data.tar.gz: e88f0e2c78bba7f92aec919a21326d75ac84b324c5ff3c0c2b5177346605bb62
+  metadata.gz: 380bac98137ba1ffb3ffded9336dc97b0b92b6f75f152a20cbc7355ce601feb9
+  data.tar.gz: 6ff8a1a2cf154e7f7cfa9b9937aa17ece09b0ccb3dfc168c258d068fe0a6a8ca
 SHA512:
-  metadata.gz: ae702cfaa01941f91f445145af9f4143a234f3ef9c41cec601454fa75a1b0268b9ffa70a2384b236472b916281e2dac38c8721791c5b1d7c60029b1b135949f2
-  data.tar.gz: 3891869ced3281e666861618dae0f43f81eff9f62c1a8cfd26d4e67758085585fe33595918b484fdf67fdf13ed1b7e013de82730229bf8c8d4fed39e5afc0981
+  metadata.gz: 79b809ec51c6db6122bf12ed43c14eef0f24ea14d9e9f9166f0e648fb9a45698645f91a368e36fd2e230a3f45655847a9438126584b8b8f941723d150191c546
+  data.tar.gz: 926256c87d483ee1a5b2024271a59e7df2acbaef72c19461827cfa6e69e20cfa35de366cd2eea7ee322dce0c1ead6bbe6c229bd5918a1d79e80f972e9358e634

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    highline_wrapper (1.0.0)
+    highline_wrapper (1.3.0)
       highline (~> 2.0)
 
 GEM
@@ -9,13 +9,13 @@ GEM
   specs:
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    faker (2.16.0)
+    faker (2.18.0)
       i18n (>= 1.6, < 2)
-    ffi (1.14.2)
-    formatador (0.2.5)
-    guard (2.16.2)
+    ffi (1.15.3)
+    formatador (0.3.0)
+    guard (2.17.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -30,9 +30,9 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     highline (2.0.3)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    listen (3.4.1)
+    listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -42,18 +42,17 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -67,24 +66,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    rubocop (1.18.2)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     shellany (0.0.1)
     thor (1.1.0)
     unicode-display_width (2.0.0)
 
 PLATFORMS
-  x86_64-darwin-20
+  x86_64-darwin-19
 
 DEPENDENCIES
   bundler (~> 2.2)
@@ -92,9 +91,8 @@ DEPENDENCIES
   guard-rspec (~> 4.3)
   highline_wrapper!
   pry (~> 0.13)
-  rake (~> 13.0)
   rspec (~> 3.9)
   rubocop (~> 1.10)
 
 BUNDLED WITH
-   2.2.4
+   2.2.21

data/Guardfile

@@ -2,6 +2,6 @@
 
 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(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { 'spec' }
 end

data/LICENSE.md

@@ -0,0 +1,29 @@
+BSD 3-Clause "New" or "Revised" License
+
+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

@@ -46,66 +46,87 @@ Then, you can call its questions to receive answers. There's several configurati
 ### 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?')
 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.
-
+--- This question is required ---
 What is your favorite number?
-
-This question is required.
-
+--- 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('What is your private token?', {secret: true, required: true})
-What is your private token?
-
-This question is required.
+> HighlineWrapper.new.ask('Please type your private token:', {secret: true, indicate_default_message: false})
+Please type your private token:
 
-What is your private token?
-
-This question is required.
+=> ""
 
-What is your private token?
+> HighlineWrapper.new.ask('Please type your private token:', {secret: true, required: true})
+Please type your private token:
 
-This question is required.
+--- This question is required ---
+Please type your private token:
 
-What is 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>
@@ -113,61 +134,79 @@ What is your private token?
 ### 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?
-no
+--- Default selected: YES ---
+=> true
 
-=> false
+> 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?
-yes
-
-=> true
+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.
-
+--- This question is required ---
 Do you like Ruby?
-No
-
+--- 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.
-
+--- 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 question
+### 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`
@@ -185,7 +224,6 @@ What is your favorite number of these?
 2. two
 3. three
 2
-
 => {:value=>"two"}
 
 > HighlineWrapper.new.ask_multiple_choice('What is your favorite number of these?', ['one', 'two', 'three'], {with_index: true})
@@ -194,15 +232,39 @@ What is your favorite number of these?
 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
+=> {:value=>"two"}
+
 > 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})
@@ -210,51 +272,55 @@ What is your favorite number of these?
 1. one
 2. two
 3. three
-
-This question is required.
-
+--- This question is required ---
 What is your favorite number of these?
 1. one
 2. two
 3. three
-
-This question is required.
-
+--- This question is required ---
 What is your favorite number of these?
 1. one
 2. two
 3. three
-2
-
-=> {:value=>"two"}
+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})
+>  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" question
+### 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
@@ -272,7 +338,6 @@ What are your favorite numbers of these?
 2. two
 3. three
 1, 3
-
 => [{:value=>"one"}, {:value=>"three"}]
 
 > HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {with_indexes: true})
@@ -281,15 +346,29 @@ What are your favorite numbers of these?
 2. two
 3. three
 1, 3
-
 => [{:value=>"one", :index=>0}, {:value=>"three", :index=>2}]
 
-> HighlineWrapper.new.ask_checkbox("What are your favorite numbers of these?", ['one', 'two','three'], {defaults: ['two', 'three']})
+> 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})
@@ -297,15 +376,17 @@ What are your favorite numbers of these?
 1. one
 2. two
 3. three
-
-This question is required.
-
+--- 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})
@@ -313,49 +394,49 @@ What are your favorite numbers of these?
 1. one
 2. two
 3. three
-
-This question is required.
-
+--- 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: []})
-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'], {defaults: [], with_indexes: true})
+> 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}]
 ```
 
 </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
+
+To submit a feature request, bug ticket, etc, please submit an official [GitHub issue](https://github.com/emmahsax/highline_wrapper/issues/new). To copy or make changes, please [fork this repository](https://github.com/emmahsax/highline_wrapper/fork). When/if you'd like to contribute back to this upstream, please create a pull request on this repository.
+
+Please follow included Issue Template(s) and Pull Request Template(s) when creating issues or pull requests.
+
+### Security Policy
+
+To report any security vulnerabilities, please view this repository's [Security Policy](https://github.com/emmahsax/highline_wrapper/security/policy).
 
-## Contributing
+### Licensing
 
-To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmahsax/highline_wrapper/issues/new).
+For information on licensing, please see [LICENSE.md](https://github.com/emmahsax/highline_wrapper/blob/main/LICENSE.md).
 
-To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmahsax/highline_wrapper/security/policy).
+### 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

@@ -13,15 +13,14 @@ class HighlineWrapper
   #
   # 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)
-  #
-  # Notes:
-  #  If required == true, the question will repeat until the user answers the question
-  #  If required == true, then the default value will be ignored
   def ask(prompt, options = {})
     defaults = {
+      indicate_default_message: true,
       secret: false,
       default: '',
       required: false
@@ -34,14 +33,13 @@ class HighlineWrapper
   #
   # 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)
-  #
-  # Notes:
-  #  If required == true, the question will repeat until the user answers the question
-  #  If required == true, then the default value will be ignored
   def ask_yes_no(prompt, options = {})
     defaults = {
+      indicate_default_message: true,
       default: true,
       required: false
     }
@@ -56,16 +54,14 @@ class HighlineWrapper
   # 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)
-  #
-  # Notes:
-  #   If required == true, the question will repeat until the user answers the question
-  #   If required == true, then the default value will be ignored
-  #   If default == nil and required == false, and the user skips the question, the answer will be nil
   def ask_multiple_choice(prompt, choices, options = {})
     defaults = {
+      indicate_default_message: true,
       with_index: false,
       default: nil,
       required: false
@@ -81,16 +77,14 @@ class HighlineWrapper
   # 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)
-  #
-  # Notes:
-  #   If required == true, the question will repeat until the user answers the question
-  #   If required == true, then the defaults value will be ignored
-  #   If defaults == [] and required == false, then the method will return an empty array
   def ask_checkbox(prompt, choices, options = {})
     defaults = {
+      indicate_default_message: true,
       with_indexes: false,
       defaults: [],
       required: false

data/lib/highline_wrapper/checkbox_question.rb

@@ -7,13 +7,12 @@ class HighlineWrapper
     class << self
       def ask(prompt, choices, options)
         indices = ask_highline(format_options(prompt, choices))
-        puts
 
         return format_multiple_selections(choices, indices, options[:with_indexes]) unless indices.empty?
         return recurse(prompt, choices, options) if options[:required]
-        return options[:defaults] if options[:defaults].empty?
+        return return_empty_defaults(options) if options[:defaults].empty?
 
-        format_multiple_selections(choices, options[:defaults].map { |d| choices.index(d) }, options[:with_indexes])
+        return_defaults(choices, options)
       end
 
       private def ask_highline(prompt)
@@ -22,6 +21,17 @@ class HighlineWrapper
         indices
       end
 
+      private def return_defaults(choices, options)
+        options[:default_indexes] = options[:defaults].map { |d| choices.index(d) }
+        print_default_message(options, choices) if options[:indicate_default_message]
+        format_multiple_selections(choices, options[:default_indexes], options[:with_indexes])
+      end
+
+      private def print_default_message(options, choices)
+        defaults = options[:default_indexes].map { |i| "#{i + 1}. #{choices[i]}".strip }.join(', ')
+        puts "--- Defaults selected: #{defaults} ---"
+      end
+
       private def format_multiple_selections(choices, indices, with_indexes)
         selected = []
         indices.each { |index| selected << format_selection(choices, index, with_indexes) }

data/lib/highline_wrapper/multiple_choice_question.rb

@@ -7,13 +7,22 @@ class HighlineWrapper
     class << self
       def ask(prompt, choices, options)
         index = ask_highline(format_options(prompt, choices)).to_i - 1
-        puts
 
         return format_selection(choices, index, options[:with_index]) unless index == -1
         return recurse(prompt, choices, options) if options[:required]
-        return nil if options[:default].nil?
+        return return_empty_defaults(options) if options[:default].nil?
 
-        format_selection(choices, choices.index(options[:default]), options[:with_index])
+        return_defaults(choices, options)
+      end
+
+      private def return_defaults(choices, options)
+        options[:default_index] = choices.index(options[:default])
+        print_default_message(options) if options[:indicate_default_message]
+        format_selection(choices, options[:default_index], options[:with_index])
+      end
+
+      private def print_default_message(options)
+        puts "--- Default selected: #{options[:default_index] + 1}. #{options[:default]} ---"
       end
     end
   end

data/lib/highline_wrapper/open_ended_question.rb

@@ -7,13 +7,21 @@ class HighlineWrapper
     class << self
       def ask(prompt, options)
         answer = ask_highline(prompt, secret: options[:secret]).to_s
-        puts unless answer.empty? && options[:secret]
 
         return answer unless answer.empty?
         return recurse(prompt, nil, options) if options[:required]
 
+        print_default_message(options) if options[:indicate_default_message]
         options[:default]
       end
+
+      private def print_default_message(options)
+        if !options[:secret]
+          puts "--- Default selected: #{options[:default].empty? ? 'EMPTY' : options[:default]} ---"
+        elsif options[:secret]
+          puts '--- Default selected: HIDDEN ---'
+        end
+      end
     end
   end
 end

data/lib/highline_wrapper/question.rb

@@ -23,10 +23,15 @@ class HighlineWrapper
       end
 
       def recurse(prompt, choices, options)
-        puts "This question is required.\n\n"
+        puts '--- This question is required ---'
         choices.nil? ? ask(prompt, options) : ask(prompt, choices, options)
       end
 
+      def return_empty_defaults(options)
+        puts '--- Default selected: EMPTY ---' if options[:indicate_default_message]
+        options[:defaults] || options[:default]
+      end
+
       private def highline
         @highline ||= HighLine.new
       end

data/lib/highline_wrapper/version.rb

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

data/lib/highline_wrapper/yes_no_question.rb

@@ -7,19 +7,27 @@ class HighlineWrapper
     class << self
       def ask(prompt, options)
         answer = ask_highline(prompt).to_s.downcase
-        puts
 
         return parse(answer, prompt, options) unless answer.empty?
         return recurse(prompt, nil, options) if options[:required]
 
+        print_default_message(options) if options[:indicate_default_message]
         options[:default]
       end
 
-      def parse(answer, prompt, options)
-        return true if answer.include?('y')
-        return false if answer.include?('n')
+      private def parse(answer, prompt, options)
+        case answer
+        when 'yes', 'y'
+          true
+        when 'no', 'n'
+          false
+        else
+          recurse(prompt, nil, options)
+        end
+      end
 
-        recurse(prompt, nil, options)
+      private def print_default_message(options)
+        puts "--- Default selected: #{options[:default] ? 'YES' : 'NO'} ---"
       end
     end
   end

data/spec/highline_wrapper/checkbox_question_spec.rb

@@ -44,6 +44,12 @@ describe HighlineWrapper::CheckboxQuestion do
       resp = subject.ask(Faker::Lorem.sentence, choices, options)
       expect(resp).to eq([])
     end
+
+    it 'should call the return empty defaults if the user skips' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject).to receive(:return_empty_defaults)
+      subject.ask(Faker::Lorem.sentence, choices, options)
+    end
   end
 
   context 'with required set to true' do
@@ -97,6 +103,7 @@ describe HighlineWrapper::CheckboxQuestion do
       context 'with defaults set' do
         let(:options) do
           {
+            indicate_default_message: true,
             with_indexes: false,
             defaults: ['two'],
             required: false
@@ -114,6 +121,31 @@ describe HighlineWrapper::CheckboxQuestion do
           resp = subject.ask(Faker::Lorem.sentence, choices, options)
           expect(resp).to eq([{ value: 'two' }])
         end
+
+        it 'should call to return the defaults if the user skips' do
+          allow(highline).to receive(:ask).and_return('')
+          expect(subject).to receive(:return_defaults).and_call_original
+          expect(subject).to receive(:puts)
+          subject.ask(Faker::Lorem.sentence, choices, options)
+        end
+
+        context 'when the indicate_default_message is false' do
+          let(:options) do
+            {
+              indicate_default_message: false,
+              with_indexes: false,
+              defaults: ['two'],
+              required: false
+            }
+          end
+
+          it 'should call to return the defaults if the user skips' do
+            allow(highline).to receive(:ask).and_return('')
+            expect(subject).to receive(:return_defaults)
+            expect(subject).not_to receive(:puts)
+            subject.ask(Faker::Lorem.sentence, choices, options)
+          end
+        end
       end
 
       context 'with defaults set to []' do
@@ -182,6 +214,12 @@ describe HighlineWrapper::CheckboxQuestion do
           resp = subject.ask(Faker::Lorem.sentence, choices, options)
           expect(resp).to eq([])
         end
+
+        it 'should call the return empty defaults message' do
+          allow(highline).to receive(:ask).and_return('')
+          expect(subject).to receive(:return_empty_defaults)
+          subject.ask(Faker::Lorem.sentence, choices, options)
+        end
       end
     end
   end

data/spec/highline_wrapper/multiple_choice_question_spec.rb

@@ -44,6 +44,12 @@ describe HighlineWrapper::MultipleChoiceQuestion do
       resp = subject.ask(Faker::Lorem.sentence, choices, options)
       expect(resp).to eq(nil)
     end
+
+    it 'should call the return empty defaults if the user skips' do
+      allow(highline).to receive(:ask).and_return('')
+      expect(subject).to receive(:return_empty_defaults)
+      subject.ask(Faker::Lorem.sentence, choices, options)
+    end
   end
 
   context 'with required set to true' do
@@ -97,6 +103,7 @@ describe HighlineWrapper::MultipleChoiceQuestion do
       context 'with default set' do
         let(:options) do
           {
+            indicate_default_message: true,
             with_index: false,
             default: 'two',
             required: false
@@ -114,6 +121,31 @@ describe HighlineWrapper::MultipleChoiceQuestion do
           resp = subject.ask(Faker::Lorem.sentence, choices, options)
           expect(resp).to eq({ value: 'two' })
         end
+
+        it 'should call to return the defaults if the user skips' do
+          allow(highline).to receive(:ask).and_return(0)
+          expect(subject).to receive(:return_defaults).and_call_original
+          expect(subject).to receive(:puts)
+          subject.ask(Faker::Lorem.sentence, choices, options)
+        end
+
+        context 'when the indicate_default_message is false' do
+          let(:options) do
+            {
+              indicate_default_message: false,
+              with_indexes: false,
+              default: 'two',
+              required: false
+            }
+          end
+
+          it 'should call to return the defaults if the user skips' do
+            allow(highline).to receive(:ask).and_return(0)
+            expect(subject).to receive(:return_defaults)
+            expect(subject).not_to receive(:puts)
+            subject.ask(Faker::Lorem.sentence, choices, options)
+          end
+        end
       end
 
       context 'with default nil' do
@@ -182,6 +214,12 @@ describe HighlineWrapper::MultipleChoiceQuestion do
           resp = subject.ask(Faker::Lorem.sentence, choices, options)
           expect(resp).to eq(nil)
         end
+
+        it 'should call the return empty defaults message' do
+          allow(highline).to receive(:ask).and_return(0)
+          expect(subject).to receive(:return_empty_defaults)
+          subject.ask(Faker::Lorem.sentence, choices, options)
+        end
       end
     end
   end

data/spec/highline_wrapper/open_ended_question_spec.rb

@@ -21,6 +21,7 @@ describe HighlineWrapper::OpenEndedQuestion do
   context 'with the options as defaults' do
     let(:options) do
       {
+        indicate_default_message: true,
         secret: false,
         default: '',
         required: false
@@ -44,6 +45,12 @@ describe HighlineWrapper::OpenEndedQuestion do
       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
@@ -73,6 +80,7 @@ describe HighlineWrapper::OpenEndedQuestion do
     let(:default_string) { Faker::Lorem.sentence }
     let(:options) do
       {
+        indicate_default_message: false,
         secret: false,
         default: default_string,
         required: false
@@ -90,5 +98,11 @@ describe HighlineWrapper::OpenEndedQuestion 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

@@ -60,4 +60,55 @@ describe HighlineWrapper::Question do
       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

@@ -21,13 +21,14 @@ describe HighlineWrapper::YesNoQuestion do
   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)
+      expect(highline).to receive(:ask).and_return('Y')
       subject.ask(Faker::Lorem.sentence, options)
     end
 
@@ -42,6 +43,18 @@ describe HighlineWrapper::YesNoQuestion do
       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
@@ -68,6 +81,7 @@ describe HighlineWrapper::YesNoQuestion do
   context 'with required set to false' do
     let(:options) do
       {
+        indicate_default_message: false,
         default: false,
         required: false
       }
@@ -84,5 +98,11 @@ describe HighlineWrapper::YesNoQuestion do
       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: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !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
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         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: []
@@ -132,7 +118,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/highline_wrapper.rb
@@ -150,7 +136,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/emmahsax/highline_wrapper
 licenses:
-- MIT
+- BSD-3-Clause
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -167,10 +153,10 @@ 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 HighLine wrapper
 test_files:
 - spec/spec_helper.rb
 - spec/highline_wrapper/checkbox_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.