guard-compass 0.0.6 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 392583dbb2cb95a232f982ea4112ba107e1b964b
+  data.tar.gz: 89c2c4163fb44ba6ac6430f9a347456461ccf9d0
+SHA512:
+  metadata.gz: 9732f96f9c9d65eaede347bfe373dbe971cf394d9147714ef743f7a49e569535f1f32a58a3f5db75979dfe07f2f8991fedb43387662fda6c8dce1a9b48635b53
+  data.tar.gz: 4522bb4b9addfa2c2622da61442431072311631ec9a97b0a0287210ba50f4aad421982b49f91d177a87d1de038b02f7a25b62da43c842281a0186da740a74ce7

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+## Unreleased Changes
+
+No changes.
+
+## 0.0.8 - Jul 12, 2013
+
+### Bug fix
+
+* [#11][] New `:compile_on_start` option to compile stylesheets when Guard is started. ([@mhayes][])
+* [#7][] Fix crash on Sass syntax failure by displaying Growl notification instead. ([@bradphelan][])
+* [#4][] Changed awkward reporter.announce text . ([@adamnbowen][])
+* [#3][] Added compass syntax success/error notifications. ([@stefanoverna][])
+* [#2][] Fix gemspec preventing `bundle install`. ([@rymai][])
+* [#1][] You can now define the options `:project_path` and `:configuration_file` to
+  find and run Compass Compiler (see README for more information). This was a problem with
+  non-standard deployment. ([@oliamb][])
+
+### Improvement
+
+* Create a watch rules based on the compass config (no more need to create watchers).
+
+## 0.0.6 - Oct 25, 2010
+
+* Guard quit on ctrl-c when `guard-compass` is in.
+
+## 0.0.5 - Oct 24, 2010
+
+* Initial release
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#1]: https://github.com/guard/guard-compass/issues/1
+[#2]: https://github.com/guard/guard-compass/issues/2
+[#3]: https://github.com/guard/guard-compass/issues/3
+[#4]: https://github.com/guard/guard-compass/issues/4
+[#7]: https://github.com/guard/guard-compass/issues/7
+[#11]: https://github.com/guard/guard-compass/issues/11
+[@adamnbowen]: https://github.com/adamnbowen
+[@bradphelan]: https://github.com/bradphelan
+[@mhayes]: https://github.com/mhayes
+[@oliamb]: https://github.com/oliamb
+[@rymai]: https://github.com/rymai
+[@stefanoverna]: https://github.com/stefanoverna

data/README.md

@@ -0,0 +1,86 @@
+# Guard::Compass
+
+[![Gem Version](https://badge.fury.io/rb/guard-compass.png)](http://badge.fury.io/rb/guard-compass) [![Build Status](https://travis-ci.org/guard/guard-compass.png?branch=master)](https://travis-ci.org/guard/guard-compass) [![Dependency Status](https://gemnasium.com/guard/guard-compass.png)](https://gemnasium.com/guard/guard-compass) [![Code Climate](https://codeclimate.com/github/guard/guard-compass.png)](https://codeclimate.com/github/guard/guard-compass) [![Coverage Status](https://coveralls.io/repos/guard/guard-compass/badge.png?branch=master)](https://coveralls.io/r/guard/guard-compass)
+
+Guard::Compass allows to automatically run [Compass](https://github.com/chriseppstein/compass)
+whenever a stylesheet file is modified.
+
+* Tested against Ruby 1.8.7, 1.9.3, 2.0.0, JRuby (1.8 mode & 1.9 mode) & Rubinius (1.8 mode & 1.9 mode).
+
+## Install
+
+Please be sure to have [Guard](http://github.com/guard/guard) installed before continue.
+
+The simplest way to install Guard::Compass is to use [Bundler](http://gembundler.com/).
+
+Add Guard::Compass to your `Gemfile`:
+
+```ruby
+group :development do
+  gem 'guard-compass'
+end
+```
+
+and install it by running Bundler:
+
+```bash
+$ bundle
+```
+
+Add guard definition to your Guardfile by running the following command:
+
+```bash
+guard init compass
+```
+
+## Usage
+
+Please read [Guard usage doc](http://github.com/guard/guard#readme)
+
+## Configure Guard::Compass plug-in
+
+The default configuration generated by 'guard init compass' looks like this
+
+```ruby
+guard :compass
+```
+
+## Options
+
+### List of available options
+
+```ruby
+:project_path => '../foo/bar'                 # path to the compass project directory (from guard working directory)
+:configuration_file => '../compass_config.rb' # path to your compass configuration file (from guard working directory)
+```
+
+By default, the project path is equal to the guard working directory (the folder from where you start Guard).
+Compass will look into some default location for the config file from there.
+
+The configuration_file is computed by compass. You don't need to define watchers like
+in other Guard plug-in because they are generated from the Compass configuration files, cool!
+
+For the complete list of options, please refer to the Compass documentation.
+
+## Development
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard-compass/master/frames).
+* Source hosted at [GitHub](https://github.com/guard/guard-compass).
+
+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. All specs run by Travis CI must pass.
+* Update the [README](https://github.com/guard/guard-compass/blob/master/README.md).
+* 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).
+
+## Maintainer
+
+[Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai), [rymai.me](http://rymai.me))
+
+## Author
+
+[Olivier Amblet](https://github.com/oliamb)

data/lib/guard/compass.rb

@@ -1,56 +1,163 @@
 require 'guard'
 require 'guard/guard'
+require 'guard/watcher'
+require 'guard/reporter'
+require 'guard/compass_helper'
 
 require 'compass'
 require 'compass/commands'
 require 'compass/logger'
+require 'compass/compiler'
+
+module Compass
+  class Compiler
+    alias :old_handle_exception :handle_exception
+    def handle_exception(sass_filename, css_filename, e)
+      old_handle_exception(sass_filename, css_filename, e)
+      # rethrow the exception, we need it to notificate the user!
+      raise Sass::SyntaxError, "[#{File.basename(sass_filename)}:#{e.sass_line}] #{e.message}"
+    end
+  end
+end
 
 module Guard
   class Compass < Guard
-    attr_reader :updater
-    
-    VERSION = '0.0.6'
-    
+    attr_reader :updater, :working_path
+    attr_accessor :reporter
+
     def initialize(watchers = [], options = {})
       super
-      @options[:workdir] = File.expand_path(File.dirname("."))
+      @reporter = Reporter.new
+      @working_path = Pathname.pwd # the Guard base path is the current working_path
+    end
+
+    # Load Compass Configuration
+    def create_watchers
+      # root_path is the path to the compass project
+      # working_path is the current Guard (and by extension Compass) working directory
+
+      watchers.clear
+
+      config_file = (options[:configuration_file] || ::Compass.detect_configuration_file(root_path))
+      config_path = pathname(working_path, config_file)
+      src_path = pathname(root_path, ::Compass.configuration.sass_dir)
+
+      watchers.push Watcher.new(%r{^#{src_path.relative_path_from(working_path)}/.*})
+      watchers.push Watcher.new(%r{^#{config_path.relative_path_from(working_path)}$})
+    end
+
+    def root_path
+      options[:project_path].nil? ? working_path : pathname(working_path, options[:project_path])
+    end
+
+    def valid_sass_path?
+      if ::Compass.configuration.sass_dir.nil?
+        reporter.failure("Sass files src directory not set.\nPlease check your Compass configuration.")
+        return false
+      end
+
+      path = pathname(root_path, ::Compass.configuration.sass_dir )
+
+      unless path.exist?
+        reporter.failure("Sass files src directory not found: #{path}\nPlease check your Compass configuration.")
+        false
+      else
+        true
+      end
+    end
+
+    def valid_configuration_path?
+      config_file = (options[:configuration_file] || ::Compass.detect_configuration_file(root_path))
+
+      if config_file.nil?
+        reporter.failure "Cannot find a Compass configuration file, please add information to your Guardfile guard 'compass' declaration."
+        return false
+      end
+
+      config_path = pathname(working_path, config_file)
+
+      if config_path.exist?
+        true
+      else
+        reporter.failure "Compass configuration file not found: #{config_path}\nPlease check Guard configuration."
+        false
+      end
     end
-    
+
     # Guard Interface Implementation
-    
+
     # Compile all the sass|scss stylesheets
     def start
       create_updater
-      UI.info "Guard::Compass is watching at your stylesheets."
+      if options[:compile_on_start]
+        reporter.announce "Guard::Compass is going to compile your stylesheets."
+        perform
+      else
+        reporter.announce "Guard::Compass is waiting to compile your stylesheets."
+      end
       true
     end
-    
+
     def stop
       @updater = nil
       true
     end
-    
+
     # Reload the configuration
     def reload
       create_updater
       true
     end
-    
+
     # Compile all the sass|scss stylesheets
     def run_all
-      @updater.execute
-      true
+      perform
     end
-    
+
     # Compile the changed stylesheets
     def run_on_change(paths)
-      @updater.execute
-      true
+      perform
     end
-    
+
     private
+      include CompassHelper
+
+      # Cleanup of the given options
+      def cleanup_options
+        # Ensure configuration file make reference to an absolute path.
+        if options[:configuration_file]
+          options[:configuration_file] = pathname(working_path, options[:configuration_file]).to_s
+        end
+      end
+
+      def perform
+        if valid_sass_path?
+          begin
+            @updater.execute
+          rescue Sass::SyntaxError => e
+            msg = "#{e.sass_backtrace_str}"
+            ::Guard::Notifier.notify msg, :title => "Guard Compass", :image => :failed
+            return false
+          rescue Exception => e
+            ::Guard::Notifier.notify e.to_s, :title => "Guard Compass", :image => :failed
+            return false
+          end
+          true
+        else
+          false
+        end
+      end
+
       def create_updater
-        @updater = ::Compass::Commands::UpdateProject.new(@options[:workdir] , @options)
+        cleanup_options
+        if valid_configuration_path?
+          @updater = ::Compass::Commands::UpdateProject.new(working_path.to_s, options)
+          create_watchers
+          return valid_sass_path?
+        else
+          return false
+        end
       end
+
   end
-end
+end

data/lib/guard/compass/templates/Guardfile

@@ -1,3 +1,15 @@
-guard 'compass' do
-  watch('^src/(.*)\.s[ac]ss')
-end
+# Guard::Compass
+#
+# You don't need to configure watchers for guard 'compass' declaration as they generated
+# from your Compass configuration file. You might need to define the Compass working directory
+# and point to the configuration file depending of your project structure.
+#
+# Available options:
+#
+# * :workging_directory => Define the Compass working directory, relative to the Guardfile directory
+# * :configuration_file => Path to the Compass configuration file, relative to :project_path
+#
+# Like usual, the Compass configuration path are relative to the :project_path
+
+# guard 'compass', :project_path => 'not_current_dir', :configuration_file => 'path/to/my/compass_config.rb'
+guard :compass

data/lib/guard/compass/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module CompassVersion
+    VERSION = '0.0.8'
+  end
+end

data/lib/guard/compass_helper.rb

@@ -0,0 +1,47 @@
+require 'compass'
+require 'compass/commands'
+require 'compass/commands/project_base'
+require 'compass/compiler'
+
+module Guard
+  module CompassHelper
+    # Build a path agains components that might be relative or absolute.
+    # Whenever an absolute component is found, it became the new 
+    # base path on which next relative components are built.
+    def pathname(*components)
+      result = Pathname.pwd
+      components.each do |c|
+        pc = Pathname.new(c)
+        if(pc.relative?)
+          result = result + pc
+        else
+          result = pc
+        end
+      end
+      return result
+    rescue
+      raise "Cannot process #{components.inspect}: #{$!}"
+    end
+    
+    # Excerpt from Compass updater commands #
+
+    def check_for_sass_files!(compiler)
+      if compiler.sass_files.empty?
+        message = "Nothing to compile. If you're trying to start a new project, you have left off the directory argument.\n"
+        message << "Run \"compass -h\" to get help."
+        raise Compass::Error, message
+      end
+    end
+
+    def new_compiler_instance(working_path)
+      compiler_opts = ::Compass.sass_engine_options
+      compiler_opts.merge!(:quiet => options[:quiet],
+                           :force => options[:force],
+                           :dry_run => options[:dry_run])
+      ::Compass::Compiler.new(working_path,
+        ::Compass.configuration.sass_path,
+        ::Compass.configuration.css_path,
+        compiler_opts)
+    end
+  end
+end

data/lib/guard/reporter.rb

@@ -0,0 +1,19 @@
+module Guard
+  # Send a report to the Guard UI
+  # The Reporter is a wrapper arround guard UI because
+  # it is currently subject to change.
+  class Reporter
+    def success(message)
+      UI.info(message)
+    end
+    def failure(message)
+      UI.error(message)
+    end
+    def unstable(message)
+      UI.info(message)
+    end
+    def announce(message)
+      UI.info(message)
+    end
+  end
+end

metadata

@@ -1,153 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guard-compass
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+version: !ruby/object:Gem::Version
+  version: 0.0.8
 platform: ruby
-authors: 
+authors:
 - Olivier Amblet
+- Rémy Coutable
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-26 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 0
-        - 2
-        - 1
-        version: 0.2.1
-  prerelease: false
-  type: :runtime
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 61
-        segments: 
-        - 0
-        - 10
-        - 5
-        version: 0.10.5
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
   type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
   name: compass
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 0
-        - 2
-        version: 1.0.2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+  type: :runtime
   prerelease: false
-  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.5
+- !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7712058
-        segments: 
-        - 2
-        - 0
-        - 0
-        - rc
-        version: 2.0.0.rc
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rspec
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 1
-        - 4
-        version: 0.1.4
   prerelease: false
-  type: :development
-  name: guard-rspec
-  version_requirements: *id005
-description: Guard::Compass automatically rebuilds scss|sass files when a modification occurs taking in account your compass configuration.
-email: 
-- olivier@amblet.net
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Guard::Compass automatically rebuilds scss|sass files when a modification
+  occurs taking in account your compass configuration.
+email:
+- remy@rymai.me
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/guard/compass/templates/Guardfile
+- lib/guard/compass/version.rb
 - lib/guard/compass.rb
+- lib/guard/compass_helper.rb
+- lib/guard/reporter.rb
+- CHANGELOG.md
 - LICENSE
-- README.textile
-has_rdoc: true
-homepage: http://rubygems.org/gems/guard-compass
+- README.md
+homepage: https://github.com/guard/guard-compass
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: guard-compass
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Guard gem for Compass
 test_files: []
-

data/README.textile

@@ -1,25 +0,0 @@
-h1. Guard Compass Plug-in
-
-Let you configure a Guard that will run compass whenever a stylesheet is updated.
-
-h2. Quick Start
-
-bc. $ (sudo) gem install compass
-$ compass -f blueprint my_compass_project
-$ cd my_compass_project
-$ bundle init
-
-Then, edit the Gemfile for it to looks like:
-
-bc. source "http://rubygems.org"
-gem 'guard-compass'
-
-You can now download missing gems and initialize the guard
-
-bc. $ bundle install
-$ guard init
-$ guard init compass
-$ guard
-
-Your scss(or sass) stylesheets are now guarded.
-