guard-phpunit2 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25e1c7f4051f51755b045436eacfd314d3d3c561
+  data.tar.gz: ff726d26e443aed564382611d7b730be0e62d15e
+SHA512:
+  metadata.gz: 40c41dff5824407ca8bd0dc31c2566da9a2fa23ed4933a2c51f885026d1a846c37affafa9460c37200c3235fc66791bf6334db8fe730d8c93f04b7ab919f9f79
+  data.tar.gz: 4eccfb676173ae0b94d5a16af0fc264df88f080969578c79e52d434ee8b383e70d785a6fe2680ec7f8db9c391f741b495b2e4bf0e281d48daee2b5d99622af5f

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

@@ -0,0 +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.

data/README.md

@@ -0,0 +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

data/lib/guard/phpunit2/formatter.rb

@@ -0,0 +1,64 @@
+module Guard
+  class PHPUnit2
+
+    # The Guard::PHPUnit formatter parses the output
+    # of phpunit which gets printed by the progress
+    # printer.
+    #
+    module Formatter
+      class << self
+
+        # Parses the tests output.
+        #
+        # @param [String] text the output of phpunit.
+        # @return [Hash] the parsed results
+        #
+        def parse_output(text)
+          results = {
+            :tests    => look_for_words_in('test',    text),
+            :failures => look_for_words_in('failure', text),
+            :errors   => look_for_words_in('error', text),
+            :pending  => look_for_words_in(['skipped', 'incomplete'], text),
+            :duration => look_for_duration_in(text)
+          }
+          results.freeze
+        end
+
+        private
+
+        # Searches for a list of strings in the tests output
+        # and returns the total number assigned to these strings.
+        #
+        # @param [String, Array<String>] string_list the words
+        # @param [String] text the tests output
+        # @return [Integer] the total number assigned to the words
+        #
+        def look_for_words_in(strings_list, text)
+          count = 0
+          strings_list = Array(strings_list)
+          strings_list.each do |s|
+            text =~ %r{
+              (\d+)   # count of what we are looking for
+              [ ]     # then a space
+              #{s}s?  # then the string
+              .*      # then whatever
+              \Z      # start looking at the end of the text
+            }x
+            count += $1.to_i unless $1.nil?
+          end
+          count
+        end
+
+        # Searches for the duration in the tests output
+        #
+        # @param [String] text the tests output
+        # @return [Integer] the duration
+        #
+        def look_for_duration_in(text)
+          text =~ %r{Finished in (\d)+ seconds?.*\Z}m
+          $1.nil? ? 0 : $1.to_i
+        end
+      end
+    end
+  end
+end

data/lib/guard/phpunit2/inspector.rb

@@ -0,0 +1,54 @@
+module Guard
+  class PHPUnit2
+
+    # The Guard::PHPUnit inspector verfies that the changed paths
+    # are valid for Guard::PHPUnit.
+    #
+    module Inspector
+      class << self
+
+        attr_accessor :tests_path
+
+        # Clean the changed paths and return only valid
+        # PHPUnit tests files.
+        #
+        # @param [Array<String>] paths the changed paths
+        # @return [Array<String>] the valid tests files
+        #
+        def clean(paths)
+          paths.uniq!
+          paths.compact!
+          paths = paths.select { |p| test_file?(p) }
+          clear_tests_files_list
+          paths
+        end
+
+        private
+
+        # Checks if the paths is a valid test file.
+        #
+        # @param [String] path the test path
+        # @return [Boolean] whether the path a valid test or not
+        #
+        def test_file?(path)
+          tests_files.include?(path)
+        end
+
+        # Scans the tests path and keeps a list of all
+        # tests paths.
+        #
+        def tests_files
+          @tests_files ||= Dir.glob( File.join(tests_path, '**', '*Test.php') )
+        end
+
+        # Clears the list of PHPUnit tests.
+        #
+        # @see #clean
+        #
+        def clear_tests_files_list
+          @tests_files = nil
+        end
+      end
+    end
+  end
+end

data/lib/guard/phpunit2/notifier.rb

