cliutils 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8d4b5956a8169f6d9921d0ed268188a65578fc9
-  data.tar.gz: fc2066b9c99902a3db434abceb0811ce6285eae5
+  metadata.gz: cca92462495e55bd03893b1ce6a19c1830288b56
+  data.tar.gz: dd8f5e2ed4434f381f0bca8a66d34fcab3cf6834
 SHA512:
-  metadata.gz: 746e189a28faa6d4cc66653bfab9bd4c804bac063516432c2ebfb214fa10ed178f371e44f86ba223ac4ce84d881d5fca43c2daa3a809a066381772e5930c3280
-  data.tar.gz: 1cb57fd665d770383fca928c5aa7951e8a635e4f082d445649633e90873717b2ef0ae145459c093ae09bc1d838a4ece89daae44f3b19661c104f57e573f0c731
+  metadata.gz: 226d3b909c6a8f887818491f4611db68128e991c818c4aeb8268316f3f3d0415bf06a5a6967e961c6377f0cfbc3149b8dd94e3ad68dd1e4dcb18086cecdbc46a
+  data.tar.gz: 0404033a25e60197ec39c4e58cde3a72616d1a09c9d051a44d0c4e74a85e349d3c1b949c33516bc847f38ab77c959de3cf5a1c1109bdc5cbd43d8e9b57e33c82

data/HISTORY.md

@@ -1,3 +1,7 @@
+# 1.2.4 (2014-04-06)
+
+* Cleanup and refactoring
+
 # 1.2.3 (2014-04-05)
 
 * Fixed a bug in ingest_prefs

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake/clean'
 require 'rubygems'
 
 def version
-  contents = File.read File.expand_path('../lib/cliutils/version.rb', __FILE__)
+  contents = File.read File.expand_path('../lib/cliutils/constants.rb', __FILE__)
   contents[/VERSION = '([^']+)'/, 1]
 end
 

data/cliutils.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cliutils/version'
+require 'cliutils/constants'
 
 Gem::Specification.new do |spec|
   spec.name             = "cliutils"

data/lib/cliutils/configuration.rb

@@ -12,7 +12,7 @@ module CLIUtils
       'INFO'  => Logger::INFO,
       'WARN'  => Logger::WARN,
       'ERROR' => Logger::ERROR,
-      'FATAL' => Logger::FATAL,
+      'FATAL' => Logger::FATAL
     }
 
     # Hook that triggers when this module is included.

data/lib/cliutils/configurator.rb

@@ -8,7 +8,7 @@ module CLIUtils
     # Stores the path to the configuration file.
     # @return [String]
     attr_reader :config_path
-    
+
     # Stores the configuration data itself.
     # @return [Hash]
     attr_reader :data
@@ -21,8 +21,8 @@ module CLIUtils
       @config_path = _path
       @data = {}
 
-      if File.exists?(_path)
-        data = YAML::load_file(_path)
+      if File.exist?(_path)
+        data = YAML.load_file(_path)
         @data.deep_merge!(data).deep_symbolize_keys!
       end
     end
@@ -55,10 +55,11 @@ module CLIUtils
     # @param [Prefs] prefs The Prefs class to examine
     # @return [void]
     def ingest_prefs(prefs)
-      fail 'Invaid Prefs class' if !prefs.kind_of?(Prefs)
+      fail 'Invaid Prefs class' unless prefs.kind_of?(Prefs)
       prefs.prompts.each do |p|
-        add_section(p.config_section.to_sym) unless @data.key?(p.config_section.to_sym)
-        @data[p.config_section.to_sym].merge!(p.config_key.to_sym => p.answer)
+        section_sym = p.config_section.to_sym
+        add_section(section_sym) unless @data.key?(section_sym)
+        @data[section_sym].merge!(p.config_key.to_sym => p.answer)
       end
     end
 
@@ -80,7 +81,9 @@ module CLIUtils
     # stored flat file.
     # @return [void]
     def save
