ztk 1.14.1 → 1.15.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWQ3ZjgzODdmMWM2ZWNmMTY2NDk4ZjBjNjhmYjY2ZmVmYzgxZDM3Ng==
+    ODJhNjRkODMyODczZDA0ZTNhN2RjZjI1Y2Q2OTY3MWMzNzlhYzUzYg==
   data.tar.gz: !binary |-
-    ODBkZmE5ZjFjOTRhZTcyODY1ZTdhYWQ1ZGJkNDM2ODVhMzg2NWFmMQ==
+    YjMzYjJlOGY0ZTkxOTg4NzhmZDMyMzE0NDNiNjE2YTdiZDBjMzZjZA==
 SHA512:
   metadata.gz: !binary |-
-    ODE1YTk3ZmUyODk5MDNhNjIwNmU2NWIyZjBlYzdjNmVmMzYzZThjNDc1NzEx
-    YTc5OTI1MGJkZjczM2M1NWM0MTFmM2E4ZmMxMGUwNmRmZjZkNTcwZjJkN2U4
-    ZjgxZWEyNWVkMDFiNzNhMjM1MmIxZjdmMDU5N2M1N2NlYWI0NWI=
+    OGYyMTI5ODlhNzNmYzAxNDc1N2E2MjZmYzRkNGRmYzBkODc4YjBhNTZjYzgw
+    NTU4NTczMzJkYWY0N2EzNzA5ZmViODM4YWJmY2MxYjE5OGExZWU4OTIxNTcx
+    N2JjNDY4MTI5NjBjYjFkNzBmMzEwMzFlMGIyMzRiNmZmMDhiOGQ=
   data.tar.gz: !binary |-
-    NGE0ZjhiZjhlMWUyMmUzNjAzYjZiMWJjZTRkNzZlODQ0YTYyZWJjYjU5ZjAz
-    MzYwYjA0NDk3YjdmNTcyYWE5MmRmYzg5OGIxMjI3NzI1Y2Y1ZWZkZTAwNDRj
-    NzBmMDQwOWU2Y2UwZWRhZmIzNGQ2OGQ2MWQzZTVhYTRhMWU1ZDc=
+    NjM4MDk0NDRkOGYxNDk3NmQxODQ1YTNmOTY0ZmJiYmI4MTE1NTljYmZlN2M5
+    OTNjZjE4ZTkzZjc4M2RiZTcxMzkxNDQwY2RiMTBjMDY5NDJhMzM5NGJjZDEz
+    ZmY5MGZiYjg0ZDQ4YWFiMjFjYzA3NGE3MWNmM2YxZWUzMjY0YmY=

data/lib/ztk/base.rb

@@ -128,13 +128,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))
-        if @config.ui.logger.respond_to?(:logdev)
-          @config.ui.logger.logdev.write(ZTK::ANSI.uncolor(yield))
-          @config.ui.logger.logdev.respond_to?(:flush) and @config.ui.logger.logdev.flush
-        else
-          @config.ui.logger.instance_variable_get(:@logdev).instance_variable_get(:@dev).write(ZTK::ANSI.uncolor(yield))
-          @config.ui.logger.instance_variable_get(:@logdev).instance_variable_get(:@dev).respond_to?(:flush) and @config.ui.logger.instance_variable_get(:@logdev).instance_variable_get(:@dev).flush
-        end
+        @config.ui.logger << ZTK::ANSI.uncolor(yield)
       end
     end
 

data/lib/ztk/logger.rb

@@ -4,9 +4,14 @@ module ZTK
 
   # Standard Logging Class
   #
-  # Supplies loggers the same as the base ruby logger class, except adds some
-  # extra spice to your log messages.  This includes uSec timestamping, PIDs and
-  # caller tree details.
+  # Allows chaining standard Ruby loggers as well as adding extra spice to your
+  # log messages.  This includes uSec timestamping, PIDs and caller tree
+  # details.
+  #
+  # This class accepts the same initialize arguments as the Ruby logger class.
+  # You can chain multiple loggers together, for example to get an effect of
+  # logging to STDOUT and a file simultaneously without having to modify your
+  # existing logging statements.
   #
   # One can override the logging level on the command line with programs that
   # use this library like so:
@@ -22,21 +27,70 @@ module ZTK
   #     $logger.error { "This is a error message!" }
   #     $logger.fatal { "This is a fatal message!" }
   #
+  # = Simple logger chain:
+  #
+  #     logger = ZTK::Logger.new
+  #     logger.loggers << ::Logger.new(STDOUT)
+  #     logger.loggers << ::Logger.new('test.log')
+  #
+  #     logger.debug { "This will be written to STDOUT as well as test.log!" }
+  #
+  # = Alternate 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>
   class Logger < ::Logger
-    attr_accessor :stdout_echo
 
     # Log Levels
     SEVERITIES = Severity.constants.inject([]) {|arr,c| arr[Severity.const_get(c)] = c; arr}
 
+    class LogDevice
+      attr_reader   :dev
+      attr_reader   :filename
+
+      def initialize(chain)
+        @chain    = chain
+        @dev      = nil
+        @filename = nil
+      end
+
+      def write(message)
+        @chain.loggers.each do |logger|
+          logger << message
+        end
+      end
+
+      def close
+        @chain.loggers.each do |logger|
+          logger.instance_variable_get(:@logdev).close
+        end
+      end
+    end
+
+
+    attr_accessor :loggers
+
     def initialize(*args)
-      super(*args)
+      super(StringIO.new)
+
+      @loggers = Array.new
+      if args.count > 0
+        @loggers << ::Logger.new(*args)
+      end
+
+      @logdev = LogDevice.new(self)
+
       set_log_level
     end
 
-    # Provides access to the raw log device.
-    def logdev
-      @logdev.instance_variable_get(:@dev)
+    # Generates a human-readable string about the logger.
+    def inspect
+      loggers_inspect = @loggers.collect{|logger| logger.instance_variable_get(:@logdev).instance_variable_get(:@dev).inspect }.join(', ')
+      "#<#{self.class} loggers=[#{loggers_inspect}]>"
     end
 
     # Specialized logging.  Logs messages in the same format, except has the
@@ -55,9 +109,12 @@ module ZTK
       add(severity, nil, nil, shift, &block)
     end
 
-    # Generates a human-readable string about the logger.
-    def inspect
-      "#<#{self.class} filename=#{@logdev.filename.inspect}>"
+    def level=(value)
+      @level = value
+
+      @loggers.each { |logger| logger.level = @level }
+
+      value
     end
 
 
@@ -96,9 +153,7 @@ module ZTK
       message = [message, progname].flatten.compact.join(": ")
       message = "%19s.%06d|%05d|%5s|%s%s\n" % [Time.now.utc.strftime("%Y-%m-%d|%H:%M:%S"), Time.now.utc.usec, Process.pid, SEVERITIES[severity], called_by, message]
 
-      statement = ZTK::ANSI.uncolor(message)
-      (stdout_echo == true) and $stdout.write(statement)
-      @logdev.write(statement)
+      @logdev.write(ZTK::ANSI.uncolor(message))
       @logdev.respond_to?(:flush) and @logdev.flush
 
       true

data/lib/ztk/ssh/download.rb

@@ -41,45 +41,56 @@ module ZTK
         options.ui.logger.info { "download(#{remote.inspect}, #{local.inspect})" }
 
         ZTK::RescueRetry.try(:ui => config.ui, :tries => ZTK::SSH::RESCUE_RETRY_ATTEMPTS, :on_retry => method(:on_retry)) do
