sawaal 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6951a118f49374178545e4c34d8e19341b872542
-  data.tar.gz: a6d932398b2d7c1c7ef6eb9eab3e13eae45d6df1
+  metadata.gz: 5e978a9b6e143d26214406463c01e71a451e7a68
+  data.tar.gz: 71902ca54956076caad312c058a26417018f8b50
 SHA512:
-  metadata.gz: 35d8afd33063c9dda00824903d1b1ca78e9ba4ffd89f557454e68119464fa64c29bc96d315b88fd6356628127cadbab8f2ae8868e09bb410aa1199298909dc5f
-  data.tar.gz: 3e45020160d7867a1d908dde9ef0821632c10512e90643b34a0c96b6421a230380c628aaf8584fda1b410797303593505e5b9284ac260b43a174fd19165c6f74
+  metadata.gz: 52ac2030ccee6a5e821e23178ed0e713d2574c59c73e32ac25a424a89aabd260c761478d2855e7cfefdb4fb67e38b9c1feb7172127488b0075a434a40e984e64
+  data.tar.gz: 22a8352be84bc657308306c2be8c7443c7231c8ca20f4f5ff33247410ae10cda5c3f25e33d61dd8eda959787f9ce392714524583166ffbbd44fa9aadb79550f7

data/CHANGELOG.md

@@ -14,6 +14,11 @@ List of changes so far that have been released to ruby gems.
 
 <!-- markdown-toc end -->
 
+1.0.1 / 2015-07-29
+==================
+
+Bugfixes and minor improvements
+
 1.0.0 / 2015-07-27
 ==================
 

data/README.md

@@ -3,7 +3,6 @@
 [![Build](http://img.shields.io/travis-ci/anshulverma/sawaal.svg?style=flat-square)](https://travis-ci.org/anshulverma/sawaal)
 [![Coverage](http://img.shields.io/codeclimate/coverage/github/anshulverma/sawaal.svg?style=flat-square)](https://codeclimate.com/github/anshulverma/sawaal)
 [![Quality](http://img.shields.io/codeclimate/github/anshulverma/sawaal.svg?style=flat-square)](https://codeclimate.com/github/anshulverma/sawaal)
-[![Dependencies](http://img.shields.io/gemnasium/anshulverma/sawaal.svg?style=flat-square)](https://gemnasium.com/anshulverma/sawaal)
 [![Inline docs](http://inch-ci.org/github/anshulverma/sawaal.svg?style=flat-square)](http://inch-ci.org/github/anshulverma/sawaal)
 [![Downloads](http://img.shields.io/gem/dt/sawaal.svg?style=flat-square)](https://rubygems.org/gems/sawaal)
 
@@ -11,16 +10,35 @@
 **Table of Contents**
 
 - [sawaal](#sawaal)
-- [Summary](#summary)
+- [Quickstart](#quickstart)
     - [Installation](#installation)
-    - [Usage](#usage)
     - [Contributing](#contributing)
 
 <!-- markdown-toc end -->
 
-# Summary
+# Quickstart
 
-TODO: Write a gem description
+Here is an example usage of this gem. This should be enough to get
+started with `sawaal`.
+
+``` ruby
+require 'sawaal'
+
+selected = Sawaal::Selector.choose(
+    'which key is the best?', {
+      :key1 => 'key1 is the best',
+      :key2 => 'key2 is the best for sure',
+      :key3 => 'key3 might be the one',
+      :key4 => 'key4 is surely the best',
+      :key5 => 'key5'
+    })
+
+puts selected
+```
+
+The only thing to remember is that in the choose call, you can use
+either a hash of options or an array. If you used an array, the return
+selected value will be the 0-based index of the selected item.
 
 ## Installation
 
@@ -38,10 +56,6 @@ Or install it yourself as:
 
     $ gem install sawaal
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/sawaal/fork )

data/lib/sawaal.rb

@@ -1,7 +1,13 @@
 # encoding: utf-8
 
-require 'sawaal/version'
+require 'io/console'
+
+require 'sawaal/color'
+require 'sawaal/cursor'
+require 'sawaal/selections'
 require 'sawaal/selector'
+require 'sawaal/tty'
+require 'sawaal/version'
 
 # Helps a command line application by allowing it to ask
 # multiple choice questions

data/lib/sawaal/cursor.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-require 'sawaal/color'
-require 'sawaal/tty'
-
 module Sawaal
   # Handle cursor movements and text highlighting
   #

data/lib/sawaal/selector.rb

@@ -1,10 +1,5 @@
 # encoding: utf-8
 
-require 'io/console'
-
-require 'sawaal/cursor'
-require 'sawaal/selections'
-
 module Sawaal
   # Way into invoking the selection
   #

data/lib/sawaal/version.rb

@@ -2,5 +2,5 @@
 
 # Track version of the module
 module Sawaal
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/spec_helper.rb

@@ -7,10 +7,6 @@ if ENV['CI']
     config.logger.level = Logger::WARN
   end
   CodeClimate::TestReporter.start
-
-  # enable coveralls
-  require 'coveralls'
-  Coveralls.wear!
 end
 
 # enable simplecov for code coverage

data/spec/version_spec.rb

@@ -2,6 +2,6 @@
 
 describe Sawaal do
   it 'has a valid version tag' do
-    expect(Sawaal::VERSION).to(eq('1.0.0'))
+    expect(Sawaal::VERSION).to(eq('1.0.1'))
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: sawaal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 description: |2
@@ -61,17 +61,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Helper gem for asking questions on terminal