-      File.open(@config_path, 'w') { |f| f.write(@data.deep_stringify_keys.to_yaml) }
+      File.open(@config_path, 'w') do |f|
+        f.write(@data.deep_stringify_keys.to_yaml)
+      end
     end
   end
 end

data/lib/cliutils/{version.rb → constants.rb}

@@ -1,4 +1,5 @@
+# Stores constants to use.
 module CLIUtils
   # The current version of the gem
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

data/lib/cliutils/ext/{Hash+Extensions.rb → hash_extensions.rb}

@@ -2,13 +2,12 @@
 # Contains many convenient methods borrowed from Rails
 # http://api.rubyonrails.org/classes/Hash.html
 class Hash
-
   # Deep merges a hash into the current one.
   # @param [Hash] other_hash The hash to merge in
   # @yield &block
   # @return [Hash]
   def deep_merge!(other_hash, &block)
-    other_hash.each_pair do |k,v|
+    other_hash.each_pair do |k, v|
       tv = self[k]
       if tv.is_a?(Hash) && v.is_a?(Hash)
         self[k] = tv.deep_merge(v, &block)
@@ -23,28 +22,28 @@ class Hash
   # returns the new Hash.
   # @return [Hash]
   def deep_stringify_keys
-    deep_transform_keys{ |key| key.to_s }
+    deep_transform_keys { |key| key.to_s }
   end
 
   # Same as deep_stringify_keys, but destructively
   # alters the original Hash.
   # @return [Hash]
   def deep_stringify_keys!
-    deep_transform_keys!{ |key| key.to_s }
+    deep_transform_keys! { |key| key.to_s }
   end
 
   # Recursively turns all Hash keys into symbols and
   # returns the new Hash.
   # @return [Hash]
   def deep_symbolize_keys
-    deep_transform_keys{ |key| key.to_sym rescue key }
+    deep_transform_keys { |key| key.to_sym rescue key }
   end
 
   # Same as deep_symbolize_keys, but destructively
   # alters the original Hash.
   # @return [Hash]
   def deep_symbolize_keys!
-    deep_transform_keys!{ |key| key.to_sym rescue key }
+    deep_transform_keys! { |key| key.to_sym rescue key }
   end
 
   # Generic method to perform recursive operations on a
@@ -78,7 +77,7 @@ class Hash
         result[yield(key)] = _deep_transform_keys_in_object(value, &block)
       end
     when Array
-      object.map {|e| _deep_transform_keys_in_object(e, &block) }
+      object.map { |e| _deep_transform_keys_in_object(e, &block) }
     else
       object
     end
@@ -98,9 +97,9 @@ class Hash
       end
       object
     when Array
-      object.map! {|e| _deep_transform_keys_in_object!(e, &block)}
+      object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
     else
       object
     end
   end
-end
+end

data/lib/cliutils/ext/{Logger+Extensions.rb → logger_extensions.rb}

@@ -2,21 +2,20 @@ require 'logger'
 
 #  Logger Class extensions
 class Logger
-
   # Creates a custom Logger level based on the passed
   # tag.
   # @param [String] tag The Logger level to create
   # @return [void]
   def self.custom_level(tag)
-    SEV_LABEL << tag 
-    idx = SEV_LABEL.size - 1 
+    SEV_LABEL << tag
+    idx = SEV_LABEL.size - 1
 
     define_method(tag.downcase.gsub(/\W+/, '_').to_sym) do |progname, &block|
       add(idx, nil, progname, &block)
-    end 
-  end 
-  
+    end
+  end
+
   custom_level('PROMPT')
   custom_level('SECTION')
   custom_level('SUCCESS')
-end
+end

data/lib/cliutils/ext/{String+Extensions.rb → string_extensions.rb}

@@ -1,38 +1,51 @@
 #  String Class extensions
 class String
-
   # Outputs a string in a formatted color.
   # @param [<Integer, String>] color_code The code to use
   # @return [void]
   def colorize(color_code)
     "\033[#{ color_code }m#{ self }\033[0m"
   end
-  
+
   # Makes the associated string blue.
   # @return [void]
