guard 1.0.0 → 1.0.1

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## Master
+
+## 1.0.1 - 7 March, 2012
+
+### Improvements
+
+- [#236](https://github.com/guard/guard/pull/236) Add support for `notifysend`. ([@alandipert][])
+- Update vendor/darwin to rb-fsevent 0.9.0. ([@thibaudgg][])
+- [#249 & #250](https://github.com/guard/guard/issues/250) Fix programmatic examples that didn't work. ([@oreoshake][])
+- [#238](https://github.com/guard/guard/issues/238) Don't try to load the FSEvents listener on older versions of OSX. ([@philomory][])
+- [#233](https://github.com/guard/guard/issues/233) Guard::Listener.select_and_init requires hash. (reported by [@sunaku][], fixed by [@thibaudgg][])
+- [#227 & #232](https://github.com/guard/guard/issues/232) Add the ability to initialize all guards at once. (proposed by [@rupert654][], done by [@Maher4Ever][])
+
 ## 1.0.0 - 19 January, 2012
 
 ### Improvements
@@ -385,6 +398,7 @@
 - Improved listeners support (`rb-fsevent` & `rb-inotify`). ([@thibaudgg][])
 - Added polling listening fallback. ([@thibaudgg][])
 
+[@alandipert]: https://github.com/alandipert
 [@anithri]: https://github.com/anithri
 [@benolee]: https://github.com/benolee
 [@brainopia]: https://github.com/brainopia
@@ -426,9 +440,12 @@
 [@nicksieger]: https://github.com/nicksieger
 [@niklas]: https://github.com/niklas
 [@oliamb]: https://github.com/oliamb
+[@oreoshake]: https://github.com/oreoshake
 [@pcreux]: https://github.com/pcreux
+[@philomory]: https://github.com/philomory
 [@pirukire]: https://github.com/pirukire
 [@rmm5t]: https://github.com/rmm5t
+[@rupert654]: https://github.com/rupert654
 [@rymai]: https://github.com/rymai
 [@scottdavis]: https://github.com/scottdavis
 [@semperos]: https://github.com/semperos

data/README.md

@@ -66,8 +66,31 @@ the time, try the [Rubygems Bundler](https://github.com/mpapis/rubygems-bundler)
 You can configure Guard to make use of the following system notification libraries, but it's strongly recommended
 to use either Ruby GNTP, Libnotify or Notifu:
 
+#### Growl
+
+* Runs on Mac OS X
+* Supports all [Growl](http://growl.info/) versions
+
+The [growl](https://rubygems.org/gems/growl) gem is compatible with all versions of Growl and uses a command line tool
+[growlnotify](http://growl.info/extras.php#growlnotify) that must be separately downloaded and installed. The version of
+the command line tool must match your Growl version. The `growl` gem does **not** support multiple notification
+channels.
+
+You have to download the installer for `growlnotify` from the [Growl download section](http://growl.info/downloads).
+
+To use `growl` you have to add it to your `Gemfile` and run bundler:
+
+```ruby
+group :development do
+  gem 'growl'
+end
+```
+
 #### Ruby GNTP
 
+**There's currently a bug in Growl that prevents displaying the icons through GNTP, see
+[issue #231](https://github.com/guard/guard/issues/231). Use the growl gem until fixed.**
+
 * Runs on Mac OS X, Linux and Windows
 * Supports [Growl](http://growl.info/) version >= 1.3, [Growl for Linux](http://mattn.github.com/growl-for-linux/),
   [Growl for Windows](http://www.growlforwindows.com/gfw/default.aspx) and
@@ -105,6 +128,10 @@ group :development do
 end
 ```
 
+If you are unable to build the `libnotify` gem on your system, Guard
+also has a built in notifier - `notifysend` - that shells out to the
+`notify-send` utility that comes with `libnotify-bin`.
+
 #### Notifu
 
 * Runs on Windows
@@ -120,26 +147,6 @@ group :development do
 end
 ```
 
-#### Growl
-
-* Runs on Mac OS X
-* Supports all [Growl](http://growl.info/) versions
-
-The [growl](https://rubygems.org/gems/growl) gem is compatible with all versions of Growl and uses a command line tool
-[growlnotify](http://growl.info/extras.php#growlnotify) that must be separately downloaded and installed. The version of
-the command line tool must match your Growl version. The `growl` gem does **not** support multiple notification
-channels.
-
-You have to download the installer for `growlnotify` from the [Growl download section](http://growl.info/downloads).
-
-To use `growl` you have to add it to your `Gemfile` and run bundler:
-
-```ruby
-group :development do
-  gem 'growl'
-end
-```
-
 #### GrowlNotify
 
 * Runs on Mac OS X
@@ -201,26 +208,41 @@ $ guard help start
 
 ### Init
 
-You can generate an empty `Guardfile` by running the `init` task:
+You can generate a Guardfile and have all installed guards be automatically added into
+it by running the `init` task without any option:
 
 ```bash
 $ guard init
 ```
 
-In addition, the `init` task can be used to append a supplied Guard template from an installed Guard to your existing
-`Guardfile`:
+You can also specify the name of an installed Guard to only get that Guard
+in the generated Guardfile:
 
 ```bash
 $ guard init <guard-name>
 ```
 
-You can also define your own templates in `~/.guard/templates/` which can be appended in the same way to your existing 
+You can also define your own templates in `~/.guard/templates/` which can be appended in the same way to your existing
 `Guardfile`:
 
 ```bash
 $ guard init <template-name>
 ```
 
+**Note**: If you already have a `Guardfile` in the current directory, the `init` task can be used
+to append a supplied Guard template from an installed Guard to your existing
+`Guardfile`.
+
+#### `-b`/`--bare` option
+
+You can generate an empty `Guardfile` by running the `init` task with the bare
+option:
+
+```bash
+$ guard init --bare
+$ guard init -b # shortcut
+```
+
 ### Start
 
 Just launch Guard inside your Ruby or Rails project with:
@@ -796,8 +818,7 @@ Evaluate a `Guardfile`:
 require 'guard'
 
 Guard.setup
-Guard::Dsl.evaluate_guardfile(:guardfile => '/path/to/Guardfile')
-Guard.start
+Guard.start(:guardfile => '/path/to/Guardfile')
 ```
 
 Evaluate a string as `Guardfile`:
@@ -813,8 +834,7 @@ guardfile = <<-EOF
   end
 EOF
 
-Guard::Dsl.evaluate_guardfile(:guardfile_contents => guardfile)
-Guard.start
+Guard.start(:guardfile_contents => guardfile)
 ```
 
 Issues
@@ -832,7 +852,7 @@ When you file an issue, please try to follow to these simple rules if applicable
 * Add your `Guardfile` and `Gemfile` to the issue.
 * Make sure that the issue is reproducible with your description.
 
-Development [![Dependency Status](https://gemnasium.com/guard/guard.png?branch=master)](https://gemnasium.com/guard/guard) 
+Development [![Dependency Status](https://gemnasium.com/guard/guard.png?branch=master)](https://gemnasium.com/guard/guard)
 -----------
 
 * Documentation hosted at [RubyDoc](http://rubydoc.info/github/guard/guard/master/frames).
@@ -854,7 +874,7 @@ For questions please join us in our [Google group](http://groups.google.com/grou
 Core Team
 ---------
 
-* [Michael Kessler](https://github.com/netzpirat) ([@netzpirat](http://twitter.com/netzpirat))
+* [Michael Kessler](https://github.com/netzpirat) ([@netzpirat](http://twitter.com/netzpirat)), sponsored by [mksoft.ch](https://mksoft.ch)
 * [Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai))
 * [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg))
 

data/lib/guard.rb

@@ -23,44 +23,62 @@ module Guard
   class << self
     attr_accessor :options, :interactor, :listener, :lock
 
-    # Creates the initial Guardfile template and/or add a Guard implementation
-    # Guardfile template to an existing Guardfile.
+    # Creates the initial Guardfile template when it does not
+    # already exist.
     #
-    # @see Guard::Guard.init
+    # @see Guard::CLI.init
     #
-    # @param [String] guard_name the name of the Guard or template to initialize
+    # @param [Hash] options The options for creating a Guardfile
+    # @option options [Boolean] :abort_on_existence Whether to abort or not when a Guardfile already exists
     #
-    def initialize_template(guard_name = nil)
+    def create_guardfile(options = {})
       if !File.exist?('Guardfile')
         ::Guard::UI.info "Writing new Guardfile to #{ Dir.pwd }/Guardfile"
         FileUtils.cp(GUARDFILE_TEMPLATE, 'Guardfile')
-      elsif guard_name.nil?
+      elsif options[:abort_on_existence]
         ::Guard::UI.error "Guardfile already exists at #{ Dir.pwd }/Guardfile"
-        exit 1
+        abort
       end
+    end
 
-      if guard_name
-        guard_class = ::Guard.get_guard_class(guard_name, true)
-        if guard_class
-          guard_class.init(guard_name)
-        elsif File.exist?(File.join(HOME_TEMPLATES, guard_name))
-          content  = File.read('Guardfile')
-          template = File.read(File.join(HOME_TEMPLATES, guard_name))
-
-          File.open('Guardfile', 'wb') do |f|
-            f.puts(content)
-            f.puts("")
-            f.puts(template)
-          end
+    # Adds the Guardfile template of a Guard implementation
+    # to an existing Guardfile.
+    #
+    # @see Guard::CLI.init
+    #
+    # @param [String] guard_name the name of the Guard or template to initialize
+    #
+    def initialize_template(guard_name)
+      guard_class = ::Guard.get_guard_class(guard_name, true)
 
-          ::Guard::UI.info "#{ guard_name } template added to Guardfile, feel free to edit it"
-        else
-          const_name  = guard_name.downcase.gsub('-', '')
-          UI.error "Could not load 'guard/#{ guard_name.downcase }' or '~/.guard/templates/#{ guard_name.downcase }' or find class Guard::#{ const_name.capitalize }"
+      if guard_class
+        guard_class.init(guard_name)
+      elsif File.exist?(File.join(HOME_TEMPLATES, guard_name))
+        content  = File.read('Guardfile')
+        template = File.read(File.join(HOME_TEMPLATES, guard_name))
+
+        File.open('Guardfile', 'wb') do |f|
+          f.puts(content)
+          f.puts("")
+          f.puts(template)
         end
+
+        ::Guard::UI.info "#{ guard_name } template added to Guardfile, feel free to edit it"
+      else
+        const_name  = guard_name.downcase.gsub('-', '')
+        UI.error "Could not load 'guard/#{ guard_name.downcase }' or '~/.guard/templates/#{ guard_name.downcase }' or find class Guard::#{ const_name.capitalize }"
       end
     end
 
+    # Adds the templates of all installed Guard implementations
+    # to an existing Guardfile.
+    #
+    # @see Guard::CLI.init
+    #
+    def initialize_all_templates
+      guard_gem_names.each {|g| initialize_template(g) }
+    end
+
     # Initialize the Guard singleton:
     #
     # - Initialize the internal Guard state.
@@ -206,14 +224,14 @@ module Guard
     # Stop Guard listening to file changes
     #
     def stop
-      UI.info 'Bye bye...', :reset => true
-
       run_on_guards do |guard|
         run_supervised_task(guard, :stop)
       end
 
       interactor.stop if interactor
       listener.stop
+
+      UI.info 'Bye bye...', :reset => true
     end
 
     # Reload all Guards currently enabled.

data/lib/guard/cli.rb

@@ -102,18 +102,35 @@ module Guard
       ::Guard::UI.info "Guard version #{ ::Guard::VERSION }"
     end
 
-    desc 'init [GUARD]', 'Generates a Guardfile at the current working directory, or insert the given GUARD to an existing Guardfile'
+    desc 'init [GUARD]', 'Generates a Guardfile at the current directory (if it is not already there) and adds all installed guards or the given GUARD into it'
 
-    # Appends the Guard template to the `Guardfile`, or creates an initial
-    # `Guardfile` when no Guard name is passed.
+    method_option :bare,
+                  :type => :boolean,
+                  :default => false,
+                  :aliases => '-b',
+                  :banner => 'Generate a bare Guardfile without adding any installed guard into it'
+
+    # Initializes the templates of all installed Guards and adds them
+    # to the `Guardfile` when no Guard name is passed. When passed
+    # a guard name is does the same but only for that Guard.
     #
-    # @see Guard.initialize_template
+    # @see Guard::Guard.initialize_template
+    # @see Guard::Guard.initialize_all_templates
     #
     # @param [String] guard_name the name of the Guard to initialize
     #
     def init(guard_name = nil)
       verify_bundler_presence
-      ::Guard.initialize_template(guard_name)
+
+      ::Guard.create_guardfile(:abort_on_existence => options[:bare])
+
+      return if options[:bare]
+
+      if guard_name.nil?
+        ::Guard::initialize_all_templates
+      else
+        ::Guard.initialize_template(guard_name)
+      end
     end
 
     desc 'show', 'Show all defined Guards and their options'
@@ -135,7 +152,7 @@ module Guard
     # shows a hint to do so if not.
     #
     def verify_bundler_presence
-      ::Guard::UI.warning "You are using Guard outside of Bundler, this is dangerous and could not work. Using `bundle exec guard` is safer." unless ENV['BUNDLE_GEMFILE']
+      ::Guard::UI.warning "You are using Guard outside of Bundler, this is dangerous and may not work. Using `bundle exec guard` is safer." unless ENV['BUNDLE_GEMFILE']
     end
 
   end

data/lib/guard/dsl.rb

@@ -106,20 +106,40 @@ module Guard
       #
       def reevaluate_guardfile
         ::Guard.run do
-          # Stop each old guards
-          ::Guard.run_on_guards do |guard|
-            ::Guard.run_supervised_task(guard, :stop)
-          end
-          ::Guard.guards.clear
-          ::Guard.reset_groups
-          ::Guard::Notifier.clear_notifications
-          @@options.delete(:guardfile_contents)
+          before_reevaluate_guardfile
           Dsl.evaluate_guardfile(@@options)
-          UI.error 'No guards found in Guardfile, please add at least one.' if ::Guard.guards.empty?
+          after_reevaluate_guardfile
+        end
+      end
+
+      # Stop Guards and clear internal state
+      # before the Guardfile will be re-evaluated.
+      #
+      def before_reevaluate_guardfile
+        ::Guard.run_on_guards do |guard|
+          ::Guard.run_supervised_task(guard, :stop)
+        end
+
+        ::Guard.guards.clear
+        ::Guard.reset_groups
+        ::Guard::Notifier.clear_notifications
+
+        @@options.delete(:guardfile_contents)
+      end
+
+      # Start Guards and notification and show a message
+      # after the Guardfile has been re-evaluated.
+      #
+      def after_reevaluate_guardfile
+        ::Guard::Notifier.turn_on if ::Guard::Notifier.enabled?
+
+        if ::Guard.guards.empty?
+          ::Guard::Notifier.notify('No guards found in Guardfile, please add at least one.', :title => 'Guard re-evaluate', :image => :failed)
+        else
           msg = 'Guardfile has been re-evaluated.'
-          UI.info(msg)
-          Notifier.notify(msg)
-          # Start each new guards
+          ::Guard::UI.info(msg)
+          ::Guard::Notifier.notify(msg, :title => 'Guard re-evaluate')
+
           ::Guard.run_on_guards do |guard|
             ::Guard.run_supervised_task(guard, :start)
           end
@@ -134,7 +154,6 @@ module Guard
         new.instance_eval(contents, @@options[:guardfile_path], 1)
       rescue
         UI.error "Invalid Guardfile, original error is:\n#{ $! }"
-        exit 1
       end
 
       # Test if the current `Guardfile` contains a specific Guard.
@@ -185,8 +204,7 @@ module Guard
         end
 
         unless guardfile_contents_usable?
-          UI.error "The command file(#{ @@options[:guardfile] }) seems to be empty."
-          exit 1
+          UI.error 'No Guards found in Guardfile, please add at least one.'
         end
       end
 

data/lib/guard/listener.rb

@@ -32,7 +32,7 @@ module Guard
     # @option options [String] watchdir the directory to watch
     # @return [Guard::Listener] the chosen listener
     #
-    def self.select_and_init(options = nil)
+    def self.select_and_init(options = {})
       watchdir = options && options[:watchdir] && File.expand_path(options[:watchdir])
       watchdir = Dir.pwd unless watchdir
 

data/lib/guard/listeners/darwin.rb

@@ -30,7 +30,7 @@ module Guard
     # @return [Boolean] whether usable or not
     #
     def self.usable?(no_vendor = false)
-      return false unless RbConfig::CONFIG['target_os'] =~ /darwin/i
+      return false unless RbConfig::CONFIG['target_os'] =~ /darwin(9|1\d)/i
 
       $LOAD_PATH << File.expand_path('../../../vendor/darwin/lib', __FILE__) unless no_vendor
       require 'rb-fsevent'

data/lib/guard/notifier.rb

@@ -7,6 +7,7 @@ require 'guard/notifiers/gntp'
 require 'guard/notifiers/growl'
 require 'guard/notifiers/growl_notify'
 require 'guard/notifiers/libnotify'
+require 'guard/notifiers/notifysend'
 require 'guard/notifiers/rb_notifu'
 
 module Guard
@@ -47,6 +48,7 @@ module Guard
         :growl        => ::Guard::Notifier::Growl,
         :growl_notify => ::Guard::Notifier::GrowlNotify,
         :libnotify    => ::Guard::Notifier::Libnotify,
+        :notifysend   => ::Guard::Notifier::NotifySend,
         :notifu       => ::Guard::Notifier::Notifu
     }
 
@@ -151,7 +153,7 @@ module Guard
     # is available.
     #
     def auto_detect_notification
-      available = [:growl_notify, :gntp, :growl, :libnotify, :notifu].any? { |notifier| add_notification(notifier, { }, true) }
+      available = [:growl_notify, :gntp, :growl, :libnotify, :notifysend, :notifu].any? { |notifier| add_notification(notifier, { }, true) }
       ::Guard::UI.info('Guard could not detect any of the supported notification libraries.') unless available
     end