ztk 1.6.2 → 1.6.3

data/lib/ztk/report/list.rb

@@ -0,0 +1,67 @@
+module ZTK
+  class Report
+
+    # Report List Functionality
+    module List
+
+      # 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
+      end
+
+    end
+
+  end
+end

data/lib/ztk/report/private.rb

@@ -0,0 +1,44 @@
+module ZTK
+  class Report
+
+    # Report Private Functionality
+    module 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
+
+    end
+
+  end
+end

data/lib/ztk/report/spreadsheet.rb

@@ -0,0 +1,72 @@
+module ZTK
+  class Report
+
+    # Report Spreadsheet Functionality
+    module Spreadsheet
+
+      # 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
+
+    end
+
+  end
+end

data/lib/ztk/ssh.rb

@@ -1,8 +1,3 @@
-require 'ostruct'
-require 'net/ssh'
-require 'net/ssh/proxy/command'
-require 'net/sftp'
-
 module ZTK
 
   # SSH Error Class
@@ -24,7 +19,7 @@ module ZTK
   #
   # If you want to specify SSH options you can:
   #
-  #     keys = File.expand_path(File.join(ENV['HOME'], '.ssh', 'id_rsa'))
+  #     keys = File.expand_path(File.join(Dir.home, '.ssh', 'id_rsa'))
   #     ssh = ZTK::SSH.new(:host_name => '127.0.0.1', :user => ENV['USER'], :keys => keys)
   #
   # = Configuration Examples:
@@ -41,8 +36,8 @@ module ZTK
   # Specify an identity file:
   #
   #     ssh.config do |config|
-  #       config.keys = File.expand_path(File.join(ENV['HOME'], '.ssh', 'id_rsa'))
-  #       config.proxy_keys = File.expand_path(File.join(ENV['HOME'], '.ssh', 'id_rsa'))
+  #       config.keys = File.expand_path(File.join(Dir.home, '.ssh', 'id_rsa'))
+  #       config.proxy_keys = File.expand_path(File.join(Dir.home, '.ssh', 'id_rsa'))
   #     end
   #
   # Specify a timeout:
@@ -65,6 +60,11 @@ module ZTK
   #
   # @author Zachary Patten <zachary AT jovelabs DOT com>
   class SSH < ZTK::Base
+    require 'ostruct'
+    require 'net/ssh'
+    require 'net/ssh/proxy/command'
+    require 'net/sftp'
+
     # Exit Signal Mappings
     EXIT_SIGNALS = {
       1 => "SIGHUP",
@@ -96,15 +96,20 @@ module ZTK
       27 => "SIGPROF"
     }
 
-    autoload :Bootstrap, 'ztk/ssh/bootstrap'
-    autoload :Command,   'ztk/ssh/command'
-    autoload :Download,  'ztk/ssh/download'
-    autoload :Exec,      'ztk/ssh/exec'
-    autoload :File,      'ztk/ssh/file'
-    autoload :Upload,    'ztk/ssh/upload'
+    require 'ztk/ssh/bootstrap'
+    require 'ztk/ssh/command'
+    require 'ztk/ssh/console'
+    require 'ztk/ssh/core'
+    require 'ztk/ssh/download'
+    require 'ztk/ssh/exec'
+    require 'ztk/ssh/file'
+    require 'ztk/ssh/private'
+    require 'ztk/ssh/upload'
 
     include ZTK::SSH::Bootstrap
     include ZTK::SSH::Command
+    include ZTK::SSH::Console
+    include ZTK::SSH::Core
     include ZTK::SSH::Download
     include ZTK::SSH::Exec
     include ZTK::SSH::File
@@ -155,113 +160,14 @@ module ZTK
         :exit_code => 0,
         :silence => false
       }.merge(configuration))
-      config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
-    end
-
-    # Starts an SSH session.  Can also be used to get the Net::SSH object.
-    #
-    # Primarily used internally.
-    def ssh
-      @ssh ||= Net::SSH.start(config.host_name, config.user, ssh_options)
-    end
-
-    # Starts an SFTP session.  Can also be used to get the Net::SFTP object.
-    #
-    # Primarily used internally.
-    def sftp
-      @sftp ||= Net::SFTP.start(config.host_name, config.user, ssh_options)
-    end
-
-    # Close our session gracefully.
-    def close
-      config.ui.logger.debug { "close" }
-      ssh and !ssh.closed? and ssh.close
-    end
-
-    # The on_retry method we'll use with the RescueRetry class.
-    def on_retry(exception)
-      close
-      @ssh = nil
-      @sftp = nil
-    end
 
-    # Launches an SSH console, replacing the current process with the console
-    # process.
-    #
-    # @example Launch a console:
-    #   ssh = ZTK::SSH.new
-    #   ssh.config do |config|
-    #     config.user = ENV["USER"]
-    #     config.host_name = "127.0.0.1"
-    #   end
-    #   ssh.console
-    def console
       config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
-      config.ui.logger.info { "console(#{console_command.inspect})" }
-
-      config.ui.logger.fatal { "REPLACING CURRENT PROCESS - GOODBYE!" }
-      Kernel.exec(console_command)
     end
 
 
   private
 
