interactive 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b4b79a65cc5ac54133c83d492ac1ead6ae2e9d
-  data.tar.gz: 53c30ac9d8daacd36e4b3e5f294c4e3ad52fc886
+  metadata.gz: d9dcea125c70a876fcb818733193c9d9554a4455
+  data.tar.gz: f992006a8ae904ccf96f52bd227892edccabef92
 SHA512:
-  metadata.gz: ddfd47284226b675a8afb50de9dd5aa6a3a072000227b657e8260efc3ad1ad841a405ea3b3086acf100895ec49ada6c9c4b50238602036b8407d37deb643ed01
-  data.tar.gz: ddac10c4ef2bb18eb1c50f632ed34578d8f0c54ce476061110219b2079c4aa398b4abc89e0321361877994ac3c3bc959b0b88c7f866423d03f67954174255f31
+  metadata.gz: 95ce90bea80d01932067744d6dbd7c7581ba971a4736968b4562361124cce93fa5a2e70f3004ece8bb98d61c94c0b8218f9be6dfe2d1df25e3da78f00ceeaf73
+  data.tar.gz: f50ec4bc741764e1a8eb07c4afe6380f9e07575afd5ed9ed921bd300a7365d6a3318cc07d6310ab2ac1954ea0b335430131489e2d995ca90f38049e13d4e8687

data/CHANGELOG.markdown

@@ -1,9 +1,7 @@
-v0.1.0 -- Mon Mar 16 07:17:53 EDT 2015
+v0.3.0 -- Wed Mar 18 11:28:05 EDT 2015
 --------------------------------------
-- Added support for handling ranges.
-- 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.
+- Added support for questions without options
+- Aliased `Question#ask_and_wait_for_valid_response` as `Question#ask`
 
 v0.2.0 -- Mon Mar 16 21:52:21 EDT 2015
 --------------------------------------
@@ -13,3 +11,10 @@ v0.2.0 -- Mon Mar 16 21:52:21 EDT 2015
   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)
+
+v0.1.0 -- Mon Mar 16 07:17:53 EDT 2015
+--------------------------------------
+- Added support for handling ranges.
+- 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.

data/README.md

@@ -23,13 +23,55 @@ Or install it yourself as:
 
 ## Usage
 
+### Questions Without any Options
+If you want to ask a user a question accepting all answers:
+
+```ruby
+require 'interactive'
+include 'interactive'
+
+question = Question.new do |q|
+  q.question = "What is your api token password?"
+end
+
+question.ask do |response|
+  # response is an object that responds to string methods
+  puts response.split
+end
+```
+
+This will ask:
+
+```ruby
+=> What are your project ids?
+```
+
+You can respond like so, for example:
+
+```ruby
+$ 123someid hello4545 12992hhoo
+```
+
+That will give us the following:
+
+```ruby
+=> 123someid
+   hello4545
+   12992hhoo
+```
+
 ### Questions With Lazy Shortcut Explanations
+
 If you want to ask a user a question expecting certain answers:
 
+
 ```ruby
-question = Interactive::Question.new do |ques|
-  ques.question = "Which item do you want to use?"
-  ques.options = [1..3, :cancel, :quit]
+require 'interactive'
+include 'interactive'
+
+question = Question.new do |q|
+  q.question = "Which item do you want to use?"
+  q.options = [1..3, :cancel, :quit]
 end
 ```
 
@@ -37,7 +79,7 @@ You can run the loop and wait for a valid response and do query methods on the
 response:
 
 ```ruby
-question.ask_and_wait_for_valid_response do |response|
+question.ask do |response|
   if response.whole_num_1?
     # do stuff if user responded with "1"
   elsif response.whole_num?
@@ -82,14 +124,18 @@ Providing an array of options to the options array will trigger the shortcut
 explanation right after asking the question:
 
 ```ruby
+require 'interactive'
+include 'interactive'
+
+# ...
 
 options_list = ["/some/path", "/some/other/path"]
-iq = Interactive::Question.new do |q|
+iq = 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|
+iq.ask 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])

data/lib/interactive.rb

@@ -1,4 +1,5 @@
 require "interactive/version"
+require "delegate"
 require "interactive/option"
 require "interactive/options"
 require "interactive/question_with_eager_full_explanation"

data/lib/interactive/options.rb

@@ -1,12 +1,17 @@
 require 'delegate'
+require 'interactive'
 
 module Interactive
-  class Options < SimpleDelegator
-    include Interactive
-    attr_accessor :options
+  module_function
+  def Options(options=[])
+    options.empty? ? EmptyOptions.new([]) : NonEmptyOptions.new(options)
+  end
 
+  class NonEmptyOptions < SimpleDelegator
+    include Interactive
     def initialize(options)
-      flatten_ranges(options)
+      @options = options
+      flatten_ranges(@options)
       wrap_each_option
       super(@options)
     end
@@ -16,7 +21,7 @@ module Interactive
     end
 
     def shortcuts_meanings
-      options.inject("") { |accum, opt| "#{accum}  #{opt.shortcut_value} -- #{opt.value}\n"}
+      @options.inject("") { |accum, opt| "#{accum}  #{opt.shortcut_value} -- #{opt.value}\n"}
     end
 
     def has_hash?
@@ -42,11 +47,31 @@ module Interactive
     end
 
     def first_chars
-      options.inject("") { |accum, opt| "#{accum}#{ opt.shortcut_value}/" }
+      @options.inject("") { |accum, opt| "#{accum}#{ opt.shortcut_value}/" }
     end
 
     def first_chars_without_last_slash(first_chars)
       first_chars[0..first_chars.length-2]
     end
   end
+
+
+  class EmptyOptions < SimpleDelegator
+    def initialize(options)
+      @options = options
+      super(@options)
+    end
+
+    def shortcuts_string
+      ''
+    end
+
+    def shortcuts_meanings
+      ''
+    end
+
+    def has_hash?
+      false
+    end
+  end
 end

data/lib/interactive/question.rb

@@ -5,12 +5,11 @@ module Interactive
     def initialize(&block)
       yield self
 
-      @options = Interactive::Options.new(Array(@options))
+      @options = Interactive::Options(Array(@options))
 
       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)
+      alias :ask :ask_and_wait_for_valid_response
     end
 
     def ask_and_wait_for_valid_response(&block)

data/lib/interactive/question_with_eager_full_explanation.rb

@@ -3,7 +3,7 @@ class QuestionWithEagerFullExplanation < SimpleDelegator
     loop do
       puts "#{question} #{options.shortcuts_string}"
       puts options.shortcuts_meanings
-      resp = Interactive::Response.new(options)
+      resp = Interactive::Response(options)
 
       yield resp
       break unless resp.invalid?

data/lib/interactive/question_with_lazy_full_explanation.rb

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

data/lib/interactive/response.rb

@@ -1,7 +1,29 @@
 require 'interactive'
 
 module Interactive
-  class Response
+  module_function
+
+  def Response(*args)
+    args = Array(args).flatten
+    args.empty? ? ResponseWithNoArgs.new(args) : ResponseWithArgs.new(args)
+  end
+
+  class ResponseWithNoArgs < SimpleDelegator
+    def initialize(*args)
+      @_response = STDIN.gets.chomp
+      super(@_response)
+    end
+
+    def valid?
+      true
+    end
+
+    def invalid?
+      false
+    end
+  end
+
+  class ResponseWithArgs < SimpleDelegator
     def initialize(*args)
       @args = Array(args).flatten
       check_validity
@@ -11,10 +33,8 @@ module Interactive
       define_methods
       define_invalid
       define_whole_number
-    end
 
-    def to_i
-      @_response.to_i
+      super(@_response)
     end
 
     private
@@ -23,7 +43,6 @@ module Interactive
       raise ArgumentError, "may not use :invalid or 'invalid' as an argument. Private method." if @args.map(&:to_s).include?('invalid')
       raise ArgumentError, "may not use :whole_number or 'whole_number' as an argument. Private method." if @args.map(&:to_s).include?('whole_number')
       raise ArgumentError, "may not have keyword options that have the same first letter." if first_chars_not_unique
-      raise ArgumentError, "wrong number of arguments (need at least two arguments)." if @args.length < 2
     end
 
     def define_methods

data/lib/interactive/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interactive
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edderic Ugaddan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake