ztk 1.6.2 → 1.6.3

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem "json" if (RUBY_VERSION == "1.8.7")
+gem "activesupport", "< 4.0.0" if (RUBY_VERSION < "1.9.3")
 
 gemspec

data/Rakefile

@@ -39,7 +39,7 @@ require 'yard'
 require 'yard/rake/yardoc_task'
 
 GEM_NAME = File.basename(Dir.pwd)
-DOC_PATH = File.expand_path(File.join("..", "/", "#{GEM_NAME}.doc"))
+DOC_PATH = File.expand_path(File.join("..", "", "#{GEM_NAME}.doc"))
 
 namespace :doc do
   YARD::Rake::YardocTask.new(:pages) do |t|

data/lib/ztk/command.rb

@@ -1,7 +1,3 @@
-require 'ostruct'
-require 'timeout'
-require 'socket'
-
 module ZTK
 
   # Command Error Class
@@ -22,6 +18,18 @@ module ZTK
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Command < ZTK::Base
+    require 'ostruct'
+    require 'timeout'
+    require 'socket'
+
+    require 'ztk/command/download'
+    require 'ztk/command/exec'
+    require 'ztk/command/private'
+    require 'ztk/command/upload'
+
+    include ZTK::Command::Download
+    include ZTK::Command::Exec
+    include ZTK::Command::Upload
 
     # @param [Hash] configuration Sets the overall default configuration for the
     #   class.  For example, all calls to *exec* against this instance will use
@@ -46,168 +54,14 @@ module ZTK
         :exit_code => 0,
         :silence => false
       }.merge(configuration))
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
-    end
-
-    # Execute Command
-    #
-    # @example Execute a command:
-    #   cmd = ZTK::Command.new(:silence => true)
-    #   puts cmd.exec("hostname", :silence => false).inspect
-    #
-    # @param [String] command The command to execute.
-    # @param [Hash] options The options hash for executing the command.
-    # @option options [Integer] :timeout (600) How long in seconds before
-    #   the command will timeout.
-    # @option options [Boolean] :ignore_exit_status (false) Whether or not
-    #   we should ignore the exit status of the the process we spawn.  By
-    #   default we do not ignore the exit status and throw an exception if it is
-    #   non-zero.
-    # @option options [Integer] :exit_code (0) The exit code we expect the
-    #   process to return.  This is ignore if *ignore_exit_status* is true.
-    # @option options [Boolean] :silence (false) Whether or not we should
-    #   squelch the output of the process.  The output will always go to the
-    #   logging device supplied in the ZTK::UI object.  The output is always
-    #   available in the return value from the method additionally.
-    #
-    # @return [OpenStruct#output] The output of the command, both STDOUT and
-    #   STDERR combined.
-    # @return [OpenStruct#exit_code] The exit code of the process.
-    def exec(command, options={})
-      options = OpenStruct.new(config.send(:table).merge(options))
-
-      options.ui.logger.debug { "config=#{options.send(:table).inspect}" }
-      options.ui.logger.debug { "options=#{options.send(:table).inspect}" }
-      options.ui.logger.info { "command(#{command.inspect})" }
-
-      if options.replace_current_process
-        options.ui.logger.fatal { "REPLACING CURRENT PROCESS - GOODBYE!" }
-        Kernel.exec(command)
-      end
-
-      output = ""
-      exit_code = -1
-      stdout_header = false
-      stderr_header = false
-
-      parent_stdout_reader, child_stdout_writer = IO.pipe
-      parent_stderr_reader, child_stderr_writer = IO.pipe
-
-      start_time = Time.now.utc
-
-      pid = Process.fork do
-        parent_stdout_reader.close
-        parent_stderr_reader.close
-
-        STDOUT.reopen(child_stdout_writer)
-        STDERR.reopen(child_stderr_writer)
-        STDIN.reopen("/dev/null")
-
-        child_stdout_writer.close
-        child_stderr_writer.close
 