-    # Builds our SSH options hash.
-    def ssh_options
-      options = {}
-
-      # These are plainly documented on the Net::SSH config class.
-      options.merge!(:encryption => config.encryption) if config.encryption
-      options.merge!(:compression => config.compression) if config.compression
-      options.merge!(:compression_level => config.compression_level) if config.compression_level
-      options.merge!(:timeout => config.timeout) if config.timeout
-      options.merge!(:forward_agent => config.forward_agent) if config.forward_agent
-      options.merge!(:global_known_hosts_file => config.global_known_hosts_file) if config.global_known_hosts_file
-      options.merge!(:auth_methods => config.auth_methods) if config.auth_methods
-      options.merge!(:host_key => config.host_key) if config.host_key
-      options.merge!(:host_key_alias => config.host_key_alias) if config.host_key_alias
-      options.merge!(:host_name => config.host_name) if config.host_name
-      options.merge!(:keys => config.keys) if config.keys
-      options.merge!(:keys_only => config.keys_only) if config.keys_only
-      options.merge!(:hmac => config.hmac) if config.hmac
-      options.merge!(:port => config.port) if config.port
-      options.merge!(:proxy => Net::SSH::Proxy::Command.new(proxy_command)) if config.proxy_host_name
-      options.merge!(:rekey_limit => config.rekey_limit) if config.rekey_limit
-      options.merge!(:user => config.user) if config.user
-      options.merge!(:user_known_hosts_file => config.user_known_hosts_file) if config.user_known_hosts_file
-
-      # This is not plainly documented on the Net::SSH config class.
-      options.merge!(:password => config.password) if config.password
-
-      config.ui.logger.debug { "ssh_options(#{options.inspect})" }
-      options
-    end
-
-    # Builds a human readable tag about our connection.  Used for internal
-    # logging purposes.
-    def tag
-      tags = Array.new
-
-      if config.proxy_host_name
-        proxy_user_host = "#{config.proxy_user}@#{config.proxy_host_name}"
-        proxy_port = (config.proxy_port ? ":#{config.proxy_port}" : nil)
-        tags << [proxy_user_host, proxy_port].compact.join
-        tags << " >>> "
-      end
-
-      user_host = "#{config.user}@#{config.host_name}"
-      port = (config.port ? ":#{config.port}" : nil)
-      tags << [user_host, port].compact.join
-
-      tags.join.strip
-    end
-
-    def log_header(what)
-      count = 8
-      sep = ("=" * count)
-      header = [sep, "[ #{what} ]", sep, "[ #{tag} ]", sep, "[ #{what} ]", sep].join
-      "#{header}\n"
-    end
+    include ZTK::SSH::Private
 
   end
 

data/lib/ztk/ssh/bootstrap.rb

@@ -32,7 +32,7 @@ module ZTK
         tempfile = Tempfile.new("bootstrap")
 
         local_tempfile = tempfile.path
-        remote_tempfile = ::File.join("/", "tmp", ::File.basename(local_tempfile))
+        remote_tempfile = ::File.join(ZTK::Locator.root, "tmp", ::File.basename(local_tempfile))
 
         ::File.open(local_tempfile, 'w') do |file|
           file.puts(content)

data/lib/ztk/ssh/console.rb

@@ -0,0 +1,28 @@
+module ZTK
+  class SSH
+
+    # SSH Console Functionality
+    module Console
+
+      # Launches an SSH console, replacing the current process with the console
+      # process.
+      #
+      # @example Launch a console:
+      #   ssh = ZTK::SSH.new
+      #   ssh.config do |config|
+      #     config.user = ENV["USER"]
+      #     config.host_name = "127.0.0.1"
+      #   end
+      #   ssh.console
+      def console
+        config.ui.logger.debug { "config=#{config.send(:table).inspect}" }
+        config.ui.logger.info { "console(#{console_command.inspect})" }
+
+        config.ui.logger.fatal { "REPLACING CURRENT PROCESS - GOODBYE!" }
+        Kernel.exec(console_command)
+      end
+
+    end
+
+  end
+end

data/lib/ztk/ssh/core.rb

@@ -0,0 +1,37 @@
+module ZTK
+  class SSH
+
+    # SSH Core Functionality
+    module Core
+
+      # Starts an SSH session.  Can also be used to get the Net::SSH object.
+      #
+      # Primarily used internally.
+      def ssh
+        @ssh ||= Net::SSH.start(config.host_name, config.user, ssh_options)
+      end
+
+      # Starts an SFTP session.  Can also be used to get the Net::SFTP object.
+      #
+      # Primarily used internally.
+      def sftp
+        @sftp ||= Net::SFTP.start(config.host_name, config.user, ssh_options)
+      end
+
+      # Close our session gracefully.
+      def close
+        config.ui.logger.debug { "close" }
+        ssh and !ssh.closed? and ssh.close
+      end
+
+      # The on_retry method we'll use with the RescueRetry class.
+      def on_retry(exception)
+        close
+        @ssh = nil
+        @sftp = nil
+      end
+
+    end
+
+  end
+end

data/lib/ztk/ssh/download.rb

@@ -21,8 +21,8 @@ module ZTK
       #     config.user = ENV["USER"]
       #     config.host_name = "127.0.0.1"
       #   end
-      #   local = File.expand_path(File.join("/tmp", "id_rsa.pub"))
-      #   remote = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa.pub"))
+      #   local = File.expand_path(File.join(ZTK::Locator.root, "tmp", "id_rsa.pub"))
+      #   remote = File.expand_path(File.join(Dir.home, ".ssh", "id_rsa.pub"))
       #   ssh.download(remote, local)
       def download(remote, local, options={})
         options = {:recursive => ::File.directory?(local) }.merge(options)