guard 0.6.2 → 0.6.3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.6.3 - September 1, 2011
+
+### New features:
+
+- Pull request [#130](https://github.com/guard/guard/pull/130): Adds ignore_paths option to DSL. ([@ianwhite][])
+- Pull request [#128](https://github.com/guard/guard/pull/128): Users can add additional settings to ~/.guard.rb that augment the existing Guardfile. ([@tpope][])
+
 ## 0.6.2 - August 17, 2011
 
 ### Bugs fixes:
@@ -5,12 +12,12 @@
 - Re-add the possibility to use the `growl` gem since the `growl_notify` gem this is currently known to not work in conjunction with Spork. ([@netzpirat][])
 - Ensure that scoped groups and group name are symbolized before checking for inclusion. ([@rymai][])
 
-### New features
+### New features:
 
 - Groups are now stored in a @groups variable (will be used for future features). ([@rymai][])
 - Guards will now receive their group in the options hash at initialization (will be used for future features). ([@rymai][])
 
-### Improvement
+### Improvement:
 
 - Explain the growl/growl_notify differences in the README. ([@netzpirat][])
 
@@ -28,11 +35,11 @@
 - Pull request [#107](https://github.com/guard/guard/pull/107): Small spelling fix. ([@dnagir][])
 - Dir.glob now ignores files that don't need to be watched. ([@rymai][])
 
-### New features
+### New features:
 
 - Pull request [#112](https://github.com/guard/guard/pull/112): Add `list` command to CLI. ([@docwhat][])
 
-### Improvements
+### Improvements:
 
 - Pull request [#99](https://github.com/guard/guard/pull/99): [OS X] Switch from growl gem to growl_notify gem. ([@johnbintz][])
 - Pull request [#115](https://github.com/guard/guard/pull/115): [Linux] Add ':transient => true' to default libnotify options. ([@zonque][])
@@ -51,12 +58,12 @@
 
 ## 0.5.0 - July 2, 2011
 
-### New features
+### New features:
 
 - Guard::Ego is now part of Guard, so Guardfile is automagically re-evaluated when modified. ([@thibaudgg][])
 - Pull request [#91](https://github.com/guard/guard/pull/91): Show Guards in Guardfile with the `guard -T`. ([@johnbintz][])
 
-### Improvements
+### Improvements:
 
 - Issue [#98](https://github.com/guard/guard/issues/98): Multiple calls per watch event on linux with rb-inotify. ([@jeffutter][] & [@netzpirat][])
 - Pull request [#94](https://github.com/guard/guard/pull/94): Show backtrace in terminal when a problem with a watch action occurs. ([@capotej][])
@@ -78,7 +85,7 @@
 
 ## 0.4.1 - June 7, 2011
 
-### Improvements
+### Improvements:
 
 - Pull request [#77](https://github.com/guard/guard/pull/77): Refactor `get_guard_class` to first try the constant and fallback to require + various tweaks. ([@mislav][])
 - Notifier improvement, don't use system notification library if could not be required. ([@yannlugrin][])
@@ -94,7 +101,7 @@
 - Pull request [#73](https://github.com/guard/guard/pull/73): Allow DSL's `group` method to accept a Symbol as group name. ([@johnbintz][])
 - Pull request [#51](https://github.com/guard/guard/pull/51): Allow options (like `:priority`) to be passed through to the Notifier. ([@indirect][] & [@netzpirat][])
 
-### Improvements
+### Improvements:
 
 - Pull request [#74](https://github.com/guard/guard/pull/74): Added link definitions to make the CHANGELOG more DRY! That's for sure now, we have the cleanest CHANGELOG ever! (even the link definitions are sorted alphabetically!) ([@pcreux][])
 

data/README.md

@@ -1,4 +1,4 @@
-Guard [![Build Status](https://secure.travis-ci.org/guard/guard.png)](http://travis-ci.org/guard/guard)
+Guard [![Build Status](https://travis-ci.org/guard/guard.png)](http://travis-ci.org/guard/guard)
 =====
 
 Guard is a command line tool that easily handle events on files modifications.
@@ -255,10 +255,13 @@ Optional:
 
 * The `#watch` method allows you to define which files are supervised by this guard. An optional block can be added to overwrite the paths sent to the guard's `#run_on_change` method or to launch any arbitrary command.
 * The `#group` method allows you to group several guards together. Groups to be run can be specified with the Guard DSL option `--group` (or `-g`). This comes in handy especially when you have a huge Guardfile and want to focus your development on a certain part. Guards that don't belong to a group are considered global and are always run.
+* The `#ignore_paths` method allows you to ignore top level directories altogether.  This comes is handy when you have large amounts of non-source data in you project.  By default .bundle, .git, log, tmp, and vendor are ignored.  Currently it is only possible to ignore the immediate descendants of the watched directory.
 
 Example:
 
 ``` ruby
+ignore_paths 'foo', 'bar'
+
 group 'backend' do
   guard 'bundler' do
     watch('Gemfile')
@@ -331,6 +334,21 @@ Group frontend:
   livereload
 ```
 
+User config file
+----------------
+
+If a .guard.rb is found in your home directory, it will be appended to
+the Guardfile.  This can be used for tasks you want guard to handle but
+other users probably don't.  For example, indexing your source tree with
+[Ctags](http://ctags.sourceforge.net):
+
+``` ruby
+guard 'shell' do
+  watch(%r{^(?:app|lib)/.+\.rb$}) { `ctags -R` }
+end
+
+```
+
 Create a new guard
 ------------------
 

data/lib/guard/dsl.rb

@@ -7,7 +7,8 @@ module Guard
         options.is_a?(Hash) or raise ArgumentError.new("evaluate_guardfile not passed a Hash!")
 
         @@options = options.dup
-        instance_eval_guardfile(fetch_guardfile_contents)
+        fetch_guardfile_contents
+        instance_eval_guardfile(guardfile_contents_with_user_config)
 
         UI.error "No guards found in Guardfile, please add at least one." if !::Guard.guards.nil? && ::Guard.guards.empty?
       end
@@ -72,14 +73,17 @@ module Guard
           UI.error "The command file(#{@@options[:guardfile]}) seems to be empty."
           exit 1
         end
-
-        guardfile_contents
       end
 
       def guardfile_contents
         @@options ? @@options[:guardfile_contents] : ""
       end
 
+      def guardfile_contents_with_user_config
+        config = File.read(user_config_path) if File.exist?(user_config_path)
+        [guardfile_contents, config].join("\n")
+      end
+
       def guardfile_path
         @@options ? @@options[:guardfile_path] : ""
       end
@@ -102,6 +106,10 @@ module Guard
         File.expand_path(File.join("~", ".Guardfile"))
       end
 
+      def user_config_path
+        File.expand_path(File.join("~", ".guard.rb"))
+      end
+
     end
 
     def group(name, &guard_definition)
@@ -126,5 +134,9 @@ module Guard
       @watchers << ::Guard::Watcher.new(pattern, action)
     end
 
+    def ignore_paths(*paths)
+      UI.info "Ignoring paths: #{paths.join(', ')}"
+      ::Guard.listener.ignore_paths.push(*paths)
+    end
   end
 end

data/lib/guard/listener.rb

@@ -9,8 +9,9 @@ module Guard
   autoload :Polling, 'guard/listeners/polling'
 
   class Listener
+    DefaultIgnorePaths = %w[. .. .bundle .git log tmp vendor]
     
-    attr_reader :directory
+    attr_reader :directory, :ignore_paths
 
     def self.select_and_init(*a)
       if mac? && Darwin.usable?
@@ -29,6 +30,8 @@ module Guard
       @directory           = directory.to_s
       @sha1_checksums_hash = {}
       @relativize_paths    = options.fetch(:relativize_paths, true)
+      @ignore_paths        = DefaultIgnorePaths
+      @ignore_paths        |= options[:ignore_paths] if options[:ignore_paths]
       update_last_event
     end
 
@@ -77,14 +80,19 @@ module Guard
     def relativize_paths?
       !!@relativize_paths
     end
+    
+    # return children of the passed dirs that are not in the ignore_paths list
+    def exclude_ignored_paths(dirs, ignore_paths = self.ignore_paths)
+      Dir.glob(dirs.map { |d| "#{d.sub(%r{/+$}, '')}/*" }, File::FNM_DOTMATCH).reject do |path|
+        ignore_paths.include?(File.basename(path))
+      end
+    end
 
   private
 
     def potentially_modified_files(dirs, options={})
-      paths = Dir.glob(dirs.map { |d| "#{d.sub(%r{/+$}, '')}/*" }, File::FNM_DOTMATCH).reject do |path|
-        %w[. .. .bundle .git log tmp vendor].include?(File.basename(path))
-      end
-
+      paths = exclude_ignored_paths(dirs)
+      
       if options[:all]
         paths.inject([]) do |array, path|
           if File.file?(path)

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = "0.6.2" unless defined? Guard::VERSION
+  VERSION = "0.6.3" unless defined? Guard::VERSION
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-17 00:00:00.000000000Z
+date: 2011-09-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70138447631700 !ruby/object:Gem::Requirement
+  requirement: &70194363346280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138447631700
+  version_requirements: *70194363346280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70138447631080 !ruby/object:Gem::Requirement
+  requirement: &70194363334300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70138447631080
+  version_requirements: *70194363334300
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70138447630400 !ruby/object:Gem::Requirement
+  requirement: &70194363333680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *70138447630400
+  version_requirements: *70194363333680
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70138447629860 !ruby/object:Gem::Requirement
+  requirement: &70194363333100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70138447629860
+  version_requirements: *70194363333100
 description: Guard is a command line tool to easily handle events on file system modifications.
 email:
 - thibaud@thibaud.me
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: guard
-rubygems_version: 1.8.7
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Guard keeps an eye on your file modifications