interactive 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b4efce0bf189c7b0a8adc60366457b50510cbe1
-  data.tar.gz: 3e19e3f985a2b18722dc99ade99a3ef970feafa2
+  metadata.gz: 9619d284dc3cc786e129bd08d223793905f26e7a
+  data.tar.gz: df6b8e044710d93f821081f7f40abdeb9ce8c213
 SHA512:
-  metadata.gz: d6f3f4fc0e3b08451d43c5fa562999199ab2e890fcdb30fccf243da1269bf434abe8643936fcd01c34ba42ae6dab571be97945c5ca4f54e9811d6c781458094f
-  data.tar.gz: 50b82f8817f6706fae656063f65a66c1af98c2391c009552d351ca585eb369a8dd71c33d04335a62b7b43335f18c171011f9c40369557a1e45c3862f0a5113f1
+  metadata.gz: e71708a64f3f61a9be18cb8757f0ec0c25fbc9600b74fc676803d60bf558150767f50381b50d1e27223b586a726c892fffd06e7baf96189db8af98cd0f047186
+  data.tar.gz: 55e31021ea77758ba04dd25b81551b9f974f8b6763b2ad240c56dbb806a2b8b7ec163a6f22ac7433d80eca41557efcab8377f5e1194afdef446441815114506d

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+v0.6.0 -- Sat Mar 28 22:32:12 EDT 2015
+--------------------------------------
+- added support for displaying tabular data
+
 v0.5.0 -- Fri Mar 20 20:01:26 EDT 2015
 --------------------------------------
 - added `Question#reask`.

data/README.md

@@ -154,6 +154,46 @@ Which path do you want to use? [0/1/c]
   c -- cancel
 ```
 
+You could also present tabular data:
+
+```ruby
+character_1 = OpenStruct.new(name: 'Frank Underwood', job: 'Vice President')
+character_2 = OpenStruct.new(name: 'Zoe Barnes', job: 'Reporter')
+characters_list = [character_1, character_2]
+
+iq = Question.new do |q|
+  q.question = "Which House of Cards character are you interested in?"
+  q.options = [characters_list, :cancel]
+  q.columns = [:index, :name, :job]
+end
+
+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])
+  elsif response.cancel?
+    # do stuff to cancel...
+  end
+end
+```
+
+This will ask the question with a table:
+
+```
+Which House of Cards character are you interested in? [0/1/c]
+  c -- cancel
++-------+-----------------+----------------+
+| index | name            | job            |
++-------+-----------------+----------------+
+| 0     | Frank Underwood | Vice President |
+| 1     | Zoe Barnes      | Reporter       |
++-------+-----------------+----------------+
+```
+
+Note that the second, and up to the last, value of the `columns` list are the
+messages that get sent to each object in the `objects` list of the `options`
+array.
+
 ### Question#reask
 ```ruby
 

data/interactive.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'byebug', '~> 3.5'
   spec.add_development_dependency 'bundler'
+  spec.add_runtime_dependency 'terminal-table', '~> 1.4', '>= 1.4.5'
 end

data/lib/interactive.rb

@@ -1,5 +1,6 @@
 require "interactive/version"
 require "delegate"
+require "terminal-table"
 require "interactive/option"
 require "interactive/options"
 require "interactive/question_with_eager_full_explanation"

data/lib/interactive/options.rb

@@ -3,8 +3,14 @@ require 'interactive'
 
 module Interactive
   module_function
-  def Options(options=[])
-    options.empty? ? EmptyOptions.new([]) : NonEmptyOptions.new(options)
+  def Options(options=[], columns=[])
+    if options.empty?
+      EmptyOptions.new([])
+    elsif Array(columns).any?
+      TabularOptions.new(options, columns)
+    else
+      NonEmptyOptions.new(options)
+    end
   end
 
   class NonEmptyOptions < SimpleDelegator
@@ -55,6 +61,57 @@ module Interactive
     end
   end
 
+  class TabularOptions < NonEmptyOptions
+    def initialize(options, columns)
+      @options = options
+      @headings = columns.clone
+      columns.shift
+      @table_columns = columns
+      super(@options)
+    end
+
+    def shortcuts_meanings
+      non_table_shortcuts_meanings + table_shortcuts_meanings
+    end
+
+    private
+
+    def non_table_shortcuts_meanings
+      non_table_options.inject("") {|accum, opt| "#{accum}  #{opt[0]} -- #{opt}\n"}
+    end
+
+    def table_shortcuts_meanings
+      @table = Terminal::Table.new(headings: @headings)
+      @table.align_column(0, :right)
+      rows.each {|row| @table << row}
+      @table.to_s
+    end
+
+    def non_table_options
+      @options.reject do |opt|
+        @table_columns.inject(true) {|accum, col| accum && opt.value.respond_to?(col) }
+      end
+    end
+
+    def table_options
+      @options.select do |opt|
+        opt_responds_to_each_column?(opt)
+      end
+    end
+
+    def rows
+      table_options.map.with_index do |opt, index|
+        @table_columns.inject([]) do |accum, col|
+          accum << opt.value.send(col)
+        end.insert(0, index)
+      end
+    end
+
+    def opt_responds_to_each_column?(opt)
+      @table_columns.inject(true) {|accum, col| accum && opt.value.respond_to?(col) }
+    end
+  end
+
 
   class EmptyOptions < SimpleDelegator
     def initialize(options)

data/lib/interactive/question.rb

@@ -3,16 +3,20 @@ require 'forwardable'
 module Interactive
   class Question
     extend Forwardable
-    attr_accessor :question, :options
+    attr_accessor :question, :options, :columns
     def_delegators :@question_type, :reask!
 
     def initialize(&block)
       yield self
 
-      @options = Interactive::Options(Array(@options))
+      @options = Interactive::Options(Array(@options), @columns)
 
       raise ArgumentError, "question cannot be nil nor empty." if question.nil? || question.empty?
-      @question_type = @options.has_hash? ? QuestionWithEagerFullExplanation.new(self) : QuestionWithLazyFullExplanation.new(self)
+      if @columns || @options.has_hash?
+        @question_type = QuestionWithEagerFullExplanation.new(self)
+      else
+        @question_type = QuestionWithLazyFullExplanation.new(self)
+      end
     end
 
     def ask_and_wait_for_valid_response(&block)

data/lib/interactive/version.rb

@@ -1,3 +1,3 @@
 module Interactive
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interactive
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Edderic Ugaddan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 description: 
 email:
 - edderic@gmail.com