cliprompt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2c39aedd67c12a2734f38e679d32c7b1ae6c8f6
-  data.tar.gz: 5e604e2d805ee1d616458b95f63223eb46d0151c
+  metadata.gz: 86d11cf88a04a54a9de51a6c0c4b13f10e990742
+  data.tar.gz: 26f54665588aca02d7eab0ed3d854a996b1452f4
 SHA512:
-  metadata.gz: 610a45749b91f060bdf845e8a076cafb9c28adb0cd9532583d6045b870ac20654f654d19082bf67bc9bc52bf9635a224833dcd96878839627d58ffbc02de591f
-  data.tar.gz: f4b5741a5b759afccb146d7496d8e0870abf888bbffe9a064ff6ee9374843732f0f94bc44530da6839614b48b44687bf54a34d0173829ce184e92f71bb77d758
+  metadata.gz: 28dbc268c87c25ced11fdb697e44edbcf916442f155eae97410e2ce4e9325e29eb492e305403e10bd27bfb1816559389a2d270d730237236a298a4db92114b2d
+  data.tar.gz: bb58e7977ac42c5642674eb78672ae02224bab65d74daa98b3d395e51b340f51b5a372c58417eeb8525a782e0b03d1df82feda73223bf0cf8fcefe15f40d4e2d

data/README.md

@@ -2,16 +2,17 @@ Cliprompt
 ==============
 
 [![Gem Version](https://badge.fury.io/rb/cliprompt.png)](http://rubygems.org/gems/cliprompt)
+[![Downloads](http://img.shields.io/gem/dt/cliprompt.svg)](https://rubygems.org/gems/cliprompt)
 [![Build Status](https://travis-ci.org/mose/cliprompt.png?branch=master)](https://travis-ci.org/mose/cliprompt)
 [![Coverage Status](https://coveralls.io/repos/mose/cliprompt/badge.png?branch=master)](https://coveralls.io/r/mose/cliprompt?branch=master)
 [![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)
+[![Inch CI](https://inch-ci.org/github/mose/cliprompt.svg)](https://inch-ci.org/github/mose/cliprompt)
 
 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
 ----------
-
 - manages questions, choices, default values, yes/no values (done)
 - makes possible to have env vars set for defaults (done)
 

data/lib/cliprompt/optionset.rb

@@ -22,6 +22,7 @@ module Cliprompt
       end
     end
 
+    # placeholder for nil type objects
     def parse_nilclass(args)
     end
 

data/lib/cliprompt/version.rb

@@ -1,3 +1,3 @@
 module Cliprompt
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/cliprompt.rb

@@ -13,6 +13,7 @@ module Cliprompt
   MSG_INPUT_A_NUMBER = "You need input a number."
   MSG_CHOSE_A_NUMBER = "Choose a number:"
 
+  # interactive setup of option
   def ask(question, *options)
     if options[0].class == Optionset
       opts = options[0]
@@ -25,6 +26,7 @@ module Cliprompt
     opts.validate(question, answer)
   end
 
+  # if environment var is set, use it, otherwise, ask for a value
   def guess(env, question, *options)
     opts = Optionset.new(*options)
     if ENV[env]
@@ -34,23 +36,30 @@ module Cliprompt
     end
   end
 
+  # output a message
+  # message - string to output
   def say(message)
     output.puts message
   end
 
+  # paints a message in bold and red and output it
+  # message - string to paint
   def shout(message)
     output.puts Paint[message, :bold, :red ]
   end
 
+  # makes possible to set input and output
   def setio(input, output)
     @@input = input
     @@output = output
   end
 
+  # defaults to STDIN
   def input
     @@input ||= STDIN
   end
 
+  # defaults to STDOUT
   def output
     @@output ||= STDOUT
   end

data/spec/lib/cliprompt/optionset_spec.rb

@@ -194,21 +194,21 @@ describe Cliprompt::Optionset do
     context 'when enter key is hit,' do
       Given(:input) { '' }
       Given(:set) { Cliprompt::Optionset.new() }
-      When { set.stub(:check_default).with(question) }
+      When { allow(set).to receive(:check_default).with(question) }
       Then { expect(set).to receive(:check_default).with(question) }
       And  { expect{ set.validate(question, input) }.not_to raise_error }
     end
     context 'when it is a boolean,' do
       Given(:input) { 'x' }
       Given(:set) { Cliprompt::Optionset.new(boolean: true) }
-      When { set.stub(:check_boolean).with(question, input) }
+      When { allow(set).to receive(:check_boolean).with(question, input) }
       Then { expect(set).to receive(:check_boolean).with(question, input) }
       And  { expect{ set.validate(question, input) }.not_to raise_error }
     end
     context 'when it is a choice list,' do
       Given(:input) { 'x' }
       Given(:set) { Cliprompt::Optionset.new(choices: [1,2,3]) }
-      When { set.stub(:check_choices).with(question, input) }
+      When { allow(set).to receive(:check_choices).with(question, input) }
       Then { expect(set).to receive(:check_choices).with(question, input) }
       And  { expect{ set.validate(question, input) }.not_to raise_error }
     end
@@ -224,7 +224,7 @@ describe Cliprompt::Optionset do
     Given(:msg) { Cliprompt::MSG_MANDATORY_TEXT }
     context 'when there is no default set,' do
       Given(:set) { Cliprompt::Optionset.new() }
-      When { set.stub(:ask_again).with(question, msg) }
+      When { allow(set).to receive(:ask_again).with(question, msg) }
       Then { expect(set).to receive(:ask_again).with(question, msg) }
       And  { expect{ set.check_default(question) }.not_to raise_error }
      end
@@ -243,7 +243,7 @@ describe Cliprompt::Optionset do
     Given(:set) { Cliprompt::Optionset.new(boolean: true) }
     context 'when a non yes-no answer is given,' do
       When(:input) { 'xxx' }
-      When { set.stub(:ask_again).with(question, msg) }
+      When { allow(set).to receive(:ask_again).with(question, msg) }
       Then { expect(set).to receive(:ask_again).with(question, msg) }
       And  { expect{ set.check_boolean(question, input) }.not_to raise_error }
      end
@@ -272,7 +272,7 @@ describe Cliprompt::Optionset do
     Given(:set) { Cliprompt::Optionset.new(choices: choices) }
     context 'when answer is not in choices list,' do
       When(:input) { 'x' }
-      When { set.stub(:ask_again).with(question, msg) }
+      When { allow(set).to receive(:ask_again).with(question, msg) }
       Then { expect(set).to receive(:ask_again).with(question, msg) }
       And  { expect{ set.check_choices(question, input) }.not_to raise_error }
      end
@@ -287,8 +287,8 @@ describe Cliprompt::Optionset do
     Given(:question) { 'so what?' }
     Given(:msg) { 'heho gimme something' }
     Given(:set) { Cliprompt::Optionset.new() }
-    When { Cliprompt.stub(:shout).with(msg) }
-    When { Cliprompt.stub(:ask).with(question, set) }
+    When { allow(Cliprompt).to receive(:shout).with(msg) }
+    When { allow(Cliprompt).to receive(:ask).with(question, set) }
     Then { expect(Cliprompt).to receive(:shout).with(msg) }
     And  { expect(Cliprompt).to receive(:ask).with(question, set) }
     And  { expect{ set.ask_again(question, msg)}.not_to raise_error }

data/spec/lib/cliprompt_spec.rb

@@ -14,44 +14,44 @@ describe Cliprompt do
     Given(:answer) { 'xxx' }
     context 'without default,' do
       When(:args) { }
-      When { input.stub(:gets).and_return answer }
+      When { allow(input).to receive(:gets).and_return answer }
       Then { expect(subject.ask(question, args)).to eq answer }
       And  { expect(output.string).to eq "#{question} " }
     end
     context 'with a default,' do
       When(:default) { 'ooo' }
       When(:args) { { default: default } }
-      When { input.stub(:gets).and_return answer }
+      When { allow(input).to receive(:gets).and_return answer }
       Then { expect(subject.ask(question, args)).to eq answer }
       And  { expect(output.string).to eq "#{question} [#{default}] " }
     end
     context 'with an optionset,' do
       When(:args) { Cliprompt::Optionset.new() }
-      When { input.stub(:gets).and_return answer }
+      When { allow(input).to receive(:gets).and_return answer }
       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' }
+      When { allow(input).to receive(: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 '' }
+      When { allow(input).to receive(: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} [0] " }
     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' }
+      When { allow(input).to receive(: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' }
+      When { allow(input).to receive(: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
@@ -69,7 +69,7 @@ describe Cliprompt do
     end
     context 'when env var is not provided,' do
       When(:answer) { 'ooo' }
-      When { input.stub(:gets).and_return answer }
+      When { allow(input).to receive(:gets).and_return answer }
       Then { expect(subject.guess(env_var, question, args)).to eq answer }
       And  { expect(output.string).to eq "#{question} " }
     end

data/spec/spec_helper.rb

@@ -11,9 +11,6 @@ if ENV['COV']
   end
   SimpleCov.start :hpcli
 else
-  # require 'coveralls'
-  # Coveralls.wear!
-
   require "codeclimate-test-reporter"
   CodeClimate::TestReporter.start
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliprompt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-given
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -116,18 +102,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".rspec"
-- ".ruby-version"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- cliprompt.gemspec
-- example.rb
 - lib/cliprompt.rb
 - lib/cliprompt/optionset.rb
 - lib/cliprompt/version.rb
@@ -154,11 +130,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Env aware lib for CLI prompt.
 test_files:
-- spec/lib/cliprompt/optionset_spec.rb
-- spec/lib/cliprompt_spec.rb
 - spec/spec_helper.rb
+- spec/lib/cliprompt_spec.rb
+- spec/lib/cliprompt/optionset_spec.rb

data/.coveralls.yml

@@ -1 +0,0 @@
-repo_token: k1iNRfDdAPW1ajziFDqPE0sZHTfbCtyA2

data/.gitignore

@@ -1,23 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-vendor/

data/.rspec

@@ -1,3 +0,0 @@
---color
---tty
---format documentation

data/.ruby-version

@@ -1 +0,0 @@
-2.1.1

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-bundler_args: --path vendor
-cache: bundler
-rvm:
-  - 1.9.3
-  - 2.1.1
-env:
-  - CODECLIMATE_REPO_TOKEN=6db08b5c1a63559766b1277a5dc1dfb7ea10e02594180a7eb5c755bba50f40de

data/CHANGELOG.md

@@ -1,42 +0,0 @@
-Cliprompt Changelog
-=====================
-
-v0.1.0 - 2014-05-10
--------------------
-
-- fix tests for rspec 3 compliance
-
-v0.0.6 - 2014-08-10
---------------------
-
-- fix validation of list type to be a number
-
-v0.0.5 - 2014-05-27
---------------------
-
-- fix to one space after question that was 2 spaces when no default is provided
-- when choices are a list, show the default in the question, in more than in the list
-- clean some ruby warnings (running with --debug helps)
-
-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/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in cliprompt.gemspec
-gemspec

data/Rakefile

@@ -1,14 +0,0 @@
-require "bundler/gem_tasks"
-
-require 'rake/testtask'
-require 'rspec/core/rake_task' # RSpec 2.0
-
-desc 'launch rspec tests'
-task :spec do
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.rspec_opts = ['-c', '-f progress', '-r ./spec/spec_helper.rb']
-    t.pattern = 'spec/lib/**/*_spec.rb'
-  end
-end
-
-task default: :spec

data/cliprompt.gemspec

@@ -1,29 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cliprompt/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "cliprompt"
-  spec.version       = Cliprompt::VERSION
-  spec.authors       = ["mose"]
-  spec.email         = ["mose@mose.com"]
-  spec.summary       = %q{Env aware lib for CLI prompt.}
-  spec.description   = %q{This library provides a simple DSL for managing user interaction in a CLI application.}
-  spec.homepage      = "https://github.com/mose/cliprompt"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency 'paint'
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec-given'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-end

data/example.rb

@@ -1,69 +0,0 @@
-require_relative 'lib/cliprompt'
-
-class Myclass
-  include Cliprompt
-
-  def initialize
-  end
-
-  def askit
-    puts '-------------------'
-    puts 'numeric default'
-    show "what is your age?", 42
-    show "what is your size?", 6.2
-    puts '-------------------'
-    puts 'Free form'
-    show "This simply ask for a simple form mandatory thing?"
-    show "This simply ask for a simple form mandatory thing?", 'with a default'
-    show "This simply ask for a simple form mandatory thing?", default: 'with a default again'
-    puts '-------------------'
-    puts 'yes/no'
-    show 'a boolean?', 'y/N'
-    show 'a boolean?', 'yN'
-    show 'a boolean?', 'yesno'
-    show 'a boolean?', 'yesNo'
-    show 'a boolean?', boolean: true
-    show 'a boolean?', boolean: true, default: false
-    puts '-------------------'
-    puts 'a list of choices'
-    show 'a list without default?', [22, 33, 44, '55']
-    show 'a list with default?', ['22', '33', '=44', '55']
-    show 'a list without default?', choices: ['22', '33', '44', '55'], default: 22
-    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 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}"
-    puts
-  end
-
-  def showguess(*args)
-    it = guess *args
-    puts "-- returned #{it.inspect}"
-    puts
-  end
-
-end
-
-m = Myclass.new
-m.guessit
-m.askit
-m.biglist