guard-rails-assets 0.0.4 → 0.0.5

data/Gemfile

@@ -2,4 +2,4 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'rake'
+gem 'rake', :require => false

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    guard-rails-assets (0.0.3)
+    guard-rails-assets (0.0.5)
       guard
+      rake
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
-    guard (0.4.2)
+    guard (0.5.1)
       thor (~> 0.14.6)
     rake (0.9.2)
     rspec (2.6.0)

data/README.md

@@ -28,15 +28,17 @@ $ guard init rails-assets
 ## Rails 3.1
 
 The Rails 3.1 is a mandatory requirement, but is not enforeced via dependencies for now.
-The reason is that the assets are currently compiled via command line and thus this guard does not
-explicitly depend on Rails.
+The reason is that the assets can currently be compiled using following "runners":
 
-Good thing about it is that assets will always be same as produced by Rails.
-Bad thing is that it is pretty slow (~10 seconds) because it starts Rails from ground zero.
+1. rake command (CLI);
+2. loading the actual Rails environment.
+
+In the 1st case - this Guard is not actually using Rails directly while in the 2nd - it loads it explicitly.
 
-*NOTE*: The guard runs the `rake assets:clean assets:precopile`.
-As of current Rails 3.1 edge that means that the assets will be deleted before they are compiled.
+Good thing about the 1st approach is that assets will always be same as produced by Rails.
+Bad thing is that it is pretty slow (~10 seconds) because it starts Rails from ground zero.
 
+The 2nd approach is good because it is much faster, but does not reload Rails environment (so you have to restart guard).
 
 ## Guardfile and Options
 
@@ -47,21 +49,28 @@ In addition to the standard configuration, this Guard has options to specify whe
 - `:reload` - compile assets when the guard quites (Ctrl-C) (not enabled by default)
 - `:all` - compile assets when running all the guards (Ctrl-/) (not enabled by default)
 
+Also you can set the `:runner` option:
+
+- `:cli` - compile assets using the rake task - the most correct method, but slow.
+- `:rails` - compile assets by loading rails environment (default) - fast, but does not pick up changes.
+
+
+
 For example:
 
 
 ```ruby
-# compile ONLY when something changes
-guard 'rails-assets', :run_on => :change do
+# This is the default behaviour
+guard 'rails-assets', :run_on => [:start, :change], :runner => :rails do
   watch(%r{^app/assets/.+$})
 end
 
-# compile when something changes and when starting
-guard 'rails-assets', :run_on => [:start, :change] do
+# compile ONLY when something changes
+guard 'rails-assets', :run_on => :change do
   watch(%r{^app/assets/.+$})
 end
 
-# This is the default behaviour
+# compile when something changes and when starting
 guard 'rails-assets', :run_on => [:start, :change] do
   watch(%r{^app/assets/.+$})
 end
@@ -72,7 +81,6 @@ end
 - Source hosted at [GitHub](https://github.com/dnagir/guard-rails-assets)
 - Report issues and feature requests to [GitHub Issues](https://github.com/dnagir/guard-rails-assets/issues)
 
-
 Pull requests are very welcome!
 
 ## Licensed under WTFPL
@@ -92,7 +100,3 @@ Pull requests are very welcome!
 
   0. You just DO WHAT THE FUCK YOU WANT TO.
 ```
-
-
-
-

data/guard-rails-assets.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "guard-rails-assets"
 
   s.add_dependency             'guard'
+  s.add_dependency             'rake'
   s.add_development_dependency 'rspec'
 
   s.files         = `git ls-files`.split("\n")

data/lib/guard/rails-assets.rb

@@ -6,13 +6,17 @@ module Guard
     def initialize(watchers=[], options={})
       super
       @options = options || {}
+      @run_on = @options[:run_on] || [:start, :change]
+      @run_on = [@run_on] unless @run_on.respond_to?(:include?)
     end
 
     def start
+      runner.start if runner.respond_to? :start
       compile_assets if run_for? :start
     end
 
     def reload
+      runner.reload if runner.respond_to? :reload
       compile_assets if run_for? :reload
     end
 
@@ -25,20 +29,30 @@ module Guard
     end
 
     def compile_assets
-      puts 'Compiling rails assets'
-      result = system "bundle exec rake assets:clean assets:precompile"
+      puts "Compiling rails assets with #{runner.class.name}."
+      result = runner.compile_assets
+
       if result
         Notifier::notify 'Assets compiled'
+        puts 'Assets compiled.'
       else
         Notifier::notify 'see the details in the terminal', :title => "Can't compile assets", :image => :failed
+        puts 'Failed to compile assets.'
+      end
+    end
+
+    def runner
+      @runner ||= begin
+        runner_name = (@options[:runner] || :rails).to_s
+
+        require_relative "rails-assets/#{runner_name}_runner"
+        ::Guard::RailsAssets.const_get(runner_name.capitalize + 'Runner').new(@options)
       end
     end
 
     def run_for? command
-      run_on = @options[:run_on]
-      run_on = [:start, :change] if not run_on or run_on.to_s.empty?
-      run_on = [run_on] unless run_on.respond_to?(:include?)
-      run_on.include?(command)
+      @run_on.include?(command)
     end
   end
 end
+

data/lib/guard/rails-assets/cli_runner.rb

@@ -0,0 +1,10 @@
+module Guard
+  class RailsAssets::CliRunner
+    def initialize(options)
+    end
+
+    def compile_assets
+      system "bundle exec rake assets:clean assets:precompile"
+    end
+  end
+end

data/lib/guard/rails-assets/rails_runner.rb

@@ -0,0 +1,64 @@
+require 'rake/dsl_definition'
+module Guard
+
+  class RailsAssets::RailsRunner
+
+    def initialize(options)
+      
+    end
+
+    # Methods to run the asset pipeline
+    # Taken from - https://github.com/rails/rails/blob/master/actionpack/lib/sprockets/assets.rake
+    module AssetPipeline
+      extend self
+      extend Rake::DSL
+      
+      def clean
+        assets = Rails.application.config.assets
+        public_asset_path = Rails.public_path + assets.prefix
+        rm_rf public_asset_path, :secure => true
+      end
+
+      def precompile
+        Sprockets::Helpers::RailsHelper
+
+        assets = Rails.application.config.assets.precompile
+        # Always perform caching so that asset_path appends the timestamps to file references.
+        Rails.application.config.action_controller.perform_caching = true
+        Rails.application.assets.precompile(*assets)
+      end
+    end
+
+    def boot_rails
+      @rails_booted ||= begin
+        require "#{Dir.pwd}/config/environment.rb"
+        true
+      end
+    end
+
+    def run_compiler
+      begin
+        @failed = false
+        AssetPipeline.clean
+        AssetPipeline.precompile
+      rescue => e
+        puts "An error occurred compiling assets: #{e}"
+        @failed = true
+      end
+    end
+
+    # Runs the asset pipeline compiler.
+    #
+    # @return [ Boolean ] Whether the compilation was successful or not
+    def compile_assets
+      boot_rails
+      run_compiler
+      
+      !failed?
+    end
+
+    def failed?
+      @failed
+    end
+  end
+end

data/lib/guard/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RailsAssetsVersion
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/guard/rails-assets/cli_runner_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Guard::RailsAssets::CliRunner do
+
+  subject { Guard::RailsAssets::CliRunner.new({}) }
+
+  it 'should run the command' do
+    subject.stub(:system)
+    subject.should_receive(:system).with("bundle exec rake assets:clean assets:precompile")
+    subject.compile_assets
+  end
+end

