guard-jammit 0.2.0 → 0.3.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Pelle Braendgaard
+Copyright (c) 2009-2012 Pelle Braendgaard, Michael Kessler
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,160 @@
+# Guard::Jammit [![Build Status](https://secure.travis-ci.org/netzpirat/guard-jammit.png)](http://travis-ci.org/netzpirat/guard-jammit)
+
+Guard::Jammit watches your assets to automatically package them using [Jammit](http://documentcloud.github.com/jammit/).
+
+Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby and Rubinius.
+
+If you have any questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
+(irc.freenode.net).
+
+## Install
+
+### Guard and Guard::Jammit
+
+The simplest way to install Guard is to use [Bundler](http://gembundler.com/).
+Please make sure to have [Guard][] installed.
+
+Add Guard::Jammit to your `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem 'guard-jammit'
+end
+```
+
+Add the default Guard::Jammit template to your `Guardfile` by running:
+
+```bash
+$ guard init jammit
+```
+
+## Usage
+
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
+
+## Guardfile
+
+Guard::Jammit can be adapted to all kind of projects. Please read the
+[Guard documentation](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
+
+```ruby
+guard :jammit do
+  watch(%r{^public/javascripts/(.*)\.js$})
+  watch(%r{^public/stylesheets/(.*)\.css$})
+end
+```
+
+## Options
+
+There are many options that can customize Guard::Jammit to your needs. Options are simply supplied as hash when
+defining the Guard in your `Guardfile`:
+
+```ruby
+guard :jammit, :package_on_start => true, :notifications => :false do
+  ...
+end
+```
+
+### General options
+
+The general options configures the environment that is needed to run Guard::Jammit:
+
+```ruby
+:config_path => 'assets.yml'                  # YAML configuration file to use for Jammit
+                                              # default: 'config/assets.yml'
+
+:output_folder => ''                          # Overwrite to configured output folder
+                                              # default: nil
+
+:base_url => 'http://www.site.com'            # Base URL for building the MHTML stylesheets
+                                              # default: nil
+
+:public_root => 'htdocs'                      # Overwrite to configured public root
+                                              # default: nil
+
+:force => true                                # Force package generation.
+                                              # default: false
+
+:package_names => [:admin, :deps]             # The package names to package.
+                                              # default: nil
+```
+
+### Workflow options
+
+The workflow options define how Guard::Jammit behaves on Guard states.
+
+```ruby
+:package_on_start => true                     # Initial package when Guard starts
+                                              # default: false
+```
+
+### System notifications options
+
+These options affects what system notifications (growl, libnotify or notifu) are shown after a spec run:
+
+```ruby
+:notifications => false                       # Show success and error notifications.
+                                              # default: true
+
+:hide_success => true                         # Disable successful package run notification.
+                                              # default: false
+```
+
+## Issues
+
+You can report issues and feature requests to [GitHub Issues](https://github.com/netzpirat/guard-jammit/issues). Try to figure out
+where the issue belongs to: Is it an issue with Guard itself or with Guard::Jammit? Please don't
+ask question in the issue tracker, instead join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
+
+When you file an issue, please try to follow to these simple rules if applicable:
+
+* Make sure you run Guard with `bundle exec` first.
+* Add debug information to the issue by running Guard with the `--verbose` option.
+* Add your `Guardfile` and `Gemfile` to the issue.
+* Make sure that the issue is reproducible with your description.
+
+## Development
+
+- Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-jammit/master/frames).
+- Source hosted at [GitHub](https://github.com/netzpirat/guard-jammit).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested.
+* Update the [Yard](http://yardoc.org/) documentation.
+* Update the README.
+* Please **do not change** the version number.
+
+For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
+`#guard` (irc.freenode.net).
+
+## Contributors
+
+* [John Bintz](https://github.com/johnbintz)
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2009-2012 Pelle Braendgaard, 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/lib/guard/jammit.rb

@@ -1,63 +1,99 @@
 require 'guard'
 require 'guard/guard'
 require 'jammit'
+
 module Guard
+
+  # The Jammit Guard that gets notifications about the following
+  # Guard events: `start`, `stop`, `reload`, `run_all` and `run_on_change`.
+  #
   class Jammit < Guard
 
+    DEFAULT_OPTIONS = {
+        :config_path      => ::Jammit::DEFAULT_CONFIG_PATH,
+        :output_folder    => nil,
+        :base_url         => nil,
+        :public_root      => nil,
+        :force            => false,
+        :package_names    => nil,
+        :package_on_start => true,
+        :notification     => true,
+        :hide_success     => false
+    }
+
+    # Initialize Guard::Jammit.
+    #
+    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
+    # @param [Hash] options the options for the Guard
+    # @option options [String] :output_folder the output folder
+    # @option options [String] :base_url the base URL for the MHTML stylesheet
+    # @option options [String] :public_root the public root folder
+    # @option options [Boolean] :force force packaging
+    # @option options [Array<String>] package_names the package names to package
+    # @option options [Boolean] :package_on_start package when Guard starts
+    # @option options [Boolean] :notification show notifications
+    # @option options [Boolean] :hide_success hide success message notification
+    #
     def initialize(watchers = [], options = {})
-      super
-      @options.merge(options)
+      options = DEFAULT_OPTIONS.merge(options)
+      super(watchers, options)
     end
 
-    # ================
-    # = Guard method =
-    # ================
-
-    # If one of those methods raise an exception, the Guard instance
-    # will be removed from the active guard.
-
-    # Call once when guard starts
-    # Please override initialize method to init stuff
+    # Gets called once when Guard starts.
+    #
+    # @raise [:task_has_failed] when run_on_change has failed
+    #
     def start
-      jammit
-    end
+      ensure_rails_env!
 
-    # Call with Ctrl-C signal (when Guard quit)
-    def stop
-      true
-    end
+      ::Guard::UI.info "Using Jammit version #{::Jammit::VERSION}"
 
-    # Call with Ctrl-Z signal
-    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
-    def reload
-      jammit
+      jammit if @options[:package_on_start]
     end
 
-    # Call with Ctrl-/ signal
-    # This method should be principally used for long action like running all specs/tests/...
+    # Gets called when all files should be packaged.
+    #
+    # @raise [:task_has_failed] when run_on_change has failed
+    #
     def run_all
       jammit
     end
 
-    # Call on file(s) modifications
+    # Gets called when watched paths and files have changes.
+    #
+    # @param [Array<String>] paths the changed paths and files
+    # @raise [:task_has_failed] when run_on_change has failed
+    #
     def run_on_change(paths)
       jammit
     end
 
+    # Runs Jammit to package the assets
+    #
     def jammit
       begin
-        ::Jammit.load_configuration @options[:config] || ::Jammit::DEFAULT_CONFIG_PATH
-        ::Guard::UI.info("Jamming #{@options[:config]}")
-        ::Guard::Notifier.notify("Jamming #{@options[:config]}", :title => 'Jammit')
-        ::Jammit.packager.force = false
-        ::Jammit.packager.precache_all
-        true
+        Thread.current[:jammit_packager] = nil
+
+        ::Jammit.package! @options
+
+        ::Guard::UI.info 'Jammit successfull packaged the assets.'
+        ::Guard::Notifier.notify('Jammit successfull packaged the assets.', :title => 'Jammit') if @options[:notification] && !@options[:hide_success]
+
       rescue Exception => e
-        ::Guard::UI.error("Jammit failed (#{e})")
-        ::Guard::Notifier.notify('Jammit failed', :title => 'Jammit', :image => :failed)
-        false
+        ::Guard::UI.error("Jammit failed to package the assets: #{e.message}")
+        ::Guard::Notifier.notify('Jammit failed to package the assets.', :title => 'Jammit', :image => :failed) if @options[:notification]
+      end
+    end
+
+    private
+
+    # Ensures that Rails env is available when Rails is only partially loaded
+    #
+    def ensure_rails_env!
+      if defined?(::Rails) && !::Rails.respond_to?(:env)
+        require 'rails'
       end
     end
 
   end
-end
+end

data/lib/guard/jammit/templates/Guardfile

@@ -1,4 +1,4 @@
-guard 'jammit' do
-  watch(/^public\/javascripts\/(.*)\.js/)
-  watch(/^public\/stylesheets\/(.*)\.css/)
+guard :jammit do
+  watch(%r{^public/javascripts/(.*)\.js$})
+  watch(%r{^public/stylesheets/(.*)\.css$})
 end

data/lib/guard/jammit/version.rb

@@ -1,5 +1,5 @@
 module Guard
-  module Jammit
-    VERSION = "0.2.0"
+  module JammitVersion
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,86 +1,152 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guard-jammit
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Pelle Braendgaard
+- Michael Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70303456951120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: jammit
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70303456951120
+- !ruby/object:Gem::Dependency
+  name: jammit
+  requirement: &70303456950600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: This is a guard plugin to watch javascript and stylesheets to afterwards run jammit.
-email: 
+  prerelease: false
+  version_requirements: *70303456950600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70303456950060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456950060
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70303456949540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456949540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70303456949040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456949040
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70303456948660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456948660
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70303456948040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456948040
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70303456947440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456947440
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70303456946880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70303456946880
+description: Watches your assets to automatically package them using Jammit.
+email:
 - pelle@stakeventures.com
+- michi@netzpiraten.ch
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .document
-- .gitignore
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.textile
-- Rakefile
-- guard-jammit.gemspec
-- lib/guard/jammit.rb
+files:
 - lib/guard/jammit/templates/Guardfile
 - lib/guard/jammit/version.rb
+- lib/guard/jammit.rb
+- LICENSE
+- README.md
 homepage: http://github.com/guard/guard-jammit
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
 rubyforge_project: guard-jammit
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Guard plugin for Jammit
 test_files: []
-
+has_rdoc: 

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,21 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in guard-jammit.gemspec
-gemspec

data/Gemfile.lock

@@ -1,28 +0,0 @@
-PATH
-  remote: .
-  specs:
-    guard-jammit (0.2.0)
-      guard
-      jammit
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    POpen4 (0.1.4)
-      Platform (>= 0.4.0)
-      open4
-    Platform (0.4.0)
-    guard (0.6.2)
-      thor (~> 0.14.6)
-    jammit (0.6.3)
-      yui-compressor (>= 0.9.3)
-    open4 (1.1.0)
-    thor (0.14.6)
-    yui-compressor (0.9.6)
-      POpen4 (>= 0.1.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  guard-jammit!

data/README.textile

@@ -1,19 +0,0 @@
-h1. Guard Jammit Plug-in
-
-Let you configure a Guard that will run jammit whenever a javascript or stylesheet is updated.
-
-h2. Quick Start
-
-Edit the Gemfile for it to looks like:
-
-bc. source "http://rubygems.org"
-gem 'guard-jammit'
-
-You can now download missing gems and initialize the guard
-
-bc. $ bundle install
-$ guard init
-$ guard init jammit
-$ guard
-
-

data/Rakefile

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

data/guard-jammit.gemspec

@@ -1,37 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "guard/jammit/version"
-
-Gem::Specification.new do |s|
-  s.name        = "guard-jammit"
-  s.version     = Guard::Jammit::VERSION
-  s.authors     = ["Pelle Braendgaard"]
-  s.email       = ["pelle@stakeventures.com"]
-  s.homepage    = %q{http://github.com/guard/guard-jammit}
-  s.summary     = %q{Guard plugin for Jammit}
-  s.description = %q{This is a guard plugin to watch javascript and stylesheets to afterwards run jammit.}
-
-  s.rubyforge_project = "guard-jammit"
-
-  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"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<guard>, [">= 0"])
-      s.add_runtime_dependency(%q<jammit>, [">= 0"])
-    else
-      s.add_dependency(%q<guard>, [">= 0"])
-      s.add_dependency(%q<jammit>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<guard>, [">= 0"])
-    s.add_dependency(%q<jammit>, [">= 0"])
-  end
-
-end