guard-sass 0.3.2 → 0.3.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Joshua Hawxwell
+Copyright (c) 2010 - 2011 Joshua Hawxwell
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,10 +1,12 @@
 # Guard-Sass
 
-guard-sass compiles your sass (and scss) files automatically when changed.
+guard-sass compiles or validates your sass (and scss) files automatically when 
+changed.
 
 ## Install
 
-You will need to have [guard](http://github.com/guard/guard) to continue, so install it now!.
+You will need to have [guard](http://github.com/guard/guard) to continue, so 
+install it now!
 
 Install the gem with:
 
@@ -18,30 +20,102 @@ And finally add a basic setup to your Guardfile with:
 
     guard init sass
 
-
 ## Usage
 
+Please read the [Guard usage documentation][gdoc].
+
+## Guardfile
+
+guard-sass can be adapted to all kind of projects. Please read the
+[Guard documentation][gdoc] for more information about the Guardfile DSL.
+
+### Ruby project
+
+In a Ruby project you want to configure your input and output directories.
+
 ```ruby
-guard 'sass' do
-  watch(%r{^sass/(.+\.s[ac]ss)})
-end
+guard 'sass', :input => 'sass', :output => 'styles'
 ```
 
-Defaults to writing to 'css/' but this can be changed by setting the output option
+If your output directory is the same as the input directory, you can simply skip it:
 
 ```ruby
-guard 'sass', :output => 'styles' do
-  watch(%r{^sass/(.+\.s[ac]ss)})
-end
+guard 'sass', :input => 'styles'
+```
+
+### Rails app with the asset pipeline
+
+With the introduction of the [asset pipeline][rpipe] in Rails 3.1 there is no 
+need to compile your Sass stylesheets with this Guard. However, if you would 
+still like to have feedback on the validation of your stylesheets (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:
+
+```ruby
+guard 'sass', :input => 'app/assets/stylesheets', :noop => true
+```
+
+This gives you (almost) immediate feedback on whether the changes made are valid, 
+and is much faster than 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 'sass', 
+  :input => 'app/assets/stylesheets', 
+  :noop => true, 
+  :hide_success => true
 ```
 
-By default a file such as `sass/forms/buttons.sass` with the above guard file would be
-output to `styles/forms/buttons.css` because `forms` would be matched with the parentheses.
-This can be disabled by passing `:shallow => true` so that it would be written to
-`styles/buttons.css` instead.
+### Rails app without the asset pipeline
+
+Without the asset pipeline you just define an input and output directory as in
+a normal Ruby project:
+
+```ruby
+guard 'sass', :input => 'app/stylesheets', :output => 'public/stylesheets'
+```
+
+## Options
 
-guard-sass also has a short notation like [guard-coffeescript][gcs], this let's you define
-an input folder (with an optional output folder) and the watcher is defined for you.
+The following options can be passed to guard-sass:
+
+```ruby
+:input => 'sass'                    # Relative path to the input directory.
+                                    # A suffix `/(.+\.s[ac]ss)` will be added to this option.
+                                    # default: nil
+
+:output => 'css'                    # Relative path to the output directory.
+                                    # default: 'css' or the :input option when supplied
+
+:notification => false              # Whether to display success and error notifications.
+                                    # default: true
+
+:hide_success => true               # Disable successful compilation messages.
+                                    # default: false
+
+:shallow => true                    # Do not create nested output directories.
+                                    # default: false
+
+:style => :nested                   # Controls the output style. Accepted options are :nested, 
+                                    # :compact, :compressed and :expanded
+                                    # default: :nested
+
+:load_paths => ['sass/partials']    # Paths for sass to find imported sass files from.
+                                    # default: all directories under current
+
+:noop => true                       # No operation: Do not write output file
+                                    # default: false
+
+:debug_info_ => true                # File and line number info for FireSass.
+                                    # default: false
+```
+
+### Output short notation
+
+guard-sass also has a short notation like [guard-coffeescript][gcs], this lets 
+you define an input folder (with an optional output folder) automatically creating
+the required watcher.
 
 ```ruby
 guard 'sass', :input => 'sass', :output => 'styles'
@@ -49,7 +123,7 @@ guard 'sass', :input => 'sass', :output => 'styles'
 guard 'sass', :input => 'stylesheets'
 ```
 
-These are equivelant to
+These are equivalent to
 
 ```ruby
 guard 'sass', :output => 'styles' do
@@ -61,25 +135,91 @@ guard 'sass' do
 end
 ```
 
+### Nested directories
 
-## Options
+By default the guard detects nested directories and writes files into the output
+directory with the same structure.
+
+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
+
+```
+/app/stylesheets/form/button.sass
+```
+
+that has been detected by the watch
+
+```ruby
+watch(%r{^app/stylesheets/(.+\.s[ac]ss)$})
+```
+
+with an output directory of
 
 ```ruby
-:input => 'sass'                    # Relative path to the input directory
-:output => 'css'                    # Relative path to the output directory
-:notification => false              # Whether to display notifications after finished,
-                                    #  default: true
-:shallow => true                    # Whether to output nested directories or just put css
-                                    #  directly in output folder, default: false
-:style => :nested                   # Controls the output style, by default :nested
-                                    #  accepted options are :nested, :compact, :compressed and :expanded
-:load_paths => ['sass/partials']    # Paths for sass to find imported sass files from,
-                                    #  default: all directories under current
-:debug_info_ => true                # File and line number info for FireSass, default: false
+:output => 'public/stylesheets'
 ```
 
+will be compiled to
+
+```
+public/stylesheets/form/button.css
+```
+
+Note the parenthesis around `.+\.s[ac]ss`. This enables guard-sass to place 
+the full path that was matched inside the parenthesis into the proper output directory.
+
+This behaviour can be switched off by passing the option `:shallow => true` to the 
+Guard, so that all stylesheets will be compiled directly to the output directory.
+So the previous example would have compiled to `public/stylesheets/button.css`.
+
+## Development
+
+- Source hosted at [GitHub](https://github.com/hawx/guard-sass)
+- Report issues and feature requests to [GitHub Issues][issues]
+
+Pull requests are very welcome!
+
+For questions please join us on our [Google group][ggroup] or
+on `#guard` (irc.freenode.net).
+
+## Contributors
+
+Have a look at the [GitHub contributor][contrib] list to see all contributors.
+
+Since this Guard is very close to [guard-coffeescript][gcs], some features have been 
+incorporated into guard-sass.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2010 - 2011 Joshua Hawxwell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-## [Contributors](https://github.com/hawx/guard-sass/contributors)
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+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.
 
 
-[gcs]: http://github.com/netzpirat/guard-coffeescript "guard-coffeescript"
+[gcs]:     http://github.com/netzpirat/guard-coffeescript
+[gdoc]:    http://github.com/guard/guard#readme
+[rpipe]:   http://guides.rubyonrails.org/asset_pipeline.html
+[issues]:  http://github.com/hawx/guard-sass/issues
+[ggroup]:  http://groups.google.com/group/guard-dev
+[contrib]: http://github.com/hawx/guard-sass/contributors

data/lib/guard/sass/version.rb

@@ -1,5 +1,5 @@
 module Guard
   class SassVersion
-    VERSION = '0.3.2'
+    VERSION = '0.3.3'
   end
 end

data/lib/guard/sass.rb

@@ -6,33 +6,34 @@ require 'sass'
 
 module Guard
   class Sass < Guard
-  
+
     DEFAULTS = {
-      :output => 'css',              # Output directory
-      :notification => true,         # Enable notifications?
-      :shallow  => false,            # Output nested directories?
-      :style => :nested,             # Nested output
-      :debug_info => false,          # File and line number info for FireSass
-      :load_paths => Dir.glob('**/**').find_all {|i| File.directory?(i) }
+      :output       => 'css',     # Output directory
+      :notification => true,      # Enable notifications?
+      :shallow      => false,     # Output nested directories?
+      :style        => :nested,   # Nested output
+      :debug_info   => false,     # File and line number info for FireSass
+      :noop         => false,     # Do no write output file
+      :hide_success => false,     # Do not show success message
+      :load_paths   => Dir.glob('**/**').find_all {|i| File.directory?(i) }
     }
-    
+
     def initialize(watchers = [], options = {})
       if options[:input]
         options[:output] = options[:input] unless options.has_key?(:output)
         watchers << ::Guard::Watcher.new(%r{^#{options.delete(:input)}/(.+\.s[ac]ss)$})
       end
-      
+
       super(watchers, DEFAULTS.merge(options))
     end
-        
-            
+
+
     # Builds the sass or scss. Determines engine to use by extension
     # of path given.
     #
     # @param file [String] path to file to build
     # @return [String] the output css
     #
-    
     def build_sass(file)
       content = File.new(file).read
       # sass or scss?
@@ -43,17 +44,11 @@ module Guard
         :style => options[:style].to_sym,
         :debug_info => options[:debug_info],
       }
-      engine = ::Sass::Engine.new(content, sass_options)
       
-      begin
-        engine.render
-      rescue ::Sass::SyntaxError => e
-        puts "ERROR: #{e.message}\n        on line #{e.sass_line} of #{e.sass_filename || file}"
-        nil
-      end
+      ::Sass::Engine.new(content, sass_options).render
     end
-    
-    # Get the file path to output the css based on the file being 
+
+    # Get the file path to output the css based on the file being
     # built.
     #
     # @param file [String] path to file being built
@@ -61,7 +56,7 @@ module Guard
     #
     def get_output(file)
       folder = File.join ::Guard.listener.directory, options[:output]
-        
+
       unless options[:shallow]
         watchers.product([file]).each do |watcher, file|
           if matches = file.match(watcher.pattern)
@@ -72,20 +67,20 @@ module Guard
           end
         end
       end
-      
+
       FileUtils.mkdir_p folder
       r = File.join folder, File.basename(file).split('.')[0]
       r << '.css'
     end
-    
+
     def ignored?(path)
       File.basename(path)[0,1] == "_"
     end
-    
+
     # ================
     # = Guard method =
     # ================
-    
+
     # Build all files being watched
     def run_all
       run_on_change(Watcher.match_files(self, Dir.glob(File.join('**', '[^_]*.*'))))
@@ -101,20 +96,28 @@ module Guard
         begin
           contents = build_sass(file)
           if contents
-            File.open(css_file, 'w') {|f| f.write(contents) }
-            ::Guard::UI.info "-> rebuilt #{file}", :reset => true
-            ::Guard::Notifier.notify("rebuilt #{file}", :title => "Guard::Sass", :image => :success) if options[:notification]
+            message = options[:noop] ? "verified #{file}" : "rebuilt #{file}"
+            
+            File.open(css_file, 'w') {|f| f.write(contents) } unless options[:noop]
+            ::Guard::UI.info "-> #{message}", :reset => true
+            if options[:notification] && !options[:hide_success]
+              ::Guard::Notifier.notify(message, :title => "Guard::Sass", :image => :success)
+            end
           end
           css_file
         rescue ::Sass::SyntaxError => e
           ::Guard::UI.error "Sass > #{e.sass_backtrace_str(file)}"
-          ::Guard::Notifier.notify("rebuild failed > #{e.sass_backtrace_str(file)}", :title => "Guard::Sass", :image => :error) if options[:notification]
+          ::Guard::Notifier.notify(
+            (options[:noop] ? 'validation' : 'rebuild') + " failed > #{e.sass_backtrace_str(file)}",
+             :title => "Guard::Sass",
+             :image => :error
+           ) if options[:notification]
           nil
         end
       end.compact
       notify changed_files
     end
-    
+
     def notify(changed_files)
       ::Guard.guards.reject{ |guard| guard == self }.each do |guard|
         paths = Watcher.match_files(guard, changed_files)
@@ -123,4 +126,4 @@ module Guard
     end
 
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-sass
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-01 00:00:00.000000000 +01:00
+date: 2011-09-04 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2156743000 !ruby/object:Gem::Requirement
+  requirement: &2153652620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156743000
+  version_requirements: *2153652620
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &2156742480 !ruby/object:Gem::Requirement
+  requirement: &2153652160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2156742480
+  version_requirements: *2153652160
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156742000 !ruby/object:Gem::Requirement
+  requirement: &2153651700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.2
   type: :development
   prerelease: false
-  version_requirements: *2156742000
+  version_requirements: *2153651700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156741520 !ruby/object:Gem::Requirement
+  requirement: &2153651240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -55,7 +55,7 @@ dependencies:
         version: 2.0.0.rc
   type: :development
   prerelease: false
-  version_requirements: *2156741520
+  version_requirements: *2153651240
 description: Guard::Sass automatically rebuilds sass (like sass --watch)
 email:
 - m@hawx.me