cli_miami 1.0.10.pre → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44cdb6180bc295546319336767322bf754f8839f
-  data.tar.gz: ebb3ecdff3f84bb6b05aab424c444dff26cc13c2
+  metadata.gz: 7de605bacb237ef651cea61f1379f0926e9ba766
+  data.tar.gz: 5444c029627276796187d75149b78bd0070ed383
 SHA512:
-  metadata.gz: 5bc15d68e3e49f20cbf87c23e1fd475602315f52514e9c5f2dff76fceccdda7327189b5769e2678415d6e0e70b008817c7381cc8d1f884074b508a488eae2978
-  data.tar.gz: fe25fb0ae7cbd5a015933a125f0683148271cf3c55c49fd30acb5206d65157ab74cb5c41495b3777c66398dfb8761c9533b004fc82ec7f1859272916636c1f1b
+  metadata.gz: 992140c26ada9a61508082b5aa88a99e20763078c255be4ad14ef4768a80f24c7a84293e9e00be241034cb4859e69259754d0673b7cb621dc72cc12010517ff2
+  data.tar.gz: 17cd92be02807fa74e80d5ac4e73d8c26a983bccd2222ecbe349331370845412e5d98e101fabcddd8c10d801f6782b11f0d8fe363d06bfbf6bd9a3ea1e348f51

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+##### 2.0.0.pre
+* renamed cli-miami to cli_miami
+
+##### 1.0.10.pre
+* developer only update
+  * integrations to travis, codeclimate & gemnasium

data/README.md

@@ -1,18 +1,23 @@
 [![gem version](https://badge.fury.io/rb/cli_miami.svg)](https://badge.fury.io/rb/cli_miami)
-[![dependencies](https://gemnasium.com/brewster1134/CLI-Miami.svg)](https://gemnasium.com/brewster1134/CLI-Miami)
-[![docs](http://inch-ci.org/github/brewster1134/CLI-Miami.svg?branch=master)](http://inch-ci.org/github/brewster1134/CLI-Miami)
-[![build](https://travis-ci.org/brewster1134/CLI-Miami.svg?branch=master)](https://travis-ci.org/brewster1134/CLI-Miami)
-[![coverage](https://coveralls.io/repos/brewster1134/CLI-Miami/badge.svg?branch=master)](https://coveralls.io/r/brewster1134/CLI-Miami?branch=master)
-[![code climate](https://codeclimate.com/github/brewster1134/CLI-Miami/badges/gpa.svg)](https://codeclimate.com/github/brewster1134/CLI-Miami)
-[![omniref](https://www.omniref.com/github/brewster1134/CLI-Miami.png)](https://www.omniref.com/github/brewster1134/CLI-Miami)
+[![dependencies](https://gemnasium.com/brewster1134/cli_miami.svg)](https://gemnasium.com/brewster1134/cli_miami)
+[![docs](http://inch-ci.org/github/brewster1134/cli_miami.svg?branch=master)](http://inch-ci.org/github/brewster1134/cli_miami)
+[![build](https://travis-ci.org/brewster1134/cli_miami.svg?branch=master)](https://travis-ci.org/brewster1134/cli_miami)
+[![coverage](https://coveralls.io/repos/brewster1134/cli_miami/badge.svg?branch=master)](https://coveralls.io/r/brewster1134/cli_miami?branch=master)
+[![code climate](https://codeclimate.com/github/brewster1134/cli_miami/badges/gpa.svg)](https://codeclimate.com/github/brewster1134/cli_miami)
 
 # CLI Miami
-A feature rich alternative for `gets` and `puts` for your cli interface
+###### A colorful & feature-rich alternative to gets & puts for your command line app
+---
 
+Build a rich command line experience for your app. CLI Miami lets you easily display clear & colorful information to your user, and prompting your user to enter information with a clear and concise approach. Easily request arrays, hashes, booleans, integers, floats, ranges, symbols, and even multiple choice. Additionally provide validation rules like minimum and maximum length, or regexp matching.
+
+---
+#### Install
 ```shell
 gem install cli_miami
 ```
 
+---
 _Gemfile_
 ```ruby
 # For the name-spaced methods CliMiami::A.sk & CliMiami::S.ay...
@@ -23,70 +28,196 @@ gem 'cli_miami', require: 'cli_miami/global'
 ```
 
 #### S.ay
-`S.ay` accepts 2 arguments, a string, and a variety of options
-_* see supported options below_
+###### Display information to the user
+---
+
+###### `S.ay` accepts a string as the first argument for the text to show, followed by a variety of styling options
+_* see Styling Options below_
 
 ```ruby
-S.ay 'Hello World', :color => :red
+S.ay 'Hello World', color: :red
 ```
 
-Sometimes you want to have multiple styles on a single line.  There are 2 ways to do this.
+If you want to mix styles on a single line, you can set newline to false
 
-The multi-line way using `:newline => false`
 ```ruby
-S.ay 'Hello ', :color => :red, :newline => false
-S.ay 'World', :color => :blue
+S.ay 'Hello ', color: :red, newline: false
+S.ay 'World', color: :blue
 ```
 
-Or on a single line using ANSI codes as methods. *All the ANSI color and style codes listed below can be used*
+#### A.sk
+###### Request information from the user
+---
+
+###### `A.sk` accepts the same styling options as `S.ay`
+_* see Styling Options below_
+
+There are 2 ways to handle the user's response.
+
 ```ruby
-S.ay "#{'Hello'.red} #{'World'.blue}"
+# passing the response to a block...
+A.sk 'What is your name?', color: :yellow do |response|
+  S.ay "Hello #{response}!", style: :bold
+end
+
+# returning the response through the `value` method
+response = A.sk 'What is your name?', color: :yellow
+S.ay "Hello #{response.value}!", style: :bold
 ```
 
-#### A.sk
-`A.sk` accepts the same arguments as `S.say`, with additional support for a block that passes the users response
+###### `A.sk` accepts an additional :type option for requesting specific values
 
 ```ruby
-A.sk 'What is your name?', :color => :yellow do |response|
-  S.ay "#{response} smells!", :style => :bold
-end
+A.sk 'What is your age?', type: :number
 ```
 
-#### Options
-Both `S.ay` and `A.sk` suport the same options
+#### Type Options
 
 ```ruby
-color:      => [symbol]             # See ansi color codes below
-bgcolor:    => [symbol]             # See ansi color codes below
-style:      => [symbol]             # See ansi style codes below. Can accept multiple styles as an array
-justify:    => [center|left|right]  # The type of justification to use
-padding:    => [integer]            # The maximum string size to justify text in
-indent:     => [integer]            # The number of characters to indent
-newline:    => [boolean]            # True if you want a newline after the output
-overwrite:  => [boolean]            # True if you want the next line to overwrite the current line
+:array
+:list             # Prompt for multiple responses for a single request
+
+:boolean          # Prompt for true/false response
+
+:dir
+:directory
+:file
+:folder
+:path             # Prompt for a local directory path
+
+:fixnum
+:integer
+:number           # Prompt for an integer
+
+:float            # Prompt for a decimal
+
+:multiple_choice  # Prompt for values from a defined list of choices (see Validation Options below)
+
+:hash
+:object           # Prompt for key/value pairs
+
+:range            # Prompt for a beginning and end numerical values
+
+:string           # Prompt for text
+
+:symbol           # Prompt for text that can convert to a proper ruby symbol
+```
+
+###### `A.sk` accepts additional validation options to further refine the user's response
+_* validation options vary depending on the :type_
+
+```ruby
+A.sk 'What is your age?', type: :number, min: 18, max: 99
+```
+
+#### Validation Options
+
+```ruby
+:array
+:list             
+  :min            # The least amount of responses allowed
+  :max            # The most amount of responses allowed
+  :value_options  # An optional hash of Type Options & Validation Options to be applied to each response
+
+:boolean
+  'true'
+  't'
+  'yes'
+  'y'             # The allowed values to represent `true`
+
+  'false'
+  'f'
+  'no'
+  'n'             # The allowed values to represent `false`
+
+:dir
+:directory
+:file
+:folder
+:path             # Must be a valid, existing path to a local file or folder
+
+:fixnum
+:float            
+:integer
+:number           
+  :min            # The lowest numerical value allowed
+  :max            # The highest numerical value allowed
+
+:multiple_choice
+  :choices        # An Array or Hash of allowed values to choose from
+                  # ['option 1', 'option 2', 'option 3']
+                  # { one: 'option 1', two: 'option 2', three: 'option 3' }
+  :min            # The least amount of responses allowed
+  :max            # The most amount of responses allowed
+
+:hash
+:object           
+  :keys           # An Array of keys that require a response
+  :min            # The least amount of key/value responses allowed
+  :max            # The most amount of key/value responses allowed
+  :value_options  # An optional hash of Type Options & Validation Options to be applied to each response value
+
+:range            
+  :min            # The smallest range of numerical values allowed
+  :max            # The largest range of numerical values allowed
+
+:string           
+  :min            # The least amount of characters allowed
+  :max            # The most amount of characters allowed
+  :regexp         # A regular expression the response must match
+
+:symbol           
+  :min            # The least amount of characters allowed
+  :max            # The most amount of characters allowed
+  :regexp         # A regular expression the response must match
+```
+
+#### Styling Options
+Both `S.ay` and `A.sk` suport the same styling options
+
+```ruby
+color:      [symbol]             # See ansi color codes below
+bgcolor:    [symbol]             # See ansi color codes below
+style:      [symbol]             # See ansi style codes below. Can accept multiple styles as an array
+justify:    [center|left|right]  # The type of justification to use
+padding:    [integer]            # The maximum string size to justify text in
+indent:     [integer]            # The number of characters to indent
+newline:    [boolean]            # Set to true if you want a newline after the output
 ```
 
 ###### ANSI Color Codes
-* `:black`
-* `:red`
-* `:green`
-* `:yellow`
-* `:blue`
-* `:magenta`
-* `:cyan`
-* `:white`
+
+```ruby
+:black
+:red
+:green
+:yellow
+:blue
+:magenta
+:cyan
+:white
+```
 
 ###### ANSI Style Codes
-* `:bold`
-* `:bright`
-* `:underline`
-* `:negative` _Swap foreground color with background color_
+
+```ruby
+:bold
+:bright
+:underline
+:negative   # Swap foreground color with background color
+```
 
 ### Development & Testing
 
 ```shell
-yuyi -m https://raw.githubusercontent.com/brewster1134/CLI-Miami/master/yuyi_menu
+# clone repo
+git clone https://github.com/brewster1134/cli_miami.git
+cd cli_miami
+
+# install dependencies
 bundle install
+
+# run watcher for linting and tests
 bundle exec guard
 ```
 

data/lib/cli_miami.rb

@@ -1,5 +1,4 @@
-#
-# load dependencies
+# Load dependencies
 #
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/keys'
@@ -7,7 +6,7 @@ require 'active_support/core_ext/string/inflections'
 require 'i18n'
 require 'readline'
 
-# open Hash class
+# Add custom Hash methods
 #
 class Hash
   def to_cli_miami_string
@@ -17,7 +16,7 @@ class Hash
   end
 end
 
-# open String class
+# Add custom String methods
 #
 class String
   def method_missing method, *args
@@ -39,17 +38,18 @@ class String
   end
 end
 
-# i18n
+# I18n
 #
-I18n.load_path += Dir["#{File.dirname(__FILE__)}/../i18n/*.yml"]
+I18n.load_path += Dir[File.expand_path(File.join('i18n', '*.yml'))]
+I18n.locale = ENV['LANG'].split('.').first.downcase
 I18n.reload!
 
-# readline
+# Readline
 #
 Readline.completion_append_character = '/'
 
-# creates Boolean type that true/false inherit
-# this allows true/false to respond to a single Boolean class to check for
+# Creates Boolean type that true/false inherit
+# This allows true/false to respond to a single Boolean class to check for
 #
 # rubocop:disable Style/Documentation
 module Boolean; end
@@ -57,7 +57,7 @@ class TrueClass; include Boolean; end
 class FalseClass; include Boolean; end
 # rubocop:enable Style/Documentation
 
-# create Cli Miami namespace and load library
+# Create Cli Miami namespace and load library
 #
 module CliMiami
   BOOLEAN_TRUE_VALUES = %w(true t yes y).freeze
@@ -202,6 +202,7 @@ module CliMiami
   end
 end
 
+# Load Cli Miami library
 require 'cli_miami/ask'
 require 'cli_miami/error'
 require 'cli_miami/metadata'

data/lib/cli_miami/error.rb

@@ -1,7 +1,7 @@
 #
 # Build custom i18n error messages
 #
-class CliMiami::Error
+class CliMiami::Error < StandardError
   attr_reader :message
 
 private

data/lib/cli_miami/metadata.rb

@@ -1,4 +1,4 @@
 module CliMiami
-  VERSION = '1.0.10.pre'.freeze
-  SUMMARY = 'A feature rich alternative for gets and puts for your command line tool'.freeze
+  VERSION = '2.0.0.pre'.freeze
+  SUMMARY = 'A colorful & feature-rich alternative to gets & puts for your command line app'.freeze
 end

data/lib/cli_miami/say.rb

@@ -12,19 +12,20 @@ class CliMiami::S
   # S.ay API method
   #
   # @param options [Symbol or Hash] options can be preset symbol, or a hash of options.
+  # @todo overwrite is unpublished and beta. it has issues under certain use cases
   #
   # By preset [Symbol[...
   # [symbol]  Uses defined preset name
   #
   # By options [Hash]...
-  # color:        => [symbol]             See README for ansi color codes
-  # bgcolor:      => [symbol]             See README for ansi color codes
-  # style:        => [symbol]             See README for ansi style codes
-  # justify:      => [center|left|right]  The type of justification to use
-  # padding:      => [integer]            The maximum string size to justify text in
-  # indent:       => [integer]            The number of characters to indent
-  # newline:      => [boolean]            True if you want a newline after the output
-  # overwrite:    => [boolean]            True if you want the next line to overwrite the current line
+  # color:      [symbol]             See README for ansi color codes
+  # bgcolor:    [symbol]             See README for ansi color codes
+  # style:      [symbol]             See README for ansi style codes
+  # justify:    [center|left|right]  The type of justification to use
+  # padding:    [integer]            The maximum string size to justify text in
+  # indent:     [integer]            The number of characters to indent
+  # newline:    [boolean]            True if you want a newline after the output
+  # overwrite:  [boolean]            True if you want the next line to overwrite the current line
   #
   # @return
   #

data/spec/fixtures/i18n.yml

@@ -1,5 +1,7 @@
-en:
+spec:
   cli_miami:
+    core:
+      empty: 'empty'
     errors:
       spec: generic error
 
@@ -37,3 +39,5 @@ en:
 
       symbol:
         spec: "symbol: %{value} - %{allowed_values}"
+  foo:
+    bar: This %{foo} is a %{bar}

data/spec/lib/cli_miami/error_spec.rb

@@ -6,7 +6,7 @@ describe CliMiami::Error do
 
         when :array, :multiple_choice
           value_type = [1, nil, :foo, '', (1..2)]
-          value_string = '1, [EMPTY], foo, [EMPTY], and 1-2'
+          value_string = '1, empty, foo, empty, and 1-2'
           allowed_values = '1-38'
 
         when :boolean

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 require 'coveralls'
 Coveralls.wear!
 require 'cli_miami'
-require 'i18n'
 
-I18n.load_path += Dir[File.expand_path("#{File.dirname(__FILE__)}/fixtures/i18n.yml")]
+I18n.load_path << File.expand_path(File.join('spec', 'fixtures', 'i18n.yml'))
+I18n.reload!
+I18n.locale = 'spec'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_miami
 version: !ruby/object:Gem::Version
-  version: 1.0.10.pre
+  version: 2.0.0.pre
 platform: ruby
 authors:
 - Ryan Brewster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-26 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,112 +28,126 @@ dependencies:
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: recursive-open-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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: guard
   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: guard-bundler
   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: guard-rubocop
   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: guard-rspec
   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
@@ -154,14 +168,14 @@ dependencies:
   name: rspec
   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
@@ -182,28 +196,28 @@ dependencies:
   name: terminal-notifier
   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: terminal-notifier-guard
   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'
 description: 
@@ -212,6 +226,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - i18n/en.yml
 - lib/cli_miami.rb
@@ -228,7 +243,7 @@ files:
 - spec/lib/cli_miami/validation_spec.rb
 - spec/lib/cli_miami_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/brewster1134/cli-miami
+homepage: https://github.com/brewster1134/cli_miami
 licenses:
 - WTFPL
 metadata: {}
@@ -238,25 +253,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0p247
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: A feature rich alternative for gets and puts for your command line tool
+summary: A colorful & feature-rich alternative to gets & puts for your command line
+  app
 test_files:
-- spec/fixtures/i18n.yml
-- spec/lib/cli_miami/ask_spec.rb
-- spec/lib/cli_miami/error_spec.rb
+- spec/lib/cli_miami_spec.rb
 - spec/lib/cli_miami/say_spec.rb
+- spec/lib/cli_miami/error_spec.rb
+- spec/lib/cli_miami/ask_spec.rb
 - spec/lib/cli_miami/validation_spec.rb
-- spec/lib/cli_miami_spec.rb
+- spec/fixtures/i18n.yml
 - spec/spec_helper.rb