cliprompt 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f310eea2a9640504286446d80f3fe6d22a65607
-  data.tar.gz: 187a52dd0480192fe77571d0b937f8c2b4c66c4c
+  metadata.gz: ad8694ae5f71787a7a5e51c1451f7f15ce16abe4
+  data.tar.gz: 1e41e408ad7acf5c27c3e7e031e4ee142abd5c59
 SHA512:
-  metadata.gz: e74304a82d4c37c39f3d5d2289cb8239635ec57738e4bf36d250745dcdb032ae8cd20494901fa8ad2870a01c4010678d0c9385968910574abf1b05b4f7a968cf
-  data.tar.gz: 2b7acdb26a178e024213beac9a4be22f5e6f08f6ae5cbc7ebca69a9b781aa7fed84f198f8ca9947f70c6bac64da62ca14894371159f92a13aa909a6f369e5bda
+  metadata.gz: 1f66243c356834abe4dbb25e165496453121fd536e16d9f4ed3127618b2566a2f3d88f8d2a8cba76d1361b4a5b5bd02bf0c88c46395983b5b2115e60c666727b
+  data.tar.gz: 992a171945a441a158ebd2ec25863944a12620d8da79322838029b62c4fc065e46f0b34ca17320f62f4b206dc591ef64c717cbb49862d5d9de534d9ac4cd8c6a

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Cliprompt Changelog
 =====================
 
+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
 -----------
 

data/README.md

@@ -7,13 +7,13 @@ 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.
+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.
 
 Features
 ----------
 
 - manages questions, choices, default values, yes/no values (done)
-- makes possible to have env vars set for defaults (todo)
+- makes possible to have env vars set for defaults (done)
 
 Usage
 ----------
@@ -33,6 +33,9 @@ class Myclass
     @url = ask "What is the url of Myclass?"
     @ssl = ask "Is it using SSL?", 'y/N'
     @age = ask "What is the age of the captain?", [22,33,=44,55]
+    # if you set set ENV['SOMEVAR'], it will override the answer and won't display the question
+    # in such case you still can use normal options and nev var will be validated against it (for boolean or choices setup)
+    @age = guess 'SOMEVAR', "What is the age of the captain?", [22,33,=44,55]
   end
 end
 ```

data/example.rb

@@ -32,12 +32,28 @@ class Myclass
     show 'a list with default?', choices: ['22', 33, '=44', '55']
   end
 
+  def guessit
+    puts '-------------------'
+    showguess 'SOMEVAR', "what is your var?"
+    showguess 'SOMEVAR', "what is your var?", 42
+    showguess 'SOMEVAR', "what is your var?", boolean: true
+    showguess 'SOMEVAR', "what is your var?", [12, 'aa']
+  end
+
   def show(*args)
     it = ask *args
     puts "-- returned #{it.inspect}"
     puts
   end
+
+  def showguess(*args)
+    it = guess *args
+    puts "-- returned #{it.inspect}"
+    puts
+  end
+
 end
 
 m = Myclass.new
+m.guessit
 m.askit

data/lib/cliprompt/optionset.rb

@@ -56,7 +56,7 @@ module Cliprompt
     end
 
     def parse_string(arg)
-      if arg.downcase.match /^y(es)?(\/)?n(o)?/
+      if arg.match /^[yY1](es)?(\/)?[nN0](o)?/
         @boolean = true
         if /y(es)?(\/)?N/.match arg
           @default = false
@@ -99,9 +99,8 @@ module Cliprompt
     end
 
     def check_boolean(question, answer)
-      answer.downcase!
-      return ask_again(question, Cliprompt::MSG_YES_OR_NO) unless /^(y(es)?|n(o)?)$/.match(answer)
-      !/^y(es)?$/.match(answer).nil?
+      return ask_again(question, Cliprompt::MSG_YES_OR_NO) unless /^([yY1](es)?|[nN0](o)?)$/.match(answer)
+      !/^[yY1](es)?$/.match(answer).nil?
     end
 
     def check_choices(question, answer)

data/lib/cliprompt/version.rb

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

data/lib/cliprompt.rb

@@ -8,7 +8,7 @@ module Cliprompt
   module_function
 
   MSG_MANDATORY_TEXT = "Sorry you need to fill that information."
-  MSG_YES_OR_NO = "You need to answer by yes, no, y or n."
+  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."
 
   def ask(question, *options)
@@ -23,6 +23,15 @@ module Cliprompt
     opts.validate(question, answer)
   end
 
+  def guess(env, question, *options)
+    opts = Optionset.new *options
+    if ENV[env]
+      opts.validate(question, ENV[env])
+    else
+      ask question, opts
+    end
+  end
+
   def say(message)
     output.puts message
   end

data/spec/lib/cliprompt_spec.rb

@@ -33,6 +33,24 @@ describe Cliprompt do
     end
   end
 
+  describe '.guess' do
+    Given(:question) { 'wazza?' }
+    Given(:env_var) { 'SOMEVAR' }
+    Given(:args) { }
+    context 'when env var is provided,' do
+      When(:env_value) { 'xxx' }
+      When { ENV[env_var] = env_value }
+      Then { expect(subject.guess(env_var, question, args)).to eq env_value }
+      And  { ENV.delete(env_var) }
+    end
+    context 'when env var is not provided,' do
+      When(:answer) { 'ooo' }
+      When { input.stub(:gets).and_return answer }
+      Then { expect(subject.guess(env_var, question, args)).to eq answer }
+      And  { expect(output.string).to eq "#{question}  " }
+    end
+  end
+
   describe '.say' do
     Given(:msg) { "hah" }
     When { subject.say msg }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliprompt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - mose