cliprompt 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad8694ae5f71787a7a5e51c1451f7f15ce16abe4
-  data.tar.gz: 1e41e408ad7acf5c27c3e7e031e4ee142abd5c59
+  metadata.gz: 130c7d8782cb21bd861497572e1f70c561d3713a
+  data.tar.gz: a7e8e0ed439cb3efb295931f8149a2f602c6df3e
 SHA512:
-  metadata.gz: 1f66243c356834abe4dbb25e165496453121fd536e16d9f4ed3127618b2566a2f3d88f8d2a8cba76d1361b4a5b5bd02bf0c88c46395983b5b2115e60c666727b
-  data.tar.gz: 992a171945a441a158ebd2ec25863944a12620d8da79322838029b62c4fc065e46f0b34ca17320f62f4b206dc591ef64c717cbb49862d5d9de534d9ac4cd8c6a
+  metadata.gz: 7a33c9fc219191d65e7f33fba11437d87795dfbc91387c6389ef9e79408297df0537f64158be384524f5097eddca13e7e700752a76d6f28ba67f3dcac1b72706
+  data.tar.gz: 2bdb0c2ee17d1e8017ee6d7b28eff9b58b7b5e15ecc1308b7bf5d3fbf8cee15973a30366379ecaaf574bb136c7ced84c99baac769afbe89bdde6cb5f06f709c0

data/CHANGELOG.md

@@ -1,19 +1,25 @@
 Cliprompt Changelog
 =====================
 
+v0.0.4 - 2014-05-24
+--------------------
+
+- add an option `aslist` for we can decide if we want it as a list or not
+- add a way to display big list, when choices are more than 5, make a list out of them
+
 v0.0.3 - 2014-05-20
--------------
+--------------------
 
 - relax the boolean check so 1 and 0 can be used for yes and no (especially for env vars)
 - added a `guess` method to have env var override question if set
 
 v0.0.2 - 2014-05-20
------------
+--------------------
 
 - fix case when numbers are used in choices
 - added some test coverage for further evolution easiness
 
 v0.0.1 - 2014-05-19
--------------
+--------------------
 
 - first draft

data/README.md

@@ -7,7 +7,7 @@ Cliprompt
 [![Dependency Status](https://gemnasium.com/mose/cliprompt.svg)](https://gemnasium.com/mose/cliprompt)
 [![Code Climate](https://codeclimate.com/github/mose/cliprompt.png)](https://codeclimate.com/github/mose/cliprompt)
 
-This library provides a simple DSL for managing user interaction in a CLI application. Still under development, not stable yet. Check the [Changelog](https://github.com/mose/cliprompt/blob/master/CHANGELOG.md) to see what is in already.
+This library provides a simple DSL for managing user interaction in a CLI application. Still under development, but usable already. Check the [Changelog](https://github.com/mose/cliprompt/blob/master/CHANGELOG.md) to see what is in already.
 
 Features
 ----------

data/example.rb

@@ -40,6 +40,15 @@ class Myclass
     showguess 'SOMEVAR', "what is your var?", [12, 'aa']
   end
 
+  def biglist
+    puts '-------------------'
+    puts 'a long list of choices'
+    show 'a list with default?', [22, 33, 44, '=55', 66, 77, 'something else']
+    show 'a list without default?', [22, 33, 44, '55', 66, 77, 'something else']
+    show 'a big list of choices but not in list?', choices: [22, 33, 44, '=55', 66, 77, 'something else'], aslist: false
+    show 'a small list of choices but we want it in list?', choices: [22, 33, '=44'], aslist: true
+  end
+
   def show(*args)
     it = ask *args
     puts "-- returned #{it.inspect}"
@@ -55,5 +64,6 @@ class Myclass
 end
 
 m = Myclass.new
-m.guessit
-m.askit
+#m.guessit
+#m.askit
+m.biglist

data/lib/cliprompt/optionset.rb

@@ -5,13 +5,14 @@ module Cliprompt
 
   class Optionset
 
-    attr_reader :choices, :default, :boolean, :envdefault
+    attr_reader :choices, :default, :boolean, :envdefault, :aslist
 
     def initialize(options = nil)
       @choices = []
       @default = nil
       @boolean = false
       @envdefault = nil
+      @aslist = false
       @type = options.class.name.downcase
       meth = "parse_#{@type}".to_sym
       if respond_to? meth
@@ -32,6 +33,11 @@ module Cliprompt
       else
         @default ||= args[:default] || args['default']
       end
+      if args[:aslist] == false || args['aslist'] == false
+        @aslist = false
+      elsif args[:aslist] == true || args['aslist'] == true
+        @aslist = true
+      end
       @boolean = args[:boolean] || args['boolean']
       @default = true if (@boolean && @default.nil?)
       @envdefault = args[:env] || args['env']
@@ -45,6 +51,7 @@ module Cliprompt
           a
         end
       end
+      @aslist = (@choices.count > 5)
     end
 
     def parse_fixnum(arg)
@@ -87,7 +94,11 @@ module Cliprompt
       elsif @boolean
         check_boolean question, answer
       elsif @choices.count > 0
-        check_choices question, answer
+        if @aslist
+          check_list question, answer
+        else
+          check_choices question, answer
+        end
       else
         answer
       end
@@ -108,6 +119,11 @@ module Cliprompt
       answer
     end
 
+    def check_list(question, answer)
+      return ask_again(question, Cliprompt::MSG_CHOSE_IN_LIST) unless answer.to_i < @choices.count
+      @choices[answer.to_i]
+    end
+
     def ask_again(question, msg)
       Cliprompt.shout msg
       Cliprompt.ask question, self

data/lib/cliprompt/version.rb

@@ -1,3 +1,3 @@
 module Cliprompt
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/cliprompt.rb

@@ -10,6 +10,7 @@ module Cliprompt
   MSG_MANDATORY_TEXT = "Sorry you need to fill that information."
   MSG_YES_OR_NO = "You need to answer by yes, no, y, n, 1 or 0."
   MSG_CHOSE_IN_LIST = "You need to chose between the available options."
+  MSG_CHOSE_A_NUMBER = "Choose a number:"
 
   def ask(question, *options)
     if options[0].class == Optionset
@@ -17,7 +18,19 @@ module Cliprompt
     else
       opts = Optionset.new *options
     end
-    output.print "#{question} #{opts.display} "
+    if opts.aslist
+      output.puts "#{question}"
+      opts.choices.each_with_index do |choice, i|
+        if opts.default == choice
+          output.printf "> %-3s %s\n", i, choice
+        else
+          output.printf "  %-3s %s\n", i, choice
+        end
+      end
+      output.print "#{MSG_CHOSE_A_NUMBER} "
+    else
+      output.print "#{question} #{opts.display} "
+    end
     answer = input.gets.chomp
     output.flush
     opts.validate(question, answer)

data/spec/lib/cliprompt_spec.rb

@@ -31,6 +31,30 @@ describe Cliprompt do
       Then { expect(subject.ask(question, args)).to eq answer }
       And  { expect(output.string).to eq "#{question}  " }
     end
+    context 'with choices requested as a list,' do
+      When(:args) { { choices: ['aaa', 'bbb', 'ccc'], aslist: true } }
+      When { input.stub(:gets).and_return '1' }
+      Then { expect(subject.ask(question, args)).to eq 'bbb' }
+      And  { expect(output.string).to eq "#{question}\n  0   aaa\n  1   bbb\n  2   ccc\n#{Cliprompt::MSG_CHOSE_A_NUMBER} " }
+    end
+    context 'with choices requested as a list with a default,' do
+      When(:args) { { choices: ['=aaa', 'bbb', 'ccc'], aslist: true } }
+      When { input.stub(:gets).and_return '' }
+      Then { expect(subject.ask(question, args)).to eq 'aaa' }
+      And  { expect(output.string).to eq "#{question}\n> 0   aaa\n  1   bbb\n  2   ccc\n#{Cliprompt::MSG_CHOSE_A_NUMBER} " }
+    end
+    context 'with choices requested as a non-list despite there are many choices,' do
+      When(:args) { { choices: %w(aaa bbb ccc ddd eee fff), aslist: false } }
+      When { input.stub(:gets).and_return 'bbb' }
+      Then { expect(subject.ask(question, args)).to eq 'bbb' }
+      And  { expect(output.string).to eq "#{question} (aaa / bbb / ccc / ddd / eee / fff) " }
+    end
+    context 'with a big list of choices,' do
+      When(:args) { %w(aaa bbb ccc ddd eee fff) }
+      When { input.stub(:gets).and_return '5' }
+      Then { expect(subject.ask(question, args)).to eq 'fff' }
+      And  { expect(output.string).to eq "#{question}\n  0   aaa\n  1   bbb\n  2   ccc\n  3   ddd\n  4   eee\n  5   fff\n#{Cliprompt::MSG_CHOSE_A_NUMBER} " }
+    end
   end
 
   describe '.guess' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliprompt
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint