guard-coffeescript 0.3.3 → 0.4.0

data/README.md

@@ -2,11 +2,12 @@
 
 ![travis-ci](http://travis-ci.org/netzpirat/guard-coffeescript.png)
 
-Guard::CoffeeScript compiles you CoffeeScripts automatically when files are modified.
+Guard::CoffeeScript compiles or validates your CoffeeScripts automatically when files are modified.
 
 Tested on MRI Ruby 1.8.7, 1.9.2 and the latest versions of JRuby & Rubinius.
 
-If you have any questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+If you have any questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
+(irc.freenode.net).
 
 ## Install
 
@@ -40,30 +41,48 @@ to install the `json` or `json_pure` gem. On Ruby 1.9, JSON is included in the s
 Guard::CoffeeScript uses [Ruby CoffeeScript](https://github.com/josh/ruby-coffee-script/) to compile the CoffeeScripts,
 that in turn uses [ExecJS](https://github.com/sstephenson/execjs) to pick the best runtime to evaluate the JavaScript.
 
-### node.js
+## Choose a runtime
+
+### CoffeeScript executable on node.js
 
 Please refer to the [CoffeeScript documentation](http://jashkenas.github.com/coffee-script/) for more information about
-how to install the latest CoffeeScript version on node.js.
+how to install the latest CoffeeScript version on [node.js](http://nodejs.org/).
 
-### JavaScript Core
+### V8 JavaScript Engine
 
-JavaScript Core is only available on Mac OS X. To use JavaScript Core you don't have to install anything, because
-JavaScript Core is packaged with Mac OS X.
+To use the [V8 JavaScript Engine](http://code.google.com/p/v8/), simple add `therubyracer` to your `Gemfile`.
+The Ruby Racer acts as a bridge between Ruby and the V8 engine, that will be automatically installed by the Ruby Racer.
 
-### V8
+```ruby
+group :development do
+  gem 'therubyracer'
+end
+```
 
-To use CoffeeScript on V8, simple add `therubyracer` to your `Gemfile`. The Ruby Racer acts as a bridge between Ruby
-and the V8 engine, that will be automatically installed by the Ruby Racer.
+Another alternative is [Mustang](https://github.com/nu7hatch/mustang), a Ruby proxy library for the awesome Google V8
+JavaScript engine. Just add `mustang` to your `Gemfile`:
 
 ```ruby
 group :development do
-  gem 'therubyracer'
+  gem 'mustang'
+end
+```
+
+### Mozilla SpiderMonkey
+
+To use [Mozilla SpiderMonkey](https://developer.mozilla.org/en/SpiderMonkey), simple add `johnson` to your `Gemfile`.
+Johnson embeds the Mozilla SpiderMonkey JavaScript runtime as a C extension.
+
+```ruby
+group :development do
+  gem 'johnson'
 end
 ```
 
 ### Mozilla Rhino
 
-If you're using JRuby, you can embed the Mozilla Rhino runtime by adding `therubyrhino` to your `Gemfile`:
+If you're using JRuby, you can embed the [Mozilla Rhino](http://www.mozilla.org/rhino/) runtime by adding `therubyrhino`
+to your `Gemfile`:
 
 ```ruby
 group :development do
@@ -71,6 +90,11 @@ group :development do
 end
 ```
 
+### Apple JavaScriptCore
+
+JavaScriptCore is only available on Mac OS X. To use JavaScript Core you don't have to install anything, because
+JavaScriptCore is packaged with Mac OS X.
+
 ### Microsoft Windows Script Host
 
 [Microsoft Windows Script Host](http://msdn.microsoft.com/en-us/library/9bbdkx3k.aspx) is available on any Microsoft
@@ -85,20 +109,44 @@ Please read the [Guard usage documentation](https://github.com/guard/guard#readm
 Guard::CoffeeScript can be adapted to all kind of projects. Please read the
 [Guard documentation](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
 
-In addition to the standard configuration, this Guard has a short notation for configure projects with a single input a output
-directory. This notation creates a watcher from the `:input` parameter that matches all CoffeeScript files under the given directory
-and you don't have to specify a watch regular expression.
-
 ### Standard Ruby gem
 
+In a custom Ruby project you want to configure your `:input` and `:output` directories.
+
 ```ruby
 guard 'coffeescript', :input => 'coffeescripts', :output => 'javascripts'
 ```
 
-### Rails 3.1 app
+If your output directory is the same as the input directory, you can simply skip it:
 
 ```ruby
-guard 'coffeescript', :input => 'app/assets/javascripts'
+guard 'coffeescript', :input => 'javascripts'
+```
+
+### Rails app with the asset pipeline
+
+With the introduction of the [asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html) in Rails 3.1 there is
+no need to compile your CoffeeScripts with this Guard. However if you like to have instant validation feedback
+(preferably with a Growl notification) directly after you save a change, then you may want still use this Guard and just
+skip the generation of the output file:
+
+```ruby
+guard 'coffeescript', :input => 'app/assets/javascripts', :noop => true
+```
+
+This give you a faster compilation feedback compared to making a subsequent request to your Rails application. If you
+just want to be notified when an error occurs you can hide the success compilation message:
+
+```ruby
+guard 'coffeescript', :input => 'app/assets/javascripts', :noop => true, :hide_success => true
+```
+
+### Rails app without the asset pipeline
+
+Without the asset pipeline you just define an input and output directory like within a normal Ruby project:
+
+```ruby
+guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts',
 ```
 
 ## Options
@@ -113,6 +161,9 @@ There following options can be passed to Guard::CoffeeScript:
 :output => 'javascripts'            # Relative path to the output directory.
                                     # default: the path given with the :input option
 
+:noop => true                       # No operation: do not write an output file.
+                                    # default: false
+
 :bare => true                       # Compile without the top-level function wrapper.
                                     # Provide either a boolean value or an Array of filenames.
                                     # default: false
@@ -124,27 +175,39 @@ There following options can be passed to Guard::CoffeeScript:
                                     # default: false
 ```
 
+### Output short notation
+
+In addition to the standard configuration, this Guard has a short notation for configure projects with a single input
+and output directory. This notation creates a watcher from the `:input` parameter that matches all CoffeeScript files
+under the given directory and you don't have to specify a watch regular expression.
+
+```ruby
+guard 'coffeescript', :input => 'javascripts'
+```
+
 ### Selective bare option
 
-The `:bare` option can take a boolean value that indicates if all scripts should be compiled without the top-level function wrapper.
+The `:bare` option can take a boolean value that indicates if all scripts should be compiled without the top-level
+function wrapper.
 
 ```ruby
 :bare => true
 ```
 
-But you can also pass an Array of filenames that should be compiled without the top-level function wrapper. The path of the file to compile is
-ignored, so the list of filenames should not contain any path information:
+But you can also pass an Array of filenames that should be compiled without the top-level function wrapper. The path of
+the file to compile is ignored, so the list of filenames should not contain any path information:
 
 ```ruby
 :bare => %w{ a.coffee b.coffee }
 ```
 
-In the above example, all `a.coffee` and `b.coffee` files will be compiled with option `:bare => true` and all other files with option `:bare => false`.
+In the above example, all `a.coffee` and `b.coffee` files will be compiled with option `:bare => true` and all other
+files with option `:bare => false`.
 
 ### Nested directories
 
-The Guard detects by default nested directories and creates these within the output directory. The detection is based on the match
-of the watch regular expression:
+The Guard detects by default nested directories and creates these within the output directory. The detection is based on
+the match of the watch regular expression:
 
 A file
 
@@ -170,11 +233,11 @@ will be compiled to
 public/javascripts/compiled/ui/buttons/toggle_button.js
 ```
 
-Note the parenthesis around the `.+\.coffee`. This enables Guard::CoffeeScript to place the full path that was matched inside the
-parenthesis into the proper output directory.
+Note the parenthesis around the `.+\.coffee`. This enables Guard::CoffeeScript to place the full path that was matched
+inside the parenthesis into the proper output directory.
 
-This behavior can be switched off by passing the option `:shallow => true` to the Guard, so that all JavaScripts will be compiled
-directly to the output directory.
+This behavior can be switched off by passing the option `:shallow => true` to the Guard, so that all JavaScripts will be
+compiled directly to the output directory.
 
 ### Multiple source directories
 
@@ -184,8 +247,8 @@ The Guard short notation
 guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts/compiled'
 ```
 
-will be internally converted into the standard notation by adding `/(.+\.coffee)` to the `input` option string and create a Watcher
-that is equivalent to:
+will be internally converted into the standard notation by adding `/(.+\.coffee)` to the `input` option string and
+create a Watcher that is equivalent to:
 
 ```ruby
 guard 'coffeescript', :output => 'public/javascripts/compiled' do
@@ -217,7 +280,8 @@ end
 
 Pull requests are very welcome! Make sure your patches are well tested.
 
-For questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
+For questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
+(irc.freenode.net).
 
 ## Contributors
 

data/lib/guard/coffeescript/runner.rb

@@ -19,7 +19,7 @@ module Guard
       private
 
         def notify_start(files, options)
-          message = options[:message] || "Compile #{ files.join(', ') }"
+          message = options[:message] || (options[:noop] ? 'Verify ' : 'Compile ') + files.join(', ')
           Formatter.info(message, :reset => true)
         end
 
@@ -32,7 +32,7 @@ module Guard
             scripts.each do |file|
               begin
                 content = compile(file, options)
-                changed_files << process_compile_result(content, file, directory)
+                changed_files << process_compile_result(content, file, directory, options)
               rescue ExecJS::ProgramError => e
                 error_message = file + ': ' + e.message.to_s
                 errors << error_message
@@ -58,10 +58,10 @@ module Guard
           file_options
         end
 
-        def process_compile_result(content, file, directory)
-          FileUtils.mkdir_p(File.expand_path(directory)) if !File.directory?(directory)
+        def process_compile_result(content, file, directory, options)
+          FileUtils.mkdir_p(File.expand_path(directory)) if !File.directory?(directory) && !options[:noop]
           filename = File.join(directory, File.basename(file.gsub(/(js\.coffee|coffee)$/, 'js')))
-          File.open(File.expand_path(filename), 'w') { |f| f.write(content) }
+          File.open(File.expand_path(filename), 'w') { |f| f.write(content) } if !options[:noop]
 
           filename
         end
@@ -89,7 +89,7 @@ module Guard
           if !errors.empty?
             Formatter.notify(errors.join("\n"), :title => 'CoffeeScript results', :image => :failed, :priority => 2)
           elsif !options[:hide_success]
-            message = "Successfully generated #{ changed_files.join(', ') }"
+            message = "Successfully #{ options[:noop] ? 'verified' : 'generated' } #{ changed_files.join(', ') }"
             Formatter.success(message)
             Formatter.notify(message, :title => 'CoffeeScript results')
           end

data/lib/guard/coffeescript/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module CoffeeScriptVersion
-    VERSION = '0.3.3'
+    VERSION = '0.4.0'
   end
 end

data/lib/guard/coffeescript.rb

@@ -15,6 +15,7 @@ module Guard
           :bare => false,
           :shallow => false,
           :hide_success => false,
+          :noop => false
       }
 
       if options[:input]
@@ -32,7 +33,7 @@ module Guard
     def run_on_change(paths)
       changed_files, success = Runner.run(Inspector.clean(paths), watchers, options)
       notify changed_files
-      
+
       success
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: guard-coffeescript
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Michael Kessler
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-17 00:00:00 +02:00
-default_executable: 
+date: 2011-09-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: guard
@@ -117,7 +116,6 @@ files:
 - lib/guard/coffeescript.rbc
 - LICENSE
 - README.md
-has_rdoc: true
 homepage: http://github.com/netzpirat/guard-coffeescript
 licenses: []
 
@@ -149,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: guard-coffeescript
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Guard gem for CoffeeScript