guard-sprockets 0.3.1 → 0.4.0

data/README.md

@@ -0,0 +1,70 @@
+# Guard::Sprockets [![Build Status](https://secure.travis-ci.org/guard/guard-sprockets.png?branch=master)](http://travis-ci.org/guard/guard-sprockets)
+
+Sprockets guard automatically packages your JavaScript files together when your source files are saved.
+
+* Compatible with Sprockets 2.x (for Sprockets 1.x compatibility, please use Guard::Sprockets 0.1.4 or the `sprockets_1` branch).
+* Tested against Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby & Rubinius.
+
+## Install
+
+Please be sure to have [Guard](https://github.com/guard/guard) installed before continue.
+
+Install the gem:
+
+```
+$ gem install guard-sprockets
+```
+
+Add it to your Gemfile (inside the `:tools` group for instance):
+
+```ruby
+group :tools do
+  gem 'guard-sprockets'
+end
+```
+
+Add guard definition to your Guardfile by running this command:
+
+```
+$ guard init sprockets
+```
+
+## Usage
+
+Please read [Guard usage doc](https://github.com/guard/guard#readme)
+
+## Guardfile
+
+Guard::Sprockets can be adapted to all kind of projects.
+
+### Typical Rails 3 app (default generated Guardfile)
+
+``` ruby
+guard 'sprockets', :destination => 'public/javascripts', :asset_paths => ['/app/assets/javascripts'] do
+  watch 'app/assets/javascripts/application.js'
+end
+```
+
+Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
+
+## Options
+
+``` ruby
+:destination => 'public/js'          # change the destination folder in which the compiled assets are saved, default: 'public/javascripts'
+:asset_paths => 'app/js'             # add a directory (or on array of directories) to Sprockets' environment's load path, default: ['app/assets/javascripts']
+:asset_paths => ['app/js', 'lib/js'] # asset_paths can be a String or an Array
+:minify      => true                 # minify the JavaScript files content using Uglifier, default: false
+                                     # be sure to add: "gem 'uglifier'" in your Gemfile
+:root_file   => 'app/js/app.js'      # if set, only this file will be compiled, default: nil
+```
+
+## License
+(The MIT License)
+
+Copyright (c) 2011-2012 Aaron Cruz
+
+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.
+
+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.

data/lib/guard/sprockets.rb

@@ -6,84 +6,85 @@ require 'execjs'
 
 module Guard
   class Sprockets < Guard
-    def initialize(watchers=[], options={})
-      super
 
-      @sprockets = ::Sprockets::Environment.new
+    attr_reader :asset_paths, :destination, :root_file, :sprockets
 
-      @asset_paths = options.delete(:asset_paths) || []
-      @asset_paths.each do |p|
-        @sprockets.append_path p
-      end
+    def initialize(watchers = [], options = {})
+      super(watchers, options)
+
+      @options     = options
+      @asset_paths = Array(@options[:asset_paths] || 'app/assets/javascripts')
+      @destination = @options[:destination] || 'public/javascripts'
+      @root_file   = @options[:root_file]
+
+      @sprockets = ::Sprockets::Environment.new
+      @asset_paths.each { |p| @sprockets.append_path(p) }
+      @sprockets.append_path(@root_file) if @root_file
 
-      if options.delete(:minify)
+      if @options.delete(:minify)
         begin
           require 'uglifier'
-          @sprockets_env.js_compressor = ::Uglifier.new
-          UI.info "Sprockets will compress output (minify)."
-        rescue
-          UI.error "minify: Uglifier cannot be loaded. No compression will be used.\nPlease include 'uglifier' in your Gemfile.\n#{$!}"
+          @sprockets.js_compressor = ::Uglifier.new
+          UI.info 'Sprockets will compress output.'
+        rescue LoadError => ex
+          UI.error "minify: Uglifier cannot be loaded. No compression will be used.\nPlease include 'uglifier' in your Gemfile."
+          UI.debug ex.message
         end
       end
-      # store the output destination
-      @destination = options.delete(:destination)
-      @root_file   = options.delete(:root_file)
-
-      @opts = options
     end
 
     def start
-       UI.info "Sprockets activated."
-       UI.info "  - external asset paths = #{@asset_paths.inspect}" unless @asset_paths.empty?
-       UI.info "  - destination path = #{@destination.inspect}"
-       UI.info "Sprockets guard is ready and waiting for some file changes..."
+       UI.info 'Guard::Sprockets is ready and waiting for some file changes...'
+       UI.debug "Guard::Sprockets.asset_paths = #{@asset_paths.inspect}" unless @asset_paths.empty?
+       UI.debug "Guard::Sprockets.destination = #{@destination.inspect}"
 
        run_all
     end
 
     def run_all
-      run_on_change([ @root_file ]) if @root_file
-
-      true
+      run_on_change([@root_file]) if @root_file
     end
 
-    def run_on_change(paths)
-      if @root_file
-        sprocketize(@root_file)
-      else
-        paths.each do |file|
-          sprocketize(file)
-        end
-      end
+    def run_on_changes(paths)
+      paths = [@root_file] if @root_file
 
-      true
+      success = true
+      paths.each do |file|
+        success &= sprocketize(file)
+      end
+      success
     end
 
     private
 
     def sprocketize(path)
-      changed = Pathname.new(path)
+      path = Pathname.new(path)
 
-      @sprockets.append_path changed.dirname
+      @sprockets.append_path(path.dirname) unless @sprockets.paths.include?(path.dirname)
 
-      output_basename = changed.basename.to_s
-      output_basename.gsub!(/^(.*\.(?:js|css))\.[^.]+$/, '\1')
+      output_filename = without_preprocessor_extension(path.basename.to_s)
+      output_path = Pathname.new(File.join(@destination, output_filename))
 
-      output_file = Pathname.new(File.join(@destination, output_basename))
+      UI.info "Sprockets will compile #{output_filename}"
 
-      UI.info "Sprockets: compiling #{output_file}"
-
-      FileUtils.mkdir_p(output_file.parent) unless output_file.parent.exist?
-      output_file.open('w') do |f|
-        f.write @sprockets[output_basename]
+      FileUtils.mkdir_p(output_path.parent) unless output_path.parent.exist?
+      output_path.open('w') do |f|
+        f.write @sprockets[output_filename]
       end
 
-      UI.info "Sprockets finished compiling #{output_file}"
-      Notifier.notify "Compiled #{output_basename}"
-    rescue ExecJS::ProgramError => e
-      UI.error "Sprockets failed to compile #{output_file}"
-      UI.error e.message
-      Notifier.notify "Syntax error in #{output_basename}: #{e.message}", :priority => 2, :image => :failed
+      UI.info "Sprockets compiled #{output_filename}"
+      Notifier.notify "Sprockets compiled #{output_filename}"
+    rescue ExecJS::ProgramError => ex
+      UI.error "Sprockets failed compiling #{output_filename}"
+      UI.error ex.message
+      Notifier.notify "Sprockets failed compiling #{output_filename}!", :priority => 2, :image => :failed
+
+      false
     end
+
+    def without_preprocessor_extension(filename)
+      filename.gsub(/^(.*\.(?:js|css))\.[^.]+$/, '\1')
+    end
+
   end
 end

data/lib/guard/sprockets/templates/Guardfile

@@ -1,3 +1,3 @@
-guard 'sprockets', :destination => "public/javascripts", :asset_paths => ['app/assets/javascripts'] do
-  watch (%r{app/assets/javascripts/application.js})
+guard 'sprockets', :destination => 'public/javascripts', :asset_paths => ['app/assets/javascripts'] do
+  watch 'app/assets/javascripts/application.js'
 end

data/lib/guard/sprockets/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module SprocketsVersion
+    VERSION = '0.4.0'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-sprockets
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,31 +10,73 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-22 00:00:00.000000000 Z
+date: 2012-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70307030217180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70307030217180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &70307030213960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307030213960
-description: guard file for sprockets
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: Guard::Sprockets automatically packages your javascript files together.
 email:
 - aaron@aaroncruz.com
 - kematzy at gmail
@@ -43,8 +85,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/guard/sprockets/templates/Guardfile
+- lib/guard/sprockets/version.rb
 - lib/guard/sprockets.rb
-homepage: http://aaroncruz.com
+- README.md
+homepage: https://rubygems.org/gems/guard-sprockets
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -56,16 +100,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1279114043870312487
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.6
 requirements: []
 rubyforge_project: guard-sprockets
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: guard file for sprockets
+summary: Guard gem for Sprockets
 test_files: []