guard-rails-assets 0.0.6 → 0.0.7

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 *.rbc
 *.swp
 .bundle
+Gemfile.lock

data/Gemfile

@@ -2,4 +2,4 @@ source "http://rubygems.org"
 
 gemspec
 
-gem 'rake', :require => false
+gem 'pry', :group => [:development, :test]

data/README.md

@@ -1,9 +1,9 @@
 # Guard::RailsAssets
 
 
-Guard::RailsAssets compiles the assets in Rails 3.1 application automatically when files are modified.
+Guard::RailsAssets compiles the assets within Rails 3.1 application whenever those change.
 
-Tested on MRI Ruby 1.9.2 (please report if it works on your platform).
+Tested on MRI 1.9.2 (please report if it works on your platform).
 
 If you have any questions please contact me [@dnagir](http://www.ApproachE.com).
 
@@ -11,8 +11,6 @@ If you have any questions please contact me [@dnagir](http://www.ApproachE.com).
 
 Please be sure to have [Guard](https://github.com/guard/guard) installed.
 
-Install the gem:
-
 Add it to your `Gemfile`, preferably inside the test and development group:
 
 ```ruby
@@ -22,27 +20,12 @@ gem 'guard-rails-assets'
 Add guard definition to your `Guardfile` by running:
 
 ```bash
-$ guard init rails-assets
+$ bundle exec 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 can currently be compiled using following "runners":
-
-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.
-
-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
+## Options
 
-In addition to the standard configuration, this Guard has options to specify when exacly to precompile assets.
+In addition to the guard configuration, `guard-rails-assets` has options to specify when exacly to precompile assets.
 
 - `:start` - compile assets when the guard starts (enabled by default)
 - `:change` - compile assets when watched files change (enabled by default)
@@ -52,8 +35,9 @@ In addition to the standard configuration, this Guard has options to specify whe
 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.
+- `:rails` - compile assets by loading rails environment (default) - fast, but does not pick up changes. Additionally it relies on a single instance of your app to be loaded, so you can't have multiple guards with different rails configurations.
 
+`:rails_env` option is available that allows you to specify the Rails environment to use (defaults to 'test').
 
 
 For example:
@@ -61,7 +45,7 @@ For example:
 
 ```ruby
 # This is the default behaviour
-guard 'rails-assets', :run_on => [:start, :change], :runner => :rails do
+guard 'rails-assets', :run_on => [:start, :change], :runner => :rails, :rails_env => 'test' do
   watch(%r{^app/assets/.+$})
 end
 

data/guard-rails-assets.gemspec

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

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

@@ -1,10 +1,11 @@
 module Guard
   class RailsAssets::CliRunner
-    def initialize(options)
+    def initialize(options={})
+      @rails_env = (options[:rails_env] || 'test').to_s
     end
 
     def compile_assets
-      system "bundle exec rake assets:clean assets:precompile"
+      system "RAILS_ENV=#{@rails_env} bundle exec rake assets:clean assets:precompile"
     end
   end
 end

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

@@ -2,63 +2,57 @@ require 'rake/dsl_definition'
 module Guard
 
   class RailsAssets::RailsRunner
+    @@rails_booted = false # Only one rails app is allowed, so make it a class var
+    @@rails_env = nil
 
-    def initialize(options)
-      
+    def initialize(options={})
+      @@rails_env = (options[:rails_env] || 'test').to_s unless @@rails_booted
     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)
+    def self.apply_hacks
+      # TODO: Hack due to Rails 3.1 issue: https://github.com/rails/rails/issues/2663#issuecomment-1990121
+      ENV["RAILS_GROUPS"] ||= "assets"
+      ENV["RAILS_ENV"]    ||= @@rails_env
+
+      # TODO: Now another hack: Rails replaces Rails.application.assets with Rails.applciation.assets.index
+      # (this happens when config.action_controller.perform_caching is true)
+      # It caches all the assets, so that the Rakse task can't be reused
+      require 'sprockets/environment'
+      Sprockets::Environment.class_eval do
+        def index; self; end # instead of Index.new(self)
       end
     end
 
-    def boot_rails
-      @rails_booted ||= begin
-        require "#{Dir.pwd}/config/environment.rb"
-        true
-      end
+    # Methods to run the asset pipeline
+    # See as a reference https://github.com/rails/rails/blob/master/actionpack/lib/sprockets/assets.rake
+    def self.boot_rails
+      return if @@rails_booted
+      puts "Booting Rails for #{@@rails_env} environment."
+      apply_hacks
+      require 'rake'
+      require "#{Dir.pwd}/config/environment.rb"
+      app = ::Rails.application
+
+      app.assets.cache = nil # don't touch my FS pls. (can we use `app.config.assets.cache_store = false` instead)?
+      app.load_tasks
+      @@rails_booted = true
     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
+      self.class.boot_rails
+      return false unless @@rails_booted
+      begin
+        Rake::Task['assets:clean'].execute
+        Rake::Task['assets:precompile'].execute
+        true
+      rescue => e
+        puts "An error occurred compiling assets: #{e}"
+        false
+      end
     end
   end
 end

data/lib/guard/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RailsAssetsVersion
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

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

@@ -2,11 +2,18 @@ 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.should_receive(:system).with("RAILS_ENV=test bundle exec rake assets:clean assets:precompile")
     subject.compile_assets
   end
+
+  context 'with production environment' do
+    subject { Guard::RailsAssets::CliRunner.new(:rails_env => :production) }
+    it 'should run the command' do
+      subject.stub(:system)
+      subject.should_receive(:system).with("RAILS_ENV=production bundle exec rake assets:clean assets:precompile")
+      subject.compile_assets
+    end
+  end
 end

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

@@ -2,70 +2,7 @@ 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
+  it 'should be tested properly as a Rails engine'
   
+  it { should respond_to :compile_assets }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-rails-assets
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000 +10:00
+date: 2011-09-04 00:00:00.000000000 +10:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &18976180 !ruby/object:Gem::Requirement
+  requirement: &23672500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18976180
+  version_requirements: *23672500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18975760 !ruby/object:Gem::Requirement
+  requirement: &23663340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18975760
+  version_requirements: *23663340
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &23662760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *23662760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18975340 !ruby/object:Gem::Requirement
+  requirement: &23661860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18975340
+  version_requirements: *23661860
 description: guard-rails-assets automatically generates JavaScript, CSS, Image files
   using Rails assets pipelie
 email:
@@ -55,7 +66,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - guard-rails-assets.gemspec
@@ -83,12 +93,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4449380752411900683
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4449380752411900683
 requirements: []
 rubyforge_project: guard-rails-assets
 rubygems_version: 1.6.2

data/Gemfile.lock

@@ -1,31 +0,0 @@
-PATH
-  remote: .
-  specs:
-    guard-rails-assets (0.0.5)
-      guard
-      rake
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    guard (0.5.1)
-      thor (~> 0.14.6)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    thor (0.14.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  guard-rails-assets!
-  rake
-  rspec