guard-coffeescript 0.5.2 → 0.5.3

data/README.md

@@ -1,27 +1,30 @@
 # Guard::CoffeeScript [![Build Status](https://secure.travis-ci.org/netzpirat/guard-coffeescript.png)](http://travis-ci.org/netzpirat/guard-coffeescript)
 
 Guard::CoffeeScript compiles or validates your CoffeeScripts automatically when files are modified.
+If you're looking for a CoffeeScript merge tool, please checkout [Guard::CoffeeDripper](https://github.com/guard/guard-coffeedripper).
 
-Tested on MRI Ruby 1.8.7, 1.9.2, REE and the latest versions of JRuby & Rubinius.
+Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE 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).
 
 ## Install
 
-Please be sure to have [Guard](https://github.com/guard/guard) installed.
+The simplest way to install Guard is to use [Bundler](http://gembundler.com/).
+Please make sure to have [Guard](https://github.com/guard/guard) installed.
 
-Install the gem:
+Add Guard::Coffeescript to your `Gemfile`:
 
-    $ gem install guard-coffeescript
+```ruby
+group :development do
+  gem 'guard-coffeescript'
+end
+```
+Add the default Guard::Coffeescript template to your `Guardfile` by running:
 
-Add it to your `Gemfile`, preferably inside the development group:
-
-    gem 'guard-coffeescript'
-
-Add guard definition to your `Guardfile` by running this command:
-
-    $ guard init coffeescript
+```bash
+$ guard init coffeescript
+```
 
 ## JSON
 
@@ -54,34 +57,42 @@ install the [executable](http://www.nodejs.org/#download).
 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.
 
-    group :development do
-      gem 'therubyracer'
-    end
+```ruby
+group :development do
+  gem 'therubyracer'
+end
+```
 
 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`:
 
-    group :development do
-      gem 'mustang'
-    end
+```ruby
+group :development do
+  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.
 
-    group :development do
-      gem 'johnson'
-    end
+```ruby
+group :development do
+  gem 'johnson'
+end
+```
 
 ### Mozilla Rhino
 
 If you're using JRuby, you can embed the [Mozilla Rhino](http://www.mozilla.org/rhino/) runtime by adding `therubyrhino`
 to your `Gemfile`:
 
-    group :development do
-      gem 'therubyrhino'
-    end
+```ruby
+group :development do
+  gem 'therubyrhino'
+end
+```
 
 ### Apple JavaScriptCore
 
@@ -107,11 +118,15 @@ Guard::CoffeeScript can be adapted to all kind of projects. Please read the
 
 In a Ruby project you want to configure your input and output directories.
 
-    guard 'coffeescript', :input => 'coffeescripts', :output => 'javascripts'
+```ruby
+guard 'coffeescript', :input => 'coffeescripts', :output => 'javascripts'
+```
 
 If your output directory is the same as the input directory, you can simply skip it:
 
-    guard 'coffeescript', :input => 'javascripts'
+```ruby
+guard 'coffeescript', :input => 'javascripts'
+```
 
 ### Rails app with the asset pipeline
 
@@ -122,45 +137,53 @@ However, if you would still like to have feedback on the validation of your Coff
 (preferably with a Growl notification) directly after you save a change, then you can still
 use this Guard and simply skip generation of the output file:
 
-    guard 'coffeescript', :input => 'app/assets/javascripts', :noop => true
+```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:
 
-    guard 'coffeescript', :input => 'app/assets/javascripts', :noop => true, :hide_success => true
+```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:
 
-    guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts'
+```ruby
+guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts'
+```
 
 ## Options
 
 There following options can be passed to Guard::CoffeeScript:
 
-    :input => 'coffeescripts'           # Relative path to the input directory.
-                                        # A suffix `/(.+\.coffee)` will be added to this option.
-                                        # default: nil
+```ruby
+:input => 'coffeescripts'           # Relative path to the input directory.
+                                    # A suffix `/(.+\.coffee)` will be added to this option.
+                                    # default: nil
 
-    :output => 'javascripts'            # Relative path to the output directory.
-                                        # default: the path given with the :input option
+: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
+: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
+:bare => true                       # Compile without the top-level function wrapper.
+                                    # Provide either a boolean value or an Array of filenames.
+                                    # default: false
 
-    :shallow => true                    # Do not create nested output directories.
-                                        # default: false
+:shallow => true                    # Do not create nested output directories.
+                                    # default: false
 
-    :hide_success => true               # Disable successful compilation messages.
-                                        # default: false
+:hide_success => true               # Disable successful compilation messages.
+                                    # default: false
 
-    :all_on_start => true               # Regenerate all files on startup
-                                        # default: false
+:all_on_start => true               # Regenerate all files on startup
+                                    # default: false
+```
 
 ### Output short notation
 
@@ -168,19 +191,25 @@ In addition to the standard configuration, this Guard has a short notation for c
 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.
 
-    guard 'coffeescript', :input => 'javascripts'
+```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.
 
-    :bare => true
+```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:
 
-    :bare => %w{ a.coffee b.coffee }
+```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`.
@@ -192,19 +221,27 @@ the match of the watch regular expression:
 
 A file
 
-    /app/coffeescripts/ui/buttons/toggle_button.coffee
+```ruby
+/app/coffeescripts/ui/buttons/toggle_button.coffee
+```
 
 that has been detected by the watch
 
-    watch(%r{^app/coffeescripts/(.+\.coffee)$})
+```ruby
+watch(%r{^app/coffeescripts/(.+\.coffee)$})
+```
 
 with an output directory of
 
-    :output => 'public/javascripts/compiled'
+```ruby
+:output => 'public/javascripts/compiled'
+```
 
 will be compiled to
 
-    public/javascripts/compiled/ui/buttons/toggle_button.js
+```ruby
+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.
@@ -216,43 +253,66 @@ compiled directly to the output directory.
 
 The Guard short notation
 
-    guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts/compiled'
+```ruby
+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:
 
-    guard 'coffeescript', :output => 'public/javascripts/compiled' do
-      watch(%r{^app/coffeescripts/(.+\.coffee)$})
-    end
+```ruby
+guard 'coffeescript', :output => 'public/javascripts/compiled' do
+  watch(%r{^app/coffeescripts/(.+\.coffee)$})
+end
+```
 
 To add a second source directory that will be compiled to the same output directory, just add another watcher:
 
-    guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts/compiled' do
-      watch(%r{lib/coffeescripts/(.+\.coffee)})
-    end
+```ruby
+guard 'coffeescript', :input => 'app/coffeescripts', :output => 'public/javascripts/compiled' do
+  watch(%r{lib/coffeescripts/(.+\.coffee)})
+end
+```
 
 which is equivalent to:
 
-    guard 'coffeescript', :output => 'public/javascripts/compiled' do
-      watch(%r{app/coffeescripts/(.+\.coffee)})
-      watch(%r{lib/coffeescripts/(.+\.coffee)})
-    end
+```ruby
+guard 'coffeescript', :output => 'public/javascripts/compiled' do
+  watch(%r{app/coffeescripts/(.+\.coffee)})
+  watch(%r{lib/coffeescripts/(.+\.coffee)})
+end
+```
+
+## Issues
+
+You can report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-coffeescript/issues). Try to figure out
+where the issue belongs to: Is it an issue with Guard itself or with a Guard::Cucumber? Please don't
+ask question in the issue tracker, instead join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
+
+When you file an issue, please try to follow to these simple rules if applicable:
+
+* Make sure you run Guard with `bundle exec` first.
+* Add debug information to the issue by running Guard with the `--debug` option.
+* Add your `Guardfile` and `Gemfile` to the issue.
+* Make sure that the issue is reproducible with your description.
 
 ## Development
 
 - Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-coffeescript/master/frames).
 - Source hosted at [GitHub](https://github.com/netzpirat/guard-coffeescript).
-- Report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-coffeescript/issues).
 
-Pull requests are very welcome! Please try to follow these simple "rules", though:
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
 
-- Please create a topic branch for every separate change you make.
-- Make sure your patches are well tested.
-- Update the README (if applicable).
-- Please **do not change** the version number.
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested.
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the README.
+* Update the CHANGELOG for noteworthy changes.
+* Please **do not change** the version number.
 
-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 in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
 
 ## Contributors
 
@@ -260,17 +320,16 @@ For questions please join us on our [Google group](http://groups.google.com/grou
 * [Andrew Assarattanakul](https://github.com/vizjerai)
 * [Elijah Miller](https://github.com/jqr)
 * [Jeremy Raines](https://github.com/jraines)
+* [JT](https://github.com/jtolds)
 * [Patrick Ewing](https://github.com/hoverbird)
 
 ## Acknowledgment
 
-[Jeremy Ashkenas](http://twitter.com/#!/jashkenas) for [CoffeeScript](http://jashkenas.github.com/coffee-script/),
+* [Jeremy Ashkenas](http://twitter.com/#!/jashkenas) for [CoffeeScript](http://jashkenas.github.com/coffee-script/),
 that little language that compiles into JavaScript and makes me enjoy the frontend.
-
-The [Guard Team](https://github.com/guard/guard/contributors) for giving us such a nice piece of software
+* The [Guard Team](https://github.com/guard/guard/contributors) for giving us such a nice piece of software
 that is so easy to extend, one *has* to make a plugin for it!
-
-All the authors of the numerous [Guards](https://github.com/guard) available for making the Guard ecosystem
+* All the authors of the numerous [Guards](https://github.com/guard) available for making the Guard ecosystem
 so much growing and comprehensive.
 
 ## License
@@ -297,4 +356,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/lib/guard/coffeescript/inspector.rb

@@ -16,9 +16,7 @@ module Guard
         def clean(paths)
           paths.uniq!
           paths.compact!
-          paths = paths.select { |p| coffee_file?(p) }
-          clear_coffee_files_list
-          paths
+          paths.select { |p| coffee_file?(p) }
         end
 
         private
@@ -29,23 +27,7 @@ module Guard
         # @return [Boolean] when the file valid
         #
         def coffee_file?(path)
-          coffee_files.include?(path)
-        end
-
-        # Scans the project and keeps a list of all
-        # CoffeeScript files.
-        #
-        # @see #clear_coffee_files_list
-        # @return [Array<String>] the valid files
-        #
-        def coffee_files
-          @coffee_files ||= Dir.glob('**/*.coffee')
-        end
-
-        # Clears the list of CoffeeScript files in this project.
-        #
-        def clear_coffee_files_list
-          @coffee_files = nil
+          path =~ /.coffee$/ && File.exists?(path)
         end
 
       end

data/lib/guard/coffeescript/version.rb

@@ -1,6 +1,6 @@
 module Guard
   module CoffeeScriptVersion
     # Guard::CoffeeScript version that is used for the Gem specification
-    VERSION = '0.5.2'
+    VERSION = '0.5.3'
   end
 end

data/lib/guard/coffeescript.rb

@@ -58,7 +58,7 @@ module Guard
     # @raise [:task_has_failed] when stop has failed
     #
     def run_all
-      run_on_change(Watcher.match_files(self, Dir.glob(File.join('**', '*.coffee'))))
+      run_on_change(Watcher.match_files(self, Dir.glob('**{,/*/**}/*.coffee')))
     end
 
     # Gets called when watched paths and files have changes.

metadata

@@ -1,188 +1,132 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guard-coffeescript
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 0.5.3
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 2
-  version: 0.5.2
 platform: ruby
-authors: 
+authors:
 - Michael Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70134895411600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 8
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.8.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: coffee-script
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70134895411600
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: &70134895409900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 2
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.2.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70134895409900
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70134895407560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: guard-rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70134895407560
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70134895405620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70134895405620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70134895404440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.7'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70134895404440
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70134895400860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 7
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.7.2
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: kramdown
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70134895400860
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70134895397000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 45
-        segments: 
-        - 0
-        - 13
-        - 3
-        version: 0.13.3
+      - !ruby/object:Gem::Version
+        version: 1.17.2
   type: :development
-  version_requirements: *id007
-description: Guard::CoffeeScript automatically generates your JavaScripts from your CoffeeScripts
-email: 
+  prerelease: false
+  version_requirements: *70134895397000
+description: Guard::CoffeeScript automatically generates your JavaScripts from your
+  CoffeeScripts
+email:
 - michi@netzpiraten.ch
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/guard/coffeescript/formatter.rb
-- lib/guard/coffeescript/formatter.rbc
 - lib/guard/coffeescript/inspector.rb
-- lib/guard/coffeescript/inspector.rbc
 - lib/guard/coffeescript/runner.rb
-- lib/guard/coffeescript/runner.rbc
 - lib/guard/coffeescript/templates/Guardfile
 - lib/guard/coffeescript/version.rb
-- lib/guard/coffeescript/version.rbc
 - lib/guard/coffeescript.rb
-- lib/guard/coffeescript.rbc
 - LICENSE
 - README.md
 homepage: http://github.com/netzpirat/guard-coffeescript
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: guard-coffeescript
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Guard gem for CoffeeScript
 test_files: []
-
+has_rdoc: