guard-rails-assets 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+*.rbc
+*.swp
+.bundle

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    guard-rails-assets (0.0.1)
+      guard
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    guard (0.4.2)
+      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

data/README.md

@@ -0,0 +1,108 @@
+# Guard::RailsAssets
+
+
+Guard::RailsAssets compiles all the assets in Rails 3.1 application automatically when files are modified.
+
+Tested on MRI Ruby 1.9.2 (please report if it works on your platform).
+Currently only POSIX system is supported. Sorry Windows guys :(
+
+If you have any questions please contact me [@dnagir](http://www.ApproachE.com).
+
+## Install
+
+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
+gem 'guard-rails-assets'
+```
+
+Add guard definition to your `Guardfile` by running:
+
+```bash
+$ 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.
+
+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.
+
+## Rails Assets Pipeline
+
+The convention used in this guard are:
+
+- assets prefix is set to 'assets' meaning that all assets are compiled in to `public/assets` folder;
+- the assets folder is disposable and can be cleared out.
+
+If the conventions above are not valid for you then perhaps you'd better submit a patch.
+
+## Guardfile and Options
+
+In addition to the standard configuration, this Guard has options to specify when exacly to precompile assets.
+
+- `:start` - compile assets when the guard starts (default)
+- `:reload` - compile assets when the guard quites (Ctrl-C) (not enabled)
+- `:all` - compile assets when running all the guard (Ctrl-/) (default)
+- `:change` - compile assets when watched files change (default)
+
+For example:
+
+
+```ruby
+# compile ONLY when something changes
+guard 'rails-assets', :run_on => :change do
+  watch(%r{^app/assets/.+$})
+end
+
+# compile when something changes and when starting
+guard 'rails-assets', :run_on => [:start, :change] do
+  watch(%r{^app/assets/.+$})
+end
+
+# This is the default behaviour
+guard 'rails-assets', :run_on => [:start, :change, :all] do
+  watch(%r{^app/assets/.+$})
+end
+```
+
+## Development
+
+- 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!
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2010 - 2011 Michael Kessler
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/guard-rails-assets.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guard/version"
+
+Gem::Specification.new do |s|
+  s.name        = "guard-rails-assets"
+  s.version     = Guard::RailsAssetsVersion::VERSION
+  s.authors     = ["Dmytrii Nagirniak"]
+  s.email       = ["dnagir@gmail.com"]
+  s.homepage    = "http://github.com/dnagir/guard-rails-assets"
+  s.summary     = %q{Guard for compiling Rails assets}
+  s.description = %q{guard-rails-assets automatically generates JavaScript, CSS, Image files using Rails assets pipelie}
+
+  s.rubyforge_project = "guard-rails-assets"
+
+  s.add_dependency             'guard'
+  s.add_development_dependency 'rspec'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/guard/rails-assets.rb

@@ -0,0 +1,49 @@
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class RailsAssets < Guard
+    def initialize(watchers=[], options={})
+      super
+      @options = options || {}
+    end
+
+    def start
+      compile_assets if run_for? :start
+    end
+
+    def reload
+      compile_assets if run_for? :reload
+    end
+
+    def run_all
+      compile_assets if run_for? :all
+    end
+
+    def run_on_change(paths=[])
+      compile_assets if run_for? :change
+    end
+
+    def compile_assets
+      puts 'Compiling rails assets'
+      result = system "rm -rf public/assets && bundle exec rake assets:precompile"   
+      if result
+        tree = `tree public/assets`
+        puts tree
+        summary = tree.split("\n").last
+        Notifier::notify summary, :title => 'Assets compiled'
+      else
+        Notifier::notify 'see the details in the terminal', :title => "Can't compile assets", :image => :failed
+      end
+    end
+
+    private
+
+    def run_for? command
+      run_on = @options[:run_on]
+      run_on = [:start, :all, :change] if not run_on or run_on.empty? 
+      run_on = [run_on] unless run_on.respond_to?(:include?)
+      run_on.include?(command)
+    end
+  end
+end

data/lib/guard/rails-assets/templates/Guardfile

@@ -0,0 +1,8 @@
+
+# Make sure this guard is ABOVE any guards using assets such as jasmine-headless-webkit
+# It is recommended to make explicit list of assets in `config/application.rb`
+# config.assets.precompile = ['application.js', 'application.css', 'all-ie.css']
+guard 'rails-assets' do
+  watch(%r{^app/assets/.+$})
+  watch('config/application.rb')
+end

data/lib/guard/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module RailsAssetsVersion
+    VERSION = "0.0.1"
+  end
+end

data/spec/guard/rails-assets_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'guard/rails-assets'
+
+describe Guard::RailsAssets do
+  let(:options) { {} }
+  subject { Guard::RailsAssets.new(['watchers'], options) }
+
+  it 'should be able to create guard' do
+    ::Guard::RailsAssets.new(['watchers'], {:options=>:here}).should_not be_nil
+  end
+
+  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
+
+  describe '#run_all' do
+    it_behaves_like 'guard command', :command => :run_all,       :run => true
+  end
+
+  describe '#run_on_change' do
+    it_behaves_like 'guard command', :command => :run_on_change, :run => true
+  end
+
+
+  describe 'asset compilation using CLI' do
+    def stub_system_with result
+      subject.should_receive(:system).with("rm -rf public/assets && bundle exec rake assets:precompile").and_return result
+    end
+
+    it 'should notify on success' do
+      stub_system_with true
+      subject.should_receive(:`).with('tree public/assets').and_return "a\nb\n1 directory, 2 files"
+      Guard::Notifier.should_receive(:notify).with('1 directory, 2 files', :title => 'Assets compiled')
+      subject.compile_assets
+    end
+    it 'should notify on failure' do
+      stub_system_with false
+      Kernel.should_not_receive(:`)
+      Guard::Notifier.should_receive(:notify).with('see the details in the terminal', :title => "Can't compile assets", :image => :failed)
+      subject.compile_assets
+    end
+  end
+
+  describe 'custom assets prefix' do
+    it 'should use given prefix'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec'
+require 'guard/rails-assets'
+require 'support/shared_examples'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    ENV["GUARD_ENV"] = 'test'
+    @project_path = Pathname.new(File.expand_path('../../', __FILE__))
+  end
+
+  config.after(:each) do
+    ENV["GUARD_ENV"] = nil
+  end
+
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,31 @@
+shared_examples_for "guard command" do |info|
+
+  def set_run_on_option info
+    # run_on_change -> change
+    # run_all -> all
+    run_option = info[:command].to_s.match(/(.*_)?(\w+)/)[2].to_sym
+    options[:run_on] = [run_option]
+  end
+
+  it "should execute #{info[:command]} when said so" do
+    set_run_on_option info
+    subject.should_receive(:compile_assets)
+    subject.send(info[:command])
+  end
+  it "should not execute #{info[:command]} when disabled" do
+    options[:run_on] = [:something_other]
+    subject.should_not_receive(:compile_assets)
+    subject.send(info[:command])
+  end
+
+  it "should #{info[:run] ? '' : 'not '}execute #{info[:command]} by default" do
+    options[:run_on] = nil
+    if info[:run]
+      subject.should_receive(:compile_assets)
+    else
+      subject.should_not_receive(:compile_assets)
+    end
+    subject.send(info[:command])
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: guard-rails-assets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dmytrii Nagirniak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &15869340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15869340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &15825660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *15825660
+description: guard-rails-assets automatically generates JavaScript, CSS, Image files
+  using Rails assets pipelie
+email:
+- dnagir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- guard-rails-assets.gemspec
+- lib/guard/rails-assets.rb
+- lib/guard/rails-assets/templates/Guardfile
+- lib/guard/version.rb
+- spec/guard/rails-assets_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: http://github.com/dnagir/guard-rails-assets
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3097363919137116973
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3097363919137116973
+requirements: []
+rubyforge_project: guard-rails-assets
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Guard for compiling Rails assets
+test_files: []