guard-shell 0.3.0 → 0.4.0

data/Readme.md

@@ -1,7 +1,6 @@
 # Guard::Shell
 
-This little addition to guard allows you to run shell commands when files are
-altered.
+This little guard allows you to run shell commands when files are altered.
 
 
 ## Install
@@ -23,41 +22,83 @@ And then add a basic setup to your Guardfile:
 
 ## Usage
 
-If you can do something in your shell, it is probably very easy to setup with
-guard-shell. It can take an option, `:all_on_start` which will, if set to true,
-run all tasks on start.
+If you can do something in your shell, or in ruby, you can do it when a file changes
+with guard-shell. It simply executes the block passed to watch if a change is 
+detected, and if anything is returned from the block it will be printed. For example
 
-There is also a shortcut method, `#n(msg, title='')`, which can be used to
-display a notification within your watch blocks. See the examples for usage.
+``` ruby
+guard :shell do
+  watch /.*/ do |m|
+    m[0] + " has changed."
+  end
+end
+```
 
-### Examples
+will simply print a message telling you a file has been changed when it is changed.
+This admittedly isn't a very useful example, but you hopefully get the idea. To run
+everything on start pass `:all_on_start` to `#guard`,
 
-#### Printing the Name of the File You Changed
+``` ruby
+guard :shell, :all_on_start => true do
+  # ...
+end
+```
+
+There is also a shortcut for easily creating notifications,
+
+``` ruby
+guard :shell do
+  watch /.*/ do |m|
+    n m[0], 'File Changed'
+  end
+end
+```
+
+`#n` takes up to three arguments; the first is the body of the message, here the path
+of the changed file; the second is the title for the notification; and the third is
+the image to use. There are three (four counting `nil` the default) different images
+that can be specified `:success`, `:pending` and `:failed`.
 
-    guard :shell do
-      # if the block returns something, it will be printed with `puts`
-      watch(/(.*)/) {|m| m[0] + " was just changed" }
-    end
+
+### Examples
 
 #### Saying the Name of the File You Changed and Displaying a Notification
 
-    guard :shell do
-      watch /(.*)/ do |m|
-        n m[0], 'Changed'
-        `say -v cello #{m[0]}`
-      end
-    end
+``` ruby
+guard :shell do
+  watch /(.*)/ do |m|
+    n m[0], 'Changed'
+    `say -v cello #{m[0]}`
+  end
+end
+```
 
 #### Rebuilding LaTeX
 
-    guard :shell do
-      watch /^([^\/]*)\.tex/ do |m|
-        `pdflatex -shell-escape #{m[0]}`
-        `rm #{m[1]}.log`
-
-        count = `texcount -inc -nc -1 #{m[0]}`.split('+').first
-        msg = "Built #{m[1]}.pdf (#{count} words)"
-        n msg, 'LaTeX'
-        "-> #{msg}"
-      end
+``` ruby
+guard :shell, :all_on_start => true do
+  watch /^([^\/]*)\.tex/ do |m|
+    `pdflatex -shell-escape #{m[0]}`
+    `rm #{m[1]}.log`
+
+    count = `texcount -inc -nc -1 #{m[0]}`.split('+').first
+    msg = "Built #{m[1]}.pdf (#{count} words)"
+    n msg, 'LaTeX'
+    "-> #{msg}"
+  end
+end
+```
+
+#### Check Syntax of a Ruby File
+
+``` ruby
+guard :shell do
+  watch /.*\.rb$/ do |m|
+    if system('ruby -c #{m[0]}')
+      n "#{m[0]} is correct", 'Ruby Syntax', :success
+    else
+      n "#{m[0]} is incorrect", 'Ruby Syntax', :failed
     end
+  end
+end
+```

data/lib/guard/shell.rb

@@ -5,7 +5,7 @@ require 'guard/watcher'
 module Guard
   class Shell < Guard
 
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
 
     # Calls #run_all if the :all_on_start option is present.
     def start
@@ -26,8 +26,8 @@ module Guard
 
   class Dsl
     # Easy method to display a notification
-    def n(msg, title='')
-      ::Guard::Notifier.notify(msg, :title => title)
+    def n(msg, title='', image=nil)
+      Notifier.notify(msg, :title => title, :image => image)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-shell
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000 Z
+date: 2012-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2152958780 !ruby/object:Gem::Requirement
+  requirement: &2156563560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152958780
+  version_requirements: *2156563560
 description: ! "    Guard::Shell automatically runs shell commands when watched files
   are\n    modified.\n"
 email: m@hawx.me