guard-phpunit 0.1.3 → 0.1.4

data/lib/guard/phpunit/formatters/PHPUnit-Progress/Tests/printer_skipped.phpt

@@ -0,0 +1,19 @@
+--TEST--
+phpunit Number - Only skipped tests 
+--FILE--
+<?php
+$group     = 'skipped';
+$testClass = 'NumberTest';
+
+$_SERVER['argv'][1] = '--group';
+$_SERVER['argv'][2] = $group;
+$_SERVER['argv'][3] = dirname(__FILE__) . "/_files/${testClass}.php";
+
+require_once 'PHPUnit/Autoload.php';
+PHPUnit_TextUI_Command::main();
+?>
+--EXPECTF--
+%rS+%r
+
+Finished in %i second%S
+%i tests, 0 assertions, %i skipped

data/lib/guard/phpunit/formatters/PHPUnit-Progress/Tests/printer_skipped_variation.phpt

@@ -0,0 +1,20 @@
+--TEST--
+phpunit Number - Only skipped tests and colors enabled  
+--FILE--
+<?php
+$group     = 'skipped';
+$testClass = 'NumberTest';
+
+$_SERVER['argv'][1] = '--group';
+$_SERVER['argv'][2] = $group;
+$_SERVER['argv'][3] = '--colors';
+$_SERVER['argv'][4] = dirname(__FILE__) . "/_files/${testClass}.php";
+
+require_once 'PHPUnit/Autoload.php';
+PHPUnit_TextUI_Command::main();
+?>
+--EXPECTF--
+SS
+
+Finished in %i second%S
+2 tests, 0 assertions, 2 skipped

data/lib/guard/phpunit/formatters/PHPUnit-Progress/phpunit.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit printerClass="PHPUnit_Extensions_Progress_ResultPrinter">
+</phpunit>

data/lib/guard/phpunit/inspector.rb

@@ -1,54 +1,54 @@
-module Guard
-  class PHPUnit
-
-    # 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
+module Guard
+  class PHPUnit
+
+    # 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/phpunit/notifier.rb

@@ -1,68 +1,68 @@
-module Guard
-  class PHPUnit
-
-    # 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
+module Guard
+  class PHPUnit
+
+    # 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/phpunit/runner.rb

@@ -1,194 +1,197 @@
-require 'tmpdir'
-require 'fileutils'
-
-module Guard
-  class PHPUnit
-
-    # 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?
-          system('which phpunit > /dev/null 2>&1')
-        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)
-          formatter_path = File.join( File.dirname(__FILE__), 'formatters', 'PHPUnit-Progress')
-
-          cmd_parts = []
-          cmd_parts << "phpunit"
-          cmd_parts << "--include-path #{formatter_path}"
-          cmd_parts << "--printer PHPUnit_Extensions_Progress_ResultPrinter"
-          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
+require 'tmpdir'
+require 'fileutils'
+
+module Guard
+  class PHPUnit
+
+    # 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)
+          formatter_path = File.join( File.dirname(__FILE__), 'formatters', 'PHPUnit-Progress')
+
+          cmd_parts = []
+          cmd_parts << "phpunit"
+          cmd_parts << "--include-path #{formatter_path}"
+          cmd_parts << "--printer PHPUnit_Extensions_Progress_ResultPrinter"
+          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