sshkit 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.4
+
+* Rename the ConnectionManager class to Coordinator, connections are handled
+  in the backend, if it needs to create some connections.
+
 ## 0.0.3
 
 * Refactor the runner classes into an abstract heirarchy.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sshkit (0.0.2)
+    sshkit (0.0.3)
       net-ssh
       term-ansicolor
 

data/lib/sshkit/all.rb

@@ -6,13 +6,18 @@ require_relative 'host'
 
 require_relative 'command'
 require_relative 'configuration'
-require_relative 'connection_manager'
+require_relative 'coordinator'
 
 require_relative 'formatters/abstract'
 require_relative 'formatters/black_hole'
 require_relative 'formatters/pretty'
 require_relative 'formatters/dot'
 
+require_relative 'runners/abstract'
+require_relative 'runners/sequential'
+require_relative 'runners/parallel'
+require_relative 'runners/group'
+
 require_relative 'backends/abstract'
 require_relative 'backends/printer'
 require_relative 'backends/netssh'

data/lib/sshkit/coordinator.rb

@@ -0,0 +1,38 @@
+module SSHKit
+
+  class Coordinator
+
+    attr_accessor :hosts
+
+    def initialize(raw_hosts)
+      @raw_hosts = Array(raw_hosts)
+      raise NoValidHosts unless Array(raw_hosts).any?
+      resolve_hosts!
+    end
+
+    def each(options={}, &block)
+      options = default_options.merge(options)
+      case options[:in]
+      when :parallel then Runner::Parallel
+      when :sequence then Runner::Sequential
+      when :groups   then Runner::Group
+      else
+        raise RuntimeError, "Don't know how to handle run style #{options[:in].inspect}"
+      end.new(hosts, &block).execute
+    end
+
+    private
+
+      attr_accessor :cooldown
+
+      def default_options
+        { in: :parallel }
+      end
+
+      def resolve_hosts!
+        @hosts = @raw_hosts.collect { |rh| rh.is_a?(Host) ? rh : Host.new(rh) }.uniq
+      end
+
+  end
+
+end

data/lib/sshkit/dsl.rb

@@ -5,7 +5,7 @@ module SSHKit
   module DSL
 
     def on(hosts, options={}, &block)
-      ConnectionManager.new(hosts).each(options, &block)
+      Coordinator.new(hosts).each(options, &block)
     end
 
   end

data/lib/sshkit/runners/abstract.rb

@@ -0,0 +1,24 @@
+module SSHKit
+
+  module Runner
+
+    class Abstract
+
+      attr_reader :hosts, :block
+
+      def initialize(hosts, &block)
+        @hosts       = Array(hosts)
+        @block       = block
+      end
+
+      private
+
+      def backend(host, &block)
+        SSHKit.config.backend.new(host, &block)
+      end
+
+    end
+
+  end
+
+end

data/lib/sshkit/runners/group.rb

@@ -0,0 +1,21 @@
+module SSHKit
+
+  module Runner
+
+    class Group < Sequential
+      attr_writer :group_size
+      def execute
+        hosts.each_slice(group_size).collect do |group_hosts|
+          Parallel.new(group_hosts, &block).execute
+          sleep wait_interval
+        end.flatten
+      end
+      private
+      def group_size
+        @group_size ||= 2
+      end
+    end
+
+  end
+
+end

data/lib/sshkit/{connection_manager.rb → runners/parallel.rb}

@@ -1,5 +1,3 @@
-require 'timeout'
-
 module SSHKit
 
   module Runner
@@ -64,44 +62,3 @@ module SSHKit
   end
 
 end
-
-module SSHKit
-
-  NoValidHosts = Class.new(StandardError)
-
-  class ConnectionManager
-
-    attr_accessor :hosts
-
-    def initialize(raw_hosts)
-      @raw_hosts = Array(raw_hosts)
-      raise NoValidHosts unless Array(raw_hosts).any?
-      resolve_hosts!
-    end
-
-    def each(options={}, &block)
-      options = default_options.merge(options)
-      case options[:in]
-      when :parallel then Runner::Parallel
-      when :sequence then Runner::Sequential
-      when :groups   then Runner::Group
-      else
-        raise RuntimeError, "Don't know how to handle run style #{options[:in].inspect}"
-      end.new(hosts, &block).execute
-    end
-
-    private
-
-      attr_accessor :cooldown
-
-      def default_options
-        { in: :parallel }
-      end
-
-      def resolve_hosts!
-        @hosts = @raw_hosts.collect { |rh| rh.is_a?(Host) ? rh : Host.new(rh) }.uniq
-      end
-
-  end
-
-end

data/lib/sshkit/runners/sequential.rb

@@ -0,0 +1,21 @@
+module SSHKit
+
+  module Runner
+
+    class Sequential < Abstract
+      attr_writer :wait_interval
+      def execute
+        hosts.each do |host|
+          backend(host, &block).run
+          sleep wait_interval
+        end
+      end
+      private
+      def wait_interval
+        @wait_interval ||= 2
+      end
+    end
+
+  end
+
+end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/functional/{test_connection_manager.rb → test_coordinator.rb}

@@ -2,7 +2,7 @@ require 'helper'
 
 module SSHKit
 
-  class TestConnectionManager < FunctionalTest
+  class TestCoordinator < FunctionalTest
 
     def setup
 

data/test/unit/{test_connection_manager.rb → test_coordinator.rb}

@@ -3,7 +3,7 @@ require 'helper'
 
 module SSHKit
 
-  class TestConnectionManager < UnitTest
+  class TestCoordinator < UnitTest
 
     def setup
       @s = String.new
@@ -23,17 +23,17 @@ module SSHKit
     def test_connection_manager_handles_a_single_argument
       h = Host.new('1.example.com')
       Host.expects(:new).with('1.example.com').once().returns(h)
-      ConnectionManager.new '1.example.com'
+      Coordinator.new '1.example.com'
     end
 
     def test_connection_manager_resolves_hosts
       h = Host.new('n.example.com')
       Host.expects(:new).times(3).returns(h)
-      ConnectionManager.new %w{1.example.com 2.example.com 3.example.com}
+      Coordinator.new %w{1.example.com 2.example.com 3.example.com}
     end
 
     def test_connection_manager_removes_duplicates_after_resolving_hosts
-      cm = ConnectionManager.new %w{user@1.example.com:22 user@1.example.com}
+      cm = Coordinator.new %w{user@1.example.com:22 user@1.example.com}
       assert_equal ['user@1.example.com:22'], cm.hosts.map(&:to_s)
     end
 
@@ -43,7 +43,7 @@ module SSHKit
       end
       String.new.tap do |str|
         SSHKit.capture_output str do
-          ConnectionManager.new(%w{1.example.com}).each &spy
+          Coordinator.new(%w{1.example.com}).each &spy
         end
         assert_equal "echo 1.example.com", str.strip
       end
@@ -51,7 +51,7 @@ module SSHKit
 
     def test_the_connection_manaager_runs_things_in_parallel_by_default
       SSHKit.capture_output @s do
-        ConnectionManager.new(%w{1.example.com 2.example.com}).each &block_to_run
+        Coordinator.new(%w{1.example.com 2.example.com}).each &block_to_run
       end
       assert_equal 2, results.length
       assert_equal *results.map(&:to_i)
@@ -59,7 +59,7 @@ module SSHKit
 
     def test_the_connection_manager_can_run_things_in_sequence
       SSHKit.capture_output @s do
-        ConnectionManager.new(%w{1.example.com 2.example.com}).each in: :sequence, &block_to_run
+        Coordinator.new(%w{1.example.com 2.example.com}).each in: :sequence, &block_to_run
       end
       assert_equal 2, results.length
       assert_operator results.first.to_i, :<, results.last.to_i
@@ -67,7 +67,7 @@ module SSHKit
 
     def test_the_connection_manager_can_run_things_in_groups
       SSHKit.capture_output @s do
-        ConnectionManager.new(%w{1.example.com 2.example.com 3.example.com
+        Coordinator.new(%w{1.example.com 2.example.com 3.example.com
                                  4.example.com 5.example.com 6.example.com}).each in: :groups, &block_to_run
       end
       assert_equal 6, results.length

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -245,16 +245,20 @@ files:
 - lib/sshkit/backends/printer.rb
 - lib/sshkit/command.rb
 - lib/sshkit/configuration.rb
-- lib/sshkit/connection_manager.rb
+- lib/sshkit/coordinator.rb
 - lib/sshkit/dsl.rb
 - lib/sshkit/formatters/abstract.rb
 - lib/sshkit/formatters/black_hole.rb
 - lib/sshkit/formatters/dot.rb
 - lib/sshkit/formatters/pretty.rb
 - lib/sshkit/host.rb
+- lib/sshkit/runners/abstract.rb
+- lib/sshkit/runners/group.rb
+- lib/sshkit/runners/parallel.rb
+- lib/sshkit/runners/sequential.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec
-- test/functional/test_connection_manager.rb
+- test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
 - test/integration/backends/test_netssh.rb
@@ -263,7 +267,7 @@ files:
 - test/unit/core_ext/test_string.rb
 - test/unit/test_command.rb
 - test/unit/test_configuration.rb
-- test/unit/test_connection_manager.rb
+- test/unit/test_coordinator.rb
 - test/unit/test_host.rb
 homepage: http://wacku.github.com/sshkit
 licenses: []
@@ -290,7 +294,7 @@ signing_key:
 specification_version: 3
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby
 test_files:
-- test/functional/test_connection_manager.rb
+- test/functional/test_coordinator.rb
 - test/functional/test_ssh_server_comes_up_for_functional_tests.rb
 - test/helper.rb
 - test/integration/backends/test_netssh.rb
@@ -299,6 +303,6 @@ test_files:
 - test/unit/core_ext/test_string.rb
 - test/unit/test_command.rb
 - test/unit/test_configuration.rb
-- test/unit/test_connection_manager.rb
+- test/unit/test_coordinator.rb
 - test/unit/test_host.rb
 has_rdoc: