guard-rspec 4.0.4 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5d1eeb4a0d8baf1b0f82b447f0bc4e08fe30d86
-  data.tar.gz: af29a93959847c6076ac203a22570cef35cf5f61
+  metadata.gz: acd119aa512362402fccfa51caf2168e627a5a6c
+  data.tar.gz: 3a79c88569a0726cd24ed0dd0e731312998772f2
 SHA512:
-  metadata.gz: ca4ff200acd14bf0e93f38f4a13aa55ccb50bb55ddda39535f84f8b449b5c2b907fc08f0c101a17abdc117c41a28d6588759aa106eda15b837eb86a9951dbc4a
-  data.tar.gz: e9300fb45717bb537fd2874e93e5f25d72bef1e5d14db0a53346fa3c8b0258468c448bb7e1518b23451840d370db803b6d5d47720926ce36a8de9ca351564e63
+  metadata.gz: a2ad3248d30ef9030f6841f54d85b6a0807bf9f5a3be094137fb1903d6e22e636cfbf8ddca811d96dcfba152ab43809b2785ed35e6d26278b0477d23f7e90582
+  data.tar.gz: b15e378838881ab59220bcf55404f88dcb52b93ef9a068df2ac56717741d7970c196b1a95b82b4ff69b5c467ada30c8192c8bc592b4bf5ec3eee96814b81db80

data/.gitignore

@@ -6,3 +6,5 @@ pkg/*
 .rbx/*
 Gemfile.lock
 coverage/
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -4,4 +4,8 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx

data/README.md

@@ -69,15 +69,18 @@ end
 ### List of available options:
 
 ``` ruby
-cmd: 'zeus rspec'      # specify a custom rpsec command to run, default: 'rspec'
-spec_paths: ['spec']   # specify a custom array of paths that contain spec files
-focus_on_failed: false # focus on the first 10 failed specs, rerun till they pass, default: true
-keep_failed: true      # keep failed specs until they pass (add them to new ones), default: false
-all_after_pass: true   # run all specs after changed specs pass, default: false
-all_on_start: true     # run all the specs at startup, default: false
-launchy: nil           # pass a path to an rspec results file, e.g. ./tmp/spec_results.html
-notification: false    # display notification after the specs are done running, default: true
-run_all: { cmd: 'custom rspec command', message: 'custom message' } # Custom options to use when running all specs.
+cmd: 'zeus rspec'      # Specify a custom rspec command to run, default: 'rspec'
+spec_paths: ['spec']   # Specify a custom array of paths that contain spec files
+failed_mode: :focus    # What to do with failed specs
+                       # Available values:
+                       #  :focus (default) - focus on the first 10 failed specs, rerun till they pass
+                       #  :keep - keep failed specs until they pass (add them to new ones)
+                       #  :none - just report
+all_after_pass: true   # Run all specs after changed specs pass, default: false
+all_on_start: true     # Run all the specs at startup, default: false
+launchy: nil           # Pass a path to an rspec results file, e.g. ./tmp/spec_results.html
+notification: false    # Display notification after the specs are done running, default: true
+run_all: { cmd: 'custom rspec command', message: 'custom message' } # Custom options to use when running all specs
 ```
 
 ### Using Launchy to view rspec results

data/lib/guard/rspec.rb

@@ -3,6 +3,7 @@ require 'guard/plugin'
 
 module Guard
   class RSpec < Plugin
+    require 'guard/rspec/options'
     require 'guard/rspec/deprecator'
     require 'guard/rspec/runner'
 
@@ -10,16 +11,13 @@ module Guard
 
     def initialize(options = {})
       super
-      @options = {
-        all_on_start: false
-      }.merge(options)
-
+      @options = Options.with_defaults(options)
       Deprecator.warns_about_deprecated_options(@options)
       @runner = Runner.new(@options)
     end
 
     def start
-      ::Guard::UI.info "Guard::RSpec is running"
+      ::Guard::UI.info 'Guard::RSpec is running'
       run_all if options[:all_on_start]
     end
 
@@ -41,7 +39,6 @@ module Guard
     def _throw_if_failed
       throw :task_has_failed unless yield
     end
-
   end
 end
 

data/lib/guard/rspec/command.rb

@@ -10,12 +10,7 @@ module Guard
 
       def initialize(paths, options = {})
         @paths = paths
-        @options = {
-          focus_on_failed: true,
-          notification: true,
-          cmd:          'rspec'
-        }.merge(options)
-
+        @options = options
         super(_parts.join(' '))
       end
 
@@ -23,14 +18,13 @@ module Guard
 
       def _parts
         parts = [options[:cmd]]
-        parts << _formatter
-        parts << _notifier
-        parts << _focuser
+        parts << _visual_formatter
+        parts << _guard_formatter
         parts << "--failure-exit-code #{FAILURE_EXIT_CODE}"
         parts << paths.join(' ')
       end
 
-      def _formatter
+      def _visual_formatter
         return if _cmd_include_formatter?
         _rspec_formatters || '-f progress'
       end
@@ -46,16 +40,9 @@ module Guard
         options[:cmd] =~ /(?:^|\s)(?:-f\s*|--format(?:=|\s+))([\w:]+)/
       end
 
-      def _notifier
-        return unless options[:notification]
-        "-r #{File.dirname(__FILE__)}/formatters/notifier.rb -f Guard::RSpec::Formatters::Notifier"
-      end
-
-      def _focuser
-        return unless options[:focus_on_failed]
-        "-r #{File.dirname(__FILE__)}/formatters/focuser.rb -f Guard::RSpec::Formatters::Focuser"
+      def _guard_formatter
+        "-r #{File.dirname(__FILE__)}/formatter.rb -f Guard::RSpec::Formatter"
       end
-
     end
   end
 end

data/lib/guard/rspec/deprecator.rb

@@ -16,13 +16,15 @@ module Guard
         _version_option
         _exclude_option
         _use_cmd_option
+        _keep_failed_option
+        _focus_on_failed_option
       end
 
       private
 
       def _spec_opts_env
         return if ENV['SPEC_OPTS'].nil?
-        UI.warning "The SPEC_OPTS environment variable is present. This can conflict with guard-rspec, particularly notifications."
+        UI.warning "The SPEC_OPTS environment variable is present. This can conflict with guard-rspec."
       end
 
       def _version_option
@@ -42,6 +44,16 @@ module Guard
         end
       end
 
+      def _keep_failed_option
+        return unless options.key?(:keep_failed)
+        _deprectated('The :keep_failed option is deprecated. Please set new :failed_mode option value to :keep instead. https://github.com/guard/guard-rspec#list-of-available-options')
+      end
+
+      def _focus_on_failed_option
+        return unless options.key?(:focus_on_failed)
+        _deprectated('The :focus_on_failed option is deprecated. Focus mode is the default and can be changed using new :failed_mode option. https://github.com/guard/guard-rspec#list-of-available-options')
+      end
+
       def _deprectated(message)
         UI.warning %{Guard::RSpec DEPRECATION WARNING: #{message}}
       end

data/lib/guard/rspec/formatter.rb

@@ -0,0 +1,36 @@
+require 'rspec/core/formatters/base_formatter'
+
+module Guard
+  class RSpec
+    class Formatter < ::RSpec::Core::Formatters::BaseFormatter
+      TEMPORARY_FILE_PATH = './tmp/rspec_guard_result'
+
+      # Write summary to temporary file for runner
+      def dump_summary(duration, total, failures, pending)
+        FileUtils.mkdir_p('tmp')
+        File.open(TEMPORARY_FILE_PATH, 'w') do |f|
+          f.puts _message(total, failures, pending, duration)
+          f.puts _failed_paths.join("\n") if failures > 0
+        end
+      rescue
+        # nothing really we can do, at least don't kill the test runner
+      end
+
+      private
+
+      def _failed_paths
+        failed = examples.select { |e| e.execution_result[:status] == 'failed' }
+        failed.map { |e| e.metadata[:location] }
+      end
+
+      def _message(example_count, failure_count, pending_count, duration)
+        message = "#{example_count} examples, #{failure_count} failures"
+        if pending_count > 0
+          message << " (#{pending_count} pending)"
+        end
+        message << " in #{duration.round(4)} seconds"
+        message
+      end
+    end
+  end
+end

data/lib/guard/rspec/inspectors/base_inspector.rb

@@ -0,0 +1,52 @@
+module Guard
+  class RSpec
+    module Inspectors
+      class BaseInspector
+        attr_accessor :options, :spec_paths
+
+        def initialize(options = {})
+          @options = options
+          @spec_paths = @options[:spec_paths]
+        end
+
+        def paths(paths)
+          raise _abstract
+        end
+
+        def failed(locations)
+          raise _abstract
+        end
+
+        def reload
+          raise _abstract
+        end
+
+        private
+
+        def _abstract
+          'Must be implemented in subclass'
+        end
+
+        # Leave only spec/feature files from spec_paths, remove others
+        def _clean(paths)
+          paths.uniq!
+          paths.compact!
+          spec_dirs = _select_only_spec_dirs(paths)
+          spec_files = _select_only_spec_files(paths)
+          spec_dirs + spec_files
+        end
+
+        def _select_only_spec_dirs(paths)
+          paths.select { |p| File.directory?(p) || spec_paths.include?(p) }
+        end
+
+        def _select_only_spec_files(paths)
+          spec_files = spec_paths.collect { |path| Dir[File.join(path, "**{,/*/**}", "*[_.]spec.rb")] }
+          feature_files = spec_paths.collect { |path| Dir[File.join(path, "**{,/*/**}", "*.feature")] }
+          files = (spec_files + feature_files).flatten
+          paths.select { |p| files.include?(p) }
+        end
+      end
+    end
+  end
+end

data/lib/guard/rspec/inspectors/factory.rb

@@ -0,0 +1,24 @@
+require 'guard/rspec/inspectors/simple_inspector.rb'
+require 'guard/rspec/inspectors/keeping_inspector.rb'
+require 'guard/rspec/inspectors/focused_inspector.rb'
+
+module Guard
+  class RSpec
+    module Inspectors
+      class Factory
+        class << self
+          def create(options = {})
+            case options[:failed_mode]
+              when :focus ; FocusedInspector.new(options)
+              when :keep  ; KeepingInspector.new(options)
+              else        ; SimpleInspector.new(options)
+            end
+          end
+
+          private :new
+        end
+      end
+    end
+  end
+end
+

data/lib/guard/rspec/inspectors/focused_inspector.rb

@@ -0,0 +1,39 @@
+require 'guard/rspec/inspectors/base_inspector.rb'
+
+module Guard
+  class RSpec
+    module Inspectors
+      # Inspector that focuses on set of paths if any of them is failing.
+      # Returns only that set of paths on all future calls to #paths
+      # until they all pass
+      class FocusedInspector < BaseInspector
+        attr_accessor :focused_locations
+
+        def initialize(options = {})
+          super
+          @focused_locations = []
+        end
+
+        def paths(paths)
+          if focused_locations.any?
+            focused_locations
+          else
+            _clean(paths)
+          end
+        end
+
+        def failed(locations)
+          if locations.empty?
+            @focused_locations = []
+          else
+            @focused_locations = locations if focused_locations.empty?
+          end
+        end
+
+        def reload
+          @focused_locations = []
+        end
+      end
+    end
+  end
+end

data/lib/guard/rspec/inspectors/keeping_inspector.rb

@@ -0,0 +1,96 @@
+require 'guard/rspec/inspectors/base_inspector.rb'
+
+module Guard
+  class RSpec
+    module Inspectors
+      # Inspector that remembers all failed paths and
+      # returns that paths in future calls to #paths method
+      # along with any new paths passed as parameter to #paths
+      class KeepingInspector < BaseInspector
+        attr_accessor :failed_locations
+
+        def initialize(options = {})
+          super
+          @failed_locations = []
+        end
+
+        def paths(paths)
+          _with_failed_locations(_clean(paths))
+        end
+
+        def failed(locations)
+          @failed_locations = locations
+        end
+
+        def reload
+          @failed_locations = []
+        end
+
+        private
+
+        # Return paths + failed locations.
+        # Do not include location in result if its path is already included.
+        def _with_failed_locations(paths)
+          failed_paths = failed_locations.map { |l| _location_path(l) }
+          (paths | failed_paths).uniq
+        end
+
+        # Extract file path from location
+        def _location_path(location)
+          location.match(/^(\.\/)?(.*?)(:\d+)?$/)[2]
+        end
+      end
+    end
+  end
+end
+
+#
+#  FIXME uncomment when RSpec #952 will be resolved
+#
+#  This is correct version of KeepingInspector class,
+#  bit it doesn't work because of bug with RSpec
+#  https://github.com/rspec/rspec-core/issues/952
+#
+#module Guard
+#  class RSpec
+#    module Inspectors
+#      # Inspector that remembers all failed paths and
+#      # returns that paths in future calls to #paths method
+#      # along with any new paths passed as parameter to #paths
+#      class KeepingInspector < BaseInspector
+#        attr_accessor :failed_locations
+#
+#        def initialize(options = {})
+#          super
+#          @failed_locations = []
+#        end
+#
+#        def paths(paths)
+#          _with_failed_locations(_clean(paths))
+#        end
+#
+#        def failed(locations)
+#          @failed_locations = locations
+#        end
+#
+#        def reload
+#          @failed_locations = []
+#        end
+#
+#        private
+#
+#        # Return paths + failed locations.
+#        # Do not include location in result if its path is already included.
+#        def _with_failed_locations(paths)
+#          locations = failed_locations.select { |l| !paths.include?(_location_path(l)) }
+#          paths | locations
+#        end
+#
+#        # Extract file path from location
+#        def _location_path(location)
+#          location.match(/^(\.\/)?(.*?)(:\d+)?$/)[2]
+#        end
+#      end
+#    end
+#  end
+#end

data/lib/guard/rspec/inspectors/simple_inspector.rb

@@ -0,0 +1,21 @@
+require 'guard/rspec/inspectors/base_inspector.rb'
+
+module Guard
+  class RSpec
+    module Inspectors
+      class SimpleInspector < BaseInspector
+        def paths(paths)
+          _clean(paths)
+        end
+
+        def failed(locations)
+          # Don't care
+        end
+
+        def reload
+          # Nothing to reload
+        end
+      end
+    end
+  end
+end