cli_miami 1.0.3.pre → 1.0.5.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719e8649e44771d53e0bca18acd408340159a58b
-  data.tar.gz: 7e59f4a97ad922d23a819bc73b5f28e9db79f711
+  metadata.gz: 42418b61ff38c853438626c7bc70ad533ce728d7
+  data.tar.gz: 8cc0c02b300bd52c9d15969edd95f88468717645
 SHA512:
-  metadata.gz: 9ef54e39d4cac9503534f0b66cc378f8992c6427868087f8901ea7c72e8491a3a852a66a5bbb5918499f47831dbe3c54e147794a68f3890cace9b5587c04b7e5
-  data.tar.gz: 80e5523952bf696fe7bae610f839d187d23643575013da129778203cb58c57fa793a6bee856545e5f625282461f0fb5e4f2e70a35fa0f6da45baee2b4e21ef68
+  metadata.gz: 3df0997f3ba2a4e57859962b3024c3f488a04ffd59fccf3e8eca8d0a29cd5392aa70caac8240abcb7f6b503842e530449e9976a4ea38848b69c28c8902707ebc
+  data.tar.gz: 2aba81627198c963ab0c46d44d2135cb0e7b492fec548927643d5d25251326ce500b87e4368e48e3018c38af5d9c26a2dffc16b559f4601408df380c9b088222

data/README.md

@@ -15,11 +15,11 @@ gem install cli_miami
 
 _Gemfile_
 ```ruby
-# This exposes the shortened API for `A.sk` and `S.ay`
+# For the name-spaced methods CliMiami::A.sk & CliMiami::S.ay...
 gem 'cli_miami'
 
-# if you need the API to be namespaced (`CliMiami::A.sk`, `CliMiami::S.ay`)
-gem 'cli_miami', :require => :namespaced
+# For the friendlier global methods A.sk & S.ay...
+gem 'cli_miami', require: 'cli_miami/global'
 ```
 
 #### S.ay
@@ -59,7 +59,7 @@ Both `S.ay` and `A.sk` suport the same options
 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|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

data/i18n/en.yml

@@ -3,32 +3,40 @@ en:
     # 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
+      enter_empty_value: Press Enter when finished...
+      enter_end_value: Enter the maximum value
+      enter_start_value: Enter the minimum value
+      enter_value_for: "Enter a value for %{key}"
+
+      # TYPE SPECIFIC MESSAGES
+      multiple_choice:
+        prompt: 'Choose one of the following options:'
+        selected_choices: Selected Options
 
     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})"
+      convert: "%{value} cannot be converted to a %{type} %{description}"
+      length: "%{value} has a length of %{value_length}, but must be between %{allowed_values} %{description}"
+      regexp: "%{value} does not match the required format of %{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})"
+        length: "You entered %{value_length} items, but you need between %{allowed_values} %{description}"
       boolean:
       file:
-        validate: "`%{value}` is not a valid path. Allowed values are: `%{allowed_values}` (%{description})"
+        validate: "%{value} is not a valid path %{description}"
       fixnum:
-        length: "`%{value}` must be between %{min} and %{max} . Allowed values are: `%{allowed_values}` (%{description})"
+        length: "%{value} is invalid. Enter a number between %{allowed_values} %{description}"
       float:
-        length: "`%{value}` must be between %{min} and %{max} . Allowed values are: `%{allowed_values}` (%{description})"
+        length: "%{value} is invalid. Enter a number between %{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})"
+        length: "You entered %{value_length} items, but you need between %{allowed_values} %{description}"
+        keys: "You are missing values for %{keys} %{description}"
+      multiple_choice:
+        length: "You have selected %{value_length} options, but you need between %{allowed_values} %{description}"
+        delete_required_key: "You cannot delete the required key %{key}"
       range:
       string:
       symbol:

data/lib/cli_miami/ask.rb

@@ -21,11 +21,11 @@ private
   def initialize question, options
     options = CliMiami.get_options options
 
-    # add description to question
-    question << ' (' << options[:description] << ')'
-
     # display question
-    CliMiami::S.ay question, options
+    CliMiami::S.ay question, options.merge(preset: :cli_miami_instruction)
+
+    # display description
+    CliMiami::S.ay options[:description], preset: :cli_miami_instruction_sub, indent: 4 if options[:description]
 
     # request given type to user
     @value = request_type options
@@ -45,7 +45,7 @@ private
   def request_type options
     send("request_#{options[:type]}", options)
   rescue
-    CliMiami::S.ay I18n.t('cli_miami.errors.type', options)
+    CliMiami::S.ay I18n.t('cli_miami.errors.type', options.merge(preset: :cli_miami_fail))
   end
 
   # for most types, a simple validation check is all that is needed
@@ -86,7 +86,7 @@ private
   alias_method :request_string, :request_until_valid
   alias_method :request_symbol, :request_until_valid
 
-  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
   def request_array options
     array = []
     value_options = CliMiami.get_options(options[:value_options] || {})
@@ -96,21 +96,83 @@ private
     while array.length < options[:max]
       response = request_until_valid value_options, true
 
+      # user attempting to finish entering items
       if response.empty?
         break if CliMiami::Validation.new(array, options).valid?
         redo
+
+      # remove item if user enters it twice
+      elsif array.include? response
+        array.delete response
+
+      # add response to the list
       else
         array << response
       end
 
       # update user
-      CliMiami::S.ay array.to_sentence, :cli_miami_success
+      CliMiami::S.ay array.to_sentence, :cli_miami_update
     end
 
     array
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+  def request_multiple_choice options
+    selected_choices = nil
+    selected_choice_indexes = []
+
+    while selected_choice_indexes.length < options[:max]
+      # quit if all the options have been selected
+      break if selected_choice_indexes.length == options[:choices].length
+
+      # display options
+      CliMiami::S.ay
+      CliMiami::S.ay I18n.t('cli_miami.core.multiple_choice.prompt'), :cli_miami_instruction
+      options[:choices].each_with_index do |li, i|
+        # show already selected choices with a different color
+        choice_text = "#{(i + 1).to_s.rjust(3)}: #{li}"
+        choice_text_color = selected_choice_indexes.include?(i) ? :black : :cyan
+        CliMiami::S.ay choice_text, style: :bright, color: choice_text_color
+      end
+
+      # request a response from the user (return fixnum)
+      response = request_until_valid({
+        type: :fixnum,
+        min: 1,
+        max: options[:choices].length
+      }, true)
+
+      if response == ''
+        break if CliMiami::Validation.new(selected_choice_indexes, options).valid?
+        redo
+      else
+        # convert human readable response to array index
+        response_index = response - 1
+
+        # add choice to array
+        if selected_choice_indexes.include? response_index
+          selected_choice_indexes.delete response_index
+        else
+          selected_choice_indexes << response_index
+        end
+      end
+
+      # update user
+      CliMiami::S.ay
+      CliMiami::S.ay I18n.t('cli_miami.core.multiple_choice.selected_choices'), :cli_miami_instruction_sub
+      selected_choices = selected_choice_indexes.map{ |i| options[:choices][i] }
+      selected_choices.each do |sc|
+        CliMiami::S.ay "• #{sc}", preset: :cli_miami_update, indent: 3
+      end
+    end
+
+    selected_choices
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
-  # rubocop:disable Metrics/AbcSize, Metrics/BlockNesting, Metrics/PerceivedComplexity
+  # rubocop:disable Metrics/AbcSize, Metrics/BlockNesting, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   def request_hash options
     hash = {}
     options[:keys] ||= []
@@ -126,7 +188,7 @@ private
           hash[key.to_sym] = request_until_valid value_options
 
           # update user
-          CliMiami::S.ay hash.to_s, :cli_miami_success
+          CliMiami::S.ay hash.to_cli_miami_string, :cli_miami_update
         end
 
         # set boolean so we know all required keys are set
@@ -146,20 +208,35 @@ private
           break if CliMiami::Validation.new(hash, options).valid?
           redo
         else
+          CliMiami::S.ay I18n.t('cli_miami.core.enter_value_for', key: user_key), :cli_miami_instruction
+
           # 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
+          user_value = request_until_valid value_options, true
+
+          if user_value.empty?
+            if options[:keys].include? user_key
+              # prevent deleting required keys
+              CliMiami::S.ay I18n.t('cli_miami.errors.multiple_choice.delete_required_key', key: user_key), :cli_miami_fail
+              redo
+            else
+              # delete user-specified key
+              hash.delete user_key
+            end
+          else
+            # set user-defined key
+            hash[user_key] = user_value
+          end
         end
       end
 
-      CliMiami::S.ay hash.to_s, :cli_miami_success
+      CliMiami::S.ay hash.to_cli_miami_string, :cli_miami_update
     end
 
     hash
   end
-  # rubocop:enable Metrics/AbcSize, Metrics/BlockNesting, Metrics/PerceivedComplexity
+  # rubocop:enable Metrics/AbcSize, Metrics/BlockNesting, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
-  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
   def request_range options
     start_value = nil
     end_value = nil
@@ -167,13 +244,13 @@ private
 
     # 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
+      CliMiami::S.ay I18n.t('cli_miami.core.enter_start_value'), preset: :cli_miami_instruction, 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
+      CliMiami::S.ay I18n.t('cli_miami.core.enter_end_value'), preset: :cli_miami_instruction, newline: false
       end_value = request_until_valid range_value_options
     end
 
@@ -190,5 +267,5 @@ private
       request_range options
     end
   end
-  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 end

data/lib/cli_miami/error.rb

@@ -69,7 +69,7 @@ private
       all_boolean_values = CliMiami::BOOLEAN_TRUE_VALUES + CliMiami::BOOLEAN_FALSE_VALUES
       all_boolean_values.to_sentence
 
-    when :fixnum, :float, :range, :string, :symbol
+    when :fixnum, :float, :multiple_choice, :range, :string, :symbol
       "#{options[:min]}-#{options[:max]}"
 
     when :regexp
@@ -83,26 +83,37 @@ private
 
   # build an i18n dot notation string to use for lookup in the language yaml
   #
-  # rubocop:disable Style/ClosingParenthesisIndentation
+  # rubocop:disable Metrics/MethodLength
   def i18n_lookup_keys options, *error_keys
     # check for type specific error first, then look for generic errors
