interactive 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2c6959fba0126e77b3a9147f7f23435a19064cf
-  data.tar.gz: 7418c32a98aacddb6df983502f09abdf738f2d5c
+  metadata.gz: f2b4b79a65cc5ac54133c83d492ac1ead6ae2e9d
+  data.tar.gz: 53c30ac9d8daacd36e4b3e5f294c4e3ad52fc886
 SHA512:
-  metadata.gz: 4fe3a14aa9871323c85e1045d9eb0341422ec9489f49484d30756555e053eb1b7ec1c93a431c407b7294f87c9bd302936b7ddac18ef0a6cde98c816def50a0b1
-  data.tar.gz: a3144758369854cbf2790e558147f2a6bcd2f7f3269920e98c37cc08c67519b496fc3a3ff813cdb0534ee09709684eece520276616662b24cf4a9478f9b74d64
+  metadata.gz: ddfd47284226b675a8afb50de9dd5aa6a3a072000227b657e8260efc3ad1ad841a405ea3b3086acf100895ec49ada6c9c4b50238602036b8407d37deb643ed01
+  data.tar.gz: ddac10c4ef2bb18eb1c50f632ed34578d8f0c54ce476061110219b2079c4aa398b4abc89e0321361877994ac3c3bc959b0b88c7f866423d03f67954174255f31

data/CHANGELOG.markdown

@@ -4,3 +4,12 @@ v0.1.0 -- Mon Mar 16 07:17:53 EDT 2015
 - Useful for processing responses of questions like "Which item do you want to
   use?", where whole number responses such as "1", "2", etc. makes sense.
 - Refactored, DRY'er.
+
+v0.2.0 -- Mon Mar 16 21:52:21 EDT 2015
+--------------------------------------
+
+- Added support for handling an array.
+- The items of that array gets internally turned into hashes, with keys
+  corresponding to the index in the array.
+- Putting in an array will eagerly trigger the full explanation of
+  the shortcut (i.e. show the full explanation right after the question)

data/README.md

@@ -23,6 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
+### Questions With Lazy Shortcut Explanations
 If you want to ask a user a question expecting certain answers:
 
 ```ruby
@@ -49,30 +50,62 @@ question.ask_and_wait_for_valid_response do |response|
 end
 ```
 
-That will ask the question appended by the shortcuts:
+That will ask the question appended by the shortcuts (without full explanation):
 
-```ruby
-# => "Which item do you want to use? [1/2/3/c/q]"
+```sh
+Which item do you want to use? [1/2/3/c/q]
 ```
 
 If the response is valid:
 
-```ruby
-$ a
-# => response.add? will return true
+```sh
+$ a  # response.add? will return true
 ```
 
 If the response is invalid, it prints out the question and goes into detail as
 to what the shortcuts stand for:
 
-```ruby
+```sh
 $ bad-response