data/spec/guard/rails-assets/rails_runner_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Guard::RailsAssets::RailsRunner do
+
+  subject { Guard::RailsAssets::RailsRunner.new({}) }
+  
+  describe ".compile_assets" do
+    
+    let(:asset_pipeline) { Guard::RailsAssets::RailsRunner::AssetPipeline }
+    
+    before do
+      described_class.class_eval do
+        def boot_rails
+        end
+      end
+    end
+    
+    context "successful compile" do
+      before do
+        asset_pipeline.stub(:clean)
+        asset_pipeline.stub(:precompile)
+      end
+      
+      it "cleans the assets" do
+        asset_pipeline.should_receive(:clean)
+        subject.compile_assets
+      end
+      
+      it "runs the compiler" do
+        asset_pipeline.should_receive(:precompile)
+        subject.compile_assets
+      end
+      
+      it "returns true" do
+        subject.compile_assets.should be_true
+      end
+    end
+    
+    context "with a compilation error" do
+      
+      before do
+        asset_pipeline.stub(:clean)
+        asset_pipeline.should_receive(:precompile).and_raise(StandardError)
+        @output = capture(:stdout) do
+          @result = subject.compile_assets
+        end
+      end
+      
+      it "outputs the error" do
+        @output.should include("An error occurred")
+      end
+      
+      it "returns false" do
+        @result.should be_false
+      end
+      
+      context "on next successful compile" do
+        
+        it "works" do
+          asset_pipeline.should_receive(:clean)
+          asset_pipeline.should_receive(:precompile)
+          subject.compile_assets.should be_true
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/guard/rails-assets_spec.rb

@@ -2,55 +2,80 @@ require 'spec_helper'
 require 'guard/rails-assets'
 
 describe Guard::RailsAssets do
-  let(:options) { {} }
-  subject { Guard::RailsAssets.new(['watchers'], options) }
 
-  describe '#start' do
-    it_behaves_like 'guard command', :command => :start,         :run => true
-  end
 
-  describe '#reload' do
-    it_behaves_like 'guard command', :command => :reload,        :run => false
-  end
+  context 'with any runner' do
 
-  describe '#run_all' do
-    it_behaves_like 'guard command', :command => :run_all,       :run => false
-  end
+    let(:options) { {:runner => :cli} }
+    let(:runner) { mock('runner') }
+    subject { Guard::RailsAssets.new(['watchers'], options) }
 
-  describe '#run_on_change' do
-    it_behaves_like 'guard command', :command => :run_on_change, :run => true
-  end
+    before do
+     Guard::RailsAssets::CliRunner.stub(:new).and_return runner
+    end
 
-  describe 'run options' do
-    it 'should allow array of symbols' do
-      guard = Guard::RailsAssets.new(['watchers'], :run_on => [:start, :change])
-      guard.run_for?(:start).should be_true
-      guard.run_for?(:reload).should be_false
+    describe '#start' do
+      it_behaves_like 'guard command', :command => :start,         :run => true
     end
 
-    it 'should allow symbol' do
-      guard = Guard::RailsAssets.new(['watchers'], :run_on => :start)
-      guard.run_for?(:start).should be_true
-      guard.run_for?(:reload).should be_false
+    describe '#reload' do
+      it_behaves_like 'guard command', :command => :reload,        :run => false
     end
-  end
 
-  describe 'asset compilation using CLI' do
-    def stub_system_with result
-      subject.should_receive(:system).with("bundle exec rake assets:clean assets:precompile").and_return result
+    describe '#run_all' do
+      it_behaves_like 'guard command', :command => :run_all,       :run => false
+    end
+
+    describe '#run_on_change' do
+      it_behaves_like 'guard command', :command => :run_on_change, :run => true
+    end
+
+    describe 'run options' do
+      it 'should allow array of symbols' do
+        guard = Guard::RailsAssets.new(['watchers'], :run_on => [:start, :change])
+        guard.run_for?(:start).should be_true
+        guard.run_for?(:reload).should be_false
+      end
+
+      it 'should allow symbol' do
+        guard = Guard::RailsAssets.new(['watchers'], :run_on => :start)
+        guard.run_for?(:start).should be_true
+        guard.run_for?(:reload).should be_false
+      end
+
     end
 