-        Kernel.exec(command)
-      end
-      child_stdout_writer.close
-      child_stderr_writer.close
-
-      reader_writer_key = {parent_stdout_reader => :stdout, parent_stderr_reader => :stderr}
-      reader_writer_map = {parent_stdout_reader => options.ui.stdout, parent_stderr_reader => options.ui.stderr}
-
-      direct_log(:info) { log_header("COMMAND") }
-      direct_log(:info) { "#{command.inspect}\n" }
-      direct_log(:info) { log_header("STARTED") }
-
-      begin
-        Timeout.timeout(options.timeout) do
-          loop do
-            pipes = IO.select(reader_writer_map.keys, [], reader_writer_map.keys).first
-            pipes.each do |pipe|
-              data = pipe.read
-
-              if (data.nil? || data.empty?)
-                sleep(0.1)
-                next
-              end
-
-              case reader_writer_key[pipe]
-              when :stdout then
-                if !stdout_header
-                  direct_log(:info) { log_header("STDOUT") }
-                  stdout_header = true
-                  stderr_header = false
-                end
-                reader_writer_map[pipe].write(data) unless options.silence
-                direct_log(:info) { data }
-
-              when :stderr then
-                if !stderr_header
-                  direct_log(:warn) { log_header("STDERR") }
-                  stderr_header = true
-                  stdout_header = false
-                end
-                reader_writer_map[pipe].write(data) unless options.silence
-                direct_log(:warn) { data }
-              end
-
-              output += data
-
-              options.on_progress.nil? or options.on_progress.call
-            end
-
-            break if reader_writer_map.keys.all?{ |reader| reader.eof? }
-          end
-        end
-      rescue Timeout::Error => e
-        direct_log(:fatal) { log_header("TIMEOUT") }
-        log_and_raise(CommandError, "Process timed out after #{options.timeout} seconds!")
-      end
-
-      Process.waitpid(pid)
-      exit_code = $?.exitstatus
-      direct_log(:info) { log_header("STOPPED") }
-
-      parent_stdout_reader.close
-      parent_stderr_reader.close
-
-      options.ui.logger.debug { "exit_code(#{exit_code})" }
-
-      if !options.ignore_exit_status && (exit_code != options.exit_code)
-        log_and_raise(CommandError, "exec(#{command.inspect}, #{options.inspect}) failed! [#{exit_code}]")
-      end
-      OpenStruct.new(:command => command, :output => output, :exit_code => exit_code)
-    end
-
-    # Not Supported
-    # @raise [CommandError] Not Supported
-    def upload(*args)
-      log_and_raise(CommandError, "Not Supported")
-    end
-
-    # Not Supported
-    # @raise [CommandError] Not Supported
-    def download(*args)
-      log_and_raise(CommandError, "Not Supported")
+      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
     end
 
 
   private
 
-    # Returns a string in the format of "user@hostname" for the current
-    # shell.
-    def tag
-      @@hostname ||= Socket.gethostname.split('.').first.strip
-      "#{ENV['USER']}@#{@@hostname}"
-    end
-
-    # Formats a header suitable for writing to the direct logger when logging
-    # sessions.
-    def log_header(what)
-      count = 8
-      sep = ("=" * count)
-      header = [sep, "[ #{what} ]", sep, "[ #{tag} ]", sep, "[ #{what} ]", sep].join
-      "#{header}\n"
-    end
+    include ZTK::Command::Private
 
   end
 

data/lib/ztk/command/download.rb

@@ -0,0 +1,16 @@
+module ZTK
+  class Command
+
+    # Command Download Functionality
+    module Download
+
+      # Not Supported
+      # @raise [CommandError] Not Supported
+      def download(*args)
+        log_and_raise(CommandError, "Not Supported")
+      end
+
+    end
+
+  end
+end

data/lib/ztk/command/exec.rb

