ztk 0.0.8 → 0.0.9

data/lib/ztk.rb

@@ -18,7 +18,7 @@
 #
 ################################################################################
 
-require "ztk/version"
+require 'ztk/version'
 
 # Main ZTK module
 #
@@ -30,13 +30,14 @@ module ZTK
   # @author Zachary Patten <zachary@jovelabs.net>
   class Error < StandardError; end
 
-  autoload :Base, "ztk/base"
-  autoload :Command, "ztk/command"
-  autoload :Logger, "ztk/logger"
-  autoload :Parallel, "ztk/parallel"
-  autoload :Spinner, "ztk/spinner"
-  autoload :SSH, "ztk/ssh"
-  autoload :TCPSocketCheck, "ztk/tcp_socket_check"
-  autoload :Template, "ztk/template"
+  autoload :Base, 'ztk/base'
+  autoload :Command, 'ztk/command'
+  autoload :Config, 'ztk/config'
+  autoload :Logger, 'ztk/logger'
+  autoload :Parallel, 'ztk/parallel'
+  autoload :Spinner, 'ztk/spinner'
+  autoload :SSH, 'ztk/ssh'
+  autoload :TCPSocketCheck, 'ztk/tcp_socket_check'
+  autoload :Template, 'ztk/template'
 
 end

data/lib/ztk/base.rb

@@ -22,7 +22,7 @@ require "ostruct"
 
 module ZTK
 
-  # ZTK::Base error class
+  # ZTK::Base Error Class
   class BaseError < Error; end
 
   # ZTK Base Class
@@ -35,18 +35,18 @@ module ZTK
   # and extend functionality as appropriate.
   class Base
 
-    # @param [Hash] config configuration options hash
-    # @option config [IO] :stdout instance of IO to be used for STDOUT
-    # @option config [IO] :stderr instance of IO to be used for STDERR
-    # @option config [IO] :stdin instance of IO to be used for STDIN
-    # @option config [Logger] :logger instance of Logger to be used for logging
+    # @param [Hash] config Configuration options hash.
+    # @option config [IO] :stdout Instance of IO to be used for STDOUT.
+    # @option config [IO] :stderr Instance of IO to be used for STDERR.
+    # @option config [IO] :stdin Instance of IO to be used for STDIN.
+    # @option config [Logger] :logger Instance of Logger to be used for logging.
     def initialize(config={})
-      defined?(Rails) and rails_logger = Rails.logger
+      # defined?(Rails) and rails_logger = Rails.logger
       @config = OpenStruct.new({
         :stdout => $stdout,
         :stderr => $stderr,
         :stdin => $stdin,
-        :logger => (rails_logger || $logger)
+        :logger => $logger
       }.merge(config))
 
       @config.stdout.respond_to?(:sync=) and @config.stdout.sync = true
@@ -85,7 +85,7 @@ module ZTK
       if block_given?
         @config.logger and @config.logger.method(method_name.to_sym).call { yield }
       else
-        raise(Error, "You must supply a block to the log method!")
+        raise BaseError, "You must supply a block to the log method!"
       end
     end
 

data/lib/ztk/command.rb

@@ -22,7 +22,7 @@ require "ostruct"
 
 module ZTK
 
-  # ZTK::Command error class
+  # ZTK::Command Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class CommandError < Error; end

data/lib/ztk/config.rb

@@ -0,0 +1,130 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   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.
+#
+################################################################################
+
+require 'ostruct'
+
+module ZTK
+
+  # ZTK::Config Error Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class ConfigError < Error; end
+
+  # Configuration Module
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  module Config
+
+    # Extend base class with this module.
+    #
+    # 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
+      end
+
+      base.configuration = OpenStruct.new
+    end
+
+    # Loads a configuration from a file.
+    def from_file(filename)
+      self.instance_eval(IO.read(filename), filename, 1)
+    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
+
+    # Get the value of a configuration key.
+    #
+    # @param [Symbol, String] key A symbol or string of the configuration
+    #   key to return.
+    #
+    # @return The value currently assigned to the configuration key.
+    def [](key)
+      _get(key)
+    end
+
+    # Set the value of a configuration key.
+    #
+    # @param [Symbol, String] key A symbol or string of the configuration
+    #   key to set.
+    # @param value The value which you want to assign to the configuration
+    #   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)
+      end
+
+      _get(method_symbol)
+    end
+
+
+  private
+
+    def _set(key, value)
+      key = key.to_s
+      (key =~ /=/) or key += '='
+
+      self.configuration.send(key.to_sym, value)
+    end
+
+    def _get(key)
+      key = key.to_s
+      (key !~ /=/) or key = key[0..-2]
+
+      self.configuration.send(key.to_sym)
+    end
+
+  end
+
+end

data/lib/ztk/parallel.rb

@@ -22,7 +22,7 @@ require "base64"
 
 module ZTK
 
-  # ZTK::Parallel error class
+  # ZTK::Parallel Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class ParallelError < Error; end
@@ -62,6 +62,13 @@ module ZTK
   # @author Zachary Patten <zachary@jovelabs.net>
   class Parallel < ZTK::Base
 
+    MAX_FORKS = case RUBY_PLATFORM
+    when /darwin/ then
+      %x( sysctl hw.ncpu ).chomp.split(':').last.strip.to_i
+    when /linux/ then
+      %x( grep -c processor /proc/cpuinfo ).chomp.strip.to_i
+    end
+
     # Result Set
     attr_accessor :results
 
@@ -71,9 +78,11 @@ module ZTK
     # @option config [Proc] :after_fork (nil) Proc to call after forking.
     def initialize(config={})
       super({
-        :max_forks => %x( grep -c processor /proc/cpuinfo ).chomp.to_i,
+        :max_forks => MAX_FORKS
       }.merge(config))
 
+      raise ParallelError, "max_forks must be equal to or greater than one!" if @config.max_forks < 1
+
       @forks = Array.new
       @results = Array.new
       GC.respond_to?(:copy_on_write_friendly=) and GC.copy_on_write_friendly = true

data/lib/ztk/spinner.rb

@@ -22,13 +22,14 @@ require "ostruct"
 
 module ZTK
 
-  # ZTK::Spinner error class
+  # ZTK::Spinner Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   # @author Stephen Nelson-Smith <stephen@atalanta-systems.com>
   class SpinnerError < Error; end
 
   # Spinner Class
+  #
   # @author Zachary Patten <zachary@jovelabs.net>
   # @author Stephen Nelson-Smith <stephen@atalanta-systems.com>
   class Spinner

data/lib/ztk/ssh.rb

@@ -25,7 +25,7 @@ require "net/sftp"
 
 module ZTK
 
-  # ZTK::SSH error class
+  # ZTK::SSH Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class SSHError < Error; end

data/lib/ztk/tcp_socket_check.rb

@@ -23,7 +23,7 @@ require 'timeout'
 
 module ZTK
 
-  # ZTK::TCPSocketCheck error class
+  # ZTK::TCPSocketCheck Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class TCPSocketCheckError < Error; end

data/lib/ztk/template.rb

@@ -22,7 +22,7 @@ require "erubis"
 
 module ZTK
 
-  # ZTK::Template error class
+  # ZTK::Template Error Class
   #
   # @author Zachary Patten <zachary@jovelabs.net>
   class TemplateError < Error; end

data/lib/ztk/version.rb

@@ -19,5 +19,5 @@
 ################################################################################
 
 module ZTK
-  VERSION = "0.0.8" unless const_defined?(:VERSION)
+  VERSION = "0.0.9" unless const_defined?(:VERSION)
 end

data/spec/support/test-config.rb

@@ -0,0 +1,2 @@
+message   "Hello World"
+thing     (1+1)

data/spec/ztk/config_spec.rb

@@ -0,0 +1,72 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   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.
+#
+################################################################################
+
+require "spec_helper"
+
+describe ZTK::Config do
+
+  subject { class C; extend(ZTK::Config); end; C }
+
+  before(:all) do
+    $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 a kind of ZTK::Config" do
+      subject.should be_a_kind_of ZTK::Config
+    end
+
+    describe "default config" do
+
+      it "should have an OpenStruct object for holding the configuration" do
+        subject.configuration.should be_an_instance_of OpenStruct
+        subject.keys.length.should == 0
+      end
+
+    end
+
+    describe "behaviour" do
+
+      it "should allow setting of arbratary configuration keys" do
+        subject.thing = "something"
+        subject.thing.should == "something"
+        subject[:thing].should == "something"
+      end
+
+      it "should allow hash bracket style access to configuration keys" do
+        subject[:thing] = "nothing"
+        subject[:thing].should == "nothing"
+      end
+
+      it "should allow loading of configurations from disk" do
+        config_file = File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "test-config.rb"))
+        subject.from_file(config_file)
+        subject.message.should == "Hello World"
+        subject.thing.should == 2
+      end
+
+    end
+
+  end
+
+end

data/spec/ztk/ssh_spec.rb

@@ -60,39 +60,43 @@ describe ZTK::SSH do
 
     end
 
-  end
-
-  # this stuff doesn't work as is under travis-ci
-  if !ENV['CI'] && !ENV['TRAVIS']
+    # this stuff doesn't work as is under travis-ci
+    if !ENV['CI'] && !ENV['TRAVIS']
+
+      describe "behaviour" do
+
+        it "should be able to connect to 127.0.0.1 as the current user and execute a command (your key must be in ssh-agent)" do
+          stdout = StringIO.new
+          subject.config do |config|
+            config.stdout = stdout
+            config.user = ENV["USER"]
+            config.host_name = "127.0.0.1"
+          end
+          hostname = %x( hostname -f ).chomp
+          status = subject.exec("hostname -f")
+          status.exit.exitstatus.should == 0
+          stdout.rewind
+          stdout.read.chomp.should == hostname
+        end
+
+        it "should be able to proxy through 127.0.0.1, connecting to 127.0.0.1 as the current user and execute a command (your key must be in ssh-agent)" do
+          stdout = StringIO.new
+          subject.config do |config|
+            config.stdout = stdout
+            config.user = ENV["USER"]
+            config.host_name = "127.0.0.1"
+            config.proxy_user = ENV["USER"]
+            config.proxy_host_name = "127.0.0.1"
+          end
+          hostname = %x( hostname -f ).chomp
+          status = subject.exec("hostname -f")
+          status.exit.exitstatus.should == 0
+          stdout.rewind
+          stdout.read.chomp.should == hostname
+        end
 
-    it "should be able to connect to 127.0.0.1 as the current user and execute a command (your key must be in ssh-agent)" do
-      stdout = StringIO.new
-      subject.config do |config|
-        config.stdout = stdout
-        config.user = ENV["USER"]
-        config.host_name = "127.0.0.1"
       end
-      hostname = %x( hostname -f ).chomp
-      status = subject.exec("hostname -f")
-      status.exit.exitstatus.should == 0
-      stdout.rewind
-      stdout.read.chomp.should == hostname
-    end
 
-    it "should be able to proxy through 127.0.0.1, connecting to 127.0.0.1 as the current user and execute a command (your key must be in ssh-agent)" do
-      stdout = StringIO.new
-      subject.config do |config|
-        config.stdout = stdout
-        config.user = ENV["USER"]
-        config.host_name = "127.0.0.1"
-        config.proxy_user = ENV["USER"]
-        config.proxy_host_name = "127.0.0.1"
-      end
-      hostname = %x( hostname -f ).chomp
-      status = subject.exec("hostname -f")
-      status.exit.exitstatus.should == 0
-      stdout.rewind
-      stdout.read.chomp.should == hostname
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -175,6 +175,7 @@ files:
 - lib/ztk.rb
 - lib/ztk/base.rb
 - lib/ztk/command.rb
+- lib/ztk/config.rb
 - lib/ztk/logger.rb
 - lib/ztk/parallel.rb
 - lib/ztk/spinner.rb
@@ -183,8 +184,10 @@ files:
 - lib/ztk/template.rb
 - lib/ztk/version.rb
 - spec/spec_helper.rb
+- spec/support/test-config.rb
 - spec/support/test-template.txt.erb
 - spec/ztk/command_spec.rb
+- spec/ztk/config_spec.rb
 - spec/ztk/logger_spec.rb
 - spec/ztk/parallel_spec.rb
 - spec/ztk/ssh_spec.rb
@@ -205,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3183770896296440620
+      hash: -1649300180131473211
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -214,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3183770896296440620
+      hash: -1649300180131473211
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -223,8 +226,10 @@ specification_version: 3
 summary: Contains various classes and utilities I find I regularly need.
 test_files:
 - spec/spec_helper.rb
+- spec/support/test-config.rb
 - spec/support/test-template.txt.erb
 - spec/ztk/command_spec.rb
+- spec/ztk/config_spec.rb
 - spec/ztk/logger_spec.rb
 - spec/ztk/parallel_spec.rb
 - spec/ztk/ssh_spec.rb