guard 1.1.0.beta → 1.1.0

data/CHANGELOG.md

@@ -1,8 +1,9 @@
-## 1.1.0 - Unreleased
+## 1.1.0 - 2. June, 2012
 
 ### Improvements
 
 - Listening is now handled by the [Listen gem](https://github.com/guard/listen).
+- Replace the `--verbose` option with the `--debug` option.
 - New `--latency`/`-l` option to overwrite Listen's default latency.
 - New `--force-polling`/`-p` option to force usage of the Listen polling listener.
 - `--watch-all-modifications`/`-A` option is removed and is now always on.

data/README.md

@@ -7,7 +7,7 @@ This document contains a lot of information, please take your time and read thes
 any questions, ask them in our [Google group](http://groups.google.com/group/guard-dev) or on `#guard`
 (irc.freenode.net).
 
-Before you file an issue, make sure you have read the file an issue section that contains some
+Before you file an issue, make sure you have read the _[file an issue](#file-an-issue)_ section that contains some
 important information.
 
 Features
@@ -285,13 +285,14 @@ $ guard -g group_name another_group_name # shortcut
 
 See the Guardfile DSL below for creating groups.
 
-#### `-v`/`--verbose` option
+#### `-d`/`--debug` option
 
-Guard can be run in verbose mode:
+Guard can display debug information which can be very usefull for plugins
+developers with:
 
 ```bash
-$ guard --verbose
-$ guard -v # shortcut
+$ guard --debug
+$ guard -d # shortcut
 ```
 
 #### `-w`/`--watchdir` option
@@ -694,177 +695,6 @@ guard :shell do
 end
 ```
 
-Advanced Linux system configuration
------------------------------------
-
-It's not uncommon to encounter a system limit on the number of files you can monitor.
-For example, Ubuntu Lucid's (64bit) inotify limit is set to 8192.
-
-You can get your current inotify file watch limit by executing:
-
-```bash
-$ cat /proc/sys/fs/inotify/max_user_watches
-```
-
-And set a new limit temporary with:
-
-```bash
-sudo sysctl fs.inotify.max_user_watches=524288
-sudo sysctl -p
-```
-
-If you like to make your limit permanent, use:
-
-```bash
-echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf
-sudo sysctl -p
-```
-
-You may also need to pay attention to the values of `max_queued_events` and `max_user_instances`.
-
-Create a Guard
---------------
-
-Creating a new Guard is very easy. For example, to create a Guard named `yoyo` just create a new gem by running `bundle gem guard-yoyo`. Please make your Guard start with `guard-`, so that it can easily be found on RubyGems.
-
-```bash
-$ mkdir guard-yoyo
-$ cd guard-yoyo
-$ bundle gem guard-yoyo
-```
-
-Now extend the project structure to have an initial Guard:
-
-```bash
-.travis.yml  # bonus point!
-CHANGELOG.md # bonus point!
-Gemfile
-guard-yoyo.gemspec
-Guardfile
-lib/
-  guard/
-    yoyo/
-      templates/
-        Guardfile # needed for `guard init <guard-name>`
-      version.rb
-    yoyo.rb
-test/ # or spec/
-README.md
-```
-
-Your Guard main class `Guard::Yoyo` in `lib/guard/guard-yoyo.rb` must inherit from
-[Guard::Guard](http://rubydoc.info/github/guard/guard/master/Guard/Guard) and should implement at least the
-`#run_on_changes` task method. `#run_on_additions`, `#run_on_modifications` and `#run_on_removals` task methods
-could be use instead of `#run_on_changes` task method for more control about how changes are handled.
-
-Here is an example scaffold for `lib/guard/yoyo.rb`:
-
-```ruby
-require 'guard'
-require 'guard/guard'
-
-module Guard
-  class Yoyo < Guard
-
-    # Initialize a Guard.
-    # @param [Array<Guard::Watcher>] watchers the Guard file watchers
-    # @param [Hash] options the custom Guard options
-    def initialize(watchers = [], options = {})
-      super
-    end
-
-    # Call once when Guard starts. Please override initialize method to init stuff.
-    # @raise [:task_has_failed] when start has failed
-    def start
-    end
-
-    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
-    # @raise [:task_has_failed] when stop has failed
-    def stop
-    end
-
-    # Called when `reload|r|z + enter` is pressed.
-    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
-    # @raise [:task_has_failed] when reload has failed
-    def reload
-    end
-
-    # Called when just `enter` is pressed
-    # This method should be principally used for long action like running all specs/tests/...
-    # @raise [:task_has_failed] when run_all has failed
-    def run_all
-    end
-
-    # Default behaviour on file(s) changes that the Guard watches.
-    # @param [Array<String>] paths the changes files or paths
-    # @raise [:task_has_failed] when run_on_change has failed
-    def run_on_changes(paths)
-    end
-  end
-end
-```
-
-Please take a look at the source code of some of the [existing Guards](https://github.com/guard)
-for more concrete example and inspiration.
-
-Alternatively, a new Guard can be added inline to a `Guardfile` with this basic structure:
-
-```ruby
-require 'guard/guard'
-
-module ::Guard
-  class InlineGuard < ::Guard::Guard
-    def run_all
-    end
-
-    def run_on_changes(paths)
-    end
-  end
-end
-```
-
-[@avdi](https://github.com/avdi) has a very cool inline Guard example in his blog post
-[A Guardfile for Redis](http://avdi.org/devblog/2011/06/15/a-guardfile-for-redis).
-
-Programmatic use of Guard
--------------------------
-
-The Guardfile DSL can also be used in a programmatic fashion by calling
-[Guard::Dsl.evaluate_guardfile](http://rubydoc.info/github/guard/guard/master/Guard/Dsl#evaluate_guardfile-class_method).
-
-Available options are as follow:
-
-* `:guardfile`          - The path to a valid `Guardfile`.
-* `:guardfile_contents` - A string representing the content of a valid `Guardfile`.
-
-Remember, without any options given, Guard will look for a `Guardfile` in your current directory and if it does not find
-one, it will look for it in your `$HOME` directory.
-
-Evaluate a `Guardfile`:
-
-```ruby
-require 'guard'
-
-Guard.setup
-Guard.start(:guardfile => '/path/to/Guardfile')
-```
-
-Evaluate a string as `Guardfile`:
-
-```ruby
-require 'guard'
-
-Guard.setup
-
-guardfile = <<-EOF
-  guard 'rspec' do
-    watch(%r{^spec/.+_spec\.rb$})
-  end
-EOF
-
-Guard.start(:guardfile_contents => guardfile)
-```
-
 File an issue
 -------------
 
@@ -879,7 +709,7 @@ using?
 When you file a bug, please try to follow these simple rules if applicable:
 
 * Make sure you run Guard with `bundle exec` first.
-* Add verbose information to the issue by running Guard with the `--verbose` option.
+* Add debug information to the issue by running Guard with the `--debug` option.
 * Add your `Guardfile` and `Gemfile` to the issue.
 * Make sure that the issue is reproducible with your description.
 
@@ -895,10 +725,9 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
 
 * Please create a topic branch for every separate change you make.
 * Make sure your patches are well tested. All specs run with `rake spec:portability` must pass.
-  * On OS X you need to compile once rb-fsevent executable with `rake build_mac_exec`.
 * Update the [Yard](http://yardoc.org/) documentation.
-* Update the README.
-* Update the CHANGELOG for noteworthy changes.
+* Update the [README](https://github.com/guard/guard/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/guard/guard/blob/master/CHANGELOG.md) for noteworthy changes.
 * 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
@@ -912,7 +741,7 @@ For questions please join us in our [Google group](http://groups.google.com/grou
 
 * [Maher Sallam](https://github.com/Maher4Ever) ([@mahersalam](http://twitter.com/mahersalam))
 * [Michael Kessler](https://github.com/netzpirat) ([@netzpirat](http://twitter.com/netzpirat), [mksoft.ch](https://mksoft.ch))
-* [Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai), [rymai.me](http://rymai.me/))
+* [Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai), [rymai.me](http://rymai.me))
 * [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg), [thibaud.me](http://thibaud.me/))
 
 ### Contributors

data/lib/guard.rb

@@ -33,7 +33,7 @@ module Guard
     #
     # @option options [Boolean] clear if auto clear the UI should be done
     # @option options [Boolean] notify if system notifications should be shown
-    # @option options [Boolean] verbose if verbose output should be shown
+    # @option options [Boolean] debug if debug output should be shown
     # @option options [Array<String>] group the list of groups to start
     # @option options [String] watchdir the director to watch
     # @option options [String] guardfile the path to the Guardfile
@@ -54,7 +54,7 @@ module Guard
       setup_listener
       setup_signal_traps
 
-      debug_command_execution if @options[:verbose]
+      debug_command_execution if @options[:debug]
 
       Dsl.evaluate_guardfile(options)
       UI.error 'No guards found in Guardfile, please add at least one.' if @guards.empty?

data/lib/guard/cli.rb

@@ -25,11 +25,11 @@ module Guard
                   :aliases => '-n',
                   :banner  => 'Notifications feature (growl/libnotify)'
 
-    method_option :verbose,
+    method_option :debug,
                   :type    => :boolean,
                   :default => false,
-                  :aliases => '-v',
-                  :banner  => 'Show verbose messages'
+                  :aliases => '-d',
+                  :banner  => 'Show debug information'
 
     method_option :group,
                   :type    => :array,
@@ -78,7 +78,7 @@ module Guard
                   :type    => :numeric,
                   :aliases => '-l',
                   :banner  => 'Overwrite Listen\'s default latency'
-    
+
     method_option :force_polling,
                   :type    => :boolean,
                   :default => false,

data/lib/guard/ui.rb

@@ -68,7 +68,7 @@ module Guard
       def debug(message, options = { })
         unless ENV['GUARD_ENV'] == 'test'
           reset_line if options[:reset]
-          STDERR.puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:verbose]
+          STDERR.puts color("DEBUG (#{Time.now.strftime('%T')}): ", :yellow) + message if ::Guard.options && ::Guard.options[:debug]
         end
       end
 
@@ -83,7 +83,7 @@ module Guard
       def clear
         system('clear;') if ::Guard.options[:clear]
       end
-      
+
       # Show a scoped action message.
       #
       # @param [String] action the action to show
@@ -93,7 +93,7 @@ module Guard
         scope_message ||= scopes[:guard]
         scope_message ||= scopes[:group]
         scope_message ||= 'all'
-        
+
         info "#{action} #{scope_message}"
       end
 

data/lib/guard/version.rb

@@ -1,4 +1,4 @@
 module Guard
   # The current gem version of Guard
-  VERSION = '1.1.0.beta'
+  VERSION = '1.1.0'
 end

data/man/guard.1

@@ -27,7 +27,7 @@ The following options are available:
 \fB\-n\fR, \fB\-\-notify\fR \fIFLAG\fR Disable notifications (Growl or Libnotify depending on your system)\. Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false\. FLAG can be \fBtrue\fR/\fBfalse\fR or \fBt\fR/\fBf\fR\.
 .
 .P
-\fB\-v\fR, \fB\-\-verbose\fR Runs Guard in verbose mode\.
+\fB\-d\fR, \fB\-\-debug\fR Runs Guard in debug mode\.
 .
 .P
 \fB\-g\fR, \fB\-\-group\fR \fIGROUP1\fR \fIGROUP2\fR\.\.\. Runs only the groups specified by GROUP1, GROUP2 etc\. Groups name should be separated by spaces\. Guards that don\'t belong to a group are considered global and are always run\.

data/man/guard.1.html

@@ -97,8 +97,8 @@
   Notifications can be disabled globally by setting a GUARD_NOTIFY environment variable to false.
   FLAG can be <code>true</code>/<code>false</code> or <code>t</code>/<code>f</code>.</p>
 
-<p><code>-v</code>, <code>--verbose</code>
-  Runs Guard in verbose mode.</p>
+<p><code>-d</code>, <code>--debug</code>
+  Runs Guard in debug mode.</p>
 
 <p><code>-g</code>, <code>--group</code> <var>GROUP1</var> <var>GROUP2</var>...
   Runs only the groups specified by GROUP1, GROUP2 etc.

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta
-  prerelease: 6
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-20 00:00:00.000000000 Z
+date: 2012-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -147,7 +147,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/fsevent_watch_guard
 - bin/guard
 - images/failed.png
 - images/pending.png
@@ -205,3 +204,4 @@ signing_key:
 specification_version: 3
 summary: Guard keeps an eye on your file modifications
 test_files: []
+has_rdoc: