guard-phpunit 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+## 0.1.4 - August 09, 2012
+
+- [#2][]: Add support for Windows.
+
+## 0.1.3 - June 15, 2012
+
+- [#3][]: Support Guard v1.1 API.
+
+## 0.1.2 - January 26, 2012
+
+- Fix checking phpunit existence on zsh.
+- Update Guard to it's first gold release.
+- Small bug fixes.
+
+## 0.1.1 - January 03, 2012
+
+- Update gem dependencies.
+- Small bug fixes.
+
+## 0.1.0 - November 30, 2011
+
+- Add detection for phpunit existence.
+- Add the `:keep_failed` option.
+- Add the `:all_after_pass` option.
+- Refactor a portion of the code and small bug fixes.
+
+## 0.0.2 - 0.0.3 - November 25, 2011
+
+- Small bug fixes.
+
+## 0.0.1 - November 24, 2011
+
+- Initial release.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#2]: https://github.com/Maher4Ever/guard-phpunit/issues/2
+[#3]: https://github.com/Maher4Ever/guard-phpunit/issues/3

data/LICENSE

@@ -1,19 +1,19 @@
-Copyright (C) 2011 by Maher Sallam
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Copyright (C) 2011 by Maher Sallam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,106 +1,106 @@
-Guard::PHPUnit [![Build Status](https://secure.travis-ci.org/Maher4Ever/guard-phpunit.png)](http://travis-ci.org/Maher4Ever/guard-phpunit) [![Dependency Status](https://gemnasium.com/Maher4Ever/guard-phpunit.png?branch=master)](https://gemnasium.com/Maher4Ever/guard-phpunit)
-==============
-
-Guard-phpunit allows you to automatically run [PHPUnit][6] tests when sources
-are modified. It helps with integrating test-driven development (TDD) into
-your development process: Just launch guard-phpunit before you start working
-and it will notify you about the status of your tests!
-
-*Note*: Although guard-phpunit should work with any [PHP][7] version [PHPUnit][6] supports,
-it has only been tested on [PHP][7] 5.3.8 and 5.4.4.
-
-Install
--------
-
-Please be sure to have [PHP][7], [PHPUnit][6] and [Ruby][1] installed on your machine before
-you proceed with the installation.
-
-The latest versions of [Ruby][1] come with a packages-manager called `gem`. `gem` can be used to
-install various packages, including guard-phpunit.
-
-To install guard-phpunit, run the following command in the terminal:
-
-```shell
-$ gem install guard-phpunit
-```
-
-Usage
------
-
-Please read the [Guard usage documentation][3].
-
-Guardfile
----------
-
-Guard-phpunit can be used with any kind of [PHP][7] projects that uses PHPUnit as
-its testing framwork. Please read the [Guard documentation][3] for more information
-about the Guardfile DSL.
-
-By default, guard-phpunit will use the current working directory (pwd) to
-search for tests and run them on start (if you enabled the `:all_on_start` option).
-
-### Example PHP project
-
-The [PHPUnit documentaion][4] uses the [Object Freezer][5] library as an example on how
-to organize tests. This project uses the `Tests` directory for its tests.
-
-An example of the Guardfile for the same project would look
-something like:
-
-```ruby
-guard 'phpunit', :tests_path => 'Tests', :cli => '--colors' do
-  # Watch tests files
-  watch(%r{^.+Test\.php$})
-
-  # Watch library files and run their tests
-  watch(%r{^Object/(.+)\.php}) { |m| "Tests/#{m[1]}Test.php" }
-end
-```
-
-Options
--------
-
-The following options can be passed to Guard::PHPUnit:
-
-```ruby
-:all_on_start => false        # Run all tests on startup.
-                              # default: true
-
-:all_after_pass => false      # Run all tests after changed tests pass. This ensures
-                              # that the process of making changed tests pass didn't
-                              # break something else.
-                              # default: true
-
-:keep_failed => false         # Remember failed tests and keep running them with
-                              # each change until they pass.
-                              # default: true
-
-:tests_path => 'tests'        # Relative path to the tests directory. This path
-                              # is used when running all the tests.
-                              # default: the current working directory (pwd)
-
-:cli => '--colors'            # The options passed to the phpunit command
-                              # when running the tests.
-                              # default: nil
-```
-
-Development
------------
-
-* Source hosted at [GitHub](https://github.com/Maher4Ever/guard-phpunit)
-* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/Maher4Ever/guard-phpunit/issues)
-
-Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
-you make.
-
-Author
-------
-
-[Maher Sallam](https://github.com/Maher4Ever)
-
-[1]:http://ruby-lang.org
-[3]:https://github.com/guard/guard#readme
-[4]:http://www.phpunit.de/manual/current/en/
-[5]:https://github.com/sebastianbergmann/php-object-freezer/
-[6]:http://www.phpunit.de
-[7]:http://php.net
+Guard::PHPUnit [![Build Status](https://secure.travis-ci.org/Maher4Ever/guard-phpunit.png)](http://travis-ci.org/Maher4Ever/guard-phpunit) [![Dependency Status](https://gemnasium.com/Maher4Ever/guard-phpunit.png?branch=master)](https://gemnasium.com/Maher4Ever/guard-phpunit)
+==============
+
+Guard-phpunit allows you to automatically run [PHPUnit][6] tests when sources
+are modified. It helps with integrating test-driven development (TDD) into
+your development process: Just launch guard-phpunit before you start working
+and it will notify you about the status of your tests!
+
+*Note*: Although guard-phpunit should work with any [PHP][7] version [PHPUnit][6] supports,
+it has only been tested on [PHP][7] 5.3.8 and 5.4.4.
+
+Install
+-------
+
+Please be sure to have [PHP][7], [PHPUnit][6] and [Ruby][1] installed on your machine before
+you proceed with the installation.
+
+The latest versions of [Ruby][1] come with a packages-manager called `gem`. `gem` can be used to
+install various packages, including guard-phpunit.
+
+To install guard-phpunit, run the following command in the terminal:
+
+```shell
+$ gem install guard-phpunit
+```
+
+Usage
+-----
+
+Please read the [Guard usage documentation][3].
+
+Guardfile
+---------
+
+Guard-phpunit can be used with any kind of [PHP][7] projects that uses PHPUnit as
+its testing framwork. Please read the [Guard documentation][3] for more information
+about the Guardfile DSL.
+
+By default, guard-phpunit will use the current working directory (pwd) to
+search for tests and run them on start (if you enabled the `:all_on_start` option).
+
+### Example PHP project
+
+The [PHPUnit documentaion][4] uses the [Object Freezer][5] library as an example on how
+to organize tests. This project uses the `Tests` directory for its tests.
+
+An example of the Guardfile for the same project would look
+something like:
+
+```ruby
+guard 'phpunit', :tests_path => 'Tests', :cli => '--colors' do
+  # Watch tests files
+  watch(%r{^.+Test\.php$})
+
+  # Watch library files and run their tests
+  watch(%r{^Object/(.+)\.php}) { |m| "Tests/#{m[1]}Test.php" }
+end
+```
+
+Options
+-------
+
+The following options can be passed to Guard::PHPUnit:
+
+```ruby
+:all_on_start => false        # Run all tests on startup.
+                              # default: true
+
+:all_after_pass => false      # Run all tests after changed tests pass. This ensures
+                              # that the process of making changed tests pass didn't
+                              # break something else.
+                              # default: true
+
+:keep_failed => false         # Remember failed tests and keep running them with
+                              # each change until they pass.
+                              # default: true
+
+:tests_path => 'tests'        # Relative path to the tests directory. This path
+                              # is used when running all the tests.
+                              # default: the current working directory (pwd)
+
+:cli => '--colors'            # The options passed to the phpunit command
+                              # when running the tests.
+                              # default: nil
+```
+
+Development
+-----------
+
+* Source hosted at [GitHub](https://github.com/Maher4Ever/guard-phpunit)
+* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/Maher4Ever/guard-phpunit/issues)
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
+you make.
+
+Author
+------
+
+[Maher Sallam](https://github.com/Maher4Ever)
+
+[1]:http://ruby-lang.org
+[3]:https://github.com/guard/guard#readme
+[4]:http://www.phpunit.de/manual/current/en/
+[5]:https://github.com/sebastianbergmann/php-object-freezer/
+[6]:http://www.phpunit.de
+[7]:http://php.net

data/lib/guard/phpunit.rb

@@ -1,112 +1,112 @@
-require 'guard'
-require 'guard/guard'
-
-module Guard
-
-  # The PHPUnit guard gets notified about system
-  # events.
-  #
-  class PHPUnit < Guard
-
-    autoload :Inspector, 'guard/phpunit/inspector'
-    autoload :Formatter, 'guard/phpunit/formatter'
-    autoload :Notifier,  'guard/phpunit/notifier'
-    autoload :Runner,    'guard/phpunit/runner'
-
-    DEFAULT_OPTIONS = {
-      :all_on_start   => true,
-      :all_after_pass => true,
-      :keep_failed    => true,
-      :cli            => nil,
-      :tests_path     => Dir.pwd
-    }
-
-    # Initialize Guard::PHPUnit.
-    #
-    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
-    # @param [Hash] options the options for the Guard
-    # @option options [Boolean] :all_on_start run all tests on start
-    # @option options [Boolean] :all_after_pass run all tests after failed tests pass
-    # @option options [Boolean] :keep_failed remember failed tests or not
-    # @option options [String] :cli The CLI arguments passed to phpunit
-    # @option options [String] :tests_path the path where all tests exist
-    #
-    def initialize(watchers = [], options = {})
-      defaults = DEFAULT_OPTIONS.clone
-      @options = defaults.merge(options)
-      super(watchers, @options)
-
-      @failed_paths     = []
-      @previous_failed = false
-
-      Inspector.tests_path = @options[:tests_path]
-    end
-
-    # Gets called once when Guard starts.
-    #
-    # @raise [:task_has_failed] when stop has failed
-    #
-    def start
-      run_all if options[:all_on_start]
-    end
-
-    # Gets called when all tests should be run.
-    #
-    # @raise (see #start)
-    #
-    def run_all
-      success = Runner.run(options[:tests_path], options.merge(
-        :message => 'Running all tests'
-      ))
-
-      @previous_failed = !success
-      throw :task_has_failed unless success
-    end
-
-    # Gets called when the watched tests have changes.
-    #
-    # @param [Array<String>] paths to the changed tests
-    # @raise (see #start)
-    #
-    def run_on_changes(paths)
-      paths = Inspector.clean(paths + @failed_paths)
-      success = Runner.run(paths, options)
-
-      update_failed_paths(success, paths)
-      run_all_after_pass(success)
-      throw :task_has_failed unless success
-    end
-
-    private
-
-    # Adds or removes path to the failed_paths bassed
-    # on the tests result.
-    #
-    # @param [Boolean] tests_passed whether the tests passed or not
-    # @param [Array<String>] paths the tests paths
-    #
-    def update_failed_paths(tests_passed, paths)
-      return unless @options[:keep_failed]
-
-      if tests_passed
-        @failed_paths -= paths
-      else
-        @failed_paths += paths
-      end
-    end
-
-    # Runs all tests after the failed tests pass.
-    #
-    # @param (see .update_failed_paths)
-    #
-    def run_all_after_pass(tests_passed)
-      return unless @options[:all_after_pass]
-
-      if tests_passed
-        run_all if @previous_failed
-      else
-        @previous_failed = true
-      end
-    end
-  end
-end
+require 'guard'
+require 'guard/guard'
+
+module Guard
+
+  # The PHPUnit guard gets notified about system
+  # events.
+  #
+  class PHPUnit < Guard
+
+    autoload :Inspector, 'guard/phpunit/inspector'
+    autoload :Formatter, 'guard/phpunit/formatter'
+    autoload :Notifier,  'guard/phpunit/notifier'
+    autoload :Runner,    'guard/phpunit/runner'
+
+    DEFAULT_OPTIONS = {
+      :all_on_start   => true,
+      :all_after_pass => true,
+      :keep_failed    => true,
+      :cli            => nil,
+      :tests_path     => Dir.pwd
+    }
+
+    # Initialize Guard::PHPUnit.
+    #
+    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
+    # @param [Hash] options the options for the Guard
+    # @option options [Boolean] :all_on_start run all tests on start
+    # @option options [Boolean] :all_after_pass run all tests after failed tests pass
+    # @option options [Boolean] :keep_failed remember failed tests or not
+    # @option options [String] :cli The CLI arguments passed to phpunit
+    # @option options [String] :tests_path the path where all tests exist
+    #
+    def initialize(watchers = [], options = {})
+      defaults = DEFAULT_OPTIONS.clone
+      @options = defaults.merge(options)
+      super(watchers, @options)
+
+      @failed_paths     = []
+      @previous_failed = false
+
+      Inspector.tests_path = @options[:tests_path]
+    end
+
+    # Gets called once when Guard starts.
+    #
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def start
+      run_all if options[:all_on_start]
+    end
+
+    # Gets called when all tests should be run.
+    #
+    # @raise (see #start)
+    #
+    def run_all
+      success = Runner.run(options[:tests_path], options.merge(
+        :message => 'Running all tests'
+      ))
+
+      @previous_failed = !success
+      throw :task_has_failed unless success
+    end
+
+    # Gets called when the watched tests have changes.
+    #
+    # @param [Array<String>] paths to the changed tests
+    # @raise (see #start)
+    #
+    def run_on_changes(paths)
+      paths = Inspector.clean(paths + @failed_paths)
+      success = Runner.run(paths, options)
+
+      update_failed_paths(success, paths)
+      run_all_after_pass(success)
+      throw :task_has_failed unless success
+    end
+
+    private
+
+    # Adds or removes path to the failed_paths bassed
+    # on the tests result.
+    #
+    # @param [Boolean] tests_passed whether the tests passed or not
+    # @param [Array<String>] paths the tests paths
+    #
+    def update_failed_paths(tests_passed, paths)
+      return unless @options[:keep_failed]
+
+      if tests_passed
+        @failed_paths -= paths
+      else
+        @failed_paths += paths
+      end
+    end
+
+    # Runs all tests after the failed tests pass.
+    #
+    # @param (see .update_failed_paths)
+    #
+    def run_all_after_pass(tests_passed)
+      return unless @options[:all_after_pass]
+
+      if tests_passed
+        run_all if @previous_failed
+      else
+        @previous_failed = true
+      end
+    end
+  end
+end