@@ -0,0 +1,139 @@
+module ZTK
+  class Command
+
+    # Command Exec Functionality
+    module Exec
+
+      # Execute Command
+      #
+      # @example Execute a command:
+      #   cmd = ZTK::Command.new(:silence => true)
+      #   puts cmd.exec("hostname", :silence => false).inspect
+      #
+      # @param [String] command The command to execute.
+      # @param [Hash] options The options hash for executing the command.
+      # @option options [Integer] :timeout (600) How long in seconds before
+      #   the command will timeout.
+      # @option options [Boolean] :ignore_exit_status (false) Whether or not
+      #   we should ignore the exit status of the the process we spawn.  By
+      #   default we do not ignore the exit status and throw an exception if it is
+      #   non-zero.
+      # @option options [Integer] :exit_code (0) The exit code we expect the
+      #   process to return.  This is ignore if *ignore_exit_status* is true.
+      # @option options [Boolean] :silence (false) Whether or not we should
+      #   squelch the output of the process.  The output will always go to the
+      #   logging device supplied in the ZTK::UI object.  The output is always
+      #   available in the return value from the method additionally.
+      #
+      # @return [OpenStruct#output] The output of the command, both STDOUT and
+      #   STDERR combined.
+      # @return [OpenStruct#exit_code] The exit code of the process.
+      def exec(command, options={})
+        options = OpenStruct.new(config.send(:table).merge(options))
+
+        options.ui.logger.debug { "config=#{options.send(:table).inspect}" }
+        options.ui.logger.debug { "options=#{options.send(:table).inspect}" }
+        options.ui.logger.info { "command(#{command.inspect})" }
+
+        if options.replace_current_process
+          options.ui.logger.fatal { "REPLACING CURRENT PROCESS - GOODBYE!" }
+          Kernel.exec(command)
+        end
+
+        output = ""
+        exit_code = -1
+        stdout_header = false
+        stderr_header = false
+
+        parent_stdout_reader, child_stdout_writer = IO.pipe
+        parent_stderr_reader, child_stderr_writer = IO.pipe
+
+        start_time = Time.now.utc
+
+        pid = Process.fork do
+          parent_stdout_reader.close
+          parent_stderr_reader.close
+
+          STDOUT.reopen(child_stdout_writer)
+          STDERR.reopen(child_stderr_writer)
+          STDIN.reopen("/dev/null")
+
+          child_stdout_writer.close
+          child_stderr_writer.close
+
+          Kernel.exec(command)
+        end
+        child_stdout_writer.close
+        child_stderr_writer.close
+
+        reader_writer_key = {parent_stdout_reader => :stdout, parent_stderr_reader => :stderr}
+        reader_writer_map = {parent_stdout_reader => options.ui.stdout, parent_stderr_reader => options.ui.stderr}
+
+        direct_log(:info) { log_header("COMMAND") }
+        direct_log(:info) { "#{command.inspect}\n" }
+        direct_log(:info) { log_header("STARTED") }
+
+        begin
+          Timeout.timeout(options.timeout) do
+            loop do
+              pipes = IO.select(reader_writer_map.keys, [], reader_writer_map.keys).first
+              pipes.each do |pipe|
+                data = pipe.read
+
+                if (data.nil? || data.empty?)
+                  sleep(0.1)
+                  next
+                end
+
+                case reader_writer_key[pipe]
+                when :stdout then
+                  if !stdout_header
+                    direct_log(:info) { log_header("STDOUT") }
+                    stdout_header = true
+                    stderr_header = false
+                  end
+                  reader_writer_map[pipe].write(data) unless options.silence
+                  direct_log(:info) { data }
+
+                when :stderr then
+                  if !stderr_header
+                    direct_log(:warn) { log_header("STDERR") }
+                    stderr_header = true
+                    stdout_header = false
+                  end
+                  reader_writer_map[pipe].write(data) unless options.silence
+                  direct_log(:warn) { data }
+                end
+
+                output += data
+
+                options.on_progress.nil? or options.on_progress.call
+              end
+
+              break if reader_writer_map.keys.all?{ |reader| reader.eof? }
+            end
+          end
+        rescue Timeout::Error => e
+          direct_log(:fatal) { log_header("TIMEOUT") }
+          log_and_raise(CommandError, "Process timed out after #{options.timeout} seconds!")
+        end
+
+        Process.waitpid(pid)
+        exit_code = $?.exitstatus
+        direct_log(:info) { log_header("STOPPED") }
+
+        parent_stdout_reader.close
+        parent_stderr_reader.close
+
+        options.ui.logger.debug { "exit_code(#{exit_code})" }
+
+        if !options.ignore_exit_status && (exit_code != options.exit_code)
+          log_and_raise(CommandError, "exec(#{command.inspect}, #{options.inspect}) failed! [#{exit_code}]")
+        end
+        OpenStruct.new(:command => command, :output => output, :exit_code => exit_code)
+      end
+
+    end
+
+  end
+end

data/lib/ztk/command/private.rb

@@ -0,0 +1,26 @@
+module ZTK
+  class Command
+
+    # Command Private Functionality
+    module Private
+
+      # Returns a string in the format of "user@hostname" for the current
+      # shell.
+      def tag
+        @@hostname ||= Socket.gethostname.split('.').first.strip
+        "#{ENV['USER']}@#{@@hostname}"
+      end
+
+      # Formats a header suitable for writing to the direct logger when logging
+      # sessions.
+      def log_header(what)
+        count = 8
+        sep = ("=" * count)
+        header = [sep, "[ #{what} ]", sep, "[ #{tag} ]", sep, "[ #{what} ]", sep].join
+        "#{header}\n"
+      end
+
+    end
+
+  end
+end

data/lib/ztk/command/upload.rb

@@ -0,0 +1,16 @@
+module ZTK
+  class Command
+
+    # Command Upload Functionality
+    module Upload
+
+      # Not Supported
+      # @raise [CommandError] Not Supported
+      def upload(*args)
+        log_and_raise(CommandError, "Not Supported")
+      end
+
+    end
+
+  end
+end

data/lib/ztk/locator.rb

@@ -31,6 +31,19 @@ module ZTK
         raise LocatorError, "Could not locate '#{File.join(args)}'!"
       end
 
+      # Returns the root for the filesystem we are operating on.  Ignores
+      # mount boundries on *nix.
+      #
+      # For all flavors of *nix this should always return "/".
+      #
+      # Windows should expect something similar to "C:\".
+      #
+      # @return [String] The root path of the file-system.  For unix this should
+      #   always be "/".  For windows this should be something like "C:\".
+      def root
+        Dir.pwd.split(File::SEPARATOR).first
+      end
+
     end
 
   end

data/lib/ztk/report.rb

@@ -1,6 +1,3 @@
-require 'socket'
-require 'timeout'
-
 module ZTK
 
   # Report Error Class
@@ -19,169 +16,28 @@ module ZTK
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class Report < ZTK::Base
+    require 'socket'
+    require 'timeout'
+
+    require 'ztk/report/list'
+    require 'ztk/report/private'
+    require 'ztk/report/spreadsheet'
+
+    include ZTK::Report::List
+    include ZTK::Report::Spreadsheet
 
     # @param [Hash] configuration Configuration options hash.
     def initialize(configuration={})
       super({
       }.merge(configuration))
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
-    end
-
-    # Displays data in a spreadsheet style.
-    #
-    #     +-------------+-------+-------+--------+----------------+-------------------+--------------+---------+
-    #     | NAME        | ALIVE | ARCH  | DISTRO | IP             | MAC               | CHEF VERSION | PERSIST |
-    #     +-------------+-------+-------+--------+----------------+-------------------+--------------+---------+
-    #     | sudo        | false | amd64 | ubuntu | 192.168.99.110 | 00:00:5e:34:d6:aa | N/A          | true    |
-    #     | timezone    | false | amd64 | ubuntu | 192.168.122.47 | 00:00:5e:92:d7:f6 | N/A          | true    |
-    #     | chef-client | false | amd64 | ubuntu | 192.168.159.98 | 00:00:5e:c7:ce:26 | N/A          | true    |
-    #     | users       | false | amd64 | ubuntu | 192.168.7.78   | 00:00:5e:89:f9:50 | N/A          | true    |
-    #     +-------------+-------+-------+--------+----------------+-------------------+--------------+---------+
-    #
-    # @param [Array<Object>,Object] dataset A single object or an array of
-    #   objects for which we want to generate a report
-    # @param [Array] headers An array of headers used for ordering the output.
-    # @return [OpenStruct]
-    def spreadsheet(dataset, headers, &block)
-      !block_given? and log_and_raise(ReportError, "You must supply a block!")
-      headers.nil? and log_and_raise(ReportError, "Headers can not be nil!")
-      dataset.nil? and log_and_raise(ReportError, "Dataset can not be nil!")
-
-      rows = Array.new
-      max_lengths = OpenStruct.new
-      headers = headers.map(&:to_s).map(&:downcase).map(&:to_sym)
-
-      if dataset.is_a?(Array)
-        dataset.each do |data|
-          rows << block.call(data)
-        end
-      else
-        rows << block.call(dataset)
-      end
-      rows.compact!
-
-      if rows.count > 0
-        max_lengths = max_spreadsheet_lengths(headers, rows)
-        header_line = headers.collect { |header| "%-#{max_lengths.send(:table)[header]}s" % header.to_s.upcase }
-        header_line = format_row(header_line)
-
-        config.ui.stdout.puts(format_header(headers, max_lengths))
-        config.ui.stdout.puts(header_line)
-        config.ui.stdout.puts(format_header(headers, max_lengths))
-
-        rows.each do |row|
-          row_line = headers.collect do |header|
-            header_length = max_lengths.send(:table)[header]
-            content = row.send(:table)[header]
-
-            "%-#{header_length}s" % content
-          end
-
-          row_line = format_row(row_line)
-          config.ui.stdout.puts(row_line)
-        end
-
-        config.ui.stdout.puts(format_header(headers, max_lengths))
-        OpenStruct.new(:rows => rows, :max_lengths => max_lengths, :width => calculate_spreadsheet_width(headers, max_lengths))
-      else
-        OpenStruct.new(:rows => rows, :max_lengths => 0, :width => 0)
-      end
-
-    end
-
-    # Displays data in a key-value list style.
-    #
-    #     +-------------------------------------------------------------------+
-    #     |                      PROVIDER: Cucumber::Chef::Provider::Vagrant  |
-    #     |                            ID: default                            |
-    #     |                         STATE: aborted                            |
-    #     |                      USERNAME: vagrant                            |
-    #     |                    IP ADDRESS: 127.0.0.1                          |
-    #     |                          PORT: 2222                               |
-    #     |               CHEF-SERVER API: http://127.0.0.1:4000              |
-    #     |             CHEF-SERVER WEBUI: http://127.0.0.1:4040              |
-    #     |      CHEF-SERVER DEFAULT USER: admin                              |
-    #     |  CHEF-SERVER DEFAULT PASSWORD: p@ssw0rd1                          |
-    #     +-------------------------------------------------------------------+
-    #
-    # @param [Array<Object>,Object] dataset A single object or an array of
-    #   objects for which we want to generate a report
-    # @param [Array] headers An array of headers used for ordering the output.
-    # @return [OpenStruct]
-    def list(dataset, headers, &block)
-      !block_given? and log_and_raise(ReportError, "You must supply a block!")
-      headers.nil? and log_and_raise(ReportError, "Headers can not be nil!")
-      dataset.nil? and log_and_raise(ReportError, "Dataset can not be nil!")
 
