ztk 1.15.0 → 1.15.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODJhNjRkODMyODczZDA0ZTNhN2RjZjI1Y2Q2OTY3MWMzNzlhYzUzYg==
+    NzNiOWIzNTcwMDQ2NTgyN2JkM2JkNDFmZmE3OTUwZWIzMzExYWM1MQ==
   data.tar.gz: !binary |-
-    YjMzYjJlOGY0ZTkxOTg4NzhmZDMyMzE0NDNiNjE2YTdiZDBjMzZjZA==
+    YzllMGFkNmZlMTQyZTc3YzEyMTdiYTcwZGJmNzAwNTEwZDY5NjgzOQ==
 SHA512:
   metadata.gz: !binary |-
-    OGYyMTI5ODlhNzNmYzAxNDc1N2E2MjZmYzRkNGRmYzBkODc4YjBhNTZjYzgw
-    NTU4NTczMzJkYWY0N2EzNzA5ZmViODM4YWJmY2MxYjE5OGExZWU4OTIxNTcx
-    N2JjNDY4MTI5NjBjYjFkNzBmMzEwMzFlMGIyMzRiNmZmMDhiOGQ=
+    ZGRhZTJkMGU3M2JkOTYwZWIzODgyYzFmNTQ3MTY0MDQ2OGY0MmFjNGFjOGEz
+    ODZlMTYwNTZmOTdmMDRhZWFhN2MxNTlhMWI5MTA3ZjdhZjQ2YzFhYTIyOGMw
+    ZTE0ZjY5YmM3NTM3MTM4ODE1MDBjZWIyYmVjMjc2Mzc5NWZkYzU=
   data.tar.gz: !binary |-
-    NjM4MDk0NDRkOGYxNDk3NmQxODQ1YTNmOTY0ZmJiYmI4MTE1NTljYmZlN2M5
-    OTNjZjE4ZTkzZjc4M2RiZTcxMzkxNDQwY2RiMTBjMDY5NDJhMzM5NGJjZDEz
-    ZmY5MGZiYjg0ZDQ4YWFiMjFjYzA3NGE3MWNmM2YxZWUzMjY0YmY=
+    NGYwNDRjNWVjNThmYjcyNDQyMmQyZDc2OWEzOWRkNmJhZGYwNmZkNzk3YjMy
+    YjQxZTBiOTRhZWE0OTJlNWYwZTI1OGI0NTA0MDdkMThhMTZjNDFjMjE5YjAz
+    MzdhZTE4YzVjODI2MjBjYTk5OWY0MDEzZWExZDc5ZDI5NWM2ZmI=

data/README.md

@@ -6,7 +6,23 @@
 
 # ZTK
 
-Zachary's (DevOp) Tool Kit is a general purpose utility gem, featuring a collection of classes meant to simplify development of complex systems in Ruby.
+Zachary's Tool Kit is a general purpose utility gem, featuring a collection of classes meant to simplify development of complex systems in Ruby.
+
+- **ZTK::Background**
+
+  Easily turn most iterative tasks into a parallel processes and easily leverage multiple cores to speed up processing large sets of data.
+
+- **ZTK::DSL**
+
+  Create your own DSL in seconds by inheriting this DSL class.  Featuring ActiveRecord style associations where DSL objects can `belong_to` or `has_many` other DSL objects.
+
+- **ZTK::Logger**
+
+  Based off the core Ruby logger, this is meant to be a drop in replacement.  Features added logging information, including PID, uSec time resolution, method and line numbers of logging statements (i.e. the caller).  One can seamlessly chain Ruby loggers using ZTK:Logger, for example to output logs to both STDOUT and a log file on disk at the same time; all while maintaining compatibility with the core Ruby logger.
+
+- **ZTK::SSH**
+
+  An SSH class that nicely wraps up all of the SSH gems into a nice uniform interface, complete with transfer progress callbacks.  It is meant to function as a drop in replacement, but I admit this has not been heavily tested like in the case of the ZTK::Logger class.  It provides the ability to switch between SCP and SFTP for file transfers seamlessly.  Full SSH proxy support as well, plus methods to spawn up interactive SSH consoles via `Kernel.exec`.
 
 # RUBIES TESTED AGAINST
 
@@ -36,7 +52,7 @@ Issues:
 
 # LICENSE
 
-ZTK - Zachary's (DevOp) Tool Kit
+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)
 * Copyright: Copyright (c) Zachary Patten

data/lib/ztk/background.rb

@@ -89,9 +89,7 @@ module ZTK
     # @param [Hash] configuration Configuration options hash.
     #
     def initialize(configuration={})
-      super({
-      }.merge(configuration))
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+      super(configuration)
 
       @result = nil
       GC.respond_to?(:copy_on_write_friendly=) and GC.copy_on_write_friendly = true

data/lib/ztk/base.rb

@@ -21,37 +21,34 @@ module ZTK
 
     class << self
 
