cli-ui 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 257914b1c561094bd1e2a466a251b8e44055d806
-  data.tar.gz: 4a0e814e44663e4740090ecb556056e4f224e0fd
+  metadata.gz: 367667f90cce34fe2ac10fffbd13a24a8b7a90e3
+  data.tar.gz: fdc151c1343bc037c8f03c3308ec3646795e9dbd
 SHA512:
-  metadata.gz: 8a887458aa8446824c92682f32eeb995a7d002a6a1b787b68694873c7e52706de368233415f13d85b399f72e36a7c4d7cb493950d4b2773c0b6dd159b2e500fb
-  data.tar.gz: bd0dc80707861825a752de6c325f6faf8c2f404c174446d2fa760a4224a2b7e3894c493aa0f5859a5ac947b9ba871c9c8cf2e832c59b239b6bd124fda8bf5c32
+  metadata.gz: 51e249672f6214028aebf3ab31b2d90cde511da996118b50607522318528c57ae0bfe40edc4b447593fb5faf2712b964fdfafdc26e1b092ce96e8ee92366e759
+  data.tar.gz: 58e27c5790e1bb0f35581953467a8c5a38d7ca647f3cca7042e42d347c9708dc44e9007cb326fa563b241daaaaa480662de7dfdaa2ad5a3084ecf68dc4158cf6

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 *.gem
 build
 .vagrant

data/README.md

@@ -49,6 +49,19 @@ Prompt user with options and ask them to choose. Can answer using arrow keys, nu
 CLI::UI.ask('What language/framework do you use?', options: %w(rails go ruby python))
 ```
 
+Can also assign callbacks to each option
+
+```ruby
+CLI::UI.ask('What language/framework do you use?') do |handler|
+  handler.option('rails')  { |selection| selection }
+  handler.option('go')     { |selection| selection }
+  handler.option('ruby')   { |selection| selection }
+  handler.option('python') { |selection| selection }
+end
+```
+
+* Note that the two examples provided above are identical in functionality
+
 ![Interactive Prompt](https://user-images.githubusercontent.com/3074765/33797984-0ebb5e64-dcdf-11e7-9e7e-7204f279cece.gif)
 
 ---

data/lib/cli/ui/prompt.rb

@@ -5,12 +5,13 @@ module CLI
   module UI
     module Prompt
       autoload :InteractiveOptions,  'cli/ui/prompt/interactive_options'
-      private_constant :InteractiveOptions
+      autoload :OptionsHandler,      'cli/ui/prompt/options_handler'
+      private_constant :InteractiveOptions, :OptionsHandler
 
       class << self
-        # Ask a user a question with either free form answer or a set of answers
+        # Ask a user a question with either free form answer or a set of answers (multiple choice)
+        # Can use arrows, y/n, numbers (1/2), and vim bindings to control multiple choice selection
         # Do not use this method for yes/no questions. Use +confirm+
-        # Can use arrows, y/n, numbers, and vim bindings to control
         #
         # * Handles free form answers (options are nil)
         # * Handles default answers for free form text
@@ -25,14 +26,25 @@ module CLI
         #
         # ==== Options
         #
-        # * +:options+ - Options to ask the user. Will use +InteractiveOptions+ to do so
+        # * +:options+ - Options that the user may select from. Will use +InteractiveOptions+ to do so.
         # * +:default+ - The default answer to the question (e.g. they just press enter and don't input anything)
         # * +:is_file+ - Tells the input to use file auto-completion (tab completion)
         # * +:allow_empty+ - Allows the answer to be empty
         #
         # Note:
-        # * +:options+ conflicts with +:default+ and +:is_file+, you cannot set options with either of these keywords
+        # * +:options+ or providing a +Block+ conflicts with +:default+ and +:is_file+, you cannot set options with either of these keywords
         # * +:default+ conflicts with +:allow_empty:, you cannot set these together
+        # * +:options+ conflicts with providing a +Block+ , you may only set one
+        #
+        # ==== Block (optional)
+        #
+        # * A Proc that provides a +OptionsHandler+ and uses the public +:option+ method to add options and their
+        #   respective handlers
+        #
+        # ==== Return Value
+        #
+        # * If a +Block+ was not provided, the selected option or response to the free form question will be returned
+        # * If a +Block+ was provided, the evaluted value of the +Block+ will be returned
         #
         # ==== Example Usage:
         #
@@ -48,35 +60,50 @@ module CLI
         # Free form question when the answer can be empty
         #   CLI::UI::Prompt.ask('What is your opinion on this question?', allow_empty: true)
         #
-        # Question with answers
+        # Interactive (multiple choice) question
         #   CLI::UI::Prompt.ask('What kind of project is this?', options: %w(rails go ruby python))
         #
-        #
-        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true)
-          if (default && !allow_empty) || (options && (default || is_file))
-            raise(ArgumentError, 'conflicting arguments')
+        # Interactive (multiple choice) question with defined handlers
+        #   CLI::UI::Prompt.ask('What kind of project is this?') do |handler|
+        #     handler.option('rails')  { |selection| selection }
+        #     handler.option('go')     { |selection| selection }
+        #     handler.option('ruby')   { |selection| selection }
+        #     handler.option('python') { |selection| selection }
+        #   end
+        #
+        def ask(question, options: nil, default: nil, is_file: nil, allow_empty: true, &options_proc)
+          if ((options || block_given?) && (default || is_file))
+            raise(ArgumentError, 'conflicting arguments: options provided with default or is_file')
           end
 
-          if default
-            puts_question("#{question} (empty = #{default})")
-          elsif options
-            puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
+          if options || block_given?
+            ask_interactive(question, options, &options_proc)
           else
-            puts_question(question)
+            ask_free_form(question, default, is_file, allow_empty)
           end
+        end
 
-          # Present the user with options
-          if options
-            resp = InteractiveOptions.call(options)
+        # Asks the user a yes/no question.
+        # Can use arrows, y/n, numbers (1/2), and vim bindings to control
+        #
+        # ==== Example Usage:
+        #
+        # Confirmation question
+        #   CLI::UI::Prompt.confirm('Is the sky blue?')
+        #
+        def confirm(question)
+          ask_interactive(question, %w(yes no)) == 'yes'
+        end
+
+        private
 
-            # Clear the line, and reset the question to include the answer
-            print(ANSI.previous_line + ANSI.end_of_line + ' ')
-            print(ANSI.cursor_save)
-            print(' ' * CLI::UI::Terminal.width)
-            print(ANSI.cursor_restore)
-            puts_question("#{question} (You chose: {{italic:#{resp}}})")
+        def ask_free_form(question, default, is_file, allow_empty)
+          raise(ArgumentError, 'conflicting arguments: default enabled but allow_empty is false') if (default && !allow_empty)
 
-            return resp
+          if default
+            puts_question("#{question} (empty = #{default})")
+          else
+            puts_question(question)
           end
 
           # Ask a free form question
@@ -94,19 +121,34 @@ module CLI
           end
         end
 
-        # Asks the user a yes/no question.
-        # Can use arrows, y/n, numbers (1/2), and vim bindings to control
-        #
-        # ==== Example Usage:
-        #
-        # Confirmation question
-        #   CLI::UI::Prompt.confirm('Is the sky blue?')
-        #
-        def confirm(question)
-          ask(question, options: %w(yes no)) == 'yes'
+        def ask_interactive(question, options = nil)
+          raise(ArgumentError, 'conflicting arguments: options and block given') if options && block_given?
+
+          options ||= if block_given?
+            handler = OptionsHandler.new
+            yield handler
+            handler.options
+          end
+
+          raise(ArgumentError, 'insufficient options') if options.nil? || options.size < 2
+          puts_question("#{question} {{yellow:(choose with ↑ ↓ ⏎)}}")
+          resp = interactive_prompt(options)
+
+          # Clear the line, and reset the question to include the answer
+          print(ANSI.previous_line + ANSI.end_of_line + ' ')
+          print(ANSI.cursor_save)
+          print(' ' * CLI::UI::Terminal.width)
+          print(ANSI.cursor_restore)
+          puts_question("#{question} (You chose: {{italic:#{resp}}})")
+
+          return handler.call(resp) if block_given?
+          resp
         end
 
-        private
+        # Useful for stubbing in tests
+        def interactive_prompt(options)
+          InteractiveOptions.call(options)
+        end
 
         def write_default_over_empty_input(default)
           CLI::UI.raw do

data/lib/cli/ui/prompt/options_handler.rb

@@ -0,0 +1,24 @@
+module CLI
+  module UI
+    module Prompt
+      # A class that handles the various options of an InteractivePrompt and their callbacks
+      class OptionsHandler
+        def initialize
+          @options = {}
+        end
+
+        def options
+          @options.keys
+        end
+
+        def option(option, &handler)
+          @options[option] = handler
+        end
+
+        def call(option)
+          @options[option].call(option)
+        end
+      end
+    end
+  end
+end

data/lib/cli/ui/version.rb

@@ -1,5 +1,5 @@
 module CLI
   module UI
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-ui
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Burke Libbey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,6 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -84,6 +83,7 @@ files:
 - lib/cli/ui/progress.rb
 - lib/cli/ui/prompt.rb
 - lib/cli/ui/prompt/interactive_options.rb
+- lib/cli/ui/prompt/options_handler.rb
 - lib/cli/ui/spinner.rb
 - lib/cli/ui/spinner/async.rb
 - lib/cli/ui/spinner/spin_group.rb

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cli-ui (0.1.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.3.0)
-    builder (3.2.3)
-    byebug (9.0.6)
-    metaclass (0.0.4)
-    method_source (0.8.2)
-    minitest (5.10.2)
-    minitest-reporters (1.1.14)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    mocha (1.2.1)
-      metaclass (~> 0.0.1)
-    parallel (1.12.0)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rubocop (0.52.0)
-      parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.15)
-  byebug
-  cli-ui!
-  method_source
-  minitest (>= 5.0.0)
-  minitest-reporters
-  mocha
-  rake (~> 10.0)
-  rubocop
-
-BUNDLED WITH
-   1.16.0