-          if (options.use_scp == false)
-            sftp.download!(remote.to_s, local.to_s, options.send(:table)) do |event, downloader, *args|
-              case event
-              when :open
-                options.ui.logger.debug { "download(#{args[0].remote} -> #{args[0].local})" }
-                options.on_progress.nil? or options.on_progress.call(:open, args)
-              when :close
-                options.ui.logger.debug { "close(#{args[0].local})" }
-                options.on_progress.nil? or options.on_progress.call(:close, args)
-              when :mkdir
-                options.ui.logger.debug { "mkdir(#{args[0]})" }
-                options.on_progress.nil? or options.on_progress.call(:mkdir, args)
-              when :get
-                options.ui.logger.debug { "get(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
-                options.on_progress.nil? or options.on_progress.call(:get, args)
-              when :finish
-                options.ui.logger.debug { "finish" }
-                options.on_progress.nil? or options.on_progress.call(:finish, args)
-              end
-            end
+          if (options.use_scp == true)
+            scp_download(remote, local, options)
           else
-            opened = false
-            args = []
+            sftp_download(remote, local, options)
+          end
+        end
 
-            scp.download!(remote.to_s, local.to_s, options.send(:table)) do |ch, name, sent, total|
-              args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]
+        true
+      end
 
-              opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))
 
-              options.ui.logger.debug { "get(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
-              options.on_progress.nil? or options.on_progress.call(:get, args)
-            end
+    private
 
+      def sftp_download(remote, local, options={})
+        sftp.download!(remote.to_s, local.to_s, options.send(:table)) do |event, downloader, *args|
+          case event
+          when :open
+            options.ui.logger.debug { "download(#{args[0].remote} -> #{args[0].local})" }
+            options.on_progress.nil? or options.on_progress.call(:open, args)
+          when :close
+            options.ui.logger.debug { "close(#{args[0].local})" }
+            options.on_progress.nil? or options.on_progress.call(:close, args)
+          when :mkdir
+            options.ui.logger.debug { "mkdir(#{args[0]})" }
+            options.on_progress.nil? or options.on_progress.call(:mkdir, args)
+          when :get
+            options.ui.logger.debug { "get(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
+            options.on_progress.nil? or options.on_progress.call(:get, args)
+          when :finish
             options.ui.logger.debug { "finish" }
             options.on_progress.nil? or options.on_progress.call(:finish, args)
           end
         end
+      end
 
-        true
+      def scp_download(remote, local, options={})
+        opened = false
+        args = []
+
+        scp.download!(remote.to_s, local.to_s, options.send(:table)) do |ch, name, sent, total|
+          args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]
+
+          opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))
+
+          options.ui.logger.debug { "get(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
+          options.on_progress.nil? or options.on_progress.call(:get, args)
+        end
+
+        options.ui.logger.debug { "finish" }
+        options.on_progress.nil? or options.on_progress.call(:finish, args)
       end
 
     end

data/lib/ztk/ssh/upload.rb

@@ -39,45 +39,56 @@ module ZTK
         config.ui.logger.info { "upload(#{local.inspect}, #{remote.inspect})" }
 
         ZTK::RescueRetry.try(:ui => config.ui, :tries => ZTK::SSH::RESCUE_RETRY_ATTEMPTS, :on_retry => method(:on_retry)) do
-          if (options.use_scp == false)
-            sftp.upload!(local.to_s, remote.to_s) do |event, uploader, *args|
-              case event
-              when :open
-                options.ui.logger.debug { "upload(#{args[0].local} -> #{args[0].remote})" }
-                options.on_progress.nil? or options.on_progress.call(:open, args)
-              when :close
-                options.ui.logger.debug { "close(#{args[0].remote})" }
-                options.on_progress.nil? or options.on_progress.call(:close, args)
-              when :mkdir
-                options.ui.logger.debug { "mkdir(#{args[0]})" }
-                options.on_progress.nil? or options.on_progress.call(:mkdir, args)
-              when :put
-                options.ui.logger.debug { "put(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
-                options.on_progress.nil? or options.on_progress.call(:put, args)
-              when :finish
-                options.ui.logger.debug { "finish" }
-                options.on_progress.nil? or options.on_progress.call(:finish, args)
-              end
-            end
+          if (options.use_scp == true)
+            scp_upload(local, remote, options)
           else
-            opened = false
-            args = []
+            sftp_upload(local, remote, options)
+          end
+        end
 
-            scp.upload!(local.to_s, remote.to_s, options.send(:table)) do |ch, name, sent, total|
-              args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]
+        true
+      end
 
-              opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))
 
-              options.ui.logger.debug { "put(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
-              options.on_progress.nil? or options.on_progress.call(:put, args)
-            end
+    private
 
+      def sftp_upload(local, remote, options={})
+        sftp.upload!(local.to_s, remote.to_s) do |event, uploader, *args|
+          case event
+          when :open
+            options.ui.logger.debug { "upload(#{args[0].local} -> #{args[0].remote})" }
+            options.on_progress.nil? or options.on_progress.call(:open, args)
+          when :close
+            options.ui.logger.debug { "close(#{args[0].remote})" }
+            options.on_progress.nil? or options.on_progress.call(:close, args)
+          when :mkdir
+            options.ui.logger.debug { "mkdir(#{args[0]})" }
+            options.on_progress.nil? or options.on_progress.call(:mkdir, args)
+          when :put
+            options.ui.logger.debug { "put(#{args[0].remote}, size #{args[2].size} bytes, offset #{args[1]})" }
+            options.on_progress.nil? or options.on_progress.call(:put, args)
+          when :finish
             options.ui.logger.debug { "finish" }
             options.on_progress.nil? or options.on_progress.call(:finish, args)
           end
         end
+      end
 
-        true
+      def scp_upload(local, remote, options={})
+        opened = false
+        args = []
+
+        scp.upload!(local.to_s, remote.to_s, options.send(:table)) do |ch, name, sent, total|
+          args = [ OpenStruct.new(:size => total, :local => name, :remote => name), sent, '' ]
+
+          opened or (options.on_progress.nil? or options.on_progress.call(:open, args) and (opened = true))
+
+          options.ui.logger.debug { "put(#{args[0].remote}, sent #{args[1]}, total #{args[0].size})" }
+          options.on_progress.nil? or options.on_progress.call(:put, args)
+        end
+
+        options.ui.logger.debug { "finish" }
+        options.on_progress.nil? or options.on_progress.call(:finish, args)
       end
 
     end

data/lib/ztk/version.rb

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

data/spec/ztk/background_spec.rb

@@ -87,6 +87,7 @@ describe ZTK::Background do
       it "should respond false when the process is still running" do
         subject.process do
           sleep(WAIT_SMALL)
+          WAIT_SMALL
         end
         subject.dead?.should be false
 

data/spec/ztk/logger_spec.rb

@@ -46,10 +46,6 @@ describe ZTK::Logger do
       subject.should be_an_instance_of ZTK::Logger
     end
 
-    it "should provide access to the raw log file handle" do
-      subject.logdev.should be_an_instance_of File
-    end
-
   end
 
   describe "general logging functionality" do
@@ -85,17 +81,16 @@ describe ZTK::Logger do
 
     it "should allow writing directly to the log device" do
       data = "Hello World"
-      subject.logdev.write(data)
+      subject << data
       IO.read(@logfile).match(data).should_not be nil
     end
 
     it "should allow us to echo log statements to STDOUT" do
       data = "Hello World"
       stdout = StringIO.new
-
       $stdout = stdout
+      subject.loggers = [ ::Logger.new($stdout) ]
 
-      subject.stdout_echo = true
       subject.debug { data }
 
       stdout.rewind

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.15.0
 platform: ruby
 authors:
 - Zachary Patten
@@ -288,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Zachary's (DevOp) Tool Kit