guard-rspec 4.6.5 → 4.7.0

data/lib/guard/rspec/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RSpecVersion
-    VERSION = "4.6.5".freeze
+    VERSION = "4.7.0".freeze
   end
 end

data/lib/guard/rspec_formatter.rb

@@ -7,19 +7,12 @@ require "fileutils"
 require "rspec"
 require "rspec/core/formatters/base_formatter"
 
-require_relative "rspec_defaults"
+require_relative "rspec_formatter_results_path"
+
+require "guard/ui"
 
 module Guard
   class RSpecFormatter < ::RSpec::Core::Formatters::BaseFormatter
-    WIKI_ENV_WARN_URL =
-      "https://github.com/guard/guard-rspec/wiki/Warning:-no-environment".freeze
-
-    NO_ENV_WARNING_MSG =
-      "no environment passed - see #{WIKI_ENV_WARN_URL}".freeze
-
-    NO_RESULTS_VALUE_MSG =
-      ":results_file value unknown (using defaults)".freeze
-
     UNSUPPORTED_PATTERN =
       "Your RSpec.configuration.pattern uses characters "\
       "unsupported by your Ruby version (File::FNM_EXTGLOB is undefined)".freeze
@@ -55,9 +48,7 @@ module Guard
         location = metadata[:location]
 
         until spec_path?(location)
-          metadata = metadata[:parent_example_group] || metadata[:example_group]
-
-          unless metadata
+          unless (metadata = _extract_group(metadata))
             STDERR.puts "no spec file location in #{root_metadata.inspect}"
             return root_metadata[:location]
           end
@@ -92,10 +83,14 @@ module Guard
         # ruby >= 2
         return flags |= File::FNM_EXTGLOB if File.const_defined?(:FNM_EXTGLOB)
 
-        fail Error::UnsupportedPattern if pattern =~ /[{}]/
+        raise Error::UnsupportedPattern if pattern =~ /[{}]/
 
         flags
       end
+
+      def _extract_group(metadata)
+        metadata[:parent_example_group] || metadata[:example_group]
+      end
     end
 
     def dump_summary(*args)
@@ -121,7 +116,11 @@ module Guard
     end
 
     def _write(&block)
-      file = _results_file
+      file = RSpecFormatterResultsPath.new.path
+      if Guard.const_defined?(:Compat)
+        msg = "Guard::RSpec: using results file: #{file.inspect}"
+        Guard::Compat::UI.debug(format(msg, file))
+      end
       FileUtils.mkdir_p(File.dirname(file))
       File.open(file, "w", &block)
     end
@@ -134,9 +133,7 @@ module Guard
 
     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 << " (#{pending_count} pending)" if pending_count > 0
       message << " in #{duration.round(4)} seconds"
       message
     end
@@ -148,16 +145,5 @@ module Guard
         example.execution_result[:status].to_s == "failed"
       end
     end
-
-    def _results_file
-      path = ENV["GUARD_RSPEC_RESULTS_FILE"]
-      if path.nil?
-        STDERR.puts("Guard::RSpec: Warning: #{NO_ENV_WARNING_MSG}\n" \
-                    "Guard::RSpec: Warning: #{NO_RESULTS_VALUE_MSG}")
-        path = RSpecDefaults::TEMPORARY_FILE_PATH
-      end
-
-      File.expand_path(path)
-    end
   end
 end

data/lib/guard/rspec_formatter_results_path.rb

@@ -0,0 +1,29 @@
+require_relative "rspec_defaults"
+
+module Guard
+  # Just a wrapper class for the results file filename
+  class RSpecFormatterResultsPath
+    WIKI_ENV_WARN_URL =
+      "https://github.com/guard/guard-rspec/wiki/Warning:-no-environment".
+      freeze
+
+    NO_ENV_WARNING_MSG =
+      "no environment passed - see #{WIKI_ENV_WARN_URL}".freeze
+
+    NO_RESULTS_VALUE_MSG =
+      ":results_file value unknown (using defaults)".freeze
+
+    attr_reader :path
+
+    def initialize
+      path = ENV["GUARD_RSPEC_RESULTS_FILE"]
+      if path.nil?
+        STDERR.puts("Guard::RSpec: Warning: #{NO_ENV_WARNING_MSG}\n" \
+                    "Guard::RSpec: Warning: #{NO_RESULTS_VALUE_MSG}")
+        path = RSpecDefaults::TEMPORARY_FILE_PATH
+      end
+
+      @path = File.expand_path(path)
+    end
+  end
+end

data/spec/lib/guard/rspec/command_spec.rb

@@ -10,11 +10,11 @@ RSpec.describe Guard::RSpec::Command do
 
   describe ".initialize" do
     it "sets paths at the end" do
-      expect(command).to match /path1 path2$/
+      expect(command).to match(/path1 path2$/)
     end
 
     it "sets custom failure exit code" do
-      expect(command).to match /--failure-exit-code 2/
+      expect(command).to match(/--failure-exit-code 2/)
     end
 
     it "sets formatter" do
@@ -26,7 +26,7 @@ RSpec.describe Guard::RSpec::Command do
       let(:options) { { cmd: "rspec -t ~slow" } }
 
       it "uses custom cmd" do
-        expect(command).to match /^rspec -t ~slow/
+        expect(command).to match(/^rspec -t ~slow/)
       end
     end
 
@@ -41,7 +41,7 @@ RSpec.describe Guard::RSpec::Command do
       end
 
       it "uses them" do
-        expect(command).to match %r{-f doc -o output}
+        expect(command).to match(/-f doc -o output/)
       end
     end
 
@@ -54,7 +54,7 @@ RSpec.describe Guard::RSpec::Command do
       end
 
       it "sets default progress formatter" do
-        expect(command).to match %r{-f progress}
+        expect(command).to match(/-f progress/)
       end
     end
 
@@ -62,7 +62,7 @@ RSpec.describe Guard::RSpec::Command do
       let(:options) { { cmd: "rspec -f doc" } }
 
       it "sets no other formatters" do
-        expect(command).to match %r{-f doc}
+        expect(command).to match(/-f doc/)
       end
     end
 
@@ -70,14 +70,14 @@ RSpec.describe Guard::RSpec::Command do
       let(:options) { { cmd: "rspec", cmd_additional_args: "-f progress" } }
 
       it "uses them" do
-        expect(command).to match %r{-f progress}
+        expect(command).to match(/-f progress/)
       end
     end
 
     context ":chdir option present" do
       let(:chdir) { "moduleA" }
       let(:paths) do
-        %w[path1 path2].map { |p| "#{chdir}#{File::Separator}#{p}" }
+        %w(path1 path2).map { |p| "#{chdir}#{File::Separator}#{p}" }
       end
 
       let(:options) do
@@ -88,7 +88,7 @@ RSpec.describe Guard::RSpec::Command do
       end
 
       it "strips path of chdir" do
-        expect(command).to match %r{path1 path2}
+        expect(command).to match(/path1 path2/)
       end
     end
   end

data/spec/lib/guard/rspec/deprecator_spec.rb

@@ -10,15 +10,17 @@ RSpec.describe Guard::RSpec::Deprecator do
       it "shows warning if SPEC_OPTS is set" do
         ENV["SPEC_OPTS"] = "-f p"
         expect(Guard::Compat::UI).to receive(:warning).with(
-          "The SPEC_OPTS environment variable is present." +
-          " This can conflict with guard-rspec.")
+          "The SPEC_OPTS environment variable is present." \
+          " This can conflict with guard-rspec."
+        )
         deprecator.warns_about_deprecated_options
         ENV["SPEC_OPTS"] = nil # otherwise other specs pick it up and fail
       end
       it "does not show warning if SPEC_OPTS is unset" do
         expect(Guard::Compat::UI).to_not receive(:warning).with(
-          "The SPEC_OPTS environment variable is present." +
-          " This can conflict with guard-rspec.")
+          "The SPEC_OPTS environment variable is present." \
+          " This can conflict with guard-rspec."
+        )
         deprecator.warns_about_deprecated_options
       end
     end
@@ -28,9 +30,10 @@ RSpec.describe Guard::RSpec::Deprecator do
 
       it "shows deprecation warning" do
         expect(Guard::Compat::UI).to receive(:warning).with(
-          "Guard::RSpec DEPRECATION WARNING:" +
-          " The :version option is deprecated." +
-          " Only RSpec ~> 2.14 is now supported.")
+          "Guard::RSpec DEPRECATION WARNING:" \
+          " The :version option is deprecated." \
+          " Only RSpec ~> 2.14 is now supported."
+        )
         deprecator.warns_about_deprecated_options
       end
     end
@@ -40,10 +43,11 @@ RSpec.describe Guard::RSpec::Deprecator do
 
       it "shows deprecation warning" do
         expect(Guard::Compat::UI).to receive(:warning).with(
-          "Guard::RSpec DEPRECATION WARNING:" +
-          " The :exclude option is deprecated." +
-          " Please Guard ignore method instead." +
-          " https://github.com/guard/guard#ignore")
+          "Guard::RSpec DEPRECATION WARNING:" \
+          " The :exclude option is deprecated." \
+          " Please Guard ignore method instead." \
+          " https://github.com/guard/guard#ignore"
+        )
         deprecator.warns_about_deprecated_options
       end
     end
@@ -55,9 +59,10 @@ RSpec.describe Guard::RSpec::Deprecator do
 
         it "shows deprecation warning" do
           expect(Guard::Compat::UI).to receive(:warning).with(
-            "Guard::RSpec DEPRECATION WARNING: The :#{option} option is" +
-            " deprecated. Please customize the new :cmd option to" +
-            " fit your need.")
+            "Guard::RSpec DEPRECATION WARNING: The :#{option} option is" \
+            " deprecated. Please customize the new :cmd option to" \
+            " fit your need."
+          )
           deprecator.warns_about_deprecated_options
         end
       end
@@ -68,11 +73,12 @@ RSpec.describe Guard::RSpec::Deprecator do
 
       it "shows deprecation warning" do
         expect(Guard::Compat::UI).to receive(:warning).with(
-          "Guard::RSpec DEPRECATION WARNING:" +
-          " 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")
+          "Guard::RSpec DEPRECATION WARNING:" \
+          " 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"
+        )
         deprecator.warns_about_deprecated_options
       end
     end
@@ -82,11 +88,12 @@ RSpec.describe Guard::RSpec::Deprecator do
 
       it "shows deprecation warning" do
         expect(Guard::Compat::UI).to receive(:warning).with(
-          "Guard::RSpec DEPRECATION WARNING:" +
-          " The :focus_on_failed option is deprecated." +
-          " Please set new :failed_mode option value to" +
-          " :focus instead." +
-          " https://github.com/guard/guard-rspec#list-of-available-options")
+          "Guard::RSpec DEPRECATION WARNING:" \
+          " The :focus_on_failed option is deprecated." \
+          " Please set new :failed_mode option value to" \
+          " :focus instead." \
+          " https://github.com/guard/guard-rspec#list-of-available-options"
+        )
         deprecator.warns_about_deprecated_options
       end
     end

data/spec/lib/guard/rspec/results_spec.rb

@@ -44,7 +44,8 @@ RSpec.describe Guard::RSpec::Results do
         subject.load
       end.to raise_error(
         Guard::RSpec::Results::InvalidData,
-        "Invalid results in: foo/bar.txt, lines:\n[]\n")
+        "Invalid results in: foo/bar.txt, lines:\n[]\n"
+      )
     end
   end
 
@@ -58,7 +59,8 @@ RSpec.describe Guard::RSpec::Results do
         subject.load
       end.to raise_error(
         Guard::RSpec::Results::InvalidData,
-        "Invalid results in: foo/bar.txt, lines:\n[\"\"]\n")
+        "Invalid results in: foo/bar.txt, lines:\n[\"\"]\n"
+      )
     end
   end
 end

data/spec/lib/guard/rspec/rspec_process_spec.rb

@@ -5,14 +5,14 @@ require "guard/rspec/rspec_process"
 RSpec.describe Guard::RSpec::RSpecProcess do
   before do
     allow(Kernel).to receive(:spawn) do |*args|
-      fail "Not stubbed: Kernel.spawn(#{args.map(&:inspect) * ','})"
+      raise "Not stubbed: Kernel.spawn(#{args.map(&:inspect) * ','})"
     end
   end
 
   let(:results) { instance_double(Guard::RSpec::Results) }
 
   let(:cmd) { "foo" }
-  let(:file) { "foobar.txt" }
+  let(:file) { "/tmp/foobar.txt" }
   let(:pid) { 1234 }
   let(:exit_code) { 0 }
   let(:status) { instance_double(Process::Status, exitstatus: exit_code) }
@@ -28,6 +28,8 @@ RSpec.describe Guard::RSpec::RSpecProcess do
 
     allow(Guard::RSpec::Results).to receive(:new).
       with(file).and_return(results)
+
+    allow(Guard::Compat::UI).to receive(:debug)
   end
 
   context "with an non-existing command" do
@@ -73,6 +75,47 @@ RSpec.describe Guard::RSpec::RSpecProcess do
       end
 
       it { is_expected.to be_all_green }
+
+      context "with a relative results file path" do
+        before do
+          allow(Guard::Compat::UI).to receive(:warning)
+        end
+        let(:file) { "foobar.txt" }
+
+        it "shows a warning" do
+          expect(Guard::Compat::UI).to receive(:warning).
+            with(/is not an absolute path/)
+          subject
+        end
+      end
+
+      context "with a missing results file" do
+        before do
+          allow(Guard::Compat::UI).to receive(:error)
+        end
+        before do
+          allow(Guard::RSpec::Results).to receive(:new).
+            with(file).and_raise(Errno::ENOENT, "foobar.txt")
+        end
+
+        it "shows a message" do
+          expect(Guard::Compat::UI).to receive(:error).
+            with(/cannot open results file/)
+
+          begin
+            subject
+          rescue Errno::ENOENT
+            nil
+          end
+        end
+
+        it "fails with an error" do
+          expect { subject }.to raise_error(
+            Errno::ENOENT,
+            /No such file or directory - foobar/
+          )
+        end
+      end
     end
   end
 end

data/spec/lib/guard/rspec/runner_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Guard::RSpec::Runner do
 
   before do
     allow(Guard::Compat::UI).to receive(:info)
+    allow(Guard::Compat::UI).to receive(:warning)
     allow(Guard::Compat::UI).to receive(:error)
     allow(Guard::RSpec::Inspectors::Factory).to receive(:create) { inspector }
     allow(Guard::RSpec::Notifier).to receive(:new) { notifier }
@@ -214,7 +215,7 @@ RSpec.describe Guard::RSpec::Runner do
         let(:chdir_options) { {} }
 
         context "when the path is relative" do
-          let(:results_file) { "foobar.txt" }
+          let(:results_file) { File.join(Dir.pwd, "foobar.txt") }
           it "uses the given file" do
             expect(Guard::RSpec::RSpecProcess).to receive(:new).
               with(anything, results_file).and_return(process)
@@ -233,24 +234,60 @@ RSpec.describe Guard::RSpec::Runner do
       end
 
       context "with chdir option" do
-        let(:chdir_options) { { chdir: "moduleA" } }
-
-        context "when the path is relative" do
-          let(:results_file) { "foobar.txt" }
+        context "when chdir option is absolute" do
+          let(:chdir_options) { { chdir: "/foo/bar/moduleA" } }
+
+          context "when the path is relative" do
+            let(:results_file) { "foobar.txt" }
+
+            it "uses a path relative to chdir" do
+              expected = "/foo/bar/moduleA/foobar.txt"
+              expect(Guard::RSpec::RSpecProcess).to receive(:new).
+                with(anything, expected).and_return(process)
+              runner.run(paths)
+            end
+          end
 
-          it "uses a path relative to chdir" do
-            expect(Guard::RSpec::RSpecProcess).to receive(:new).
-              with(anything, "moduleA/foobar.txt").and_return(process)
-            runner.run(paths)
+          context "when the path is absolute" do
+            let(:results_file) { "/foo/foobar.txt" }
+            it "uses the full given path anyway" do
+              expect(Guard::RSpec::RSpecProcess).to receive(:new).
+                with(anything, results_file).and_return(process)
+              runner.run(paths)
+            end
           end
         end
 
-        context "when the path is absolute" do
-          let(:results_file) { "/foo/foobar.txt" }
-          it "uses the full given path anyway" do
-            expect(Guard::RSpec::RSpecProcess).to receive(:new).
-              with(anything, results_file).and_return(process)
-            runner.run(paths)
+        context "when chdir option is relative" do
+          let(:chdir_options) { { chdir: "moduleA" } }
+          before do
+            allow(Guard::Compat::UI).to receive(:warning)
+          end
+
+          context "when the path is relative" do
+            let(:results_file) { "foobar.txt" }
+
+            it "uses a path relative to chdir" do
+              expected = File.join(Dir.pwd, "moduleA/foobar.txt")
+              expect(Guard::RSpec::RSpecProcess).to receive(:new).
+                with(anything, expected).and_return(process)
+              runner.run(paths)
+            end
+
+            it "shows a warning" do
+              expect(Guard::Compat::UI).to receive(:warning).
+                with(/is not an absolute path/)
+              runner.run(paths)
+            end
+          end
+
+          context "when the path is absolute" do
+            let(:results_file) { "/foo/foobar.txt" }
+            it "uses the full given path anyway" do
+              expect(Guard::RSpec::RSpecProcess).to receive(:new).
+                with(anything, results_file).and_return(process)
+              runner.run(paths)
+            end
           end
         end
       end
@@ -260,7 +297,7 @@ RSpec.describe Guard::RSpec::Runner do
       let(:options) { { cmd: "rspec" } }
       it "uses the default" do
         expect(Guard::RSpec::RSpecProcess).to receive(:new).
-          with(anything, "tmp/rspec_guard_result").and_return(process)
+          with(anything, %r{/tmp/rspec_guard_result$}).and_return(process)
         runner.run(paths)
       end
     end