cliutils 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0661e149b08f88960de4184a7a8da5532a63d97
-  data.tar.gz: 613a4708ec59139915d4e586d94270f2b043c1c2
+  metadata.gz: ed57d1bb3f3c3248b082ff1ea8a5159a2e68052b
+  data.tar.gz: 9fb6dc3532170cdcf2ef15239d99c199fb1ef04f
 SHA512:
-  metadata.gz: 2f797db44c6134ad992452ef1a352e6c3a56df8c30d0d2b8d6877c5150abcfb012813666841f582df8e75371479ca4e95a39b99699bc2febc3aeb5b4e258ded8
-  data.tar.gz: 5cf08cd508662ba10b2e0c10160abc7444703a8f0d4201be3b231cd982524089eb8d13054dd31766325a21185e3c3cada016d99a4418a242c5fac94f22fafa66
+  metadata.gz: da2909f0c9d6de3f3e75698b09414ea999e364894435dc7843334351568b89f5fa6292215ff7e67546b5b5918afa80083885f3b735ef303a202fc94492faf9f8
+  data.tar.gz: efd71929d34adea0cadecd3cc6865f48a5b3cff101de2060084994369d56f50b37d57e4a1921fb49aa9c04d16d737c3bfd38307f99580f18f2e0105af9c461bc

data/.gitignore

@@ -1 +1,3 @@
 .DS_Store
+doc
+pkg

data/.yardoc/checksums

@@ -1,11 +1,11 @@
-lib/cliutils.rb d9df8016853e34d15d313e4b31e9372f774e1a1e
-lib/cliutils/prefs.rb ff05c575b2b369a1ddf4c1a2b5d967817dca9169
-lib/cliutils/version.rb 878b4b132480b6f152a92bfb25d3df9ec01afb68
-lib/cliutils/pretty-io.rb cb9180bfab92bac8de7d2596bca1d75b75bbd5e4
-lib/cliutils/messenging.rb 4a09e017169a879edc9721039452021a8bed2744
-lib/cliutils/configurator.rb 66021010c3d747db51917eab88f1d249ce4fe03a
-lib/cliutils/configuration.rb 1de2d1b17294954071ddda7227a71501d07a8ae3
-lib/cliutils/logger-delegator.rb e8f2454faf305ed1a7a882e15a87a683684bb333
-lib/cliutils/ext/Hash+Extensions.rb e47f73d02132978ed166e8f7d320b147a9397ea1
-lib/cliutils/ext/Logger+Extensions.rb f37fc1c860e1f1ccca1671c8ae09cac23e4a2812
-lib/cliutils/ext/String+Extensions.rb 651d2853ccb9f94767af1d7199fdc83df44778d7
+lib/cliutils.rb 4f397f5444c33ebcebd8384e5b7b498186785d0d
+lib/cliutils/prefs.rb 66f1c006d76b5334ad4b2b427141796d35065c27
+lib/cliutils/version.rb 70a1622cf96c5c986b312e8b7f5751131090b30e
+lib/cliutils/pretty-io.rb fba4516ec1e2561d1b5e613e4f61b04f03e8abc0
+lib/cliutils/messenging.rb c0362bcb8e1090d83966d2b3596532c7f1576570
+lib/cliutils/configurator.rb c202ac417ea4891c990da586d1edf6333f0fa8d6
+lib/cliutils/configuration.rb 02752324c57b7c7054d9a8158f70641cd73682bc
+lib/cliutils/logger-delegator.rb 507b215088c1d019d42059832ef8280f746ee26b
+lib/cliutils/ext/Hash+Extensions.rb e51f7475afccd3ad38a4a62ddcf87216f2dcc974
+lib/cliutils/ext/Logger+Extensions.rb 946bf8385446f369264877a2fe6bb415f24dbcd8
+lib/cliutils/ext/String+Extensions.rb a0a39b16d1709e7f5c5c4eff0d6d8258e691582d

data/Gemfile.lock

@@ -1,48 +1,27 @@
 PATH
   remote: .
   specs:
-    cliutils (0.0.1)
-      methadone (~> 1.3.2)
+    cliutils (1.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.5.4)
-      childprocess (>= 0.3.6)
-      cucumber (>= 1.1.1)
-      rspec-expectations (>= 2.7.0)
-    builder (3.2.2)
-    childprocess (0.5.1)
-      ffi (~> 1.0, >= 1.0.11)
-    cucumber (1.3.12)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12)
-      multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.1.1)
-    diff-lcs (1.2.5)
-    ffi (1.9.3)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
-    json (1.8.1)
-    methadone (1.3.2)
-      bundler
-    multi_json (1.9.2)
-    multi_test (0.1.1)
+    coderay (1.1.0)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (0.9.2.2)
-    rdoc (4.1.1)
-      json (~> 1.4)
-    rspec-expectations (3.0.0.beta2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (= 3.0.0.beta2)
-    rspec-support (3.0.0.beta2)
+    slop (3.5.0)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba
   bundler (~> 1.5)
   cliutils!
-  rake (~> 0.9.2)
-  rdoc
+  pry (~> 0.9)
+  rake (~> 0)
+  yard (= 0.8.7.4)

data/README.md

@@ -45,7 +45,7 @@ include CLIUtils
 
 Alternatively, as described below, mix in only the libraries that you want.
 
-Note that although this README.md is extensive, it may not cover all methods. Check out the [tests](https://github.com/bachya/cli-utils/tree/master/test) to see more examples.
+Note that although this README.md is extensive, it may not cover all methods. Check out the [YARD documentation](http://rubydoc.info/github/bachya/cli-utils/master/frames) and the [tests](https://github.com/bachya/cli-utils/tree/master/test) to see more examples.
 
 # Libraries
 

data/Rakefile

@@ -1,45 +1,50 @@
 require 'rake/clean'
 require 'rubygems'
-require 'rubygems/package_task'
-require 'rdoc/task'
-require 'cucumber'
-require 'cucumber/rake/task'
-Rake::RDocTask.new do |rd|
-  rd.main = "README.md"
-  rd.rdoc_files.include("README.md","lib/**/**/*.rb")
-  rd.title = 'CLIUtils'
+
+def version
+  contents = File.read File.expand_path('../lib/cliutils/version.rb', __FILE__)
+  contents[/VERSION = "([^"]+)"/, 1]
 end
 
 spec = eval(File.read('cliutils.gemspec'))
 
-Gem::PackageTask.new(spec) do |pkg|
-end
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-desc 'Run features'
-Cucumber::Rake::Task.new(:features) do |t|
-  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
-  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
-  t.cucumber_opts =  opts
-  t.fork = false
-end
-
-desc 'Run features tagged as work-in-progress (@wip)'
-Cucumber::Rake::Task.new('features:wip') do |t|
-  tag_opts = ' --tags ~@pending'
-  tag_opts = ' --tags @wip'
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
-  t.fork = false
+require 'yard'
+desc 'Create YARD documentation'
+YARD::Rake::YardocTask.new do |t|
 end
 
-task :cucumber => :features
-task 'cucumber:wip' => 'features:wip'
-task :wip => 'features:wip'
-
 require 'rake/testtask'
+desc 'Run unit tests'
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/*_test.rb']
 end
 
-task :default => [:test]
+require 'pry'
+desc 'Open up a PRY session with this gem loaded'
+task :pry do
+  puts version
+end
+
+desc "Release CLIUtils version #{version}"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/cliutils-#{version}.gem"
+end
+
+desc "Build the gem"
+task :build do
+  FileUtils.mkdir_p "pkg"
+  sh "gem build cliutils.gemspec"
+  FileUtils.mv("./cliutils-#{version}.gem", "pkg")
+end
+
+task :default => :test

data/cliutils.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md', 'doc']
   spec.rdoc_options << '--title' << 'CLIUtils' << '--main' << 'README.md' << '-ri'
 
-  spec.add_development_dependency("bundler", "~> 1.5")
-  spec.add_development_dependency('rdoc', '~> 0')
+  spec.add_development_dependency('bundler', '~> 1.5')
+  spec.add_development_dependency('pry', '~> 0.9')
   spec.add_development_dependency('rake', '~> 0')
+  spec.add_development_dependency('yard', '0.8.7.4')
 end

data/lib/cliutils/configuration.rb

@@ -1,46 +1,28 @@
 require 'yaml'
 
 module CLIUtils
-  #  ======================================================
-  #  Configuration Class
-  #
-  #  Manages any configuration values and the flat YAML file
-  #  into which they get stored.
-  #  ======================================================
+  # Configuration Module
+  # Manages any configuration values and the flat YAML file
+  # into which they get stored.
   module Configuration
-    #  ====================================================
-    #  Methods
-    #  ====================================================
-    #  ----------------------------------------------------
-    #  included method
-    #
-    #  Hook called when this module gets mixed in; extends
-    #  the includer with the methods defined here.
-    #  @param k The includer
-    #  @return Void
-    #  ----------------------------------------------------
+    # Hook that triggers when this module is included.
+    # @param [Object] k The includer object
+    # @return [void]
     def self.included(k)
       k.extend(self)
     end
 
-    #  ----------------------------------------------------
-    #  configuration method
-    #
-    #  Singleton method to return (or initialize, if needed)
-    #  a Configurator.
-    #  @return Configurator
-    #  ----------------------------------------------------
+    # Singleton method to return (or initialize, if needed)
+    # a Configurator.
+    # @return [Configurator]
     def configuration
       @configuration ||= Configurator.new('~/.default-cliutils')
     end
 
-    #  ----------------------------------------------------
-    #  load_configuration method
-    #
-    #  Initializes a Configurator with the passed filepath.
-    #  @param path The path to the config file
-    #  @return Void
-    #  ----------------------------------------------------
+    # Singleton method to return (or initialize, if needed)
+    # a Configurator.
+    # @param [String] path The filepath to use
+    # @return [void]
     def load_configuration(path)
       @configuration = Configurator.new(path)
     end

data/lib/cliutils/configurator.rb

@@ -1,28 +1,15 @@
 require 'yaml'
 
 module CLIUtils
-  #  ======================================================
   #  Configuration Class
-  #
   #  Manages any configuration values and the flat YAML file
   #  into which they get stored.
-  #  ======================================================
   class Configurator
-    #  ====================================================
-    #  Attributes
-    #  ====================================================
     attr_reader :config_path, :data
 
-    #  ====================================================
-    #  Methods
-    #  ====================================================
-    #  ----------------------------------------------------
-    #  initialize method
-    #
-    #  Initializes configuration from a flat file.
-    #  @param path The filepath to the config YAML
-    #  @return void
-    #  ----------------------------------------------------
+    # Initializes configuration from a flat file.
+    # @param [String] path The filepath to the config YAML
+    # @return [void]
     def initialize(path)
       _path = File.expand_path(path)
       @config_path = _path
@@ -34,14 +21,10 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  add_section method
-    #
-    #  Adds a new section to the config file (if it doesn't
-    #  already exist).
-    #  @param section_name The section to add
-    #  @return Void
-    #  ----------------------------------------------------
+    # Adds a new section to the config file (if it doesn't
+    # already exist).
+    # @param [String] section_name The section to add
+    # @return [void]
     def add_section(section_name)
       if !@data.key?(section_name)
         @data[section_name] = {}
@@ -50,13 +33,9 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  delete_section method
-    #
-    #  Removes a section to the config file (if it exists).
-    #  @param section_name The section to remove
-    #  @return Void
-    #  ----------------------------------------------------
+    # Removes a section to the config file (if it exists).
+    # @param [String] section_name The section to remove
+    # @return [void]
     def delete_section(section_name)
       if @data.key?(section_name)
         @data.delete(section_name)
@@ -65,14 +44,10 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  ingest_prefs method
-    #
-    #  Ingests a Prefs class and adds its answers to the
-    #  configuration data.
-    #  @param prefs The Prefs class to examine
-    #  @return Void
-    #  ----------------------------------------------------
+    # Ingests a Prefs class and adds its answers to the
+    # configuration data.
+    # @param [Prefs] prefs The Prefs class to examine
+    # @return [void]
     def ingest_prefs(prefs)
       fail 'Invaid Prefs class' if !prefs.kind_of?(Prefs) || prefs.answers.nil?
       prefs.answers.each do |p|
@@ -81,37 +56,23 @@ module CLIUtils
       end
     end
 
-    #  ----------------------------------------------------
-    #  method_missing method
-    #
-    #  Allows this module to return data from the config
-    #  Hash when given a method name that matches a key.
-    #  @param name
-    #  @param *args
-    #  @param &block
-    #  @return Hash
-    #  ----------------------------------------------------
+    # Hook that fires when a non-existent method is called.
+    # Allows this module to return data from the config
+    # Hash when given a method name that matches a key.
+    # @return [Hash]
     def method_missing(name, *args, &block)
       @data[name.to_sym] || @data.merge!(name.to_sym => {})
     end
 
-    #  ----------------------------------------------------
-    #  reset method
-    #
-    #  Clears the configuration data.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Clears the configuration data.
+    # @return [void]
     def reset
       @data = {}
     end
 
-    #  ----------------------------------------------------
-    #  save method
-    #
-    #  Saves the configuration data to the previously
-    #  stored flat file.
-    #  @return Void
-    #  ----------------------------------------------------
+    # Saves the configuration data to the previously
+    # stored flat file.
+    # @return [void]
     def save
       File.open(@config_path, 'w') { |f| f.write(@data.deep_stringify_keys.to_yaml) }
     end

data/lib/cliutils/ext/Hash+Extensions.rb

@@ -1,21 +1,12 @@
-#  ======================================================
-#  Hash Class
-#
-#  Contains many convenient methods borrowed from Rails
-#  http://api.rubyonrails.org/classes/Hash.html
-#  ======================================================
+# Hash Class
+# Contains many convenient methods borrowed from Rails
+# http://api.rubyonrails.org/classes/Hash.html
 class Hash
-  #  ====================================================
-  #  Methods
-  #  ====================================================
-  #  ----------------------------------------------------
-  #  deep_merge! method
-  #
-  #  Deep merges a hash into the current one.
-  #  @param other_hash The hash to merge in
-  #  @param &block
-  #  @return 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|
       tv = self[k]
@@ -28,84 +19,58 @@ class Hash
     self
   end
 
-  #  ----------------------------------------------------
-  #  deep_stringify_keys method
-  #
-  #  Recursively turns all Hash keys into strings and
-  #  returns the new Hash.
-  #  @return Hash
-  #  ----------------------------------------------------
+  # Recursively turns all Hash keys into strings and
+  # returns the new Hash.
+  # @return [Hash]
   def deep_stringify_keys
     deep_transform_keys{ |key| key.to_s }
   end
 
-  #  ----------------------------------------------------
-  #  deep_symbolize_keys! method
-  #
-  #  Same as deep_stringify_keys, but destructively
-  #  alters the original Hash.
-  #  @return Hash
-  #  ----------------------------------------------------
+  # Same as deep_stringify_keys, but destructively
+  # alters the original Hash.
+  # @return [Hash]
   def deep_stringify_keys!
     deep_transform_keys!{ |key| key.to_s }
   end
 
-  #  ----------------------------------------------------
-  #  deep_symbolize_keys method
-  #
-  #  Recursively turns all Hash keys into symbols and
-  #  returns the new Hash.
-  #  @return Hash
-  #  ----------------------------------------------------
+  # 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 }
   end
 
-  #  ----------------------------------------------------
-  #  deep_symbolize_keys! method
-  #
-  #  Same as deep_symbolize_keys, but destructively
-  #  alters the original Hash.
-  #  @return Hash
-  #  ----------------------------------------------------
+  # 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 }
   end
 
-  #  ----------------------------------------------------
-  #  deep_transform_keys method
-  #
-  #  Generic method to perform recursive operations on a
-  #  Hash.
-  #  @return Hash
-  #  ----------------------------------------------------
+  # Generic method to perform recursive operations on a
+  # Hash.
+  # @yield &block
+  # @return [Hash]
   def deep_transform_keys(&block)
     _deep_transform_keys_in_object(self, &block)
   end
 
-  #  ----------------------------------------------------
-  #  deep_transform_keys! method
-  #
-  #  Same as deep_transform_keys, but destructively
-  #  alters the original Hash.
-  #  @return Hash
-  #  ----------------------------------------------------
+  # Same as deep_transform_keys, but destructively
+  # alters the original Hash.
+  # @yield &block
+  # @return [Hash]
   def deep_transform_keys!(&block)
     _deep_transform_keys_in_object!(self, &block)
   end
 
   private
 
-  #  ----------------------------------------------------
-  #  _deep_transform_keys_in_object method
-  #
-  #  Modification to deep_transform_keys that allows for
-  #  the existence of arrays.
-  #  https://github.com/rails/rails/pull/9720/files?short_path=4be3c90
-  #  @param object The object to examine
-  #  @param &block A block to execute on the opject
-  #  @return Object
-  #  ----------------------------------------------------
+  # Modification to deep_transform_keys that allows for
+  # the existence of arrays.
+  # https://github.com/rails/rails/pull/9720/files?short_path=4be3c90
+  # @param [Object] object The object to examine
+  # @yield &block
+  # @return [Object]
   def _deep_transform_keys_in_object(object, &block)
     case object
     when Hash
@@ -119,15 +84,11 @@ class Hash
     end
   end
 
-  #  ----------------------------------------------------
-  #  _deep_transform_keys_in_object! method
-  #
-  #  Same as _deep_transform_keys_in_object, but
-  #  destructively alters the original Object.
-  #  @param object The object to examine
-  #  @param &block A block to execute on the opject
-  #  @return Object
-  #  ----------------------------------------------------
+  # Same as _deep_transform_keys_in_object, but
+  # destructively alters the original Object.
+  # @param [Object] The object to examine
+  # @yield &block
+  # @return [Object]
   def _deep_transform_keys_in_object!(object, &block)
     case object
     when Hash

data/lib/cliutils/ext/Logger+Extensions.rb

@@ -1,17 +1,12 @@
 require 'logger'
 
-#  ======================================================
-#  Logger Class
-#  ======================================================
+#  Logger Class extensions
 class Logger
-  #  ----------------------------------------------------
-  #  custom_level method
-  #
-  #  Creates a custom Logger level based on the passed
-  #  tag.
-  #  @param tag The Logger level to create
-  #  @return Void
-  #  ----------------------------------------------------
+
+  # 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 

data/lib/cliutils/ext/String+Extensions.rb

@@ -1,26 +1,38 @@
-#  ======================================================
-#  String Class
-#  ======================================================
+#  String Class extensions
 class String
-  #  ====================================================
-  #  Color String Methods
-  #  ====================================================
-  #  ----------------------------------------------------
-  #  colorize method
-  #
-  #  Outputs a string in a formatted color.
-  #  @param color_code The code to use
-  #  @return Void
-  #  ----------------------------------------------------
+
+  # 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
+
+  # Makes the associated string cyan.
+  # @return [void]
   def cyan; colorize(36) end
+
+  # Makes the associated string green.
+  # @return [void]
   def green; colorize(32) end
+
+  # Makes the associated string purple.
+  # @return [void]
   def purple; colorize(35) end
+
+  # Makes the associated string red.
+  # @return [void]
   def red; colorize(31) end
+
+  # Makes the associated string white.
+  # @return [void]
   def white; colorize(37) end
+
+  # Makes the associated string yellow.
+  # @return [void]
   def yellow; colorize(33) end
 end