-      rows = Array.new
-      max_lengths = OpenStruct.new
-      headers = headers.map(&:to_s).map(&:downcase).map(&:to_sym)
-
-      if dataset.is_a?(Array)
-        dataset.each do |data|
-          rows << block.call(data)
-        end
-      else
-        rows << block.call(dataset)
-      end
-      rows.compact!
-
-      if rows.count > 0
-        max_key_length = headers.collect{ |header| header.to_s.length }.max
-        max_value_length = rows.collect{ |row| headers.collect{ |header| row.send(:table)[header].to_s.length }.max }.max
-
-        width = (max_key_length + max_value_length + 2 + 2 + 2)
-
-        rows.each do |row|
-          config.ui.stdout.puts("+#{"-" * width}+")
-          headers.each do |header|
-            entry_line = format_entry(header, max_key_length, row.send(:table)[header], max_value_length)
-            config.ui.stdout.puts(entry_line)
-          end
-        end
-        config.ui.stdout.puts("+#{"-" * width}+")
-        OpenStruct.new(:rows => rows, :max_key_length => max_key_length, :max_value_length => max_value_length, :width => width)
-      else
-        OpenStruct.new(:rows => rows, :max_key_length => 0, :max_value_length => 0, :width => 0)
-      end
+      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
     end
 
 
   private
 
-    def max_spreadsheet_lengths(headers, rows)
-      max_lengths = OpenStruct.new
-      headers.each do |header|
-        collection = [header, rows.collect{|r| r.send(:table)[header] } ].flatten
-        maximum = collection.map(&:to_s).map(&:length).max
-        max_lengths.send(:table)[header] = maximum
-      end
-
-      max_lengths
-    end
-
-    def calculate_spreadsheet_width(headers, max_lengths)
-      header_lengths = ((headers.count * 3) - 3)
-      max_length = max_lengths.send(:table).values.reduce(:+)
-      (2 + max_length + header_lengths + 2)
-    end
-
-    def format_header(headers, lengths)
-      line = headers.collect do |header|
-        "-" * lengths.send(:table)[header]
-      end
-
-      ["+-", line.join("-+-"), "-+"].join.strip
-    end
-
-    def format_row(*args)
-      spacer = " "
-      [spacer, args, spacer].flatten.join(" | ").strip
-    end
-
-    def format_entry(key, key_length, value, value_length)
-      "|  %#{key_length}s: %-#{value_length}s  |" % [key.to_s.upcase, value.to_s]
-    end
+    include ZTK::Report::Private
 
   end