-    i18n_lookup(options,
+    i18n_lookup(
+      options,
       'cli_miami',
       'errors',
       options[:type].to_s,
       *error_keys
-    ) || i18n_lookup(options,
+    ) || i18n_lookup(
+      options,
       'cli_miami',
       'errors',
       *error_keys
     )
   end
-  # rubocop:enable Style/ClosingParenthesisIndentation
+  # rubocop:enable Metrics/MethodLength
 
   # 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
+
+    # check if value exists, and translate it
+    if I18n.exists? i18n_string
+      # format description for i18n messages
+      if options[:description]
+        options[:description] = ' (' << options[:description] << ')'
+      end
+
+      I18n.t i18n_string, options
+    end
   end
 end

data/lib/cli_miami/global.rb

@@ -0,0 +1,5 @@
+require 'cli_miami'
+
+# create global aliases to support calling `A.sk` and `S.ay` directly
+::A = CliMiami::A
+::S = CliMiami::S

data/lib/cli_miami/say.rb

@@ -37,7 +37,7 @@ class CliMiami::S
 private
 
   def initialize text, options
-    @text = text
+    @text = text.to_s
     @options = options
 
     # formatter methods

data/lib/cli_miami/validation.rb

@@ -71,6 +71,9 @@ private
     Float string
   end
 
+  # multiple choice strings are also integers
+  alias_method :convert_string_to_multiple_choice, :convert_string_to_fixnum
+
   def convert_string_to_range string, _options
     range_array = string.split('..').map { |i| Float(i) }.sort
 
@@ -172,6 +175,10 @@ private
   end
   # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+  def validate_multiple_choice selections, options
+    validate_length selections, selections.length, options
+  end
+
   def validate_range range, options
     range_diff = (range.max - range.min) + 1
     validate_length range, range_diff, options

data/lib/cli_miami.rb

@@ -1,12 +1,205 @@
 #
-# DO NOT CHANGE THIS FILE FOR CORE CLI_MIAMI INIT FUNCTIONS!
+# load dependencies
 #
-# This file is used only for augmenting the core classes with global aliases.
-# This lets users use CLI Miami without having to pollute their global namespace
+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'
+
+# open Hash class
+#
+class Hash
+  def to_cli_miami_string
+    map do |k, v|
+      "#{k}: #{v}"
+    end.to_sentence
+  end
+end
+
+# open String class
+#
+class String
+  def method_missing method, *args
+    method_string = method.to_s.dup
+
+    if method_string.slice! 'cli_miami_'
+      preset = CliMiami.presets[method_string.to_sym]
+      options = preset.merge args[0] || {}
+      CliMiami::S.ay self, options
+    else
+      super
+    end
+  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
 #
-# the core initilization runs from `namespaced.rb`
-require 'namespaced'
+# rubocop:disable Style/Documentation
+module Boolean; end
+class TrueClass; include Boolean; end
+class FalseClass; include Boolean; end
+# rubocop:enable Style/Documentation
+
+# create Cli Miami namespace and load library
+#
+module CliMiami
+  require 'cli_miami/ask'
+  require 'cli_miami/error'
+  require 'cli_miami/say'
+  require 'cli_miami/validation'
+
+  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,
+    multiple_choice:  :multiple_choice,
+    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: {
+      indent: 2,
+      color: :red,
+      style: [:bold, :underline]
+    },
+    cli_miami_instruction: {
+      color: :green,
+      style: :bold
+    },
+    cli_miami_instruction_sub: {
+      indent: 2,
+      color: :green
+    },
+    cli_miami_success: {
+      color: :green,
+      style: [:bold, :underline]
+    },
+    cli_miami_update: {
+      indent: 2,
+      color: :cyan
+    }
+  }
+  # rubocop:enable Style/ClassVars
+
+  # Create a new custom preset
+  #
+  def self.set_preset type, options
+    raise ArgumentError, 'Preset must be a hash of options' unless options.is_a? Hash
+
+    # extend preset if it exists
+    extend_preset = options.delete(:preset)
+    if extend_preset && @@presets[extend_preset.to_sym]
+      extend_preset_options = @@presets[extend_preset.to_sym]
+      options = extend_preset_options.merge! options
+    end
+
+    # set options to global var
+    @@presets[type] = options
+  end
+
+  # getter for the presets
+  #
+  def self.presets
+    @@presets
+  end
+
+  # build an options hash from preset options and/or additional options
+  #
+  # build shared validation hash object
+  #
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+  def self.get_options user_options = {}
+    # lookup preset if passed in as a symbol, or as a :preset key in an options hash
+    if user_options.is_a? Hash
+      user_options.deep_symbolize_keys!
+      options = @@presets[user_options.delete(:preset)] || {}
+      options.deep_merge! user_options
+    else
+      options = @@presets[user_options.to_sym] || {}
+    end
+
+    # make sure all keys are symbols
+    options.deep_symbolize_keys!
+
+    # set defaults
+    options.reverse_merge!(
+      description: nil,
+      max: Float::INFINITY,
+      min: options.delete(:required) ? 1 : 0,
+      newline: true,
+      justify: :left,
+      padding: 0,
+      preset: nil,
+      regexp: //,
+      style: [],
+      type: :string
+    )
+
+    # prepare style array
+    options[:style] = [options[:style]].flatten
+
+    # lookup type in type map
+    options[:type] = TYPE_MAP[options[:type].to_sym] || :string
+
+    # convert range to min/max values
+    range = options.delete(:range)
+    if range
+      options[:min] = range.min
+      options[:max] = range.max
+    end
+
+    # convert length to min/max values
+    length = options.delete(:length)
+    if length
+      options[:min] = options[:max] = length
+    end
+
+    # if value options are set, apply the same treatment to them
+    value_options = options[:value_options]
+    if value_options
+      options[:value_options] = get_options value_options
+      options[:value_options][:description] = options[:description]
+    end
 
-# create alias classes to support `A.sk` and `S.ay` syntax
-A = CliMiami::A
-S = CliMiami::S
+    options
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+end

