sshkit 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,8 +1,38 @@
-## Changelog
+## Changelog
 
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.5
+
+* Removed configuration option `SSHKit.config.format` (see below)
+* Removed configuration option `SSHKit.config.runner` (see below)
+
+The format should now be set by doing:
+
+    SSHKit.config.output = File.open('/dev/null')
+    SSHKit.config.output = MyFormatterClass.new($stdout)
+
+The library ships with three formatters, `BlackHole`, `Dot` and `Pretty`.
+
+The default is `Pretty`, but can easily be changed:
+
+    SSHKit.config.output = SSHKit::Formatter::Pretty.new($stdout)
+    SSHKit.config.output = SSHKit::Formatter::Dot.new($stdout)
+    SSHKit.config.output = SSHKit::Formatter::BlackHole.new($stdout)
+
+The one and only argument to the formatter is the *String/StringIO*ish object
+to which the output should be sent. (It should be possible to stack
+formatters, or build a multi-formatter to log, and stream to the screen, for
+example)
+
+The *runner* is now set by `default_options` on the Coordinator class. The
+default is still *:parallel*, and can be overridden on the `on()` (or
+`Coordinator#each`) calls directly.
+
+There is no global way to change the runner style for all `on()` calls as of
+version `0.0.5`.
+
 ## 0.0.4
 
 * Rename the ConnectionManager class to Coordinator, connections are handled

data/EXAMPLES.md

@@ -165,3 +165,36 @@ An extension of the behaviour above, if you write a command like this:
 **Note:** The logic which reformats the script into a oneliner may be naïve, but in all
 known test cases, it works. The key thing is that `if` is not mapped to
 `/usr/bin/env if`, which would break with a syntax error.
+
+## Using with Rake
+
+Into the `Rakefile` simply put something like:
+
+    require 'sshkit/dsl'
+
+    SSHKit.config.command_map[:rake] = "./bin/rake"
+
+    desc "Deploy the site, pulls from Git, migrate the db and precompile assets, then restart Passenger."
+    task :deploy do
+      on "example.com" do |host|
+        within "/opt/sites/example.com" do
+          execute :git, :pull
+          execute :bundle, :install, '--deployment'
+          execute :rake, 'db:migrate'
+          execute :rake, 'assets:precompile'
+          execute :touch, 'tmp/restart.txt'
+        end
+      end
+    end
+
+## Using without the DSL
+
+The *Coordinator* will resolve all hosts into *Host* objects, you can mix and
+match.
+
+    Coordinator.new("one.example.com", SSHKit::Host.new('two.example.com')).each in: :sequence do
+      puts capture :uptime
+    end
+
+You might also look at `./lib/sshkit/dsl.rb` where you can see almost the
+exact code as above, which implements the `on()` method.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sshkit (0.0.3)
+    sshkit (0.0.5)
       net-ssh
       term-ansicolor
 
@@ -9,20 +9,20 @@ GEM
   remote: http://rubygems.org/
   specs:
     ZenTest (4.6.2)
-    ansi (1.4.2)
+    ansi (1.4.3)
     archive-tar-minitar (0.5.2)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     childprocess (0.3.6)
       ffi (~> 1.0, >= 1.0.6)
     columnize (0.3.6)
-    debugger (1.2.2)
+    debugger (1.2.3)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.1.1)
       debugger-ruby_core_source (~> 1.1.5)
     debugger-linecache (1.1.2)
       debugger-ruby_core_source (>= 1.1.1)
-    debugger-ruby_core_source (1.1.5)
+    debugger-ruby_core_source (1.1.6)
     erubis (2.7.0)
     ffi (1.2.0)
     i18n (0.6.1)
@@ -38,7 +38,7 @@ GEM
     rake (10.0.3)
     redcarpet (2.2.2)
     term-ansicolor (1.0.7)
-    turn (0.9.3)
+    turn (0.9.6)
       ansi
     unindent (1.0)
     vagrant (1.0.5)

data/README.md

@@ -3,6 +3,9 @@
 **SSHKit** is a toolkit for running commands in a structured way on one or
 more servers.
 
+[![Build Status](https://travis-ci.org/wacku/sshkit.png?branch=master)](https://travis-ci.org/wacku/sshkit)
+[![Dependency Status](https://gemnasium.com/wacku/sshkit.png)](https://gemnasium.com/wacku/sshkit)
+
 ## How might it work?
 
 The typical use-case looks something like this:

data/lib/sshkit/configuration.rb

@@ -3,12 +3,10 @@ module SSHKit
   class Configuration
 
     attr_writer :command_map
-    attr_accessor :output, :format, :runner, :backend
+    attr_accessor :output, :backend
 
     def initialize
-      @output  = $stdout
-      @format  = :dot
-      @runner  = :parallel
+      @output  = SSHKit::Formatter::Pretty.new($stdout)
       @backend = SSHKit::Backend::Netssh
     end
 

data/lib/sshkit/host.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module SSHKit
 
   UnparsableHostStringError = Class.new(StandardError)
@@ -48,6 +50,10 @@ module SSHKit
       sprintf("%s@%s:%d", username, hostname, port)
     end
 
+    def properties
+      @properties ||= OpenStruct.new
+    end
+
   end
 
   # @private

data/lib/sshkit/version.rb

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

data/test/unit/backends/test_printer.rb

@@ -27,12 +27,10 @@ module SSHKit
       end
 
       def test_simple_printing
-        sio = StringIO.new
-        SSHKit.capture_output(sio) do
+        result = String.new
+        SSHKit.capture_output(result) do
           printer.run
         end
-        sio.rewind
-        result = sio.read
         assert_equal <<-EOEXPECTED.unindent, result
           if test ! -d /opt/sites/example.com; then echo "Directory does not exist '/opt/sites/example.com'" 1>&2; false; fi
           cd /opt/sites/example.com && /usr/bin/env date

data/test/unit/test_configuration.rb

@@ -10,23 +10,11 @@ module SSHKit
     end
 
     def test_output
-      assert_equal $stdout, SSHKit.config.output
+      assert SSHKit.config.output.is_a? SSHKit::Formatter::Pretty
       assert SSHKit.config.output = $stderr
       assert_equal $stderr, SSHKit.config.output
     end
 
-    def test_runner
-      assert_equal :parallel, SSHKit.config.runner
-      assert SSHKit.config.runner = :sequence
-      assert_equal :sequence, SSHKit.config.runner
-    end
-
-    def test_format
-      assert_equal :dot, SSHKit.config.format
-      assert SSHKit.config.format = :pretty
-      assert_equal :pretty, SSHKit.config.format
-    end
-
     def test_backend
       assert_equal SSHKit::Backend::Netssh, SSHKit.config.backend
       assert SSHKit.config.backend = SSHKit::Backend::Printer

data/test/unit/test_host.rb

@@ -60,6 +60,13 @@ module SSHKit
       assert Host.new('example.com').equal? Host.new('example.com')
     end
 
+    def test_arbitrary_host_properties
+      h = Host.new('example.com')
+      assert_equal nil, h.properties.roles
+      assert h.properties.roles = [:web, :app]
+      assert_equal [:web, :app], h.properties.roles
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -235,7 +235,6 @@ files:
 - Vagrantfile
 - assets/images/example_output.png
 - assets/images/logo.png
-- example.rb
 - lib/core_ext/array.rb
 - lib/core_ext/hash.rb
 - lib/sshkit.rb

data/example.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-
-# Ruby 1.9 doesn't include the current
-# working directory on the load path.
-$: << Dir.pwd + '/lib/'
-
-# Automatically sucks in the `sshkit`
-# files so that you don't need to.
-require 'sshkit/dsl'
-
-directory = '/opt/sites/web_application'
-hosts     = SSHKit::Host.new("root@example.com")
-
-SSHKit.config.output = SSHKit::Formatter::Pretty.new($stdout)
-
-on hosts do |host|
-  target = '/opt/rack-rack-repository'
-  if host.hostname =~ /seven/
-    target = '/var/rack-rack-repository'
-  end
-  if execute(:test, "-d #{target}")
-    within target do
-      execute :git, :pull
-    end
-  else
-    execute :git, :clone, 'git://github.com/rack/rack.git', target
-  end
-end