rutty 2.3.2 → 2.4.0

data/lib/rutty/helpers.rb

@@ -2,7 +2,7 @@ require 'rutty/errors'
 require 'rutty/version'
 
 module Rutty
-  
+
   ##
   # Simple mixin module for miscellaneous methods that don't fit in elsewhere.
   #
@@ -17,10 +17,10 @@ module Rutty
     def check_installed!
       unless File.exists? self.config_dir
         raise Rutty::NotInstalledError.new %Q(Can't find conf directory at #{self.config_dir}.
-         Run `rutty init' first. (Or rutty --help for usage))
+          Run `rutty init' first. (Or rutty --help for usage))
       end
     end
-    
+
     ##
     # Returns the version string contained in {Rutty::Version::STRING}. Used by the rutty bin.
     #
@@ -29,5 +29,35 @@ module Rutty
     def self.get_version
       Rutty::Version::STRING
     end
+
+    ##
+    # Returns a string formatted to a more human-readable representation of a time difference in seconds.
+    #
+    # @since 2.4.0
+    #
+    # @param [Float] seconds_total The number of seconds to convert
+    # @return [String] The formatted string
+    def seconds_in_words seconds_total
+      hours = seconds_total / 3600
+      minutes = (seconds_total - (3600 * hours)) / 60
+      seconds = (seconds_total % (hours >= 1 ? (3600 * hours) : 60)) % 60
+      
+      out = ''
+      
+      unless hours < 1
+        out << hours.to_s
+        out << ((hours > 1) ? " hours " : " hour ")
+      end
+
+      unless minutes < 1
+        out << minutes.to_s
+        out << ((minutes > 1) ? " minutes " : " minute ")
+      end
+      
+      out << seconds.to_s
+      out << ((seconds > 1) ? " seconds" : " second")
+      
+      out.strip
+    end
   end
 end

data/lib/rutty/node.rb

@@ -9,6 +9,18 @@ module Rutty
   # @author Josh Lindsey
   # @since 2.0.0
   class Node < Config
+    class << self
+      ##
+      # Override the inherited {Rutty::Config.load_config} method, raising an exception
+      # to indicate improper usage.
+      # 
+      # @since 2.3.3
+      # @raise [RuntimeError] On call, as this class has no use for this method
+      def load_config dir
+        raise "Unable to call load_config on Node objects."
+      end
+    end
+
     ##
     # Initialize a new {Rutty::Node} instance by merging the user-provided data with
     # the configured defaults.
@@ -54,4 +66,4 @@ module Rutty
       self.tags == other.tags
     end
   end
-end
+end

data/lib/rutty/thread_pool/pool.rb

@@ -0,0 +1,80 @@
+require 'thread'
+require 'fastthread'
+require 'rutty/thread_pool/worker'
+
+module Rutty
+
+  ##
+  # A thread pool implementation using the work queue pattern. Shamelessly stolen from a StackOverflow question.
+  #
+  # @see http://stackoverflow.com/questions/81788/deadlock-in-threadpool/82777#82777
+  # @since 2.4.0
+  class ThreadPool
+    ## @return [Integer] The maximum number of concurrent {Worker} threads
+    attr_accessor :max_size
+
+    ##
+    # Creates a new {ThreadPool} instance with a maximum number of {Worker} threads.
+    def initialize max_size = 10
+      Thread.abort_on_exception = true
+      
+      @max_size = max_size
+      @queue = Queue.new
+      @workers = []
+    end
+
+    ##
+    # The current size of the <tt>@workers</tt> array.
+    #
+    # @return [Integer] The current number of {Worker} threads
+    def current_size
+      @workers.size
+    end
+
+    ##
+    # Whether any {Worker} threads are currently executing, determined by 
+    # comparing the sizes of the <tt>@workers</tt> array and the <tt>@queue</tt>.
+    #
+    # @return [Boolean] Any currently executing workers?
+    def busy?
+      @queue.size < current_size
+    end
+
+    ##
+    # Loops over every {Worker} and calls {Worker#stop}, then clears the <tt>@workers</tt> array.
+    def shutdown
+      @workers.each { |w| w.stop }
+      @workers = []
+    end
+    
+    alias :join :shutdown
+
+    ##
+    # Gets a free worker and passes it the specified closure.
+    #
+    # @see #get_worker
+    # @param [Proc, Lambda, #call] block An instance of any class that responds to <tt>#call</tt>
+    def process block = nil, &blk
+      block = blk if block_given?
+      get_worker.set_block block
+    end
+
+    private
+
+    ##
+    # Gets a free {Worker}. If the {#max_size} has been reached and the <tt>@queue</tt> isn't empty,
+    # pops an existing {Worker} from there. Otherwise spins up a new {Worker} and adds it to the <tt>@workers</tt>
+    # array.
+    #
+    # @return [Rutty::Worker] A {Worker} ready for a new job
+    def get_worker
+      if !@queue.empty? or current_size == @max_size
+        return @queue.pop
+      else
+        worker = Rutty::Worker.new @queue
+        @workers << worker
+        worker
+      end
+    end
+  end
+end

data/lib/rutty/thread_pool/worker.rb

@@ -0,0 +1,103 @@
+require 'thread'
+require 'fastthread'
+
+module Rutty
+  
+  ##
+  # The {ThreadPool} Thread wrapper, representing a single thread of execution in the pool.
+  #
+  # @since 2.4.0
+  class Worker
+    
+    ##
+    # Initialize a new {Worker}. Sets up the initial state of this instance, then spins out its thread. The thread will
+    # wait until it's signaled (by being passed a new closure to execute, or being told to die, etc.), then resume execution
+    # of its task. The Thread is wrapped in a <tt>while @running</tt> loop, allowing for easy termination from {#shutdown}.
+    #
+    # @param [Queue] thread_queue The thread queue from the {ThreadPool} instance to add this worker to
+    # @return [Worker] The new, available Worker object.
+    def initialize thread_queue
+      @mutex = Mutex.new
+      @cv = ConditionVariable.new
+      @queue = thread_queue
+      @running = true
+      
+      @thread = Thread.new do
+        @mutex.synchronize do
+          while @running
+            @cv.wait @mutex
+            block = get_block
+            
+            if block
+              @mutex.unlock
+              block.call
+              @mutex.lock
+              reset_block
+            end
+            
+            @queue << self
+          end
+        end
+      end
+    end
+
+    ##
+    # Returns the evaluation of <tt>@thread.inspect</tt>.
+    #
+    # @return [String] This thread's name
+    def name
+      @thread.inspect
+    end
+
+    ##
+    # Returns the value of <tt>@block</tt>.
+    #
+    # @return [Proc, Lambda, #call] The <tt>@block</tt> object previously passed.
+    def get_block
+      @block
+    end
+
+    ##
+    # Sets a new closure as the task for this worker. Signals the Thread to wakeup after assignment.
+    # 
+    # @param (see Rutty::ThreadPool#process)
+    # @raise [RuntimeError] If the thread is currently busy when called.
+    def set_block block
+      @mutex.synchronize do
+        raise RuntimeError, "Thread already busy." if @block
+        @block = block
+        # Signal the thread in this class, that there's a job to be done
+        @cv.signal
+      end
+    end
+    
+    ##
+    # Sets the <tt>@block</tt> to <tt>nil</tt>. Called after the Thread has finished execution of a task to
+    # ready itself for the next one.
+    def reset_block
+      @block = nil
+    end
+
+    ##
+    # Whether or not this Thread is currently executing. Determined by whether <tt>@block</tt> is <tt>nil</tt>.
+    #
+    # @return [Boolean] Is this Thread executing?
+    def busy?
+      @mutex.synchronize { !@block.nil? }
+    end
+
+    ##
+    # Sets <tt>@running</tt> to <tt>false</tt>, causing the Thread to finish after the current loop. Signals
+    # the Thread to wake and resume, then calls <tt>#join</tt>.
+    #
+    # @see #initialize
+    def stop
+      @mutex.synchronize do
+        @running = false
+        @cv.signal
+      end
+      
+      @thread.join
+    end
+  end
+end

data/lib/rutty/version.rb

@@ -8,8 +8,8 @@ module Rutty
   # @see http://semver.org
   module Version
     MAJOR = 2
-    MINOR = 3
-    PATCH = 2
+    MINOR = 4
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/rutty.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{rutty}
-  s.version = "2.3.2"
+  s.version = "2.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Lindsey"]
-  s.date = %q{2010-11-15}
+  s.date = %q{2010-11-24}
   s.default_executable = %q{rutty}
   s.description = %q{
       RuTTY is a DSH (distributed / dancer's shell) written in Ruby. It's used to run commands 
@@ -20,63 +20,66 @@ Gem::Specification.new do |s|
   s.executables = ["rutty"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+    "README.md"
   ]
   s.files = [
-    ".gitignore",
-     ".yardopts",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "bin/rutty",
-     "lib/rutty.rb",
-     "lib/rutty/actions.rb",
-     "lib/rutty/config.rb",
-     "lib/rutty/consts.rb",
-     "lib/rutty/errors.rb",
-     "lib/rutty/helpers.rb",
-     "lib/rutty/node.rb",
-     "lib/rutty/nodes.rb",
-     "lib/rutty/proc_classes.rb",
-     "lib/rutty/treetop/syntax_nodes.rb",
-     "lib/rutty/treetop/tag_query.rb",
-     "lib/rutty/treetop/tag_query.treetop",
-     "lib/rutty/version.rb",
-     "rutty.gemspec",
-     "test/helper.rb",
-     "test/test_action_add_node.rb",
-     "test/test_action_dsh.rb",
-     "test/test_action_init.rb",
-     "test/test_action_list_nodes.rb",
-     "test/test_actions.rb",
-     "test/test_config.rb",
-     "test/test_consts.rb",
-     "test/test_helpers.rb",
-     "test/test_node.rb",
-     "test/test_nodes.rb",
-     "test/test_runner.rb"
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/rutty",
+    "lib/rutty.rb",
+    "lib/rutty/actions.rb",
+    "lib/rutty/config.rb",
+    "lib/rutty/consts.rb",
+    "lib/rutty/errors.rb",
+    "lib/rutty/helpers.rb",
+    "lib/rutty/node.rb",
+    "lib/rutty/nodes.rb",
+    "lib/rutty/proc_classes.rb",
+    "lib/rutty/thread_pool/pool.rb",
+    "lib/rutty/thread_pool/worker.rb",
+    "lib/rutty/treetop/syntax_nodes.rb",
+    "lib/rutty/treetop/tag_query.rb",
+    "lib/rutty/treetop/tag_query.treetop",
+    "lib/rutty/version.rb",
+    "rutty.gemspec",
+    "test/helper.rb",
+    "test/test_action_add_node.rb",
+    "test/test_action_dsh.rb",
+    "test/test_action_init.rb",
+    "test/test_action_list_nodes.rb",
+    "test/test_action_scp.rb",
+    "test/test_actions.rb",
+    "test/test_config.rb",
+    "test/test_consts.rb",
+    "test/test_helpers.rb",
+    "test/test_node.rb",
+    "test/test_nodes.rb",
+    "test/test_runner.rb"
   ]
   s.homepage = %q{http://github.com/jlindsey/rutty}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A DSH implementation in Ruby}
   s.test_files = [
     "test/helper.rb",
-     "test/test_action_add_node.rb",
-     "test/test_action_dsh.rb",
-     "test/test_action_init.rb",
-     "test/test_action_list_nodes.rb",
-     "test/test_actions.rb",
-     "test/test_config.rb",
-     "test/test_consts.rb",
-     "test/test_helpers.rb",
-     "test/test_node.rb",
-     "test/test_nodes.rb",
-     "test/test_runner.rb"
+    "test/test_action_add_node.rb",
+    "test/test_action_dsh.rb",
+    "test/test_action_init.rb",
+    "test/test_action_list_nodes.rb",
+    "test/test_action_scp.rb",
+    "test/test_actions.rb",
+    "test/test_config.rb",
+    "test/test_consts.rb",
+    "test/test_helpers.rb",
+    "test/test_node.rb",
+    "test/test_nodes.rb",
+    "test/test_runner.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -84,39 +87,87 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<commander>, ["~> 4.0.3"])
+      s.add_runtime_dependency(%q<terminal-table>, ["~> 1.4.2"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_runtime_dependency(%q<net-ssh>, ["~> 2.0.23"])
+      s.add_runtime_dependency(%q<net-scp>, ["~> 1.0.4"])
+      s.add_runtime_dependency(%q<builder>, ["~> 2.1.2"])
+      s.add_runtime_dependency(%q<treetop>, ["~> 1.4.8"])
+      s.add_runtime_dependency(%q<fastthread>, ["~> 1.0.7"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<xml-simple>, ["~> 1.0.12"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.1"])
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_development_dependency(%q<xml-simple>, [">= 1.0.12"])
       s.add_runtime_dependency(%q<commander>, [">= 4.0.3"])
       s.add_runtime_dependency(%q<terminal-table>, [">= 1.4.2"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
       s.add_runtime_dependency(%q<net-ssh>, [">= 2.0.23"])
       s.add_runtime_dependency(%q<net-scp>, [">= 1.0.4"])
       s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
       s.add_runtime_dependency(%q<treetop>, [">= 1.4.8"])
+      s.add_runtime_dependency(%q<fastthread>, [">= 1.0.7"])
     else
+      s.add_dependency(%q<commander>, ["~> 4.0.3"])
+      s.add_dependency(%q<terminal-table>, ["~> 1.4.2"])
+      s.add_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_dependency(%q<net-ssh>, ["~> 2.0.23"])
+      s.add_dependency(%q<net-scp>, ["~> 1.0.4"])
+      s.add_dependency(%q<builder>, ["~> 2.1.2"])
+      s.add_dependency(%q<treetop>, ["~> 1.4.8"])
+      s.add_dependency(%q<fastthread>, ["~> 1.0.7"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<xml-simple>, ["~> 1.0.12"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 1.0.0"])
-      s.add_dependency(%q<jeweler>, [">= 1.4.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.1"])
       s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_dependency(%q<xml-simple>, [">= 1.0.12"])
       s.add_dependency(%q<commander>, [">= 4.0.3"])
       s.add_dependency(%q<terminal-table>, [">= 1.4.2"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
       s.add_dependency(%q<net-ssh>, [">= 2.0.23"])
       s.add_dependency(%q<net-scp>, [">= 1.0.4"])
       s.add_dependency(%q<builder>, [">= 2.1.2"])
       s.add_dependency(%q<treetop>, [">= 1.4.8"])
+      s.add_dependency(%q<fastthread>, [">= 1.0.7"])
     end
   else
+    s.add_dependency(%q<commander>, ["~> 4.0.3"])
+    s.add_dependency(%q<terminal-table>, ["~> 1.4.2"])
+    s.add_dependency(%q<json>, ["~> 1.4.6"])
+    s.add_dependency(%q<net-ssh>, ["~> 2.0.23"])
+    s.add_dependency(%q<net-scp>, ["~> 1.0.4"])
+    s.add_dependency(%q<builder>, ["~> 2.1.2"])
+    s.add_dependency(%q<treetop>, ["~> 1.4.8"])
+    s.add_dependency(%q<fastthread>, ["~> 1.0.7"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<xml-simple>, ["~> 1.0.12"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
-    s.add_dependency(%q<jeweler>, [">= 1.4.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.1"])
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     s.add_dependency(%q<xml-simple>, [">= 1.0.12"])
     s.add_dependency(%q<commander>, [">= 4.0.3"])
     s.add_dependency(%q<terminal-table>, [">= 1.4.2"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
     s.add_dependency(%q<net-ssh>, [">= 2.0.23"])
     s.add_dependency(%q<net-scp>, [">= 1.0.4"])
     s.add_dependency(%q<builder>, [">= 2.1.2"])
     s.add_dependency(%q<treetop>, [">= 1.4.8"])
+    s.add_dependency(%q<fastthread>, [">= 1.0.7"])
   end
 end