highline_wrapper 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 380bac98137ba1ffb3ffded9336dc97b0b92b6f75f152a20cbc7355ce601feb9
-  data.tar.gz: 6ff8a1a2cf154e7f7cfa9b9937aa17ece09b0ccb3dfc168c258d068fe0a6a8ca
+  metadata.gz: 2555420fa949c1eb531c1783ec99156b8937ba4c15cf1832a70ac0cac353ed9f
+  data.tar.gz: '08ab9f56f86df8686b84c2d7b7ef0b0b4e7681c325d7815d250da4aa88ce7c9e'
 SHA512:
-  metadata.gz: 79b809ec51c6db6122bf12ed43c14eef0f24ea14d9e9f9166f0e648fb9a45698645f91a368e36fd2e230a3f45655847a9438126584b8b8f941723d150191c546
-  data.tar.gz: 926256c87d483ee1a5b2024271a59e7df2acbaef72c19461827cfa6e69e20cfa35de366cd2eea7ee322dce0c1ead6bbe6c229bd5918a1d79e80f972e9358e634
+  metadata.gz: 99861a049ee6c0d92d7bc6147613381cd96a69c4b74f3881193cac6fbe4fd2cf22e3bbeffa3f5d7aca9137a7ee3892783934112e5f017c6274a8ae34f6c90531
+  data.tar.gz: dc5c3507559c75ec84372c12186cfaf32180095c6a427f9d5dd739e266cf28e55c1aebe65a7f62fd0abf90bc84d99184cc3dcd86055c88498347fde185a6ec4b

data/Gemfile.lock

@@ -1,27 +1,29 @@
 PATH
   remote: .
   specs:
-    highline_wrapper (1.3.0)
-      highline (~> 2.0)
+    highline_wrapper (1.3.2.pre.test)
+      abbrev (~> 0.1)
+      highline (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    abbrev (0.1.2)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    faker (2.18.0)
-      i18n (>= 1.6, < 2)
-    ffi (1.15.3)
-    formatador (0.3.0)
-    guard (2.17.0)
+    concurrent-ruby (1.2.3)
+    diff-lcs (1.5.1)
+    faker (3.2.3)
+      i18n (>= 1.8.11, < 2)
+    ffi (1.16.3)
+    formatador (1.1.0)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -29,65 +31,73 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    highline (2.0.3)
-    i18n (1.8.10)
+    highline (3.0.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    listen (3.5.1)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
+    lumberjack (1.2.10)
     method_source (1.0.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
-    rb-fsevent (0.11.0)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     shellany (0.0.1)
-    thor (1.1.0)
-    unicode-display_width (2.0.0)
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
-  x86_64-darwin-19
+  arm64-darwin-21
+  arm64-darwin-22
+  arm64-darwin-23
 
 DEPENDENCIES
   bundler (~> 2.2)
-  faker (~> 2.15)
+  faker (~> 3.0)
   guard-rspec (~> 4.3)
   highline_wrapper!
   pry (~> 0.13)
@@ -95,4 +105,4 @@ DEPENDENCIES
   rubocop (~> 1.10)
 
 BUNDLED WITH
-   2.2.21
+   2.5.4

data/Guardfile

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

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# Highline Wrapper
 
 A little wrapper to help ask some easy questions via the command-line with Highline. The types of questions this wrapper supports is:
 
@@ -46,17 +46,17 @@ 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 `''`
+* `indicate_default_message`: defaults to `true`
 * `required`: defaults to `false`
+* `secret`: defaults to `false`
 
 Notes:
+* If `default` is `''` and `required` is `false`, and the user skips the question, the answer will be `''`
 * 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>
@@ -69,36 +69,51 @@ 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})
@@ -115,9 +130,11 @@ Please type your private token:
 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"
@@ -134,15 +151,15 @@ Please type your private token:
 ### Yes/No questions
 
 Question configuration options:
-* `indicate_default_message`: defaults to `true`
 * `default`: defaults to `true` (aka 'yes')
+* `indicate_default_message`: defaults to `true`
 * `required`: defaults to `false`
 
 Notes:
+* If `default` is `true` and `required` is `false`, and the user skips the question, the answer will be `true`
 * 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>
@@ -150,7 +167,9 @@ Notes:
 ```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})
@@ -164,16 +183,24 @@ no
 
 > 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
@@ -182,6 +209,7 @@ N
 Do you like Ruby?
 uh-huh
 --- This question is required ---
+
 Do you like Ruby?
 YES
 => true
@@ -190,6 +218,7 @@ YES
 Do you like Ruby?
 yep
 --- This question is required ---
+
 Do you like Ruby?
 yes
 => true
@@ -200,16 +229,16 @@ yes
 ### 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`
+* `indicate_default_message`: defaults to `true`
 * `required`: defaults to `false`
+* `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)
 
 Notes:
+* If `default` is `nil` and `required` is `false`, and the user skips the question, the answer will be `nil`
 * 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
@@ -239,12 +268,16 @@ 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
@@ -257,7 +290,9 @@ 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})
@@ -272,12 +307,16 @@ 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
@@ -290,7 +329,9 @@ 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})
@@ -298,7 +339,9 @@ 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})
@@ -306,6 +349,7 @@ What is your favorite number of these?
 1. one
 2. two
 3. three
+
 => nil
 ```
 
@@ -314,16 +358,16 @@ What is your favorite number of these?
 ### 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 `[]`
+* `indicate_default_message`: defaults to `true`
 * `required`: defaults to `false`
+* `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)
 
 Notes:
+* If `defaults` is `[]` and `required` is `false`, then the method will return an empty array
 * 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
@@ -353,6 +397,7 @@ 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})
@@ -360,7 +405,9 @@ 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']})
@@ -368,7 +415,9 @@ 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})
@@ -376,12 +425,16 @@ 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
@@ -394,7 +447,9 @@ 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
@@ -407,6 +462,7 @@ What are your favorite numbers of these?
 1. one
 2. two
 3. three
+
 => [{:value=>"two", :index=>1}, {:value=>"three", :index=>2}]
 ```
 

data/lib/highline_wrapper/checkbox_question.rb

@@ -17,7 +17,7 @@ class HighlineWrapper
 
       private def ask_highline(prompt)
         indices = []
-        super(prompt).to_s.split(',').each { |i| indices << i.strip.to_i - 1 }
+        super(prompt).to_s.split(',').each { |i| indices << (i.strip.to_i - 1) }
         indices
       end
 
@@ -29,7 +29,7 @@ class HighlineWrapper
 
       private def print_default_message(options, choices)
         defaults = options[:default_indexes].map { |i| "#{i + 1}. #{choices[i]}".strip }.join(', ')
-        puts "--- Defaults selected: #{defaults} ---"
+        puts "--- Defaults selected: #{defaults} ---\n\n"
       end
 
       private def format_multiple_selections(choices, indices, with_indexes)

data/lib/highline_wrapper/multiple_choice_question.rb

@@ -22,7 +22,7 @@ class HighlineWrapper
       end
 
       private def print_default_message(options)
-        puts "--- Default selected: #{options[:default_index] + 1}. #{options[:default]} ---"
+        puts "--- Default selected: #{options[:default_index] + 1}. #{options[:default]} ---\n\n"
       end
     end
   end

data/lib/highline_wrapper/open_ended_question.rb

@@ -17,9 +17,9 @@ class HighlineWrapper
 
       private def print_default_message(options)
         if !options[:secret]
-          puts "--- Default selected: #{options[:default].empty? ? 'EMPTY' : options[:default]} ---"
+          puts "--- Default selected: #{options[:default].empty? ? 'EMPTY' : options[:default]} ---\n\n"
         elsif options[:secret]
-          puts '--- Default selected: HIDDEN ---'
+          puts "--- Default selected: HIDDEN ---\n\n"
         end
       end
     end

data/lib/highline_wrapper/question.rb

@@ -5,7 +5,6 @@ class HighlineWrapper
     class << self
       def ask_highline(prompt, secret: false)
         highline.ask(prompt) do |conf|
-          conf.readline = true
           conf.echo = '*' if secret
         end
       end
@@ -23,12 +22,12 @@ class HighlineWrapper
       end
 
       def recurse(prompt, choices, options)
-        puts '--- This question is required ---'
+        puts "--- This question is required ---\n\n"
         choices.nil? ? ask(prompt, options) : ask(prompt, choices, options)
       end
 
       def return_empty_defaults(options)
-        puts '--- Default selected: EMPTY ---' if options[:indicate_default_message]
+        puts "--- Default selected: EMPTY ---\n\n" if options[:indicate_default_message]
         options[:defaults] || options[:default]
       end
 

data/lib/highline_wrapper/version.rb

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

data/lib/highline_wrapper/yes_no_question.rb

@@ -27,7 +27,7 @@ class HighlineWrapper
       end
 
       private def print_default_message(options)
-        puts "--- Default selected: #{options[:default] ? 'YES' : 'NO'} ---"
+        puts "--- Default selected: #{options[:default] ? 'YES' : 'NO'} ---\n\n"
       end
     end
   end

data/lib/highline_wrapper.rb

@@ -4,7 +4,7 @@ require 'highline'
 
 files = "#{File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'highline_wrapper'))}/**/*.rb"
 
-Dir[files].each do |file|
+Dir[files].sort.each do |file|
   require_relative file
 end
 

data/renovate.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ],
+  "labels": [
+    "dependencies"
+  ]
+}