Shorty 0.3.0 → 0.3.1

data/README.md

@@ -76,6 +76,58 @@ In your shell:
 
     Shorty ~/uptime.rb
 
+Usage: Best Practices
+-----
+
+You are not allowed to pass arguments to :run calls:
+
+    # Not possible:
+    run :ssh, :restart, "my arg"
+
+This is intentional. You want to put all logic in a separate class/object.
+For example, let's say you use a different command for SSH start and restart
+depending on the OS. In your Ruby file, you put:
+
+    require "./My_SSH"
+    add :ssh, My_SSH
+    run :ssh, :start
+
+In a separate file, `My_SSH.rb`:
+
+    require "ohai"
+
+    O = Ohai::System.new
+    O.require_plugin "linux/platform"
+    
+    class My_SSH
+      class << self
+      
+        def start
+          case O[:platform]
+          when "ubuntu"
+            "service ssh start"
+          when ...
+            ....
+          end
+        end
+        
+      end
+    end
+
+If :run allowed arguments, you would be very tempted to 
+write Shorty/Ruby code with lots of mixed in logic:
+
+    if O[:platform] == 'ubuntu'
+      run :ssh, :restart, "sudo service ssh restart"
+    else
+      run :ssh, :restart, "some_program sshd start -now"
+    end
+
+In summary: 
+
+* Write short lines of Shorty/Ruby code.
+* Hide complicated logic in separate Ruby classes and objects.
+
 Run Tests
 ---------
 

data/Shorty.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'Bacon_Colored'
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'Exit_Zero'
+  s.add_development_dependency 'Exit_0'
   
   # Specify any dependencies here; for example:
   # s.add_runtime_dependency 'rest-client'

data/lib/Shorty/version.rb

@@ -1,3 +1,3 @@
 class Shorty
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/main.rb

@@ -3,7 +3,7 @@ require File.expand_path('spec/helper')
 require 'Shorty'
 require 'Bacon_Colored'
 require 'pry'
-require 'Exit_Zero'
+require 'Exit_0'
 
 
 # ======== Include the tests.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Shorty
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000 Z
+date: 2012-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: Exit_Zero
+  name: Exit_0
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A DSL to add before/after hooks to method calls.