data/spec/fixtures/i18n.yml

@@ -26,6 +26,9 @@ en:
       hash:
         spec: "hash: %{value} - %{allowed_values}"
 
+      multiple_choice:
+        spec: "multiple_choice: %{value} - %{allowed_values}"
+
       range:
         spec: "range: %{value} - %{allowed_values}"
 

data/spec/lib/cli_miami/ask_spec.rb

@@ -35,6 +35,12 @@ describe CliMiami::A do
       expect(ask.value).to eq %w(foo bar)
     end
 
+    it 'should allow user to remove entered values' do
+      allow($stdin).to receive(:gets).and_return 'foo', 'bar', 'foo', ''
+      ask = CliMiami::A.sk @q, type: :array
+      expect(ask.value).to eq %w(bar)
+    end
+
     it 'should prevent user from entering less than the minimum' do
       allow($stdin).to receive(:gets).and_return 'foo', '', 'bar', ''
       ask = CliMiami::A.sk @q, type: :array, min: 2
@@ -48,7 +54,57 @@ describe CliMiami::A do
     end
   end
 
+  describe 'MULTIPLE_CHOICE' do
+    it 'should allow a user to remove selections' do
+      allow($stdin).to receive(:gets).and_return '1', '2', '1', ''
+      ask = CliMiami::A.sk @q, type: :multiple_choice, choices: ['option 1', 'option 2', 'option 3']
+      expect(ask.value).to eq ['option 2']
+    end
+
+    it 'should not allow a user to select less than the min amount of choices' do
+      allow($stdin).to receive(:gets).and_return '2', '', '1', ''
+      ask = CliMiami::A.sk @q, type: :multiple_choice, min: 2, choices: ['option 1', 'option 2', 'option 3']
+      expect(ask.value).to eq ['option 2', 'option 1']
+    end
+
+    it 'should not allow a user to select more than the max amount of choices' do
+      allow($stdin).to receive(:gets).and_return '2', '1'
+      ask = CliMiami::A.sk @q, type: :multiple_choice, max: 2, choices: ['option 1', 'option 2', 'option 3']
+      expect(ask.value).to eq ['option 2', 'option 1']
+    end
+
+    it 'should not allow a user to select an invalid choice' do
+      allow($stdin).to receive(:gets).and_return '4', '-4', '2'
+      ask = CliMiami::A.sk @q, type: :multiple_choice, max: 1, choices: ['option 1', 'option 2', 'option 3']
+      expect(ask.value).to eq ['option 2']
+    end
+
+    it 'should allow a user to select an amount between the min and max' do
+      allow($stdin).to receive(:gets).and_return '3', '1', ''
+      ask = CliMiami::A.sk @q, type: :multiple_choice, min: 1, max: 3, choices: ['option 1', 'option 2', 'option 3']
+      expect(ask.value).to eq ['option 3', 'option 1']
+    end
+
+    it 'should allow a user to select all the options' do
+      allow($stdin).to receive(:gets).and_return '3', '1', '2'
+      ask = CliMiami::A.sk @q, type: :multiple_choice, choices: ['option 1', 'option 2', 'option 3']
+      expect(ask.value).to eq ['option 3', 'option 1', 'option 2']
+    end
+  end
+
   describe 'HASH' do
+    it 'should allow user to overwrite keys' do
+      allow($stdin).to receive(:gets).and_return 'foo1', '1', 'bar1', '2', 'foo1', '3', ''
+      ask = CliMiami::A.sk @q, type: :hash
+      expect(ask.value).to eq(foo1: '3', bar1: '2')
+    end
+
+    it 'should allow user to remove keys' do
+      allow($stdin).to receive(:gets).and_return 'foo1', '1', 'bar1', '2', 'foo1', '', ''
+      ask = CliMiami::A.sk @q, type: :hash
+      expect(ask.value).to eq(bar1: '2')
+    end
+
     it 'should allow user to enter keys & values until they enter an empty key string' do
       allow($stdin).to receive(:gets).and_return 'foo1', '1', 'bar1', '2', ''
       ask = CliMiami::A.sk @q, type: :hash
@@ -73,6 +129,12 @@ describe CliMiami::A do
         ask = CliMiami::A.sk @q, type: :hash, keys: [:foo4]
         expect(ask.value).to eq(foo4: '1', bar4: '2')
       end
+
+      it 'should not allow user to delete required keys' do
+        allow($stdin).to receive(:gets).and_return 'foo1', 'foo', '', 'bar', 'bar1', ''
+        ask = CliMiami::A.sk @q, type: :hash, keys: [:foo]
+        expect(ask.value).to eq(foo: 'foo1', bar: 'bar1')
+      end
     end
   end
 

data/spec/lib/cli_miami/error_spec.rb

@@ -4,7 +4,7 @@ describe CliMiami::Error do
       CliMiami::TYPE_MAP.values.uniq.each do |type|
         case type
 
-        when :array
+        when :array, :multiple_choice
           value_type = [1, nil, :foo, '', (1..2)]
           value_string = '1, [EMPTY], foo, [EMPTY], and 1-2'
           allowed_values = '1-38'

data/spec/lib/cli_miami/validation_spec.rb

@@ -27,18 +27,18 @@ describe CliMiami::Validation do
       it_behaves_like 'an invalid type', :file, File.join(Dir.pwd, 'foo')
     end
 
-    describe 'FLOAT' do
-      it_behaves_like 'a valid type', :float, '2.0', 2.0
-      it_behaves_like 'a valid type', :float, '3', 3.0
-      it_behaves_like 'an invalid type', :float, 'foo'
-    end
-
     describe 'FIXNUM' do
       it_behaves_like 'a valid type', :fixnum, '3', 3
       it_behaves_like 'a valid type', :fixnum, '3.8', 3
       it_behaves_like 'an invalid type', :fixnum, 'foo'
     end
 
+    describe 'FLOAT' do
+      it_behaves_like 'a valid type', :float, '2.0', 2.0
+      it_behaves_like 'a valid type', :float, '3', 3.0
+      it_behaves_like 'an invalid type', :float, 'foo'
+    end
+
     describe 'RANGE' do
       it_behaves_like 'a valid type', :range, '2..4', (2..4)
       it_behaves_like 'an invalid type', :range, 'foo'

data/spec/lib/cli_miami_spec.rb

@@ -1,5 +1,21 @@
 describe CliMiami do
-  subject { CliMiami }
+  describe String do
+    before do
+      CliMiami.set_preset :string_spec,
+        color: :green,
+        bgcolor: :blue
+    end
+
+    it 'should create methods for calling presets' do
+      expect($stdout).to receive(:puts).with "\e[44m\e[32mSTRING!\e[0m\e[0m"
+      'STRING!'.cli_miami_string_spec
+    end
+
+    it 'should extend presets' do
+      expect($stdout).to receive(:puts).with "\e[43m\e[32mSTRING!\e[0m\e[0m"
+      'STRING!'.cli_miami_string_spec bgcolor: :yellow
+    end
+  end
 
   describe '.set_preset' do
     it 'should raise an error if invalid options' do
@@ -16,15 +32,15 @@ describe CliMiami do
     it 'should extend an existing preset' do
       subject.set_preset :foo,
         color: :red,
-        bg_color: :blue
+        bgcolor: :blue
 
       subject.set_preset :bar,
         preset: :foo,
-        bg_color: :green
+        bgcolor: :green
 
       expect(subject.class_variable_get(:@@presets)[:bar]).to eq(
         color: :red,
-        bg_color: :green
+        bgcolor: :green
       )
     end
   end
@@ -33,7 +49,7 @@ describe CliMiami do
     before do
       subject.set_preset :foo,
         color: 'red',
-        bg_color: 'blue'
+        bgcolor: 'blue'
     end
 
     it 'should handle `required`' do
@@ -49,7 +65,7 @@ describe CliMiami do
         it 'should return the preset options' do
           expect(subject.get_options(:foo)).to include(
             color: 'red',
-            bg_color: 'blue'
+            bgcolor: 'blue'
           )
         end
       end
@@ -66,22 +82,22 @@ describe CliMiami do
         it 'should return the preset options' do
           expect(subject.get_options(preset: :foo)).to include(
             color: 'red',
-            bg_color: 'blue'
+            bgcolor: 'blue'
           )
         end
 
         it 'should extend preset options with additional passed options' do
           expect(subject.get_options(preset: :foo, style: 'bold')).to include(
             color: 'red',
-            bg_color: 'blue',
+            bgcolor: 'blue',
             style: ['bold']
           )
         end
 
         it 'should override preset options with additional passed options' do
-          expect(subject.get_options(preset: :foo, bg_color: 'green')).to include(
+          expect(subject.get_options(preset: :foo, bgcolor: 'green')).to include(
             color: 'red',
-            bg_color: 'green'
+            bgcolor: 'green'
           )
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_miami
 version: !ruby/object:Gem::Version
-  version: 1.0.3.pre
+  version: 1.0.5.pre
 platform: ruby
 authors:
 - Ryan Brewster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -180,11 +180,10 @@ files:
 - i18n/en.yml
 - lib/cli_miami.rb
 - lib/cli_miami/ask.rb
-- lib/cli_miami/core.rb
 - lib/cli_miami/error.rb
+- lib/cli_miami/global.rb
 - lib/cli_miami/say.rb
 - lib/cli_miami/validation.rb
-- lib/namespaced.rb
 - spec/fixtures/i18n.yml
 - spec/lib/cli_miami/ask_spec.rb
 - spec/lib/cli_miami/error_spec.rb

data/lib/cli_miami/core.rb

@@ -1,84 +0,0 @@
-#
-# 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/namespaced.rb

@@ -1,89 +0,0 @@
-# root namespace class
-#
-class CliMiami
-  # require & include core first
-  require 'cli_miami/core'
-  include CliMiami::Core
-
-  # CliMiami library
-  require 'cli_miami/error'
-  require 'cli_miami/validation'
-  require 'cli_miami/ask'
-  require 'cli_miami/say'
-
-  # Create a new custom preset
-  def self.set_preset type, options
-    raise ArgumentError, 'Preset must be a hash of options' unless options.is_a? Hash
-
-    # extend preset if it exists
-    extend_preset = options.delete(:preset)
-    if extend_preset && @@presets[extend_preset.to_sym]
-      extend_preset_options = @@presets[extend_preset.to_sym]
-      options = extend_preset_options.merge! options
-    end
-
-    # set options to global var
-    @@presets[type] = options
-  end
-
-  # build an options hash from preset options and/or additional options
-  #
-  # build shared validation hash object
-  #
-  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-  def self.get_options user_options = {}
-    # lookup preset if passed in as a symbol, or as a :preset key in an options hash
-    if user_options.is_a? Hash
-      user_options.deep_symbolize_keys!
-      options = @@presets[user_options.delete(:preset)] || {}
-      options.deep_merge! user_options
-    else
-      options = @@presets[user_options.to_sym] || {}
-    end
-
-    # make sure all keys are symbols
-    options.deep_symbolize_keys!
-
-    # set defaults
-    options.reverse_merge!(
-      description: I18n.t('cli_miami.core.no_description'),
-      max: Float::INFINITY,
-      min: options.delete(:required) ? 1 : 0,
-      newline: true,
-      justify: :left,
-      padding: 0,
-      regexp: //,
-      style: [],
-      type: :string
-    )
-
-    # prepare style array
-    options[:style] = [options[:style]].flatten
-
-    # lookup type in type map
-    options[:type] = TYPE_MAP[options[:type].to_sym] || :string
-
-    # convert range to min/max values
-    range = options.delete(:range)
-    if range
-      options[:min] = range.min
-      options[:max] = range.max
-    end
-
-    # convert length to min/max values
-    length = options.delete(:length)
-    if length
-      options[:min] = options[:max] = length
-    end
-
-    # if value options are set, apply the same treatment to them
-    value_options = options[:value_options]
-    if value_options
-      options[:value_options] = get_options value_options
-      options[:value_options][:description] = options[:description]
-    end
-
-    options
-  end
-  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-end