-    it 'should notify on success' do
-      stub_system_with true
-      Guard::Notifier.should_receive(:notify).with('Assets compiled')
-      subject.compile_assets
+    describe 'notifications' do
+      def stub_system_with result
+        runner.should_receive(:compile_assets).and_return result
+      end
+
+      it 'should notify on success' do
+        stub_system_with true
+        Guard::Notifier.should_receive(:notify).with('Assets compiled')
+        subject.compile_assets
+      end
+
+      it 'should notify on failure' do
+        stub_system_with false
+        Guard::Notifier.should_receive(:notify).with('see the details in the terminal', :title => "Can't compile assets", :image => :failed)
+        subject.compile_assets
+      end
     end
 
-    it 'should notify on failure' do
-      stub_system_with false
-      subject.should_not_receive(:`) # don't obtain tree
-      Guard::Notifier.should_receive(:notify).with('see the details in the terminal', :title => "Can't compile assets", :image => :failed)
-      subject.compile_assets
+  end # context with any runner
+
+  describe 'picking a runner' do
+    it 'should use Rails runner by default' do
+      Guard::RailsAssets.new(['watchers']).runner.class.should == ::Guard::RailsAssets::RailsRunner
+    end
+
+    it 'should use CLI runner' do
+      Guard::RailsAssets.new(['watchers'], :runner => :cli).runner.class.should == ::Guard::RailsAssets::CliRunner
+    end
+    
+    it 'should use RailsRunner' do
+      Guard::RailsAssets.new(['watchers'], :runner => :rails).runner.class.should == ::Guard::RailsAssets::RailsRunner
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'rspec'
 require 'guard/rails-assets'
 require 'support/shared_examples'
+require 'support/stdout_helper'
+require 'guard/rails-assets/cli_runner'
+require 'guard/rails-assets/rails_runner'
 
 RSpec.configure do |config|
   config.color_enabled = true
@@ -15,5 +18,7 @@ RSpec.configure do |config|
   config.after(:each) do
     ENV["GUARD_ENV"] = nil
   end
+  
+  config.include(Helpers)
 
 end

data/spec/support/stdout_helper.rb

@@ -0,0 +1,17 @@
+require 'stringio'
+
+module Helpers
+  
+  def capture(*streams)
+    streams.map! { |stream| stream.to_s }
+    begin
+      result = StringIO.new
+      streams.each { |stream| eval "$#{stream} = result" }
+      yield
+    ensure
+      streams.each { |stream| eval("$#{stream} = #{stream.upcase}") }
+    end
+    result.string
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-rails-assets
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-16 00:00:00.000000000Z
+date: 2011-08-02 00:00:00.000000000 +10:00
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &18715380 !ruby/object:Gem::Requirement
+  requirement: &15623720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18715380
+  version_requirements: *15623720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &15623300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15623300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18714840 !ruby/object:Gem::Requirement
+  requirement: &15622880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +44,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18714840
+  version_requirements: *15622880
 description: guard-rails-assets automatically generates JavaScript, CSS, Image files
   using Rails assets pipelie
 email:
@@ -48,11 +60,17 @@ files:
 - Rakefile
 - guard-rails-assets.gemspec
 - lib/guard/rails-assets.rb
+- lib/guard/rails-assets/cli_runner.rb
+- lib/guard/rails-assets/rails_runner.rb
 - lib/guard/rails-assets/templates/Guardfile
 - lib/guard/version.rb
+- spec/guard/rails-assets/cli_runner_spec.rb
+- spec/guard/rails-assets/rails_runner_spec.rb
 - spec/guard/rails-assets_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
+- spec/support/stdout_helper.rb
+has_rdoc: true
 homepage: http://github.com/dnagir/guard-rails-assets
 licenses: []
 post_install_message: 
@@ -65,15 +83,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3181141652634130473
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3181141652634130473
 requirements: []
 rubyforge_project: guard-rails-assets
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Guard for compiling Rails assets