ztk 0.0.5 → 0.0.6

data/spec/ztk/template_spec.rb

@@ -24,6 +24,13 @@ describe ZTK::Template do
 
   subject { ZTK::Template }
 
+  before(:all) do
+    $logger = ZTK::Logger.new("/dev/null")
+    $stdout = File.open("/dev/null", "w")
+    $stderr = File.open("/dev/null", "w")
+    $stdin = File.open("/dev/null", "r")
+  end
+
   describe "class" do
 
     it "should be ZTK::Template" do

data/ztk.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency("rake")
   gem.add_development_dependency("rspec")
   gem.add_development_dependency("simplecov")
+  gem.add_development_dependency("yard")
+  gem.add_development_dependency("redcarpet")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -123,6 +123,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Zachary's Tool Kit
 email:
 - zachary@jovelabs.com
@@ -139,18 +171,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- WIKI.md
 - bin/ztk
 - lib/ztk.rb
 - lib/ztk/base.rb
+- lib/ztk/command.rb
 - lib/ztk/logger.rb
 - lib/ztk/parallel.rb
+- lib/ztk/spinner.rb
 - lib/ztk/ssh.rb
 - lib/ztk/tcp_socket_check.rb
 - lib/ztk/template.rb
 - lib/ztk/version.rb
 - spec/spec_helper.rb
 - spec/support/test-template.txt.erb
+- spec/ztk/command_spec.rb
 - spec/ztk/logger_spec.rb
 - spec/ztk/parallel_spec.rb
 - spec/ztk/ssh_spec.rb
@@ -171,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3563770214735056009
+      hash: 3329543031620665477
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -180,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3563770214735056009
+      hash: 3329543031620665477
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -190,8 +224,10 @@ summary: Contains various classes and utilities I find I regularly need.
 test_files:
 - spec/spec_helper.rb
 - spec/support/test-template.txt.erb
+- spec/ztk/command_spec.rb
 - spec/ztk/logger_spec.rb
 - spec/ztk/parallel_spec.rb
 - spec/ztk/ssh_spec.rb
 - spec/ztk/tcp_socket_check_spec.rb
 - spec/ztk/template_spec.rb
+has_rdoc: 

data/WIKI.md

@@ -1,439 +0,0 @@
-[![Build Status](https://secure.travis-ci.org/jovelabs/ztk.png)](http://travis-ci.org/jovelabs/ztk)
-
-# ZTK
-
-Zachary's Tool Kit is a general purpose utility gem, featuring a collection of classes meant to simplify development of complex systems in Ruby.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem "ztk"
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ztk
-
-## Usage
-
-## Console
-
-    bundle install
-    bundle exec ztk
-
-## ZTK::Parallel
-
-Parallel Processing Class
-
-This class can be used to easily run iterative and linear processes in a parallel manner.
-
-### ZTK::Parallel Example Ruby Code
-
-    $logger = ZTK::Logger.new(STDOUT)
-    a_callback = Proc.new do |pid|
-      puts "Hello from After Callback - PID #{pid}"
-    end
-    b_callback = Proc.new do |pid|
-      puts "Hello from Before Callback - PID #{pid}"
-    end
-    parallel = ZTK::Parallel.new
-    parallel.config do |config|
-      config.before_fork = b_callback
-      config.after_fork = a_callback
-    end
-    3.times do |x|
-      parallel.process do
-        x
-      end
-    end
-    parallel.waitall
-    parallel.results
-
-### ZTK::Parallel Example Code Pry Run
-
-    [1] pry(main)> $logger = ZTK::Logger.new(STDOUT)
-    => #<ZTK::Logger:0x0000000204d498
-     @default_formatter=#<Logger::Formatter:0x0000000204d290 @datetime_format=nil>,
-     @formatter=nil,
-     @level=1,
-     @logdev=
-      #<Logger::LogDevice:0x0000000204cfe8
-       @dev=#<IO:<STDOUT>>,
-       @filename=nil,
-       @mutex=
-        #<Logger::LogDevice::LogDeviceMutex:0x0000000204cf20
-         @mon_count=0,
-         @mon_mutex=#<Mutex:0x0000000204ce58>,
-         @mon_owner=nil>,
-       @shift_age=nil,
-       @shift_size=nil>,
-     @progname=nil>
-    [2] pry(main)> a_callback = Proc.new do |pid|
-    [2] pry(main)*   puts "Hello from After Callback - PID #{pid}"
-    [2] pry(main)* end
-    => #<Proc:0x0000000253e1a0@(pry):2>
-    [3] pry(main)> b_callback = Proc.new do |pid|
-    [3] pry(main)*   puts "Hello from Before Callback - PID #{pid}"
-    [3] pry(main)* end
-    => #<Proc:0x0000000274bda8@(pry):5>
-    [4] pry(main)> parallel = ZTK::Parallel.new
-    => #<ZTK::Parallel:0x000000026310d0
-     @config=
-      #<OpenStruct stdout=#<IO:<STDOUT>>, stderr=#<IO:<STDERR>>, stdin=#<IO:<STDIN>>, logger=#<ZTK::Logger:0x0000000204d498 @progname=nil, @level=1, @default_formatter=#<Logger::Formatter:0x0000000204d290 @datetime_format=nil>, @formatter=nil, @logdev=#<Logger::LogDevice:0x0000000204cfe8 @shift_size=nil, @shift_age=nil, @filename=nil, @dev=#<IO:<STDOUT>>, @mutex=#<Logger::LogDevice::LogDeviceMutex:0x0000000204cf20 @mon_owner=nil, @mon_count=0, @mon_mutex=#<Mutex:0x0000000204ce58>>>>, max_forks=12, one_shot=false, before_fork=nil, after_fork=nil>,
-     @forks=[],
-     @results=[]>
-    [5] pry(main)> parallel.config do |config|
-    [5] pry(main)*   config.before_fork = b_callback
-    [5] pry(main)*   config.after_fork = a_callback
-    [5] pry(main)* end
-    => #<Proc:0x0000000253e1a0@(pry):2>
-    [6] pry(main)> 3.times do |x|
-    [6] pry(main)*   parallel.process do
-    [6] pry(main)*     x
-    [6] pry(main)*   end
-    [6] pry(main)* end
-    Hello from Before Callback - PID 31579
-    Hello from After Callback - PID 31579
-    Hello from Before Callback - PID 31579
-    Hello from After Callback - PID 31614
-    Hello from After Callback - PID 31579
-    Hello from Before Callback - PID 31579
-    Hello from After Callback - PID 31617
-    Hello from After Callback - PID 31579
-    Hello from After Callback - PID 31620
-    => 3
-    [7] pry(main)> parallel.waitall
-    => [[31614, #<Process::Status: pid 31614 exit 0>, 0],
-     [31617, #<Process::Status: pid 31617 exit 0>, 1],
-     [31620, #<Process::Status: pid 31620 exit 0>, 2]]
-    [8] pry(main)> parallel.results
-    => [0, 1, 2]
-
-Config values can also be passed like:
-
-    parallel = ZTK::Parallel.new(:before_fork => b_callback, :after_fork => a_callback)
-
-Or:
-
-    parallel = ZTK::Parallel.new
-    parallel.config.before_fork = b_callback
-    parallel.config.after_fork = a_callback
-
-Default Config Values for ZTK::Parallel:
-
-    :stdout => $stdout,
-    :stderr => $stderr,
-    :stdin => $stdin,
-    :logger => $logger,
-    :max_forks => `grep -c processor /proc/cpuinfo`.chomp.to_i,
-    :one_shot => false,
-    :before_fork => nil,
-    :after_fork => nil
-
-## ZTK::Logger
-
-Logging Class
-
-This is a logging class based off the ruby core Logger class; but with very verbose logging information, adding PID, micro second timing to log messages.  It favors passing messages via blocks in order to speed up execution when log messages do not need to be yielded.  New takes the same options as the ruby core logger class.
-
-Example:
-
-    $logger = ZTK::Logger.new("/dev/null")
-
-    $logger.debug { "This is a debug message!" }
-    $logger.info { "This is a info message!" }
-    $logger.warn { "This is a warn message!" }
-    $logger.error { "This is a error message!" }
-    $logger.fatal { "This is a fatal message!" }
-
-Example Output:
-
-    2012-09-01|21:34:45.216262|23603|FATAL|logger_spec.rb:122:block (5 levels) in <top (required)>|This is a test fatal message
-
-## ZTK::SSH
-
-SSH Class
-
-Simplified SSH class; it provides for remote execute of commands and returning of command output.  Additionally it allows for uploading and downloading of files.
-
-### ZTK::SSH Example Ruby Code
-
-    $logger = ZTK::Logger.new(STDOUT)
-    ssh = ZTK::SSH.new
-    ssh.config do |config|
-      config.ssh.user = ENV["USER"]
-      config.ssh.host = "127.0.0.1"
-    end
-    puts ssh.exec("hostname -f")
-    local = File.expand_path(File.join("/tmp", "id_rsa.pub"))
-    remote = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa.pub"))
-    ssh.download(remote, local)
-
-### ZTK::SSH Example Code Pry Run
-
-    [1] pry(main)> $logger = ZTK::Logger.new(STDOUT)
-    => #<ZTK::Logger:0x000000025f2c18
-     @default_formatter=#<Logger::Formatter:0x000000025f2ab0 @datetime_format=nil>,
-     @formatter=nil,
-     @level=1,
-     @logdev=
-      #<Logger::LogDevice:0x000000025fcc18
-       @dev=#<IO:<STDOUT>>,
-       @filename=nil,
-       @mutex=
-        #<Logger::LogDevice::LogDeviceMutex:0x000000025fcbf0
-         @mon_count=0,
-         @mon_mutex=#<Mutex:0x000000025fc9e8>,
-         @mon_owner=nil>,
-       @shift_age=nil,
-       @shift_size=nil>,
-     @progname=nil>
-    [2] pry(main)> ssh = ZTK::SSH.new
-    => #<ZTK::SSH:0x00000002c317c8
-     @config=
-      #<OpenStruct stdout=#<IO:<STDOUT>>, stderr=#<IO:<STDERR>>, stdin=#<IO:<STDIN>>, logger=#<ZTK::Logger:0x000000025f2c18 @progname=nil, @level=1, @default_formatter=#<Logger::Formatter:0x000000025f2ab0 @datetime_format=nil>, @formatter=nil, @logdev=#<Logger::LogDevice:0x000000025fcc18 @shift_size=nil, @shift_age=nil, @filename=nil, @dev=#<IO:<STDOUT>>, @mutex=#<Logger::LogDevice::LogDeviceMutex:0x000000025fcbf0 @mon_owner=nil, @mon_count=0, @mon_mutex=#<Mutex:0x000000025fc9e8>>>>, ssh=#<OpenStruct>>>
-    [3] pry(main)> ssh.config do |config|
-    [3] pry(main)*   config.ssh.user = ENV["USER"]
-    [3] pry(main)*   config.ssh.host = "127.0.0.1"
-    [3] pry(main)* end
-    => "127.0.0.1"
-    [4] pry(main)> puts ssh.exec("hostname -f")
-    2012-09-01|04:49:47.723411|25709| INFO|ssh.rb:76:exec|command(hostname -f)
-    staging.jovelabs.net
-    staging.jovelabs.net
-    => nil
-    [5] pry(main)> local = File.expand_path(File.join("/tmp", "id_rsa.pub"))
-    => "/tmp/id_rsa.pub"
-    [6] pry(main)> remote = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa.pub"))
-    => "/home/zpatten/.ssh/id_rsa.pub"
-    [7] pry(main)> ssh.download(remote, local)
-    2012-09-01|04:49:48.153389|25709| INFO|ssh.rb:133:download|parameters(/home/zpatten/.ssh/id_rsa.pub,/tmp/id_rsa.pub)
-    2012-09-01|04:49:48.153536|25709| INFO|ssh.rb:137:block in download|download(/home/zpatten/.ssh/id_rsa.pub -> /tmp/id_rsa.pub)
-    2012-09-01|04:49:48.156243|25709| INFO|ssh.rb:145:block in download|finish
-    => true
-
-### ZTK::SSH Config
-
-To proxy through another host, for example SSH to 192.168.1.1 through 192.168.0.1:
-
-    ssh.config do |config|
-      config.ssh.user = ENV["USER"]
-      config.ssh.host = "192.168.1.1"
-      config.ssh.proxy_user = ENV["USER"]
-      config.ssh.proxy_host = "192.168.0.1"
-    end
-
-Specify an identity file:
-
-    ssh.config do |config|
-      config.ssh.identify_file = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa"))
-      config.ssh.proxy_identify_file = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa"))
-    end
-
-Specify a timeout:
-
-    ssh.config do |config|
-      config.ssh.timeout = 30
-    end
-
-Specify a password:
-
-    ssh.config do |config|
-      config.ssh.password = "p@$$w0rd"
-    end
-
-Check host keys, the default is false (off):
-
-    ssh.config do |config|
-      config.ssh.host_key_verify = true
-    end
-
-### ZTK::SSH Core Methods
-
-#### Execute A Command
-
-    ssh.exec(command, options={})
-
-Where `command` is a command (i.e. `String`) to execute on the remote host (i.e. "hostname -f").  You can optionally pass `:silence => true` into `options` to suppress session output from going to STDOUT and STDERR.
-
-#### Upload A File
-
-    ssh.upload(local, remote)
-
-Where `local` is the local file/path you wish to upload on the local host to the `remote` file/path on the remote host.
-
-#### Download A File
-
-    ssh.download(remote, local)
-
-Where `remote` is the remote file/path you wish to download on the remote host to the `local` file/path on the local host.
-
-## ZTK::Template
-
-Erubis Templating
-
-### ZTK::Template Example Ruby Code
-
-    template_file = File.expand_path(File.join(File.dirname(__FILE__), "spec", "support", "test-template.txt.erb"))
-    IO.read(template_file)
-    context = { :test_variable => "Hello World" }
-    ZTK::Template.render(template_file, context)
-
-### ZTK::Template Example Code Pry Run
-
-    [1] pry(main)> template_file = File.expand_path(File.join(File.dirname(__FILE__), "spec", "support", "test-template.txt.erb"))
-    => "/home/zpatten/Dropbox/code/ztk/spec/support/test-template.txt.erb"
-    [2] pry(main)> IO.read(template_file)
-    => "<%= @test_variable %>\n"
-    [3] pry(main)> context = { :test_variable => "Hello World" }
-    => {:test_variable=>"Hello World"}
-    [4] pry(main)> ZTK::Template.render(template_file, context)
-    => "Hello World"
-
-## ZTK::TCPSocketCheck
-
-Check TCP Sockets
-
-This class has two basic modes of operation:
-
-* Read Test
-
-By default we will perform a read test against the host and port specified.  In this mode we will attempt to connect to the host and port supplied and if we can read any amount of data, regardless of the content we view this as success.
-
-* Write Test
-
-If `data` is supplied via the configuration, this will change the mode of operation to a write test.  Certain services, such as HTTP don't send any data unless you send something first.  In this mode we will attempt to connect to the host and port supplied, once connected we will write the supplied `data` to the socket and then attempt to read from the socket.  If we can read any amount of data, reagardless of the conent we view this as success.
-
-### ZTK::TCPSocketCheck Example Ruby Code
-
-    tcp_check = ZTK::TCPSocketCheck.new(:host => "github.com", :port => 22)
-    tcp_check.wait
-    tcp_check.ready?
-
-### ZTK::TCPSocketCheck Example Code Pry Run
-
-    [1] pry(main)> tcp_check = ZTK::TCPSocketCheck.new(:host => "github.com", :port => 22)
-    => #<ZTK::TCPSocketCheck:0x00000001890d18
-     @config=
-      #<OpenStruct stdout=#<IO:<STDOUT>>, stderr=#<IO:<STDERR>>, stdin=#<IO:<STDIN>>, logger=nil, host="github.com", port=22, data=nil, timeout=5>>
-    [2] pry(main)> tcp_check.wait
-    => nil
-    [3] pry(main)> tcp_check.ready?
-    => true
-
-### ZTK::TCPSocketCheck Config
-
-Here is an example TCPSocketCheck configuration.  The `timeout` and `wait` values shown are the defaults if omitted.
-
-    tcp_check = ZTK::TCPSocketCheck.new
-    tcp_check.config do |config|
-      config.host = "www.google.com"
-      config.port = 80
-      config.data = "GET"
-      config.timeout = 5
-      config.wait = 60
-    end
-
-Specify the host and port (required):
-
-    tcp_check = ZTK::TCPSocketCheck.new
-    tcp_check.config do |config|
-      config.host = "www.google.com"
-      config.port = 80
-    end
-
-Specify data to write (switches to a write mode test if this is supplied):
-
-    tcp_check = ZTK::TCPSocketCheck.new
-    tcp_check.config do |config|
-      config.host = "www.google.com"
-      config.port = 80
-      config.data = "GET"
-    end
-
-Override the `timeout` and `wait` values:
-
-    tcp_check = ZTK::TCPSocketCheck.new
-    tcp_check.config do |config|
-      config.host = "www.google.com"
-      config.port = 80
-      config.data = "GET"
-      config.timeout = 3
-      config.wait = 5
-    end
-
-### ZTK::TCPSocketCheck Core Methods
-
-#### Socket Ready?
-
-We can use the `ready?` method to test if the socket is ready in a one off manner.  This operations runtime is bound by the `timeout` configuration value.
-
-    tcp_check = ZTK::TCPSocketCheck.new
-    tcp_check.config do |config|
-      config.host = "www.google.com"
-      config.port = 80
-      config.data = "GET"
-    end
-    if tcp_check.ready? == true
-      puts "The Socket Is Ready!"
-    else
-      puts "Looks like no one is home!"
-    end
-
-#### Socket Wait
-
-We can use the `wait` method to block on the socket's `ready?` state.  The method will return only if the socket becomes ready or a timeout occurs.  This operations runtime is bound by the `wait` configuration value.
-
-    tcp_check = ZTK::TCPSocketCheck.new
-    tcp_check.config do |config|
-      config.host = "www.google.com"
-      config.port = 80
-      config.data = "GET"
-    end
-    if tcp_check.wait == true
-      puts "The Socket Is Ready!"
-    else
-      puts "We timed out or got no answer!"
-    end
-
-## ZTK::Command
-
-A class to execute commands locally.
-
-# RESOURCES
-
-Source:
-
-* https://github.com/jovelabs/ztk
-
-Issues:
-
-* https://github.com/jovelabs/ztk/issues
-
-Wiki:
-
-* https://github.com/jovelabs/ztk/wiki
-
-# LICENSE
-
-ZTK - Zachary's Tool Kit
-
-* Author: Zachary Patten <zachary@jovelabs.com>
-* Copyright: Copyright (c) Jove Labs
-* License: Apache License, Version 2.0
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.