-# => Which item do you want to use? [1/2/3/c/q]
-# =>   1 -- 1
-# =>   2 -- 2
-# =>   3 -- 3
-# =>   c -- cancel
-# =>   q -- quit
+
+Which item do you want to use? [1/2/3/c/q]
+  1 -- 1
+  2 -- 2
+  3 -- 3
+  c -- cancel
+  q -- quit
+```
+
+### Questions With Eager Shortcut Explanations
+
+Providing an array of options to the options array will trigger the shortcut
+explanation right after asking the question:
+
+```ruby
+
+options_list = ["/some/path", "/some/other/path"]
+iq = Interactive::Question.new do |q|
+  q.question = "Which path do you want to use?"
+  q.options = [options_list, :cancel]
+end
+
+iq.ask_and_wait_for_valid_response do |response|
+  if response.whole_number?
+    # response.to_i will convert the response string to an integer.
+    # useful for getting the index (i.e. options_list[response.to_i])
+  elsif response.cancel?
+    # do stuff to cancel...
+  end
+end
+```
+
+This will ask the question and show the explanation eagerly:
+
+```sh
+Which path do you want to use? [0/1/c]
+  0 -- /some/path
+  1 -- /some/other/path
+  c -- cancel
 ```
 
 ## Development

data/lib/interactive/option.rb

@@ -4,7 +4,9 @@ module Interactive
   module_function
 
   def Option(option)
-    if option.to_s.match(/^\d+$/)
+    if option.respond_to?(:to_hash)
+      @option = HashNumberedOption.new(option)
+    elsif option.to_s.match(/^\d+$/)
       @option = WholeNumberOption.new(option)
     else
       @option = WordOption.new(option)
@@ -26,6 +28,10 @@ module Interactive
     def query_method_name
       "whole_number_#{shortcut_value}?"
     end
+
+    def value
+      @option
+    end
   end
 
   class WordOption < SimpleDelegator
@@ -41,5 +47,28 @@ module Interactive
     def query_method_name
       "#{@option}?"
     end
+
+    def value
+      @option
+    end
+  end
+
+  class HashNumberedOption < SimpleDelegator
+    def initialize(option)
+      @option = option
+      super(@option)
+    end
+
+    def shortcut_value
+      @option.keys.first
+    end
+
+    def query_method_name
+      "whole_number_#{shortcut_value}?"
+    end
+
+    def value
+      @option[shortcut_value]
+    end
   end
 end

data/lib/interactive/options.rb

@@ -16,13 +16,25 @@ module Interactive
     end
 
     def shortcuts_meanings
-      options.inject("") { |accum, opt| "#{accum}  #{opt.shortcut_value} -- #{opt}\n"}
+      options.inject("") { |accum, opt| "#{accum}  #{opt.shortcut_value} -- #{opt.value}\n"}
+    end
+
+    def has_hash?
+      @options.any? {|opt| opt.respond_to?(:to_hash) }
     end
 
     private
 
     def flatten_ranges(options)
-      @options = options.inject([]) {|accum, opt| opt.respond_to?(:to_a) ? accum | opt.to_a : accum << opt}
+      @options = options.inject([]) do |accum, opt|
+        if opt.class == Range
+          accum | opt.to_a
+        elsif opt.respond_to?(:to_a)
+          accum | opt.map.with_index {|item, index| {index.to_s => item} }
+        else
+          accum << opt
+        end
+      end
     end
 
     def wrap_each_option

data/lib/interactive/question.rb

@@ -9,17 +9,12 @@ module Interactive
 
       raise ArgumentError, "question cannot be nil nor empty." if question.nil? || question.empty?
       raise ArgumentError, "options cannot be empty." if options.empty?
+
+      @question_type = @options.has_hash? ? QuestionWithEagerFullExplanation.new(self) : QuestionWithLazyFullExplanation.new(self)
     end
 
     def ask_and_wait_for_valid_response(&block)
-      loop do
-        puts "#{question} #{options.shortcuts_string}"
-        resp = Interactive::Response.new(options)
-        puts options.shortcuts_meanings if resp.invalid?
-
-        yield resp
-        break unless resp.invalid?
-      end
+      @question_type.ask_and_wait_for_valid_response(&block)
     end
 
     private

data/lib/interactive/question_with_eager_full_explanation.rb

@@ -0,0 +1,12 @@
+class QuestionWithEagerFullExplanation < SimpleDelegator
+  def ask_and_wait_for_valid_response(&block)
+    loop do
+      puts "#{question} #{options.shortcuts_string}"
+      puts options.shortcuts_meanings
+      resp = Interactive::Response.new(options)
+
+      yield resp
+      break unless resp.invalid?
+    end
+  end
+end

data/lib/interactive/question_with_lazy_full_explanation.rb

@@ -0,0 +1,12 @@
+class QuestionWithLazyFullExplanation < SimpleDelegator
+  def ask_and_wait_for_valid_response(&block)
+    loop do
+      puts "#{question} #{options.shortcuts_string}"
+      resp = Interactive::Response.new(options)
+      puts options.shortcuts_meanings if resp.invalid?
+
+      yield resp
+      break unless resp.invalid?
+    end
+  end
+end

data/lib/interactive/response.rb

@@ -13,6 +13,10 @@ module Interactive
       define_whole_number
     end
 
+    def to_i
+      @_response.to_i
+    end
+
     private
 
     def check_validity

data/lib/interactive/version.rb

@@ -1,3 +1,3 @@
 module Interactive
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/interactive.rb

@@ -1,6 +1,8 @@
 require "interactive/version"
 require "interactive/option"
 require "interactive/options"
+require "interactive/question_with_eager_full_explanation"
+require "interactive/question_with_lazy_full_explanation"
 require 'interactive/question'
 require 'interactive/response'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interactive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Edderic Ugaddan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,6 +89,8 @@ files:
 - lib/interactive/option.rb
 - lib/interactive/options.rb
 - lib/interactive/question.rb
+- lib/interactive/question_with_eager_full_explanation.rb
+- lib/interactive/question_with_lazy_full_explanation.rb
 - lib/interactive/response.rb
 - lib/interactive/version.rb
 homepage: http://github.com/Edderic/interactive