cli_miami 0.0.9 → 1.0.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47e57b45bdc22855bb5fae82dcc3dd12c54a7122
-  data.tar.gz: d13decde950c513d8bb42ffe54f6fc987c55927b
+  metadata.gz: 4027d96f33ad46d4e0859f84b1c9399ce569a8d3
+  data.tar.gz: b1442d5a721d9cedfd612ac86d73057617b2b808
 SHA512:
-  metadata.gz: c06ffeeaa5f1afdf1614ae4d0ad6fd7a99226f70471a27ad93d61d6189eb56e8cc99b8c6213e1cf3da450102714a858ae6dbbd09c12b5786ee66c7e2f97c08a8
-  data.tar.gz: 89e5be978ec19120b0eb269c18eea67159cfcad43c16177e10c1705e116669f76a5be73e153c76dd30195e966191db5a06da4f859dd5844a2b678a153829fd37
+  metadata.gz: 1f7b627d647f53c1f8cfd48cc3adbc5a02dbecdbf61a3581eeb3b24879d3b60cbecdee265b2461c6f08f7576082c2f9c23b1e8a032413a891fee5dc5f4e5fbeb
+  data.tar.gz: 2be499f83f714ac02761f01baa93e5fe0f2a133f78022700bd665490ca72044183504d59dfacd13534e3e46a23fed18076b90b54e2785bb11d8e78be4e89ef21

data/README.md

@@ -1,6 +1,10 @@
-[![Gem Version](https://badge.fury.io/rb/cli_miami.svg)](http://badge.fury.io/rb/cli_miami)
-[![Build Status](https://travis-ci.org/brewster1134/CLI-Miami.svg)](https://travis-ci.org/brewster1134/CLI-Miami)
-[![Coverage Status](https://coveralls.io/repos/brewster1134/CLI-Miami/badge.png)](https://coveralls.io/r/brewster1134/CLI-Miami)
+[![gem version](https://badge.fury.io/rb/CLI-Miami.svg)](https://rubygems.org/gems/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)
 
 # CLI Miami
 A feature rich alternative for `gets` and `puts` for your cli interface
@@ -85,3 +89,5 @@ yuyi -m https://raw.githubusercontent.com/brewster1134/CLI-Miami/master/yuyi_men
 bundle install
 bundle exec guard
 ```
+
+[![WTFPL](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-4.png)](http://www.wtfpl.net)

data/i18n/en.yml

@@ -0,0 +1,34 @@
+en:
+  cli_miami:
+    # CliMiami core library strings
+    core:
+      empty: '[EMPTY]'
+      enter_end_value: 'Enter end value'
+      enter_start_value: 'Enter starting value'
+      enter_value_for: 'Enter a value for %{key}'
+      no_description: No description provided
+
+    errors:
+      # generic error type messages
+      convert: "`%{value}` cannot be converted to `%{type}`. Allowed values are: `%{allowed_values}` (%{description})"
+      length: "`%{value}` has a length of %{value_length}, but must be between %{min} and %{max} . Allowed values are: `%{allowed_values}` (%{description})"
+      regexp: "`%{value}` does not match the required format. Allowed values are: `%{allowed_values}` (%{description})"
+      type: "Unknown type %{type}"
+
+      # specific value type messages
+      # these messages will take precedence over the general messages above
+      array:
+        length: "Your array (%{value}) has %{value_length} items, but needs between %{allowed_values} (%{description})"
+      boolean:
+      file:
+        validate: "`%{value}` is not a valid path. Allowed values are: `%{allowed_values}` (%{description})"
+      fixnum:
+        length: "`%{value}` must be between %{min} and %{max} . Allowed values are: `%{allowed_values}` (%{description})"
+      float:
+        length: "`%{value}` must be between %{min} and %{max} . Allowed values are: `%{allowed_values}` (%{description})"
+      hash:
+        length: "Your object (%{value}) has %{value_length} items, but needs between %{allowed_values} (%{description})"
+        keys: "The object has `%{value}` set, but is missing `%{keys}`. Allowed values are: `%{allowed_values}` (%{description})"
+      range:
+      string:
+      symbol:

data/lib/cli_miami/ask.rb

@@ -1,54 +1,194 @@
 #
-# class CliMiami::Ask
+# class CliMiami::A
 #
-
-require 'readline'
-
 class CliMiami::A
-  @@prompt = '>>> '
+  attr_reader :value
 
+  # A.sk API method
+  #
   # See documentation for CliMiami::S.ay
-  # The same options are accepted
+  # The same options are accepted, with the addition of
+  #   :readline   - uses Readline instead of standard `gets`
+  #   :type       - symbol specifying what type of data is requested from the user
+  #   :validate   - hash of validation options
   #
   def self.sk question, options = {}, &block
-    # set default options
-    @options = {
-      :readline => false
-    }
-
-    # merge preset options
-    if options.is_a? Symbol
-      @options.merge! CliMiami.presets[options]
-    elsif preset = options.delete(:preset)
-      @options.merge! CliMiami.presets[preset]
-    end
+    new question, options, &block
+  end
 
-    # merge remaining options
-    if options.is_a? Hash
-      @options.merge! options
-    end
+private
 
-    CliMiami::S.ay question, @options
+  def initialize question, options
+    options = CliMiami.get_options options
 
-    output = if @options[:readline]
-      Readline.readline(@@prompt).chomp('/')
-    else
-      CliMiami::S.ay @@prompt, :newline => false
-      $stdin.gets
-    end.rstrip
+    # add description to question
+    question << ' (' << options[:description] << ')'
+
+    # display question
+    CliMiami::S.ay question, options
+
+    # request given type to user
+    @value = request_type options
 
     # return response if no block is passed
+    # rubocop:disable Style/GuardClause
     if block_given?
-      yield output
+      yield @value
     else
-      return output
+      return @value
     end
+    # rubocop:enable Style/GuardClause
   end
 
-private
+  # determine the expecting type, and request input form user
+  #
+  def request_type options
+    send("request_#{options[:type]}", options)
+  rescue
+    CliMiami::S.ay I18n.t('cli_miami.errors.type', options)
+  end
+
+  # for most types, a simple validation check is all that is needed
+  # if validation fails, we request the user to try again
+  #
+  # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
+  def request_until_valid options, allow_empty_string = false
+    response = nil
+
+    while response.nil?
+      # get user input based on given file type
+      response = if options[:type] == :file
+        Readline.readline.chomp '/'
+      else
+        $stdin.gets.chomp
+      end
+
+      # for multiple entry type objects, we allow the user to justs press enter to finish adding entries
+      break if allow_empty_string && response == ''
+
+      # otherwise validate the user's input
+      validation = CliMiami::Validation.new response, options
+      if validation.valid?
+        response = validation.value
+      else
+        response = nil
+        CliMiami::S.ay validation.error, :cli_miami_fail
+      end
+    end
+
+    response
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
+  alias_method :request_boolean, :request_until_valid
+  alias_method :request_file, :request_until_valid
+  alias_method :request_float, :request_until_valid
+  alias_method :request_fixnum, :request_until_valid
+  alias_method :request_string, :request_until_valid
+  alias_method :request_symbol, :request_until_valid
+
+  # rubocop:disable Metrics/MethodLength
+  def request_array options
+    array = []
+    value_options = CliMiami.get_options(options[:value_options] || {})
+
+    # build the array by prompting the user
+    # until the array length is an acceptable length, keep prompting user for values
+    while array.length < options[:max]
+      response = request_until_valid value_options, true
+
+      if response.empty?
+        break if CliMiami::Validation.new(array, options).valid?
+        redo
+      else
+        array << response
+      end
 
-  def self.prompt; @@prompt; end
-  def self.prompt= prompt
-    @@prompt = prompt
+      # update user
+      CliMiami::S.ay array.to_sentence, :cli_miami_success
+    end
+
+    array
+  end
+
+  # rubocop:disable Metrics/AbcSize, Metrics/BlockNesting, Metrics/PerceivedComplexity
+  def request_hash options
+    hash = {}
+    options[:keys] ||= []
+    value_options = CliMiami.get_options(options[:value_options] || {})
+    required_keys_set = false
+
+    # build the hash by prompting the user
+    # until the hash length of keys is an acceptable length, keep prompting user for values
+    while hash.keys.length < options[:max]
+      # if keys options is set, prompt for those values first
+      if required_keys_set == false
+        options[:keys].each do |key|
+          hash[key.to_sym] = request_until_valid value_options
+
+          # update user
+          CliMiami::S.ay hash.to_s, :cli_miami_success
+        end
+
+        # set boolean so we know all required keys are set
+        required_keys_set = true
+
+        # end this loop to re-check the while condition to make sure the max wasn't reached from required keys
+        #   e.g. setting { max: 2, keys: [:foo, :bar] }
+        #   this prevents users from entering user-defined keys since the max will already be met
+        next
+
+      # then start prompting for keys and values
+      else
+        # request key
+        user_key = request_until_valid value_options.merge(type: :symbol), true
+
+        if user_key.empty?
+          break if CliMiami::Validation.new(hash, options).valid?
+          redo
+        else
+          # request value
+          CliMiami::S.ay I18n.t('cli_miami.core.enter_value_for', key: user_key), :cli_miami_success
+          hash[user_key] = request_until_valid value_options, true
+        end
+      end
+
+      CliMiami::S.ay hash.to_s, :cli_miami_success
+    end
+
+    hash
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/BlockNesting, Metrics/PerceivedComplexity
+
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def request_range options
+    start_value = nil
+    end_value = nil
+    range_value_options = CliMiami.get_options type: :float
+
+    # get start value
+    until (Float(start_value) rescue nil)
+      CliMiami::S.ay I18n.t('cli_miami.core.enter_start_value'), preset: :cli_miami_success, newline: false
+      start_value = request_until_valid range_value_options
+    end
+
+    # get end value
+    until (Float(end_value) rescue nil)
+      CliMiami::S.ay I18n.t('cli_miami.core.enter_end_value'), preset: :cli_miami_success, newline: false
+      end_value = request_until_valid range_value_options
+    end
+
+    # swap values if entered in reverse
+    start_value, end_value = end_value, start_value if start_value > end_value
+
+    # build range object
+    range = Range.new start_value, end_value
+
+    # if range is invalid, start over and request it again
+    if CliMiami::Validation.new(range, options).valid?
+      range
+    else
+      request_range options
+    end
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 end

data/lib/cli_miami/core.rb

@@ -0,0 +1,84 @@
+#
+# 3rd party libraries & configuration
+#
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/inflections'
+require 'i18n'
+require 'readline'
+
+# core object overrides
+#
+class Hash
+  def to_s
+    map do |k, v|
+      "#{k}: #{v}"
+    end.to_sentence
+  end
+end
+
+# i18n
+#
+# load yml locales included in the cli miami gem
+#   [PATH TO GEMS]/cli_miami/i18n/en.yml
+I18n.load_path += Dir["#{File.dirname(__FILE__)}/../i18n/*.yml"]
+# load locale in current directory named `i18n.yml`
+#   ./i18n.yml
+I18n.load_path += Dir['./i18n.yml']
+# load locales in the folder `i18n` in the current directory
+#   ./i18n/en.yml
+I18n.load_path += Dir['./i18n/*.yml']
+
+# 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
+#
+# rubocop:disable Style/Documentation
+module Boolean; end
+class TrueClass; include Boolean; end
+class FalseClass; include Boolean; end
+# rubocop:enable Style/Documentation
+
+# global configuration and setup
+#
+module CliMiami::Core
+  BOOLEAN_TRUE_VALUES = %w(true t yes y).freeze
+  BOOLEAN_FALSE_VALUES = %w(false f no n).freeze
+
+  # keys:   type values allowed through the API
+  # values: type used to validate internally in the Validation class
+  TYPE_MAP = {
+    array:      :array,
+    boolean:    :boolean,
+    dir:        :file,
+    directory:  :file,
+    file:       :file,
+    fixnum:     :fixnum,
+    float:      :float,
+    folder:     :file,
+    hash:       :hash,
+    integer:    :fixnum,
+    list:       :array,
+    number:     :fixnum,
+    object:     :hash,
+    path:       :file,
+    range:      :range,
+    string:     :string,
+    symbol:     :symbol
+  }.freeze
+
+  # default presets
+  # rubocop:disable Style/ClassVars
+  @@presets = {
+    cli_miami_fail: {
+      color: :red
+    },
+    cli_miami_success: {
+      color: :green
+    }
+  }
+  # rubocop:enable Style/ClassVars
+end

data/lib/cli_miami/error.rb

@@ -0,0 +1,108 @@
+#
+# Build custom i18n error messages
+#
+class CliMiami::Error
+  attr_reader :message
+
+private
+
+  def initialize value, options, *error_keys
+    options[:value] = convert_type_to_string value
+    options[:allowed_values] = allowed_values options
+
+    @message = i18n_lookup_keys(options, *error_keys) || 'Unknown Error'
+  end
+
+  # convert value from it's type, to a user friendly string
+  # with core ruby objects, we create a `.to_string` method instead of changes the default `.to_s` method
+  #
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def convert_type_to_string value
+    case value
+
+    when Array
+      value.map do |e|
+        if e.nil? || e == ''
+          I18n.t 'cli_miami.core.empty'
+        else
+          convert_type_to_string e
+        end
+      end.to_sentence
+
+    when Hash
+      value.map do |k, v|
+        v = if v.nil? || v == ''
+          I18n.t 'cli_miami.core.empty'
+        else
+          convert_type_to_string v
+        end
+
+        "#{k}: #{v}"
+      end.to_sentence
+
+    when Range
+      "#{value.min}-#{value.max}"
+
+    when File
+      File.expand_path value
+
+    else
+      value.to_s
+
+    end
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+  # get allowed values based on validation details
+  #
+  # rubocop:disable Metrics/MethodLength
+  def allowed_values options
+    case options[:type]
+    when :array, :hash
+      if options[:value_options]
+        allowed_values options[:value_options]
+      else
+        "#{options[:min]}-#{options[:max]}"
+      end
+
+    when :boolean
+      all_boolean_values = CliMiami::BOOLEAN_TRUE_VALUES + CliMiami::BOOLEAN_FALSE_VALUES
+      all_boolean_values.to_sentence
+
+    when :fixnum, :float, :range, :string, :symbol
+      "#{options[:min]}-#{options[:max]}"
+
+    when :regexp
+      options[:regexp].inspect
+
+    else
+      '?'
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # build an i18n dot notation string to use for lookup in the language yaml
+  #
+  # rubocop:disable Style/ClosingParenthesisIndentation
+  def i18n_lookup_keys options, *error_keys
+    # check for type specific error first, then look for generic errors
+    i18n_lookup(options,
+      'cli_miami',
+      'errors',
+      options[:type].to_s,
+      *error_keys
+    ) || i18n_lookup(options,
+      'cli_miami',
+      'errors',
+      *error_keys
+    )
+  end
+  # rubocop:enable Style/ClosingParenthesisIndentation
+
+  # use i18n dot notation keys to lookup string
+  #
+  def i18n_lookup options, *keys
+    i18n_string = keys.flatten.compact.each(&:to_s).join('.')
+    I18n.t i18n_string, options if I18n.exists? i18n_string
+  end
+end

data/lib/cli_miami/say.rb

@@ -1,13 +1,15 @@
-#
-# class CliMiami::Say
-#
 require 'term/ansicolor'
 
+# Reopen String class for ANSI color support
 class String
   include Term::ANSIColor
 end
 
+#
+# class CliMiami::S.ay
+#
 class CliMiami::S
+  # S.ay API method
   #
   # @param options [Symbol or Hash] options can be preset symbol, or a hash of options.
   #
@@ -18,7 +20,7 @@ class CliMiami::S
   # 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|ljust|rjust] The type of justification to use
+  # 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
@@ -27,75 +29,83 @@ class CliMiami::S
   # @return
   #
   def self.ay text = '', options = {}
-    # backup text and convert it to a string
-    original_text = text = text.to_s
-
     # set default options
-    @options = {
-      :style => [],
-      :newline => true
-    }
+    options = CliMiami.get_options options
+    new text, options
+  end
 
-    # merge preset options
-    if options.is_a? Symbol
-      @options.merge! CliMiami.presets[options]
-    elsif preset = options.delete(:preset)
-      @options.merge! CliMiami.presets[preset]
-    end
+private
 
-    # merge remaining options
-    if options.is_a? Hash
-      @options.merge! options
-    end
+  def initialize text, options
+    @text = text
+    @options = options
 
-    # convert single style into an array for processing
-    if !@options[:style].is_a? Array
-      @options[:style] = [@options[:style]]
-    end
+    # formatter methods
+    modify_justification!
+    modify_text_color!
+    modify_background_color!
+    modify_styles!
+    modify_indentation!
+    modify_overwrite!
 
-    # Justify/Padding options
-    if @options[:justify] && @options[:padding]
-      text = text.send @options[:justify], @options[:padding]
-    end
+    # render formatted text to user
+    print_output
+  end
+
+  # Justify/Padding options
+  # must convert option to support String class method
+  def modify_justification!
+    justify =
+      case @options[:justify]
+      when :center then :center
+      when :right then :rjust
+      else :ljust
+      end
+
+    @text = @text.send justify, @options[:padding]
+  end
 
-    # Set foreground color
+  # Set foreground color
+  def modify_text_color!
     if @options[:color]
       # if bright style is passed, use the bright color variation
-      text = if @options[:style].delete :bright
-        text.send("bright_#{@options[:color]}")
+      @text = if @options[:style].delete :bright
+        @text.send "bright_#{@options[:color]}"
       else
-        text.send(@options[:color])
+        @text.send @options[:color]
       end
     end
+  end
 
-    # Set background color
-    if @options[:bgcolor]
-      text = text.send("on_#{@options[:bgcolor]}")
-    end
+  # Set background color
+  def modify_background_color!
+    @text = @text.send("on_#{@options[:bgcolor]}") if @options[:bgcolor]
+  end
 
-    # Apply all styles
+  # Apply all styles
+  def modify_styles!
     @options[:style].each do |style|
-      text = text.send(style)
+      @text = @text.send(style)
     end
+  end
 
-    # Indent
-    if @options[:indent]
-      text = (' ' * @options[:indent]) + text
-    end
+  # Indent
+  def modify_indentation!
+    @text = (' ' * @options[:indent]) + @text if @options[:indent]
+  end
 
-    # Flag text to be overwritten by next text written
-    if @options[:overwrite]
-      text = "#{text}\r"
-    end
+  # Flag text to be overwritten by next text written
+  def modify_overwrite!
+    @text = "#{@text}\r" if @options[:overwrite]
+  end
 
+  # finally render the formatted text to the screen
+  def print_output
     # Determine if a newline should be used
     if !@options[:newline] || @options[:overwrite]
-      $stdout.print text
+      $stdout.print @text + ' '
     else
-      $stdout.puts text
+      $stdout.puts @text
     end
-
-    # return original text
-    return original_text
   end
 end