-  def blue; colorize(34) end
+  def blue
+    colorize(34)
+  end
 
   # Makes the associated string cyan.
   # @return [void]
-  def cyan; colorize(36) end
+  def cyan
+    colorize(36)
+  end
 
   # Makes the associated string green.
   # @return [void]
-  def green; colorize(32) end
+  def green
+    colorize(32)
+  end
 
   # Makes the associated string purple.
   # @return [void]
-  def purple; colorize(35) end
+  def purple
+    colorize(35)
+  end
 
   # Makes the associated string red.
   # @return [void]
-  def red; colorize(31) end
+  def red
+    colorize(31)
+  end
 
   # Makes the associated string white.
   # @return [void]
-  def white; colorize(37) end
+  def white
+    colorize(37)
+  end
 
   # Makes the associated string yellow.
   # @return [void]
-  def yellow; colorize(33) end
+  def yellow
+    colorize(33)
+  end
 end

data/lib/cliutils/{logger-delegator.rb → logger_delegator.rb}

@@ -39,7 +39,9 @@ module CLIUtils
     # @param [<String, Symbol>] target_name The target to remove
     # @return [void]
     def detach(target_name)
-      fail "Cannot delete invalid target: #{ target_name }" unless @targets.key?(target_name)
+      unless @targets.key?(target_name)
+        fail "Cannot delete invalid target: #{ target_name }"
+      end
       @targets.delete(target_name)
       LoggerDelegator.delegate
     end

data/lib/cliutils/messenging.rb

@@ -1,4 +1,4 @@
-require 'cliutils/pretty-io'
+require 'cliutils/pretty_io'
 
 module CLIUtils
   #  CLIMessenger Module
@@ -21,7 +21,7 @@ module CLIUtils
       stdout_logger.formatter = proc do |severity, datetime, progname, msg|
         send(severity.downcase, msg)
       end
-      
+
       LoggerDelegator.new(STDOUT: stdout_logger)
     end
 
@@ -32,4 +32,4 @@ module CLIUtils
       @@messenger ||= default_instance
     end
   end
-end
+end

data/lib/cliutils/prefs/pref.rb

@@ -1,6 +1,6 @@
 require 'cliutils/messenging'
-require 'cliutils/prefs/pref-behavior'
-require 'cliutils/prefs/pref-validation'
+require 'cliutils/prefs/pref_behavior'
+require 'cliutils/prefs/pref_validation'
 
 module CLIUtils
   # Pref Class
@@ -43,7 +43,7 @@ module CLIUtils
     # Stores the prompt text.
     # @return [String]
     attr_accessor :prompt
-    
+
     # Stores key/value combinations required to show this Pref.
     # @return [Hash]
     attr_accessor :validators
@@ -59,16 +59,9 @@ module CLIUtils
     # @param [Pref] other
     # @return [Boolean]
     def ==(other)
-      return self.answer == other.answer &&
-             self.behaviors == other.behaviors &&
-             self.config_key == other.config_key &&
-             self.config_section == other.config_section &&
-             self.default == other.default &&
-             self.last_error_message == other.last_error_message &&
-             self.options == other.options &&
-             self.prereqs == other.prereqs &&
-             self.prompt == other.prompt &&
-             self.validators == other.validators
+      @config_key == other.config_key &&
+      @config_section == other.config_section &&
+      @prompt == other.prompt
     end
 
     # Runs the passed text through this Pref's behaviors.
@@ -84,7 +77,6 @@ module CLIUtils
             messenger.warn("Skipping undefined Pref behavior: #{ b }")
           end
         end
-        
         modified_text
       else
         text
@@ -99,7 +91,7 @@ module CLIUtils
       _confirm_options(text) &&
       _confirm_validators(text)
     end
-    
+
     private
 
     # Validates a text against the options for this Pref
@@ -109,11 +101,11 @@ module CLIUtils
       ret = true
       if @options
         unless @options.include?(text)
