Skip to content
This repository
Browse code

Keeping the Changelog up to date and improved the Readme

  • Loading branch information...
commit 11c3e0b782da383a73c0b3e827851a0d02c75ecd 1 parent 42e4413
Rémy Coutable authored
30  CHANGELOG.markdown → CHANGELOG.md
Source Rendered
... ...
@@ -1,6 +1,23 @@
  1
+## 0.4.0.rc - May 28, 2011
  2
+
  3
+### Bugs fixes:
  4
+
  5
+- Pull request [#69](https://github.com/guard/guard/pull/69): Fixed typo in README: Ctr-/ => Ctr-\\. ([@tinogomes](https://github.com/tinogomes))
  6
+- Pull request [#66](https://github.com/guard/guard/pull/66): Support for dashes in guard names. ([@johnbintz](https://github.com/johnbintz))
  7
+- Require `guard/ui` because Guard::Notifier can be required without full Guard. ([@yannlugrin](https://github.com/yannlugrin))
  8
+- Handled quick file (<1s) modification. Avoid to catch modified files without content modification (sha1 checksum). ([@thibaudgg](https://github.com/thibaudgg) and [@netzpirat](https://github.com/netzpirat))
  9
+- Fixed Guard::Notifier (when growl/libnotify not present). ([@thibaudgg](https://github.com/thibaudgg))
  10
+- Fixed Rubygems deprecation messages. ([@thibaudgg](https://github.com/thibaudgg))
  11
+
1 12
 ### New features:
2 13
 
3  
-- Pull request [#55](https://github.com/guard/guard/issues/55): It is now possible to pass `:guardfile` (a Guardfile path) or `:guardfile_contents` (the content of a Guardfile). Hence this allows to use Guard::Dsl.evaluate_guardfile in a programmatic manner. ([@anithri](https://github.com/anithri), improved by ([@rymai](https://github.com/rymai))
  14
+- Pull request [#67](https://github.com/guard/guard/pull/67): Allow Guardfile in $HOME folder. ([@hashrocketeer](https://github.com/hashrocketeer))
  15
+- Pull request [#64](https://github.com/guard/guard/pull/64): Windows notifications support. ([@stereobooster](https://github.com/stereobooster))
  16
+- Use ENV['GUARD_NOTIFY"] to disable notifications. ([@thibaudgg](https://github.com/thibaudgg))
  17
+- Cleaning up all specs. ([@netzpirat](https://github.com/netzpirat))
  18
+- Pull request [#60](https://github.com/guard/guard/pull/60): Added Windows support. ([@stereobooster](https://github.com/stereobooster))
  19
+- Pull request [#58](https://github.com/guard/guard/pull/58): Extract code from signal handlers into methods. ([@nicksieger](https://github.com/nicksieger))
  20
+- Pull request [#55](https://github.com/guard/guard/pull/55): It is now possible to pass `:guardfile` (a Guardfile path) or `:guardfile_contents` (the content of a Guardfile) to `Guard::Dsl.evaluate_guardfile`. Hence this allows the use of `Guard::Dsl.evaluate_guardfile` in a programmatic manner. ([@anithri](https://github.com/anithri), improved by ([@rymai](https://github.com/rymai))
4 21
 
5 22
 
6 23
 ## 0.3.4 - April 24, 2011
@@ -27,7 +44,7 @@
27 44
 
28 45
 ### Bugs fixes:
29 46
 
30  
-- Pull request [#43](https://github.com/guard/guard/issues/43): Fixed `guard init` command. ([@brainopia](https://github.com/brainopia))
  47
+- Pull request [#43](https://github.com/guard/guard/pull/43): Fixed `guard init` command. ([@brainopia](https://github.com/brainopia))
31 48
 
32 49
 
33 50
 ## 0.3.1 - April 14, 2011
@@ -53,8 +70,7 @@
53 70
 ### New features:
54 71
 
55 72
 - The whole directory is now watched during `run_on_change` to detect new files modifications. ([@thibaudgg](https://github.com/thibaudgg))
56  
-- Pull request [#26](https://github.com/guard/guard/issues/26): New DSL method: `group` allows you to group several guards. ([@netzpirat](https://github.com/netzpirat))
57  
-- Pull request [#26](https://github.com/guard/guard/issues/26): New CLI option: `--group group_name` to specify certain groups of guards to start. ([@netzpirat](https://github.com/netzpirat))
  73
+- Pull request [#26](https://github.com/guard/guard/pull/26): New DSL method: `group` allows you to group several guards. New CLI option: `--group group_name` to specify certain groups of guards to start. ([@netzpirat](https://github.com/netzpirat))
58 74
 - `watch` patterns are now more strict: strings are matched with `String#==`, `Regexp` are matched with `Regexp#match`. ([@rymai](https://github.com/rymai))
59 75
 - A deprecation warning is displayed if your `Guardfile` contains `String` that look like `Regexp` (bad!). ([@rymai](https://github.com/rymai))
60 76
 - It's now possible to return an `Enumerable` in the `watch` optional blocks in the `Guardfile`. ([@rymai](https://github.com/rymai))
@@ -62,7 +78,7 @@
62 78
 ### New specs:
63 79
 
64 80
 - Guard::Watcher. ([@rymai](https://github.com/rymai))
65  
-- Pull request [#13](https://github.com/guard/guard/issues/13): Guard::Dsl. ([@oliamb](https://github.com/oliamb))
  81
+- Pull request [#13](https://github.com/guard/guard/pull/13): Guard::Dsl. ([@oliamb](https://github.com/oliamb))
66 82
 
67 83
 
68 84
 ## 0.2.2 - October 25, 2010
@@ -76,8 +92,8 @@
76 92
 
77 93
 ### Bugs fixes:
78 94
 
79  
-- Pull request [#7](https://github.com/guard/guard/issues/7): Fixes for Linux support. ([@yannlugrin](https://github.com/yannlugrin)))
80  
-- Pull request [#6](https://github.com/guard/guard/issues/6): Locate guard now chomp newline in result path. ([@yannlugrin](https://github.com/yannlugrin)))
  95
+- Pull request [#7](https://github.com/guard/guard/pull/7): Fixes for Linux support. ([@yannlugrin](https://github.com/yannlugrin)))
  96
+- Pull request [#6](https://github.com/guard/guard/pull/6): Locate guard now chomp newline in result path. ([@yannlugrin](https://github.com/yannlugrin)))
81 97
 
82 98
 
83 99
 ## 0.2.0 - October 21, 2010
31  README.markdown → README.md
Source Rendered
@@ -103,7 +103,7 @@ or if you use Bundler, to run the Guard executable specific to your bundle:
103 103
 $ bundle exec guard
104 104
 ```
105 105
 
106  
-Guard will look for a Guardfile in your current directory. If it does not find one, it will look in your home directory for one.
  106
+Guard will look for a Guardfile in your current directory. If it does not find one, it will look in your `$HOME` directory for one.
107 107
 
108 108
 Command line options
109 109
 --------------------
@@ -122,7 +122,7 @@ $ guard --notify false
122 122
 $ guard -n f # shortcut
123 123
 ```
124 124
 
125  
-Notifications can also be disabled by setting a `GUARD_NOTIFY` environment variable to `false`
  125
+Notifications can also be disabled globally by setting a `GUARD_NOTIFY` environment variable to `false`
126 126
 
127 127
 The guards to start can be specified by group (see the Guardfile DSL below) specifying the `--group` (or `-g`) option:
128 128
 
@@ -212,6 +212,31 @@ group 'frontend' do
212 212
 end
213 213
 ```
214 214
 
  215
+The Guardfile DSL can also be used in a programmatic fashion by calling directly `Guard::Dsl.evaluate_guardfile`.
  216
+Available options are as follow:
  217
+
  218
+* `:guardfile`          - The path to a valid Guardfile.
  219
+* `:guardfile_contents` - A string representing the content of a valid Guardfile
  220
+
  221
+Without any options given, Guard will look for a Guardfile in your current directory and if it does not find one, it will look in your `$HOME` directory for one.
  222
+
  223
+For instance, you could use it as follow:
  224
+
  225
+``` ruby
  226
+gem 'guard'
  227
+require 'guard'
  228
+
  229
+Guard.setup
  230
+
  231
+Guard::Dsl.evaluate_guardfile(:guardfile => '/Your/Custom/Path/To/A/Valid/Guardfile')
  232
+# or
  233
+Guard::Dsl.evaluate_guardfile(:guardfile_contents => "
  234
+  guard 'rspec' do
  235
+    watch(%r{^spec/.+_spec\.rb})
  236
+  end
  237
+")
  238
+```
  239
+
215 240
 Create a new guard
216 241
 ------------------
217 242
 
@@ -304,7 +329,7 @@ Development
304 329
 * Report Issues/Questions/Feature requests on [GitHub Issues](https://github.com/guard/guard/issues).
305 330
 
306 331
 Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
307  
-you make.
  332
+you make. Please do not change the version in your pull-request.
308 333
 
309 334
 Author
310 335
 ------
3  lib/guard/dsl.rb
@@ -3,9 +3,6 @@ class Dsl
3 3
     class << self
4 4
       @@options = nil
5 5
       
6  
-      # TODO: Add documentation to explain that it is possible to pass `:guardfile` (a Guardfile path)
7  
-      # or `:guardfile_contents` (the content of a Guardfile). Hence this allows to use Guard::Dsl.evaluate_guardfile
8  
-      # in a programmatic manner
9 6
       def evaluate_guardfile(options = {})
10 7
         options.is_a?(Hash) or raise ArgumentError.new("evaluate_guardfile not passed a Hash!")
11 8
 

0 notes on commit 11c3e0b

Please sign in to comment.
Something went wrong with that request. Please try again.