-      # @param [Hash] configuration Configuration options hash.
+      # Builds Configuration Object
+      #
+      # Builds an OpenStruct backed configuration object.
+      #
+      # @param [Hash] config Configuration options hash.
       # @option config [ZTK::UI] :ui Instance of ZTK:UI to be used for
       #   console IO and logging.
-      def build_config(configuration={})
-        if configuration.is_a?(OpenStruct)
-          configuration = configuration.send(:table)
-        end
-
-        # FIXME: this needs to be refactored into the UI class
+      # @param [Hash] override Override configuration hash.
+      def build_config(config={}, override={})
         config = OpenStruct.new({
           :ui => ::ZTK::UI.new
-        }.merge(configuration))
+        }.merge(hash_config(config)).merge(hash_config(override)))
+
+        config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
 
         config
       end
 
-      # Removes all key-value pairs which are not core so values do not bleed
-      # into classes they are not meant for.
+      # Hash Configuration
       #
-      # This method will leave :stdout, :stderr, :stdin and :logger key-values
-      # intact, while removing all other key-value pairs.
-      def sanitize_config(configuration={})
-        if configuration.is_a?(OpenStruct)
-          configuration = configuration.send(:table)
-        end
-
-        config = configuration.reject do |key,value|
-          !(%w(stdout stderr stdin logger).map(&:to_sym).include?(key))
+      # Ensure a configuration is of object type Hash.  Since we use OpenStructs
+      # we need to convert back to hash from time to time.
+      def hash_config(config={})
+        if config.is_a?(OpenStruct)
+          config.send(:table)
+        else
+          config
         end
-
-        config
       end
 
       # Logs an exception and then raises it.
@@ -73,13 +70,10 @@ module ZTK
 
     end
 
-    # @param [Hash] config Configuration options hash.
-    # @option config [IO] :stdout Instance of IO to be used for STDOUT.
-    # @option config [IO] :stderr Instance of IO to be used for STDERR.
-    # @option config [IO] :stdin Instance of IO to be used for STDIN.
-    # @option config [Logger] :logger Instance of Logger to be used for logging.
-    def initialize(config={})
-      @config = Base.build_config(config)
+    # @param [Hash] config Initial configuration hash.
+    # @param [Hash] override Override configuration hash.
+    def initialize(config={}, override={})
+      @config = Base.build_config(config, override)
     end
 
     # Configuration OpenStruct accessor method.
@@ -127,7 +121,7 @@ module ZTK
 
       if !block_given?
         log_and_raise(BaseError, "You must supply a block to the log method!")
-      elsif (@config.ui.logger.level <= ZTK::Logger.const_get(log_level.to_s.upcase))
+      elsif (@config.ui.logger.level <= ::Logger.const_get(log_level.to_s.upcase))
         @config.ui.logger << ZTK::ANSI.uncolor(yield)
       end
     end

data/lib/ztk/benchmark.rb

@@ -72,8 +72,7 @@ module ZTK
       def bench(options={}, &block)
         options = Base.build_config({
           :use_spinner => true
-        }.merge(options))
-        options.ui.logger.debug { "options=#{options.send(:table).inspect}" }
+        }, options)
 
         !block_given? and Base.log_and_raise(options.ui.logger, BenchmarkError, "You must supply a block!")
 
@@ -84,7 +83,7 @@ module ZTK
         benchmark = ::Benchmark.realtime do
           if (options.message && options.mark)
             if options.use_spinner
-              ZTK::Spinner.spin(Base.sanitize_config(options)) do
+              ZTK::Spinner.spin(options) do
                 yield
               end
             else

data/lib/ztk/command.rb

@@ -53,9 +53,7 @@ module ZTK
         :ignore_exit_status => false,
         :exit_code => 0,
         :silence => false
-      }.merge(configuration))
-
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+      }, configuration)
     end
 
 

data/lib/ztk/parallel.rb

@@ -122,8 +122,7 @@ module ZTK
     def initialize(configuration={})
       super({
         :max_forks => MAX_FORKS
-      }.merge(configuration))
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+      }, configuration)
 
       (config.max_forks < 1) and log_and_raise(ParallelError, "max_forks must be equal to or greater than one!")
 

data/lib/ztk/report.rb

@@ -28,10 +28,7 @@ module ZTK
 
     # @param [Hash] configuration Configuration options hash.
     def initialize(configuration={})
-      super({
-      }.merge(configuration))
-
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+      super(configuration)
     end
 
 

data/lib/ztk/rescue_retry.rb

@@ -109,8 +109,7 @@ module ZTK
           :on => Exception,
           :delay => 1,
           :raise => nil
-        }.merge(options))
-        options.ui.logger.debug { "options=#{options.send(:table).inspect}" }
+        }, options)
 
         !block_given? and Base.log_and_raise(options.ui.logger, RescueRetryError, "You must supply a block!")
 

data/lib/ztk/spinner.rb

@@ -40,8 +40,7 @@ module ZTK
       def spin(options={}, &block)
         options = Base.build_config({
           :step => 0.1
-        }.merge(options))
-        options.ui.logger.debug { "options(#{options.send(:table).inspect})" }
+        }, options)
 
         !block_given? and Base.log_and_raise(options.ui.logger, SpinnerError, "You must supply a block!")
 

data/lib/ztk/ssh.rb

@@ -165,9 +165,7 @@ module ZTK
         :request_pty => true,
         :exit_code => 0,
         :silence => false
-      }.merge(configuration))
-
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+      }, configuration)
     end
 
 

data/lib/ztk/tcp_socket_check.rb

@@ -74,8 +74,7 @@ module ZTK
       super({
         :timeout => 5,
         :wait => 60
-      }.merge(configuration))
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+      }, configuration)
     end
 
     # Check to see if socket on the host and port specified is ready.  This

data/lib/ztk/version.rb

@@ -1,6 +1,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "1.15.0"
+  VERSION = "1.15.1"
 
 end

data/ztk.gemspec

@@ -26,8 +26,26 @@ Gem::Specification.new do |spec|
   spec.version       = ZTK::VERSION
   spec.authors       = ["Zachary Patten"]
   spec.email         = ["zachary AT jovelabs DOT com"]
-  spec.description   = %q{Zachary's (DevOp) Tool Kit}
-  spec.summary       = %q{Zachary's (DevOp) Tool Kit}
+  spec.description   = <<-EOTEXT
+Zachary's Tool Kit is a general purpose utility gem, featuring a collection of classes meant to simplify development of complex systems in Ruby.
+
+ZTK::Background
+===============
+Easily turn most iterative tasks into a parallel processes and easily leverage multiple cores to speed up processing large sets of data.
+
+ZTK::DSL
+========
+Create your own DSL in seconds by inheriting this DSL class.  Featuring ActiveRecord style associations where DSL objects can `belong_to` or `has_many` other DSL objects.
+
+ZTK::Logger
+===========
+Based off the core Ruby logger, this is meant to be a drop in replacement.  Features added logging information, including PID, uSec time resolution, method and line numbers of logging statements (i.e. the caller).  One can seamlessly chain Ruby loggers using ZTK:Logger, for example to output logs to both STDOUT and a log file on disk at the same time; all while maintaining compatibility with the core Ruby logger.
+
+ZTK::SSH
+========
+An SSH class that nicely wraps up all of the SSH gems into a nice uniform interface, complete with transfer progress callbacks.  It is meant to function as a drop in replacement, but I admit this has not been heavily tested like in the case of the ZTK::Logger class.  It provides the ability to switch between SCP and SFTP for file transfers seamlessly.  Full SSH proxy support as well, plus methods to spawn up interactive SSH consoles via `Kernel.exec`.
+EOTEXT
+  spec.summary       = %q{Zachary's Tool Kit}
   spec.homepage      = "https://github.com/zpatten/ztk"
   spec.license       = "Apache 2.0"
 
@@ -49,4 +67,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency("yard")
   spec.add_development_dependency("redcarpet")
   spec.add_development_dependency("coveralls")
+  spec.add_development_dependency("travis")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.15.1
 platform: ruby
 authors:
 - Zachary Patten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,7 +178,64 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Zachary's (DevOp) Tool Kit
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Zachary''s Tool Kit is a general purpose utility gem, featuring a
+  collection of classes meant to simplify development of complex systems in Ruby.
+
+
+  ZTK::Background
+
+  ===============
+
+  Easily turn most iterative tasks into a parallel processes and easily leverage multiple
+  cores to speed up processing large sets of data.
+
+
+  ZTK::DSL
+
+  ========
+
+  Create your own DSL in seconds by inheriting this DSL class.  Featuring ActiveRecord
+  style associations where DSL objects can `belong_to` or `has_many` other DSL objects.
+
+
+  ZTK::Logger
+
+  ===========
+
+  Based off the core Ruby logger, this is meant to be a drop in replacement.  Features
+  added logging information, including PID, uSec time resolution, method and line
+  numbers of logging statements (i.e. the caller).  One can seamlessly chain Ruby
+  loggers using ZTK:Logger, for example to output logs to both STDOUT and a log file
+  on disk at the same time; all while maintaining compatibility with the core Ruby
+  logger.
+
+
+  ZTK::SSH
+
+  ========
+
+  An SSH class that nicely wraps up all of the SSH gems into a nice uniform interface,
+  complete with transfer progress callbacks.  It is meant to function as a drop in
+  replacement, but I admit this has not been heavily tested like in the case of the
+  ZTK::Logger class.  It provides the ability to switch between SCP and SFTP for file
+  transfers seamlessly.  Full SSH proxy support as well, plus methods to spawn up
+  interactive SSH consoles via `Kernel.exec`.
+
+'
 email:
 - zachary AT jovelabs DOT com
 executables:
@@ -291,7 +348,7 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Zachary's (DevOp) Tool Kit
+summary: Zachary's Tool Kit
 test_files:
 - spec/spec_helper.rb
 - spec/support/before_install.sh