@@ -0,0 +1,68 @@
+module Guard
+  class PHPUnit2
+
+    # The Guard::PHPUnit notifier displays a notification pop-up
+    # with the tests results.
+    #
+    module Notifier
+      class << self
+
+        # Displays a system notification.
+        #
+        # @param [String] message the message to show
+        # @param [Hash] options the notifier options
+        #
+        def notify(message, options)
+          ::Guard::Notifier.notify(message, options)
+        end
+
+        # Displays a notification about the tests results.
+        #
+        # @param [Hash] test_results the parsed tests results
+        # @option test_results [Integer] :tests tests count
+        # @option test_results [Integer] :failures failures count
+        # @option test_results [Integer] :errors count count
+        # @option test_results [Integer] :pending pending tests count
+        # @option test_results [Integer] :duration tests duration
+        #
+        def notify_results(test_results)
+          notify(message(test_results), {
+            :title => 'PHPUnit results',
+            :image => image(test_results)
+          })
+        end 
+
+        private
+
+        # Formats the message for the tests results notifier.
+        # 
+        # @param (see .notify)
+        # @return [String] the message
+        #
+        def message(results)
+          message = "#{results[:tests]} tests, #{results[:failures]} failures"
+          message << "\n#{results[:errors]} errors"    if results[:errors]  > 0
+          message << " (#{results[:pending]} pending)" if results[:pending] > 0
+          message << "\nin #{results[:duration]} seconds"
+          message
+        end
+
+        # Returns the appropriate image for the tests results.
+        # 
+        # @param (see .notify)
+        # @return [Symbol] the image symbol
+        #
+        def image(results)
+          case
+          when results[:failures] + results[:errors] > 0
+            :failed
+          when results[:pending] > 0
+            :pending
+          else
+            :success
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/phpunit2/runner.rb

@@ -0,0 +1,193 @@
+require 'tmpdir'
+require 'fileutils'
+
+module Guard
+  class PHPUnit2
+
+    # The Guard::PHPUnit runner handles running the tests, displaying
+    # their output and notifying the user about the results.
+    #
+    module Runner
+      class << self
+
+        # The exittcode phpunit returns when the tests contain failures
+        #
+        PHPUNIT_FAILURES_EXITCODE = 1
+
+        # The exittcode phpunit returns when the tests contain errors
+        #
+        PHPUNIT_ERRORS_EXITCODE   = 2
+
+        # Runs the PHPUnit tests and displays notifications
+        # about the results.
+        #
+        # @param [Array<Strings>] path to the tests files.
+        # @param (see PHPUnit#initialize)
+        # @return [Boolean] whether the tests were run successfully
+        #
+        def run(paths, options = {})
+          paths = Array(paths)
+
+          return false if paths.empty?
+
+          unless phpunit_exists?
+            UI.error('phpunit is not installed on your machine.', :reset => true)
+            return false
+          end
+
+          run_tests(paths, options)
+        end
+
+        private
+
+        # Checks that phpunit is installed on the user's
+        # machine.
+        #
+        # @return [Boolean] The status of phpunit
+        #
+        def phpunit_exists?
+          `phpunit --version`
+          true
+        rescue Errno::ENOENT
+          false
+        end
+
+        # Executes the testing command on the tests
+        # and returns the status of this process.
+        #
+        # @param (see #run)
+        # @param (see #run)
+        #
+        def run_tests(paths, options)
+
+          notify_start(paths, options)
+
+          if paths.length == 1
+            tests_path = paths.first
+            output = execute_command phpunit_command(tests_path, options)
+          else
+            create_tests_folder_for(paths) do |tests_folder|
+              output = execute_command phpunit_command(tests_folder, options)
+            end
+          end
+
+          # print the output to the terminal
+          UI.info output
+
+          # return false in case the system call fails with no status!
+          return false if $?.nil?
+
+          if $?.success? or tests_contain_failures? or tests_contain_errors?
+            notify_results(output, options)
+          else
+            notify_failure(options)
+          end
+
+          $?.success?
+        end
+
+        # Displays the start testing notification.
+        #
+        # @param (see #run)
+        # @param (see #run)
+        #
+        def notify_start(paths, options)
+          message = options[:message] || "Running: #{paths.join(' ')}"
+          UI.info(message, :reset => true)
+        end
+
+        # Displays a notification about the tests results.
+        #
+        # @param [String] output the tests output
+        # @param (see #run)
+        #
+        def notify_results(output, options)
+          return if options[:notification] == false
+          results = Formatter.parse_output(output)
+          Notifier.notify_results(results)
+        end
+
+        # Displays a notification about failing to run the tests
+        #
+        # @param (see #run)
+        #
+        def notify_failure(options)
+          return if options[:notification] == false
+          Notifier.notify('Failed! Check the console', :title => 'PHPUnit results', :image => :failed)
+        end
+
+        # Checks the exitstatus of the phpunit command
+        # for a sign of failures in the tests.
+        #
+        # @return [Boolean] whether the tests contain failures or not
+        #
+        def tests_contain_failures?
+          $?.exitstatus == PHPUNIT_FAILURES_EXITCODE
+        end
+
+        # Checks the exitstatus of the phpunit command
+        # for a sign of errors in the tests.
+        #
+        # @return [Boolean] whether the tests contain errors or not
+        #
+        def tests_contain_errors?
+          $?.exitstatus == PHPUNIT_ERRORS_EXITCODE
+        end
+
+        # Creates a temporary folder which has links to
+        # the tests paths. This method is used because PHPUnit
+        # can't run multiple tests files at the same time and generate
+        # one result for them.
+        #
+        # @param (see #run)
+        # @yield [String] d the temporary dir for the tests
+        #
+        def create_tests_folder_for(paths)
+          Dir.mktmpdir('guard_phpunit') do |d|
+            symlink_paths_to_tests_folder(paths, d)
+            yield d
+          end
+        end
+
+        # Creates symbolic links inside the folder pointing
+        # back to the paths.
+        #
+        # @see #create_tests_folder_for
+        #
+        # @param (see #run)
+        # @param [String] the folder in which the links must be made
+        #
+        def symlink_paths_to_tests_folder(paths, folder)
+          paths.each do |p|
+            FileUtils.mkdir_p( File.join(folder, File.dirname(p) ) ) unless File.dirname(p) == '.'
+            FileUtils.ln_s(Pathname.new(p).realpath, File.join(folder, p))
+          end
+        end
+
+        # Generates the phpunit command for the tests paths.
+        #
+        # @param (see #run)
+        # @param (see #run)
+        # @see #run_tests
+        #
+        def phpunit_command(path, options)
+          cmd_parts = []
+          cmd_parts << "phpunit"
+          cmd_parts << options[:cli] if options[:cli]
+          cmd_parts << path
+
+          cmd_parts.join(' ')
+        end
+
+        # Executes a system command and returns the output.
+        #
+        # @param [String] command the command to be run
+        # @return [String] the output of the executed command
+        #
+        def execute_command(command)
+          %x{#{command}}
+        end
+      end
+    end
+  end
+end

data/lib/guard/phpunit2/templates/Guardfile

@@ -0,0 +1,3 @@
+guard 'phpunit2', :cli => '--colors' do
+  watch(%r{^.+Test\.php$})
+end

data/lib/guard/phpunit2/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module PHPUnit2
+    VERSION = '0.2.1'
+  end
+end

data/lib/guard/phpunit2.rb

@@ -0,0 +1,112 @@
+require 'guard'
+require 'guard/guard'
+
+module Guard
+
+  # The PHPUnit guard gets notified about system
+  # events.
+  #
+  class PHPUnit2 < Guard
+
+    autoload :Inspector, 'guard/phpunit2/inspector'
+    autoload :Formatter, 'guard/phpunit2/formatter'
+    autoload :Notifier,  'guard/phpunit2/notifier'
+    autoload :Runner,    'guard/phpunit2/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

data/spec/fixtures/results/errors.txt

@@ -0,0 +1,11 @@
+E
+
+Errors:
+
+  1) NumberTest::testMathStillWorks
+     NumberException: Division by zero!
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/Number.php:61
+     # /home/maher/Projects/php/PHPUnit-Progress/Tests/_files/NumberTest.php:81
+
+Finished in 0 seconds
+1 test, 0 assertions, 1 errors