ztk 1.0.0.rc.1 → 1.0.0

data/lib/ztk/background.rb

@@ -21,7 +21,7 @@ require "base64"
 
 module ZTK
 
-  # ZTK::Background Error Class
+  # ZTK::Background General Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class BackgroundError < Error; end
@@ -106,6 +106,7 @@ module ZTK
     attr_accessor :pid, :result
 
     # @param [Hash] configuration Configuration options hash.
+    #
     def initialize(configuration={})
       super({
       }.merge(configuration))
@@ -121,6 +122,7 @@ module ZTK
     # @yieldreturn [Object] Block can return any object to be marshalled back to
     #   the parent processes.
     # @return [Integer] Returns the pid of the child process forked.
+    #
     def process(&block)
       !block_given? and log_and_raise(BackgroundError, "You must supply a block to the process method!")
 
@@ -167,6 +169,7 @@ module ZTK
     # @return [Array<pid, status, data>] An array containing the pid,
     #   status and data returned from the process block.  If wait2() fails nil
     #   is returned.
+    #
     def wait
       config.ui.logger.debug { "wait" }
       pid, status = (Process.wait2(@pid) rescue nil)

data/lib/ztk/base.rb

@@ -21,7 +21,7 @@ require "ostruct"
 
 module ZTK
 
-  # ZTK::Base Error Class
+  # ZTK::Base General Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class BaseError < Error; end

data/lib/ztk/benchmark.rb

@@ -21,7 +21,7 @@ require 'benchmark'
 
 module ZTK
 
-  # ZTK::Benchmark Error Class
+  # ZTK::Benchmark General Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class BenchmarkError < Error; end
@@ -87,6 +87,7 @@ module ZTK
       # @yield Block should execute the tasks to be benchmarked.
       # @yieldreturn [Object] The return value of the block is ignored.
       # @return [Float] The benchmark time.
+      #
       def bench(options={}, &block)
         options = Base.build_config({
           :use_spinner => true

data/lib/ztk/command.rb

@@ -23,7 +23,6 @@ require "timeout"
 module ZTK
 
   # ZTK::Command Error Class
-  #
   # @author Zachary Patten <zachary@jovelabs.net>
   class CommandError < Error; end
 
@@ -36,7 +35,8 @@ module ZTK
   # If we wanted to redirect STDOUT and STDERR to a StringIO we can do this:
   #
   #     std_combo = StringIO.new
-  #     cmd = ZTK::Command.new(:stdout => std_combo, :stderr => std_combo)
+  #     ui = ZTK::UI.new(:stdout => std_combo, :stderr => std_combo)
+  #     cmd = ZTK::Command.new(:ui => ui)
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class Command < ZTK::Base
@@ -62,6 +62,7 @@ module ZTK
     #
     #   cmd = ZTK::Command.new
     #   puts cmd.exec("hostname -f").inspect
+    #
     def exec(command, options={})
       options = OpenStruct.new({ :exit_code => 0, :silence => false }.merge(options))
 
@@ -175,11 +176,15 @@ module ZTK
 
   private
 
+    # Returns a string in the format of "user@hostname" for the current
+    #   shell.
     def tag
       @hostname ||= %x(hostname -f).chomp
       "#{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)

data/lib/ztk/config.rb

@@ -21,7 +21,7 @@ require 'ostruct'
 
 module ZTK
 
-  # ZTK::Config Error Class
+  # ZTK::Config General Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class ConfigError < Error; end
@@ -69,6 +69,7 @@ module ZTK
     #
     # This will add the *configuration* attribute to the base class and create
     # a new *OpenStruct* object assigning it to the *configuration* attribute.
+    #
     def self.extended(base)
       class << base
         attr_accessor :configuration
@@ -78,14 +79,16 @@ module ZTK
     end
 
     # Loads a configuration from a file.
+    #
     def from_file(filename)
-      self.instance_eval(IO.read(filename), filename, 1)
+      self.instance_eval(IO.read(filename), filename)
     end
 
     # Yields the configuration OpenStruct object to a block.
     #
     # @yield [configuration] Pass the configuration OpenStruct object to the
     #   specified block.
+    #
     def config(&block)
       block and block.call(self.configuration)
     end
@@ -96,6 +99,7 @@ module ZTK
     #   key to return.
     #
     # @return The value currently assigned to the configuration key.
+    #
     def [](key)
       _get(key)
     end
@@ -108,31 +112,37 @@ module ZTK
     #   key.
     #
     # @return The value assigned to the configuration key.
+    #
     def []=(key, value)
       _set(key, value)
     end
 
     # @see Hash#keys
+    #
     def keys
       self.configuration.send(:table).keys
     end
 
     # @see Hash#has_key?
+    #
     def has_key?(key)
       self.configuration.send(:table).has_key?(key)
     end
 
     # @see Hash#merge
+    #
     def merge(hash)
       self.configuration.send(:table).merge(hash)
     end
 
     # @see Hash#merge!
+    #
     def merge!(hash)
       self.configuration.send(:table).merge!(hash)
     end
 
     # Handles method calls for our configuration keys.
+    #
     def method_missing(method_symbol, *method_args)
       if method_args.length > 0
         _set(method_symbol, method_args.first)

data/lib/ztk/ssh.rb

@@ -38,7 +38,8 @@ module ZTK
   # If we wanted to redirect STDOUT and STDERR to a StringIO we can do this:
   #
   #     std_combo = StringIO.new
-  #     ssh = ZTK::SSH.new(:stdout => std_combo, :stderr => std_combo)
+  #     ui = ZTK::UI.new(:stdout => std_combo, :stderr => std_combo)
+  #     ssh = ZTK::SSH.new(:ui => ui)
   #
   # If you want to specify SSH options you can:
   #

data/lib/ztk/version.rb

@@ -21,6 +21,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "1.0.0.rc.1"
+  VERSION = "1.0.0"
 
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.1
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Zachary Patten
@@ -250,13 +250,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -276404012806695172
+      hash: 3551649041852268044
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 3551649041852268044
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24