inputs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a50fd879c69944fad054e0983b3bab7cae9ea75e
-  data.tar.gz: ea699d2e36e45c04ddf7e16b88fb39cb3c558d99
+  metadata.gz: 81803c73d9c385182e658da5427ddb0e751bf7f7
+  data.tar.gz: 34f780896f20a7e2ffd9217268f899b52102e076
 SHA512:
-  metadata.gz: aaca1b573e19cd0346316ddfee1cdf8ea7e304935af2f732a01a51a2e025bbb2812f9eae46b7550a1892c5b35e2bc1b9c5ec19de1f6ca57560cc6871f5938fd1
-  data.tar.gz: dd24dd3fb5cd4ef71e6895460e540c29dbd71153514d15951daa241f27a45b214bebf7181b072473729f7a44f2ca66d7d330bf8996a8a32698c748cb78d98333
+  metadata.gz: 93911d3fbfd8558a9fd975021336153ca2068c6a8cb58656166179beae087a9bbeb69034c19a24f39a4d857ad1cedcc0e54c74726938995c70074bad2c568179
+  data.tar.gz: 41c90ac69ef580ff00647a1f01bae6787195ab7743e1cdf3e9d2d3eca9548fb811529026e822900852958285cfdde304212f3ef9d881f0eaab20d0eedfcb9247

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.2.3
+  - 2.3.0
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -1,7 +1,16 @@
+[![Build Status](https://travis-ci.org/equivalent/inputs.svg?branch=master)](https://travis-ci.org/equivalent/inputs)
+![Gittens](http://gittens.r15.railsrumble.com//badge/equivalent/inputs)
+[![Open Thanks](https://thawing-falls-79026.herokuapp.com/images/thanks-2.svg)](https://thawing-falls-79026.herokuapp.com/r/fpjrqlob)
+
 # Inputs
 
 Really stupid primitive Gem that will handle some common console operations.
 
+The gem aims to be really simple. If you looking for something more complex I recommend to use
+[TTY](http://piotrmurach.github.io/tty/),[tty-prompt](https://github.com/piotrmurach/tty-prompt)
+
+[Reddit discussion](https://www.reddit.com/r/ruby/comments/4i5dep/gem_inputs_another_pointless_gem_for_handling/)
+
 ```
 require 'inputs'
 
@@ -13,6 +22,10 @@ Inputs.name('What is your name')
 # What is your name
 # => String
 
+Inputs.name!('Do you want to skip this question?')
+# What is your name
+# => String or Nil if no input
+
 Inputs.names('Names of your parents')
 # Names of your parents
 # => Array
@@ -31,17 +44,85 @@ Inputs.pick(['cat', 'dog'])
 
 ## Installation
 
-Gem is so primitive that I'm not even bothering to release it to Rubygems
+Option 1:
+
+`gem install inputs`
+
+Option 2 (If you use `bundler`) :
 
 ```ruby
-gem 'inputs', github: 'equivalent/inputs'
+# Gemfile
+gem 'inputs'
 ```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
+
+## Example
+
+```ruby
+# foo.rb
+require 'inputs'
+
+class Foo
+  def call
+    name = Inputs.name("what is your name")
+
+    if Inputs.yn("Ok #{name}, do you want to learn music instrument?")
+      instrument = Inputs.pick(instrument_options)
+
+      case instrument
+      when drums
+        puts 'Metal dude ! \,,/'
+      when guitar
+        puts "Rock on dude !"
+      when harp
+        puts "W.T.F dude ?"
+      end
+    else
+      puts "Then go home #{name} !"
+    end
+  end
+
+  private
+    def instrument_options
+      [
+        drums,
+        guitar,
+        harp
+      ]
+    end
+
+    def drums
+      'Drums'
+    end
+
+    def guitar
+      'Guitar'
+    end
+
+    def harp
+      'Harp'
+    end
+end
+
+Foo.new.call
+```
+
+![Inputs gem example](https://raw.githubusercontent.com/equivalent/scrapbook2/master/assets/images/2016/inptus-gem-example.png)
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+## Contribution
+
+I welcome any suggestions & Pull Requests. Currently there is not lot of
+tests as I thought I will never release this lib so if you decide to do
+a PR please write a test.
+
+Thank you
+

data/inputs.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rspec", "~> 3"
   spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 11.1"
 end

data/lib/inputs.rb

@@ -17,6 +17,7 @@ module Inputs
     end
   end
 
+  # Outputs a question and returns an input string. If no string is typed it returns empty string ("")
   def self.name(question)
     output question
     name = _input_evaluator.call
@@ -25,6 +26,17 @@ module Inputs
     name
   end
 
+  # Outputs a question and returns an input string. If no string is typed it returns nil
+  def self.name!(question)
+    output question
+    name = _input_evaluator.call
+    name = name.chomp
+    if name != ''
+      output name.green
+      name
+    end
+  end
+
   def self.names(question)
     output question + " (Comma separated)"
     names = _input_evaluator.call

data/lib/inputs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inputs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 description: 'Stupid pointless gem for lazy Ruby developer to implement console interfaces
   for input fields like y/n questions, names, ...  '
 email:
@@ -107,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pointless Gem for creating console input interfaces