guard-phpunit 0.0.3 → 0.1.0

data/README.md

@@ -4,7 +4,7 @@ Guard::PHPUnit [![Build Status](https://secure.travis-ci.org/Maher4Ever/guard-ph
 PHPUnit guard allows to automatically & intelligently launch tests when files
 are modified.
 
-Tested on MRI Ruby 1.8.7, 1.9.2 and 1.9.3.
+Tested on MRI Ruby (1.8.7, 1.9.2, 1.9.3), REE and Rubinius.
 
 Install
 -------
@@ -61,6 +61,15 @@ The following options can be passed to Guard::PHPUnit:
 :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)

data/lib/guard/phpunit.rb

@@ -10,11 +10,15 @@ module 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,
-      :tests_path   => Dir.pwd
+      :all_on_start   => true,
+      :all_after_pass => true,
+      :keep_failed    => true,
+      :cli            => nil,
+      :tests_path     => Dir.pwd
     }
 
     # Initialize Guard::PHPUnit.
@@ -29,6 +33,10 @@ module Guard
       defaults = DEFAULT_OPTIONS.clone
       @options = defaults.merge(options)
       super(watchers, @options)
+
+      @failed_paths     = []
+      @previous_failed = false
+
       Inspector.tests_path = @options[:tests_path]
     end
 
@@ -48,6 +56,8 @@ module Guard
       success = Runner.run(options[:tests_path], options.merge(
         :message => 'Running all tests'
       ))
+
+      @previous_failed = !success
       throw :task_has_failed unless success
     end
 
@@ -57,8 +67,44 @@ module Guard
     # @raise (see #start)
     #
     def run_on_change(paths)
-      success = Runner.run(Inspector.clean(paths), options)
+      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/lib/guard/phpunit/formatter.rb

@@ -3,8 +3,7 @@ module Guard
 
     # The Guard::PHPUnit formatter parses the output
     # of phpunit which gets printed by the progress
-    # printer and formats the parsed results 
-    # for the notifier.
+    # printer. 
     #
     module Formatter
       class << self
@@ -25,22 +24,6 @@ module Guard
           results.freeze
         end
 
-        # Outputs a system notification.
-        #
-        # @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(test_results)
-          ::Guard::Notifier.notify(notifier_message(test_results), {
-            :title => 'PHPUnit results',
-            :image => notifier_image(test_results)
-          })
-        end
-
         private
 
         # Searches for a list of strings in the tests output
@@ -75,35 +58,6 @@ module Guard
           text =~ %r{Finished in (\d)+ seconds?.*\Z}m
           $1.nil? ? 0 : $1.to_i
         end
-
-        # Formats the message for the Notifier.
-        # 
-        # @param (see .notify)
-        # @return [String] the message
-        #
-        def notifier_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 notifier_image(results)
-          case
-          when results[:failures] + results[:errors] > 0
-            :failed
-          when results[:pending] > 0
-            :pending
-          else
-            :success
-          end
-        end
       end
     end
   end

data/lib/guard/phpunit/notifier.rb

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

data/lib/guard/phpunit/runner.rb

@@ -27,44 +27,38 @@ module Guard
         #
         def run(paths, options = {})
           paths = Array(paths)
+          
           return false if paths.empty?
-
-          notify_start(paths, options)
-          output  = run_tests(paths, options)
           
-          print_output 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) 
+          unless phpunit_exists?
+            UI.error('phpunit is not installed on your machine.', :reset => true)
+            return false
           end
 
-          $?.success?
+          run_tests(paths, options)
         end
 
         private
 
-        # Displays the start testing notification.
+        # Checks that phpunit is installed on the user's
+        # machine.
         #
-        # @param (see #run)
-        # @param (see #run)
+        # @return [Boolean] The status of phpunit
         #
-        def notify_start(paths, options)
-          message = options[:message] || "Running: #{paths.join(' ')}"
-          UI.info(message, :reset => true)
+        def phpunit_exists?
+          system('which phpunit > /dev/null 2>&1')
         end
 
-        # Executes the testing commandon the tests 
-        # and returns the output.
+        # 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)
@@ -73,15 +67,30 @@ module Guard
               output = execute_command phpunit_command(tests_folder, options)
             end
           end
-          output
+
+          # 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
 
-        # Prints the tests output to the terminal.
+        # Displays the start testing notification.
         #
-        # @param [String] output the tests output
+        # @param (see #run)
+        # @param (see #run)
         #
-        def print_output(output)
-          UI.info output
+        def notify_start(paths, options)
+          message = options[:message] || "Running: #{paths.join(' ')}"
+          UI.info(message, :reset => true)
         end
 
         # Displays a notification about the tests results.
@@ -92,7 +101,7 @@ module Guard
         def notify_results(output, options)
           return if options[:notification] == false
           results = Formatter.parse_output(output)
-          Formatter.notify(results)
+          Notifier.notify_results(results)
         end
 
         # Displays a notification about failing to run the tests
@@ -101,7 +110,7 @@ module Guard
         #
         def notify_failure(options)
           return if options[:notification] == false
-          ::Guard::Notifier.notify('Failed! Check the console', :title => 'PHPUnit results', :image => :failed)
+          Notifier.notify('Failed! Check the console', :title => 'PHPUnit results', :image => :failed)
         end
         
         # Checks the exitstatus of the phpunit command

data/lib/guard/phpunit/version.rb

@@ -1,6 +1,6 @@
 module Guard
   # Guard::PHPUnitVersion is used in the gem specification.
   module PHPUnitVersion
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-phpunit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000 Z
+date: 2011-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &12540940 !ruby/object:Gem::Requirement
+  requirement: &8010520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.8
   type: :runtime
   prerelease: false
-  version_requirements: *12540940
+  version_requirements: *8010520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &12540280 !ruby/object:Gem::Requirement
+  requirement: &8008620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *12540280
+  version_requirements: *8008620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &12539720 !ruby/object:Gem::Requirement
+  requirement: &8007340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *12539720
+  version_requirements: *8007340
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &12539080 !ruby/object:Gem::Requirement
+  requirement: &8006780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,29 @@ dependencies:
         version: '0.5'
   type: :development
   prerelease: false
-  version_requirements: *12539080
+  version_requirements: *8006780
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &8005020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *8005020
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &8001860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: *8001860
 description: Guard::PHPUnit automatically run your unit-tests written with the PHPUnit
   testing framework.
 email:
@@ -66,6 +88,7 @@ files:
 - lib/guard/phpunit.rb
 - lib/guard/phpunit/formatter.rb
 - lib/guard/phpunit/inspector.rb
+- lib/guard/phpunit/notifier.rb
 - lib/guard/phpunit/runner.rb
 - lib/guard/phpunit/templates/Guardfile
 - lib/guard/phpunit/version.rb