sshkit 0.0.5 → 0.0.6

data/.gitignore

@@ -2,3 +2,4 @@
 .yardoc
 .vagrant
 test/tmp
+Gemfile.lock

data/CHANGELOG.md

@@ -3,6 +3,35 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.6
+
+* Support arbitrary properties on Host objects. (see below)
+
+Starting with this version, the `Host` class supports arbitrary properties,
+here's a proposed use-case:
+
+    servers = %w{one.example.com two.example.com
+                 three.example.com four.example.com}.collect do |s|
+      h = SSHKit::Host.new(s)
+      if s.match /(one|two)/
+        h.properties.roles = [:web]
+      else
+        h.properties.roles = [:app]
+      end
+    end
+
+    on servers do |host|
+      if host.properties.roles.include?(:web)
+        # Do something pertinent to web servers
+      elsif host.properties.roles.include?(:app)
+        # Do something pertinent to application servers
+      end
+    end
+
+Naturally, this is a contrived example, the `#properties` attribute on the
+Host instance is implemented as an [`OpenStruct`](http://ruby-doc.org/stdlib-1.9.3/libdoc/ostruct/rdoc/OpenStruct.html) and
+will behave exactly as such.
+
 ## 0.0.5
 
 * Removed configuration option `SSHKit.config.format` (see below)

data/EXAMPLES.md

@@ -198,3 +198,29 @@ match.
 
 You might also look at `./lib/sshkit/dsl.rb` where you can see almost the
 exact code as above, which implements the `on()` method.
+
+## Use the Host properties attribute
+
+Implemented since `v0.0.6`
+
+    servers = %w{one.example.com two.example.com
+                 three.example.com four.example.com}.collect do |s|
+      h = SSHKit::Host.new(s)
+      if s.match /(one|two)/
+        h.properties.roles = [:web]
+      else
+        h.properties.roles = [:app]
+      end
+    end
+
+    on servers do |host|
+      if host.properties.roles.include?(:web)
+        # Do something pertinent to web servers
+      elsif host.properties.roles.include?(:app)
+        # Do something pertinent to application servers
+      end
+    end
+
+The `SSHKit::Host#properties` is an [`OpenStruct`](http://ruby-doc.org/stdlib-1.9.3/libdoc/ostruct/rdoc/OpenStruct.html)
+which is not verified or validated in any way, it is up to you, or your
+library to attach meanings or conventions to this mechanism.

data/README.md

@@ -181,8 +181,8 @@ should be printed.
 * No built-in way to background() something (execute and background the
   process).
 * No environment handling (sshkit might not need to care)
-* No arbitrary `Host` properties (example storing `roles` on servers, or other
-  metadata that might be useful in the `on()` block)
+* ~~No arbitrary `Host` properties (example storing `roles` on servers, or other
+  metadata that might be useful in the `on()` block)~~
 * No log/warning facility (passing Log messages to the output would work)
   A log object could be made available globally which would emit a LogMessage
   type object which would be recognised by the formatters that need to care

data/lib/sshkit/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -227,7 +227,6 @@ files:
 - EXAMPLES.md
 - FAQ.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - RELEASING.md

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sshkit (0.0.5)
-      net-ssh
-      term-ansicolor
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    ZenTest (4.6.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.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.6)
-    erubis (2.7.0)
-    ffi (1.2.0)
-    i18n (0.6.1)
-    json (1.5.4)
-    log4r (1.1.10)
-    metaclass (0.0.1)
-    minitest (2.11.3)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
-    net-scp (1.0.4)
-      net-ssh (>= 1.99.1)
-    net-ssh (2.2.2)
-    rake (10.0.3)
-    redcarpet (2.2.2)
-    term-ansicolor (1.0.7)
-    turn (0.9.6)
-      ansi
-    unindent (1.0)
-    vagrant (1.0.5)
-      archive-tar-minitar (= 0.5.2)
-      childprocess (~> 0.3.1)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6.0)
-      json (~> 1.5.1)
-      log4r (~> 1.1.9)
-      net-scp (~> 1.0.4)
-      net-ssh (~> 2.2.2)
-    yard (0.8.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autotest
-  debugger
-  minitest (>= 2.11.3, < 2.12.0)
-  mocha
-  rake
-  redcarpet
-  sshkit!
-  turn
-  unindent
-  vagrant
-  yard