-          @last_error_message = "Invalid option chosen (\"#{ text }\"); valid options are: #{ options }"
+          @last_error_message = "Invalid option chosen (\"#{ text }\");"\
+          "valid options are: #{ options }"
           ret = false
         end
       end
-
       ret
     end
 
@@ -135,8 +127,7 @@ module CLIUtils
           end
         end
       end
-      
       ret
     end
   end
-end
+end

data/lib/cliutils/prefs/{pref-behavior.rb → pref_behavior.rb}

@@ -11,4 +11,4 @@ module CLIUtils
       File.expand_path(text)
     end
   end
-end
+end

data/lib/cliutils/prefs/{pref-validation.rb → pref_validation.rb}

@@ -23,7 +23,7 @@ module CLIUtils
       c = text.to_s =~ /\A[A-Za-z0-9\s]+\z/
       Validator.new(c, m)
     end
-    
+
     # Validates that a value is a date.
     # @param [String] text The text to inspect
     # @return [Boolean]
@@ -38,7 +38,7 @@ module CLIUtils
     # @param [String] text The text to inspect
     # @return [Boolean]
     def self.non_nil(text)
-      m = "Nil text not allowed"
+      m = 'Nil text not allowed'
       c = !text.nil? && !text.empty?
       Validator.new(c, m)
     end
@@ -61,4 +61,4 @@ module CLIUtils
       Validator.new(c, m)
     end
   end
-end
+end

data/lib/cliutils/prefs.rb

@@ -1,5 +1,5 @@
 require 'cliutils/prefs/pref'
-require 'cliutils/pretty-io'
+require 'cliutils/pretty_io'
 
 module CLIUtils
   # Engine to derive preferences from a YAML file, deliver
@@ -13,14 +13,14 @@ module CLIUtils
     # Stores a Configurator instance.
     # @return [Configurator]
     attr_reader :configurator
-    
+
     # Stores answers to prompt questions.
     # @return [Array]
     attr_reader :prompts
 
     # Reads prompt data from and stores it.
     # @param [<String, Hash, Array>] data Filepath to YAML, Hash, or Array
-    # @param [Configurator] configurator The configurator to take default values from
+    # @param [Configurator] configurator Source of defailt values
     # @return [void]
     def initialize(data, configurator = nil)
       @answers = []
@@ -29,21 +29,21 @@ module CLIUtils
 
       case data
       when String
-        if File.exists?(data)
+        if File.exist?(data)
           @config_path = data
-          data = YAML::load_file(data).deep_symbolize_keys
+          data = YAML.load_file(data).deep_symbolize_keys
           @prompts = _generate_prefs(data)
         else
-          fail "Invalid configuration file: #{ data }" 
+          fail "Invalid configuration file: #{ data }"
         end
       when Hash
         @config_path = nil
-        data = {:prompts => data} unless data.keys[0] == :prompts
+        data = { prompts: data } unless data.keys[0] == :prompts
         data.deep_symbolize_keys!
         @prompts = _generate_prefs(data)
       when Array
         @config_path = nil
-        data = {:prompts => data}.deep_symbolize_keys
+        data = { prompts: data }.deep_symbolize_keys
         @prompts = _generate_prefs(data)
       else
         fail 'Invalid configuration data'
@@ -59,8 +59,8 @@ module CLIUtils
       @prompts.reject { |p| p.prereqs }.each do |p|
         _deliver_prompt(p)
       end
-      
-      @prompts.find_all { |p| p.prereqs }.each do |p|
+
+      @prompts.select { |p| p.prereqs }.each do |p|
         _deliver_prompt(p) if _prereqs_fulfilled?(p)
       end
     end
@@ -75,8 +75,9 @@ module CLIUtils
       default = p.default
 
       unless @configurator.nil?
-        unless @configurator.data[p.config_section.to_sym].nil?
-          config_val = @configurator.data[p.config_section.to_sym][p.config_key.to_sym]
+        section_sym = p.config_section.to_sym
+        unless @configurator.data[section_sym].nil?
+          config_val = @configurator.data[section_sym][p.config_key.to_sym]
           default = config_val unless config_val.nil?
         end
       end
@@ -84,7 +85,6 @@ module CLIUtils
       valid_option_chosen = false
       until valid_option_chosen
         response = prompt(p.prompt, default)
-
         if p.validate(response)
           valid_option_chosen = true
           p.answer = p.evaluate_behaviors(response)
@@ -109,7 +109,7 @@ module CLIUtils
     def _prereqs_fulfilled?(p)
       ret = true
       p.prereqs.each do |req|
-        a = @prompts.detect do |answer|
+        a = @prompts.find do |answer|
           answer.config_key == req[:config_key] &&
           answer.answer == req[:config_value]
         end

data/lib/cliutils/{pretty-io.rb → pretty_io.rb}

@@ -1,7 +1,9 @@
 begin
-   require 'Win32/Console/ANSI' if (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  unless (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM).nil?
+    require 'Win32/Console/ANSI'
+  end
 rescue LoadError
-   raise 'You must run `gem install win32console` to use CLIMessage on Windows'
+  raise 'You must run `gem install win32console` to use CLIMessage on Windows'
 end
 
 require 'readline'
@@ -19,7 +21,7 @@ module CLIUtils
       # @return [Integer]
       attr_accessor :wrap_char_limit
     end
-    
+
     self.wrap = true
     self.wrap_char_limit = 80
 
@@ -41,7 +43,7 @@ module CLIUtils
           40.upto(47) do |bg|
             print "\033[#{attr};#{fg};#{bg}m #{fg};#{bg}  "
           end
-        puts "\033[0m"
+          puts "\033[0m"
         end
       end
     end
@@ -106,11 +108,11 @@ module CLIUtils
       Readline.completion_append_character = nil
       Readline.completion_proc = lambda do |prefix|
         files = Dir["#{start_dir}#{prefix}*"]
-        files.
-          map { |f| File.expand_path(f) }.
-          map { |f| File.directory?(f) ? f + "/" : f }
+        files.map { |f| File.expand_path(f) }
+             .map { |f| File.directory?(f) ? "#{ f }/" : f }
       end
-      choice = Readline.readline("# #{ prompt }#{ default.nil? ? ':' : " [default: #{ default }]:" } ".cyan)
+      p = "# #{ prompt }#{ default.nil? ? ':' : " [default: #{ default }]:" } "
+      choice = Readline.readline(p.cyan)
       if choice.empty?
         default
       else
@@ -165,13 +167,17 @@ module CLIUtils
     # @param [String] text The text to wrap
     # @param [String] prefix_str The prefix for each line
     # @return [String]
-    def _word_wrap(text, prefix_str) 
+    def _word_wrap(text, prefix_str)
       if PrettyIO.wrap
         return text if PrettyIO.wrap_char_limit <= 0
-        text.gsub(/\n/, ' ').gsub(/(.{1,#{PrettyIO.wrap_char_limit - prefix_str.length}})(\s+|$)/, "#{ prefix_str }\\1\n").strip
+
+        limit = PrettyIO.wrap_char_limit - prefix_str.length
+        text.gsub(/\n/, ' ')
+            .gsub(/(.{1,#{ limit }})(\s+|$)/, "#{ prefix_str }\\1\n")
+            .strip
       else
         text
       end
     end
   end
-end
+end

data/lib/cliutils.rb

@@ -1,18 +1,17 @@
-require 'cliutils/ext/Hash+Extensions'
-require 'cliutils/ext/Logger+Extensions'
-require 'cliutils/ext/String+Extensions'
+require 'cliutils/ext/hash_extensions'
+require 'cliutils/ext/logger_extensions'
+require 'cliutils/ext/string_extensions'
 
-require 'cliutils/pretty-io'
+require 'cliutils/constants'
+require 'cliutils/pretty_io'
 require 'cliutils/configurator'
 require 'cliutils/configuration'
-require 'cliutils/logger-delegator'
+require 'cliutils/logger_delegator'
 require 'cliutils/messenging'
 require 'cliutils/prefs'
 require 'cliutils/prefs/pref'
-require 'cliutils/version'
 
 # The CLIUtils module, which wraps everything
 # in this gem.
 module CLIUtils
-  
-end
+end

data/test/configurator_test.rb

@@ -3,6 +3,7 @@ require 'test/unit'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/configurator')
 
+# Tests for the Configurator class
 class TestConfigurator < Test::Unit::TestCase
   def setup
     @config_path = '/tmp/test.config'
@@ -10,25 +11,25 @@ class TestConfigurator < Test::Unit::TestCase
   end
 
   def teardown
-    FileUtils.rm(@config_path) if File.exists?(@config_path)
+    FileUtils.rm(@config_path) if File.exist?(@config_path)
   end
 
   def test_add_section
     @config.add_section(:test)
-    assert_equal(@config.data, {test: {}})
+    assert_equal(@config.data, test: {})
   end
 
   def test_delete_section
     @config.add_section(:test)
     @config.add_section(:test2)
     @config.delete_section(:test)
-    assert_equal(@config.data, {test2: {}})
+    assert_equal(@config.data, test2: {})
   end
 
   def test_accessing
     @config.add_section(:test)
     @config.data[:test].merge!(name: 'Bob')
-    assert_equal(@config.test, {name: 'Bob'})
+    assert_equal(@config.test, name: 'Bob')
   end
 
   def test_reset
@@ -40,9 +41,9 @@ class TestConfigurator < Test::Unit::TestCase
 
   def test_save
     @config.add_section(:section1)
-    @config.section1.merge!({ a: 'test', b: 'test' })
+    @config.section1.merge!(a: 'test', b: 'test')
     @config.save
-    
+
     File.open(@config_path, 'r') do |f|
       assert_output("---\nsection1:\n  a: test\n  b: test\n") { puts f.read }
     end

data/test/hash_extensions_test.rb

@@ -1,20 +1,21 @@
 require 'test/unit'
 
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/Hash+Extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/hash_extensions')
 
+# Tests for the Hash extension methods
 class TestHashExtensions < Test::Unit::TestCase
   def test_deep_merge!
-    h1 = {key: 'value', key2: ['value1', 'value2']}
-    h2 = {key3: {subkey1: 'value1'}, key: 'another_value'}
-    exp_result = {:key=>"another_value", :key2=>["value1", "value2"], :key3=>{:subkey1=>"value1"}}
+    h1 = { key: 'value', key2: %w(value1, value2) }
+    h2 = { key: 'another_value' }
+    exp_result = { key: 'another_value', key2: %w(value1, value2) }
     actual_result = h1.deep_merge!(h2)
     
     assert_equal(exp_result, actual_result)
   end
   
   def test_deep_stringify_keys
-    h = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
-    exp_result = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
+    h = { key: { subkey1: 'value1', subkey2: { subsubkey1: 'value' } } }
+    exp_result = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => 'value' } } }
     actual_result = h.deep_stringify_keys
     
     assert_not_equal(h, actual_result)
@@ -23,7 +24,7 @@ class TestHashExtensions < Test::Unit::TestCase
   
   def test_deep_stringify_keys!
     h = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
-    exp_result = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
+    exp_result = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => 'value' } } }
     actual_result = h.deep_stringify_keys!
     
     assert_equal(h, actual_result)
@@ -31,8 +32,8 @@ class TestHashExtensions < Test::Unit::TestCase
   end
   
   def test_deep_symbolize_keys
-    h = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
-    exp_result = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    h = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => 'value'} } }
+    exp_result = { key: { subkey1: 'value1', subkey2: { subsubkey1: 'value'} } }
     actual_result = h.deep_symbolize_keys
     
     assert_not_equal(h, actual_result)
@@ -40,8 +41,8 @@ class TestHashExtensions < Test::Unit::TestCase
   end
 
   def test_deep_symbolize_keys!
-    h = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
-    exp_result = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    h = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => 'value'} } }
+    exp_result = { key: { subkey1: 'value1', subkey2: { subsubkey1: 'value'} } }
     actual_result = h.deep_symbolize_keys!
     
     assert_equal(h, actual_result)

data/test/logger_extensions_test.rb

@@ -1,16 +1,17 @@
 require 'test/unit'
 
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/Logger+Extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/logger_extensions')
 
+# Tests for the Logger extension methods
 class TestLoggerExtensions < Test::Unit::TestCase
   def test_custom_level
     l = Logger.new(STDOUT)
     l.formatter = proc do |severity, datetime, progname, msg|
       puts "#{ severity }: #{ msg }"
     end
-    
+
     assert_output("PROMPT: test\n")  { l.prompt('test')  }
     assert_output("SECTION: test\n") { l.section('test') }
     assert_output("SUCCESS: test\n") { l.success('test') }
   end
-end
+end

data/test/messenging_test.rb

@@ -1,22 +1,23 @@
 require 'logger'
 require 'test/unit'
 
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/String+Extensions')
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/pretty-io')
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/logger-delegator')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/string_extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/pretty_io')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/logger_delegator')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/messenging')
 
+# Tests for the Hash extension methods
 class TestMessenging < Test::Unit::TestCase
   include CLIUtils::Messenging
-  
+
   def setup
     @file1path = '/tmp/file1.txt'
   end
 
   def teardown
-    FileUtils.rm(@file1path) if File.exists?(@file1path)
+    FileUtils.rm(@file1path) if File.exist?(@file1path)
   end
-  
+
   def test_stdout_output
     assert_output('# This is error'.red + "\n") { messenger.send(:error, 'This is error') }
     assert_output('# This is info'.blue + "\n") { messenger.send(:info, 'This is info') }
@@ -24,10 +25,10 @@ class TestMessenging < Test::Unit::TestCase
     assert_output('# This is success'.green + "\n") { messenger.send(:success, 'This is success') }
     assert_output('# This is warn'.yellow + "\n") { messenger.send(:warn, 'This is warn') }
   end
-  
+
   def test_wrapping
     CLIUtils::PrettyIO.wrap_char_limit = 35
-    
+
     long_str = 'This is a really long string that should wrap itself at some point, okay?'
     expected_str = long_str.gsub(/\n/, ' ').gsub(/(.{1,#{CLIUtils::PrettyIO.wrap_char_limit - 2}})(\s+|$)/, "# \\1\n").strip
     assert_output(expected_str.blue + "\n") { messenger.send(:info, long_str) }
@@ -38,13 +39,13 @@ class TestMessenging < Test::Unit::TestCase
     file_logger.formatter = proc do |severity, datetime, progname, msg|
       "#{ severity }: #{ msg }\n"
     end
-    
+
     messenger.attach(FILE: file_logger)
     messenger.send(:info, 'Info test')
     messenger.send(:error, 'Error test')
     messenger.detach(:FILE)
     messenger.send(:warn, 'Warn test')
-    
+
     File.open(@file1path, 'r') do |f|
       assert_output("INFO: Info test\nERROR: Error test\n") { puts f.read.lines.to_a[1..-1].join }
     end

data/test/prefs_test.rb

@@ -1,72 +1,73 @@
 require 'test/unit'
 require 'yaml'
 
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/Hash+Extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/hash_extensions')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs/pref')
 
+# Tests for the Prefs class
 class TestPrefs < Test::Unit::TestCase
   def setup
     @prefs_arr = [
       {
-        "prompt" => "Batman or Superman?",
-        "default" => "Batman",
-        "config_key" => "superhero",
-        "config_section" => "personal_info"
+        'prompt' => 'Batman or Superman?',
+        'default' => 'Batman',
+        'config_key' => 'superhero',
+        'config_section' => 'personal_info'
       },
       {
-        "prompt" => "Do you feel smart for preferring Batman?",
-        "default" => "Y",
-        "config_key" => "batman_answer",
-        "config_section" => "personal_info",
-        "prereqs" => [
+        'prompt' => 'Do you feel smart for preferring Batman?',
+        'default' => 'Y',
+        'config_key' => 'batman_answer',
+        'config_section' => 'personal_info',
+        'prereqs' => [
           {
-            "config_key" => "superhero",
-            "config_value" => "Batman"
+            'config_key' => 'superhero',
+            'config_value' => 'Batman'
           }
         ]
       },
       {
-        "prompt" => "Why do you prefer Superman?!",
-        "default" => "No clue",
-        "config_key" => "superman_answer",
-        "config_section" => "personal_info",
-        "prereqs" => [
+        'prompt' => 'Why do you prefer Superman?!',
+        'default' => 'No clue',
+        'config_key' => 'superman_answer',
+        'config_section' => 'personal_info',
+        'prereqs' => [
           {
-            "config_key" => "superhero",
-            "config_value" => "Superman"
+            'config_key' => 'superhero',
+            'config_value' => 'Superman'
           }
         ]
       }
     ]
-    
+
     @prefs_hash = {:prompts=>@prefs_arr}
     @prefs_filepath = '/tmp/prefstest.yaml'
     FileUtils.cp(File.join(File.dirname(__FILE__), '..', 'test/test_files/prefstest.yaml'), @prefs_filepath)
   end
 
   def teardown
-    FileUtils.rm(@prefs_filepath) if File.exists?(@prefs_filepath)
+    FileUtils.rm(@prefs_filepath) if File.exist?(@prefs_filepath)
   end
 
   def test_file_creation
     p = CLIUtils::Prefs.new(@prefs_filepath)
     prefs = YAML::load_file(@prefs_filepath).deep_symbolize_keys
 
-    assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prefs)
+    assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prompts)
   end
 
   def test_array_creation
     p = CLIUtils::Prefs.new(@prefs_arr)
     prefs = @prefs_hash.deep_symbolize_keys
-  
-    assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prefs)    
+
+    assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prompts)
   end
 
   def test_hash_creation
     p = CLIUtils::Prefs.new(@prefs_hash)
     prefs = @prefs_hash.deep_symbolize_keys
-  
-    assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prefs)
+
+    assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prompts)
   end
 end

data/test/string_extesions_test.rb

@@ -1,7 +1,8 @@
 require 'test/unit'
 
-require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/String+Extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/string_extensions')
 
+# Tests for the String extension methods
 class TestStringExtensions < Test::Unit::TestCase
   def test_custom_colors
     assert_output("\e[34mtest\e[0m\n") { puts 'test'.blue }
@@ -11,4 +12,4 @@ class TestStringExtensions < Test::Unit::TestCase
     assert_output("\e[31mtest\e[0m\n") { puts 'test'.red }
     assert_output("\e[33mtest\e[0m\n") { puts 'test'.yellow }
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Aaron Bach
@@ -86,17 +86,17 @@ files:
 - lib/cliutils.rb
 - lib/cliutils/configuration.rb
 - lib/cliutils/configurator.rb
-- lib/cliutils/ext/Hash+Extensions.rb
-- lib/cliutils/ext/Logger+Extensions.rb
-- lib/cliutils/ext/String+Extensions.rb
-- lib/cliutils/logger-delegator.rb
+- lib/cliutils/constants.rb
+- lib/cliutils/ext/hash_extensions.rb
+- lib/cliutils/ext/logger_extensions.rb
+- lib/cliutils/ext/string_extensions.rb
+- lib/cliutils/logger_delegator.rb
 - lib/cliutils/messenging.rb
 - lib/cliutils/prefs.rb
-- lib/cliutils/prefs/pref-behavior.rb
-- lib/cliutils/prefs/pref-validation.rb
 - lib/cliutils/prefs/pref.rb
-- lib/cliutils/pretty-io.rb
-- lib/cliutils/version.rb
+- lib/cliutils/prefs/pref_behavior.rb
+- lib/cliutils/prefs/pref_validation.rb
+- lib/cliutils/pretty_io.rb
 - res/readme-images/messenger-types-1.png
 - res/readme-images/messenger-warn.png
 - res/readme-images/multi-logger.png