ztk 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1209eb8e5e2897a3911c0e7048080bc532b86c43
-  data.tar.gz: 0b41dee03dac4f105de394722dfa9608e98fc221
+  metadata.gz: c57ed48dc9a7a8ea11f7461921dcb6313d67cdfc
+  data.tar.gz: c1cd99736a83e539f5d465070444d69d88a943ce
 SHA512:
-  metadata.gz: d79fceb184898082b9db8edb3c040aee94edb10f07b25588daf7700c5813699652f3c7dc0973ef23f29a0e6e601e8d93590cc3c01e86e086603074f27d300789
-  data.tar.gz: 7759484bac6dff0b686c7ae43e54a6e60ca10bfbaa288b5f9522fd0acab96816d0212c89bc4e0de1f6ae5445576822ae83a2b7541362ec317d36f20151dcca17
+  metadata.gz: 093b9939c50d55c8c3b5ba4bde9331b3e8e8c1a22c1c0be32137a4e89d1ad615c1171489dbf60604edb43fe47d7131992b442ae6b315dda8f85fda8989697f69
+  data.tar.gz: da0f11da1715c9daa86154e51615e9bb15423d856ce6e2d408c599a7a85771c639c3ee8be1cda63faa24e9bfb7cd57941bfc7d37c83c3170c1448607e43e03d5

data/README.md

@@ -104,7 +104,7 @@ Issues:
 
 ZTK - Zachary's Tool Kit
 
-* Author: Zachary Patten <zachary AT jovelabs DOT com> [![endorse](http://api.coderwall.com/zpatten/endorsecount.png)](http://coderwall.com/zpatten)
+* Author: Zachary Patten <zpatten AT jovelabs DOT io>
 * Copyright: Copyright (c) Zachary Patten
 * License: Apache License, Version 2.0
 

data/Rakefile

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/lib/ztk.rb

@@ -6,12 +6,12 @@ require 'ztk/version'
 # in mind.  It provides several classes that ease SSH and SFTP, templating,
 # and a myraid of other activities.
 #
-# @author Zachary Patten <zachary AT jovelabs DOT com>
+# @author Zachary Patten <zpatten AT jovelabs DOT io>
 module ZTK
 
   # ZTK error class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Error < StandardError; end
 
   require 'ztk/base'

data/lib/ztk/ansi.rb

@@ -2,7 +2,7 @@ module ZTK
 
   # ANSI Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class ANSIError < Error; end
 
   # ANSI Mixin Module
@@ -15,7 +15,7 @@ module ZTK
   # @example Or
   #   "green".green
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   module ANSI
 
     # Defines our ANSI color codes

data/lib/ztk/background.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Background Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class BackgroundError < Error; end
 
   # Background Processing Class
@@ -16,7 +16,7 @@ module ZTK
   # The after fork callback is called twice, once in the parent process and once
   # in the child process.
   #
-  # *example code*:
+  # @example Run a background process which simply sleeps illustrating the callback hooks:
   #
   #     a_callback = Proc.new do |pid|
   #       puts "Hello from After Callback - PID #{pid}"
@@ -40,47 +40,7 @@ module ZTK
   #     background.wait
   #     puts background.result.inspect
   #
-  # *pry output*:
-  #
-  #     [1] pry(main)> a_callback = Proc.new do |pid|
-  #     [1] pry(main)*   puts "Hello from After Callback - PID #{pid}"
-  #     [1] pry(main)* end
-  #     => #<Proc:0x00000001368a98@(pry):1>
-  #     [2] pry(main)>
-  #     [3] pry(main)> b_callback = Proc.new do |pid|
-  #     [3] pry(main)*   puts "Hello from Before Callback - PID #{pid}"
-  #     [3] pry(main)* end
-  #     => #<Proc:0x00000001060418@(pry):4>
-  #     [4] pry(main)>
-  #     [5] pry(main)> background = ZTK::Background.new
-  #     => #<ZTK::Background:0x00000001379118
-  #      @config=
-  #       #<OpenStruct stdout=#<IO:<STDOUT>>, stderr=#<IO:<STDERR>>, stdin=#<IO:<STDIN>>, logger=#<ZTK::Logger filename="/dev/null">>,
-  #      @result=nil>
-  #     [6] pry(main)> background.config do |config|
-  #     [6] pry(main)*   config.before_fork = b_callback
-  #     [6] pry(main)*   config.after_fork = a_callback
-  #     [6] pry(main)* end
-  #     => #<Proc:0x00000001368a98@(pry):1>
-  #     [7] pry(main)>
-  #     [8] pry(main)> pid = background.process do
-  #     [8] pry(main)*   sleep(1)
-  #     [8] pry(main)* end
-  #     Hello from Before Callback - PID 23564
-  #     Hello from After Callback - PID 23564
-  #     Hello from After Callback - PID 23578
-  #     => 23578
-  #     [9] pry(main)> puts pid.inspect
-  #     23578
-  #     => nil
-  #     [10] pry(main)>
-  #     [11] pry(main)> background.wait
-  #     => [23578, #<Process::Status: pid 23578 exit 0>, 1]
-  #     [12] pry(main)> puts background.result.inspect
-  #     1
-  #     => nil
-  #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Background < ZTK::Base
 
     # Result Set

data/lib/ztk/base.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Base Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class BaseError < Error; end
 
   # Base Class
@@ -16,7 +16,7 @@ module ZTK
   # You should never interact with this class directly; you should inherit it
   # and extend functionality as appropriate.
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Base
 
     class << self

data/lib/ztk/benchmark.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Benchmark Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class BenchmarkError < Error; end
 
   # Benchmark Class
@@ -16,7 +16,7 @@ module ZTK
   # the appropriate options it will display output to the user while
   # benchmarking the supplied block.
   #
-  # *example code*:
+  # @example Benchmark a simple sleep statement
   #
   #     message = "I wonder how long this will take?"
   #     mark = " ...looks like it took %0.4f seconds!"
@@ -24,19 +24,7 @@ module ZTK
   #       sleep(1.5)
   #     end
   #
-  # *pry output*:
-  #
-  #     [1] pry(main)> message = "I wonder how long this will take?"
-  #     => "I wonder how long this will take?"
-  #     [2] pry(main)> mark = " ...looks like it took %0.4f seconds!"
-  #     => " ...looks like it took %0.4f seconds!"
-  #     [3] pry(main)> ZTK::Benchmark.bench(:message => message, :mark => mark) do
-  #     [3] pry(main)*   sleep(1.5)
-  #     [3] pry(main)* end
-  #     I wonder how long this will take?  ...looks like it took 1.5229 seconds!
-  #     => 1.522871547
-  #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Benchmark
 
     class << self

data/lib/ztk/command.rb

@@ -2,21 +2,23 @@ module ZTK
 
   # Command Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class CommandError < Error; end
 
   # Command Execution Class
   #
   # @example We can get a new instance of Command like so:
+  #
   #     cmd = ZTK::Command.new
   #
-  # @example If we wanted to redirect STDOUT and STDERR to a StringIO we can do this:
+  # @example Run a command and redirect STDOUT and STDERR to a StringIO
+  #
   #     std_combo = StringIO.new
   #     ui = ZTK::UI.new(:stdout => std_combo, :stderr => std_combo)
   #     cmd = ZTK::Command.new(:ui => ui, :silence => true)
   #     puts cmd.exec("hostname", :silence => false).inspect
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Command < ZTK::Base
     require 'ostruct'
     require 'timeout'

data/lib/ztk/config.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Config Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class ConfigError < Error; end
 
   # Configuration Module
@@ -43,7 +43,7 @@ module ZTK
   #
   #     puts C.message
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   module Config
 
     # Extend base class with this module.

data/lib/ztk/dsl.rb

@@ -5,10 +5,10 @@ module ZTK
   # Generic Domain-specific Language Interface
   #
   # @see ZTK::DSL::Base
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   module DSL
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     class DSLError < Error; end
 
     require 'ztk/dsl/core'

data/lib/ztk/dsl/base.rb

@@ -128,7 +128,7 @@ module ZTK::DSL
   #     [9] pry(main)> Server.find(:my_server)
   #     => [#<Server id=:my_server attributes={:id=>:my_server, :name=>"my-server", :network_id=>:leet_net}, belongs_to_references=1>]
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Base
     include(ZTK::DSL::Core)
 
@@ -185,7 +185,7 @@ module ZTK::DSL
       "#<#{self.class.to_s} id=#{self.id.inspect} #{details.join(', ')}>"
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       # Class Inspect

data/lib/ztk/dsl/core.rb

@@ -2,7 +2,7 @@ module ZTK::DSL
 
   # DSL Core
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Core
     require 'ztk/dsl/core/attributes'
@@ -28,7 +28,7 @@ module ZTK::DSL
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     # module DualMethods
 
     #   def logger
@@ -43,7 +43,7 @@ module ZTK::DSL
 
     # end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def cattr_accessor(*args)

data/lib/ztk/dsl/core/actions.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Actions
     require 'ztk/dsl/core/actions/find'

data/lib/ztk/dsl/core/actions/find.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core::Actions
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Find
 
@@ -10,7 +10,7 @@ module ZTK::DSL::Core::Actions
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def all

data/lib/ztk/dsl/core/actions/timestamps.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core::Actions
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Timestamps
 
@@ -14,7 +14,7 @@ module ZTK::DSL::Core::Actions
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def updated_at_timestamp

data/lib/ztk/dsl/core/attributes.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Attributes
 
@@ -16,7 +16,7 @@ module ZTK::DSL::Core
       @attributes ||= Hash.new
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def attribute(key, options={})

data/lib/ztk/dsl/core/dataset.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Dataset
 
@@ -10,7 +10,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def dataset

data/lib/ztk/dsl/core/io.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module IO
 
@@ -10,7 +10,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def load(rb_file)

data/lib/ztk/dsl/core/options.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Options
 
@@ -10,7 +10,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def add_option(key)

data/lib/ztk/dsl/core/relations.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module Relations
     require 'ztk/dsl/core/relations/belongs_to'
@@ -14,7 +14,7 @@ module ZTK::DSL::Core
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def add_relation(key)

data/lib/ztk/dsl/core/relations/belongs_to.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core::Relations
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module BelongsTo
 
@@ -44,7 +44,7 @@ module ZTK::DSL::Core::Relations
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def belongs_to(key, options={})

data/lib/ztk/dsl/core/relations/has_many.rb

@@ -1,6 +1,6 @@
 module ZTK::DSL::Core::Relations
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   # @api private
   module HasMany
 
@@ -37,7 +37,7 @@ module ZTK::DSL::Core::Relations
       end
     end
 
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     module ClassMethods
 
       def has_many(key, options={})

data/lib/ztk/google_chart.rb

@@ -2,12 +2,12 @@ module ZTK
 
   # GoogleChart Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   module GoogleChart
 
     # GoogleChart Error Class
     #
-    # @author Zachary Patten <zachary AT jovelabs DOT com>
+    # @author Zachary Patten <zpatten AT jovelabs DOT io>
     class GoogleChartError < Error; end
 
     require 'ztk/google_chart/base'

data/lib/ztk/locator.rb

@@ -2,10 +2,10 @@ module ZTK
 
   # Locator Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class LocatorError < Error; end
 
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Locator
 
     class << self

data/lib/ztk/logger.rb

@@ -15,10 +15,14 @@ module ZTK
   # existing logging statements.
   #
   # One can override the logging level on the command line with programs that
-  # use this library like so:
-  #     LOG_LEVEL=DEBUG bin/cucumber-chef ssh
+  # use this library by defining the *LOG_LEVEL* environment variable to the
+  # desired logging level.
   #
-  # *Typical usage*:
+  # @example Override the logging level at runtime
+  #
+  #     LOG_LEVEL=DEBUG bin/a_ruby_script.rb
+  #
+  # @example Typical usage
   #
   #     $logger = ZTK::Logger.new("/dev/null")
   #
@@ -28,7 +32,7 @@ module ZTK
   #     $logger.error { "This is a error message!" }
   #     $logger.fatal { "This is a fatal message!" }
   #
-  # *Simple logger chain*:
+  # @example Simple logger chaining
   #
   #     logger = ZTK::Logger.new
   #     logger.loggers << ::Logger.new(STDOUT)
@@ -36,14 +40,14 @@ module ZTK
   #
   #     logger.debug { "This will be written to STDOUT as well as test.log!" }
   #
-  # *Alternate logger chaining*:
+  # @example Simple logger chaining
   #
   #     logger = ZTK::Logger.new(STDOUT)
   #     logger.loggers << ::Logger.new('test.log')
   #
   #     logger.debug { "This will be written to STDOUT as well as test.log!" }
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Logger < ::Logger
 
     # Log Levels

data/lib/ztk/parallel.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Parallel Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class ParallelError < Error; end
 
   # Parallel Processing Class
@@ -16,7 +16,7 @@ module ZTK
   # The after fork callback is called twice, once in the parent process and once
   # in the child process.
   #
-  # *example code*:
+  # @example Parallel processing with callbacks
   #
   #     a_callback = Proc.new do |pid|
   #       puts "Hello from After Callback - PID #{pid}"
@@ -43,57 +43,7 @@ module ZTK
   #     parallel.waitall
   #     puts parallel.results.inspect
   #
-  # *pry output*:
-  #
-  #     [1] pry(main)> a_callback = Proc.new do |pid|
-  #     [1] pry(main)*   puts "Hello from After Callback - PID #{pid}"
-  #     [1] pry(main)* end
-  #     => #<Proc:0x000000015a8768@(pry):1>
-  #     [2] pry(main)>
-  #     [3] pry(main)> b_callback = Proc.new do |pid|
-  #     [3] pry(main)*   puts "Hello from Before Callback - PID #{pid}"
-  #     [3] pry(main)* end
-  #     => #<Proc:0x000000012910e8@(pry):4>
-  #     [4] pry(main)>
-  #     [5] pry(main)> parallel = ZTK::Parallel.new
-  #     => #<ZTK::Parallel:0x000000015a9d48
-  #      @config=
-  #       #<OpenStruct stdout=#<IO:<STDOUT>>, stderr=#<IO:<STDERR>>, stdin=#<IO:<STDIN>>, logger=#<ZTK::Logger filename="/dev/null">, max_forks=12>,
-  #      @forks=[],
-  #      @results=[]>
-  #     [6] pry(main)> parallel.config do |config|
-  #     [6] pry(main)*   config.before_fork = b_callback
-  #     [6] pry(main)*   config.after_fork = a_callback
-  #     [6] pry(main)* end
-  #     => #<Proc:0x000000015a8768@(pry):1>
-  #     [7] pry(main)>
-  #     [8] pry(main)> puts Process.pid.inspect
-  #     24761
-  #     => nil
-  #     [9] pry(main)>
-  #     [10] pry(main)> 3.times do |x|
-  #     [10] pry(main)*   parallel.process do
-  #     [10] pry(main)*     x
-  #     [10] pry(main)*   end
-  #     [10] pry(main)* end
-  #     Hello from Before Callback - PID 24761
-  #     Hello from After Callback - PID 24761
-  #     Hello from Before Callback - PID 24761
-  #     Hello from After Callback - PID 24776
-  #     Hello from After Callback - PID 24761
-  #     Hello from Before Callback - PID 24761
-  #     Hello from After Callback - PID 24779
-  #     Hello from After Callback - PID 24761
-  #     Hello from After Callback - PID 24782
-  #     => 3
-  #     [11] pry(main)>
-  #     [12] pry(main)> parallel.waitall
-  #     => [0, 1, 2]
-  #     [13] pry(main)> puts parallel.results.inspect
-  #     [0, 1, 2]
-  #     => nil
-  #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Parallel < ZTK::Base
 
     class Break < ParallelError; end

data/lib/ztk/profiler.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Profiler Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class ProfilerError < Error; end
 
   # Profiler Class
@@ -13,7 +13,7 @@ module ZTK
   # to allow the consumer to define timing profiles in an ad hoc manner using
   # a block.
   #
-  # *Example Code*:
+  # @example Nested profiling
   #
   #     ZTK::Profiler.reset
   #
@@ -57,7 +57,7 @@ module ZTK
   #
   #     ZTK::Profiler.report
   #
-  # *Example Output*:
+  # @example Report output
   #
   #     --+ OperationAlpha 0.6070s
   #       |--+ OperationOne 0.3035s
@@ -91,7 +91,7 @@ module ZTK
   #      Profiled Time: 0.9105s
   #       Missing Time: 0.0005s
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Profiler
 
     require 'ztk/profiler/core'

data/lib/ztk/pty.rb

@@ -2,14 +2,14 @@ module ZTK
 
   # PTY Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class PTYError < Error; end
 
   # Ruby PTY Class Wrapper
   #
   # Wraps the Ruby PTY class, providing better functionality.
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class PTY
     require 'pty'
 

data/lib/ztk/rake/docs.rb

@@ -1,3 +1,4 @@
+require 'redcarpet'
 require 'yard'
 require 'yard/rake/yardoc_task'
 
@@ -8,7 +9,7 @@ DOC_PATH    = File.join(VENDOR_PATH, "docs")
 namespace :docs do
 
   YARD::Rake::YardocTask.new(:generate) do |t|
-    t.options = ['--verbose', '-o', DOC_PATH]
+    t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--verbose', '-o', DOC_PATH]
   end
 
   namespace :ghpages do
@@ -40,8 +41,9 @@ namespace :docs do
       commit_message << stats
 
       Dir.chdir(DOC_PATH) do
+        FileUtils.touch('.nojekyll')
         system(%(git add -Av))
-        system(%(git commit -m"#{commit_message.join}"))
+        system(%(git commit -S -m"#{commit_message.join}"))
         system(%(git push origin gh-pages))
       end
     end

data/lib/ztk/report.rb

@@ -2,7 +2,7 @@ module ZTK
 
   # Report Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class ReportError < Error; end
 
   # Report Class
@@ -14,7 +14,7 @@ module ZTK
   #
   # The idea here is that everything is auto-sized and simply displayed.
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Report < ZTK::Base
     require 'socket'
     require 'timeout'

data/lib/ztk/rescue_retry.rb

@@ -2,7 +2,7 @@ module ZTK
 
   # RescueRetry Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class RescueRetryError < Error; end
 
   # RescueRetry Class
@@ -13,7 +13,7 @@ module ZTK
   # The block is yielded and if a valid exception occurs the block will be
   # re-executed for the set number of attempts.
   #
-  # *example code*:
+  # @example Retry specific exceptions
   #
   #     counter = 0
   #     ZTK::RescueRetry.try(:tries => 3, :on => EOFError) do
@@ -22,6 +22,8 @@ module ZTK
   #     end
   #     puts counter.inspect
   #
+  # @example Retry all exceptions
+  #
   #     counter = 0
   #     ZTK::RescueRetry.try(:tries => 3) do
   #       counter += 1
@@ -29,6 +31,8 @@ module ZTK
   #     end
   #     puts counter.inspect
   #
+  # @example Retry exception is skipped because it does not match conditions
+  #
   #     counter = 0
   #     ZTK::RescueRetry.try(:tries => 3, :on => EOFError) do
   #       counter += 1
@@ -36,45 +40,7 @@ module ZTK
   #     end
   #     puts counter.inspect
   #
-  # *pry output*:
-  #
-  #     [1] pry(main)> counter = 0
-  #     => 0
-  #     [2] pry(main)> ZTK::RescueRetry.try(:tries => 3, :on => EOFError) do
-  #     [2] pry(main)*   counter += 1
-  #     [2] pry(main)*   raise EOFError
-  #     [2] pry(main)* end
-  #     EOFError: EOFError
-  #     from (pry):4:in `block in <main>'
-  #     [3] pry(main)> puts counter.inspect
-  #     3
-  #     => nil
-  #     [4] pry(main)>
-  #     [5] pry(main)> counter = 0
-  #     => 0
-  #     [6] pry(main)> ZTK::RescueRetry.try(:tries => 3) do
-  #     [6] pry(main)*   counter += 1
-  #     [6] pry(main)*   raise "OMGWTFBBQ"
-  #     [6] pry(main)* end
-  #     RuntimeError: OMGWTFBBQ
-  #     from (pry):10:in `block in <main>'
-  #     [7] pry(main)> puts counter.inspect
-  #     3
-  #     => nil
-  #     [8] pry(main)>
-  #     [9] pry(main)> counter = 0
-  #     => 0
-  #     [10] pry(main)> ZTK::RescueRetry.try(:tries => 3, :on => EOFError) do
-  #     [10] pry(main)*   counter += 1
-  #     [10] pry(main)*   raise "OMGWTFBBQ"
-  #     [10] pry(main)* end
-  #     RuntimeError: OMGWTFBBQ
-  #     from (pry):16:in `block in <main>'
-  #     [11] pry(main)> puts counter.inspect
-  #     1
-  #     => nil
-  #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class RescueRetry
 
     class << self

data/lib/ztk/spinner.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Spinner Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class SpinnerError < Error; end
 
   # Spinner Class
@@ -13,7 +13,7 @@ module ZTK
   # a task is executed in the supplied block.  This indicator takes the form
   # of a spinner.
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Spinner
 
     class << self
@@ -35,7 +35,7 @@ module ZTK
       #   taking place "behind the scenes".
       # @return [Object] The return value of the block.
       #
-      # @author Zachary Patten <zachary AT jovelabs DOT com>
+      # @author Zachary Patten <zpatten AT jovelabs DOT io>
       # @author Stephen Nelson-Smith <stephen@atalanta-systems.com>
       def spin(options={}, &block)
         options = Base.build_config({

data/lib/ztk/ssh.rb

@@ -2,7 +2,7 @@ module ZTK
 
   # SSH Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class SSHError < Error; end
 
   # SSH Multi-function Class
@@ -58,7 +58,7 @@ module ZTK
   #       config.host_key_verify = true
   #     end
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class SSH < ZTK::Base
     require 'ostruct'
     require 'tempfile'

data/lib/ztk/tcp_socket_check.rb

@@ -5,7 +5,7 @@ module ZTK
 
   # TCPSocketCheck Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class TCPSocketCheckError < Error; end
 
   # TCP Socket Checking Class
@@ -60,7 +60,7 @@ module ZTK
   #
   # The wait methods timeout is bound to the configuration option *wait*.
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class TCPSocketCheck < ZTK::Base
 
     # @param [Hash] configuration Configuration options hash.

data/lib/ztk/template.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # Template Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class TemplateError < Error; end
 
   # Erubis Templating Class
@@ -23,7 +23,7 @@ module ZTK
   #     This is a test template!
   #     Hello World
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class Template
 
     class << self

data/lib/ztk/ui.rb

@@ -4,7 +4,7 @@ module ZTK
 
   # UI Error Class
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class UIError < Error; end
 
   # UI Class
@@ -12,7 +12,7 @@ module ZTK
   # This class encapsulates a STDOUT, STDERR, STDIN
   # and logging device.
   #
-  # @author Zachary Patten <zachary AT jovelabs DOT com>
+  # @author Zachary Patten <zpatten AT jovelabs DOT io>
   class UI < ZTK::Base
 
     attr_accessor :stdout, :stderr, :stdin, :logger

data/lib/ztk/version.rb

@@ -1,6 +1,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/support/before_install.sh

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/ansi_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/background_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/base_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/benchmark_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/command_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/config_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/dsl_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/locator_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/logger_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/parallel_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/profiler_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/pty_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/rescue_retry_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/spinner_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/ssh_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/tcp_socket_check_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/template_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/ui_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/spec/ztk/version_spec.rb

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #

data/ztk.gemspec

@@ -1,6 +1,6 @@
 ################################################################################
 #
-#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#      Author: Zachary Patten <zpatten AT jovelabs DOT io>
 #   Copyright: Copyright (c) Zachary Patten
 #     License: Apache License, Version 2.0
 #
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.name                  = "ztk"
   spec.version               = ZTK::VERSION
   spec.authors               = %(Zachary Patten)
-  spec.email                 = [ %(zachary AT jovelabs DOT com) ]
+  spec.email                 = [ %(zpatten AT jovelabs DOT io) ]
   spec.description           = %(Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby.  These classes provide functionality I often find myself needing from project to project.  Instead of reinventing the wheel each time, I've started building a collection of reusable classes.  Easy-bake DSLs, parallel processing, complex logging, templating and many other useful design patterns, for example are all contained in simple, reusable classes with a common interface and configuration style.)
   spec.summary               = %(Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby.)
   spec.homepage              = "https://github.com/zpatten/ztk"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Zachary Patten
@@ -256,7 +256,7 @@ description: Zachary's Tool Kit contains a collection of reusable classes meant
   patterns, for example are all contained in simple, reusable classes with a common
   interface and configuration style.
 email:
-- zachary AT jovelabs DOT com
+- zpatten AT jovelabs DOT io
 executables:
 - ztk
 extensions: []
@@ -267,7 +267,6 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
-- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md

data/.yardopts

@@ -1,2 +0,0 @@
---markup-provider=redcarpet
---markup=markdown