guard-rspec 2.1.0 → 4.7.3

data/spec/lib/guard/rspec/inspectors/keeping_inspector_spec.rb

@@ -0,0 +1,200 @@
+require "guard/compat/test/helper"
+
+require "lib/guard/rspec/inspectors/shared_examples"
+
+require "guard/rspec/inspectors/keeping_inspector"
+
+klass = Guard::RSpec::Inspectors::KeepingInspector
+
+RSpec.describe klass do
+  include_examples "inspector", klass
+
+  # Use real paths because BaseInspector#_clean will be used to clean them
+  let(:other_paths) do
+    [
+      "spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb",
+      "spec/lib/guard/rspec/runner_spec.rb"
+    ]
+  end
+  let(:other_failed_locations) do
+    [
+      "./spec/lib/guard/rspec/runner_spec.rb:12",
+      "./spec/lib/guard/rspec/runner_spec.rb:100",
+      "./spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb:12"
+    ]
+  end
+
+  it "remembers failed paths and returns them along with new paths" do
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/inspectors/base_inspector_spec.rb").
+      and_return(false)
+
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/runner_spec.rb").
+      and_return(false)
+
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/deprecator_spec.rb").
+      and_return(false)
+
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb").
+      and_return(false)
+
+    allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+      and_return(paths + other_paths)
+
+    allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*[_.]spec.rb").
+      and_return([])
+
+    allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*.feature").
+      and_return([])
+
+    allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*.feature").
+      and_return([])
+
+    expect(inspector.paths(paths)).to eq(paths)
+    inspector.failed(failed_locations)
+
+    # Line numbers in failed_locations needs to be omitted because of
+    # https://github.com/rspec/rspec-core/issues/952
+    expect(inspector.paths(other_paths)).to match_array(
+      [
+        "spec/lib/guard/rspec/deprecator_spec.rb",
+        "spec/lib/guard/rspec/runner_spec.rb",
+        "spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb"
+      ]
+    )
+    inspector.failed(other_failed_locations)
+
+    # Now it returns other failed locations
+    expect(
+      inspector.paths(
+        %w(spec/lib/guard/rspec/inspectors/base_inspector_spec.rb)
+      )
+    ).to match_array(
+      [
+        "spec/lib/guard/rspec/runner_spec.rb",
+        "spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb",
+        "spec/lib/guard/rspec/inspectors/base_inspector_spec.rb"
+      ]
+    )
+    inspector.failed(other_failed_locations)
+
+    expect(
+      inspector.paths(%w(spec/lib/guard/rspec/runner_spec.rb))
+    ).to match_array(
+      [
+        "spec/lib/guard/rspec/runner_spec.rb",
+        "spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb"
+      ]
+    )
+
+    inspector.failed([])
+
+    # Now there is no failed locations
+    expect(inspector.paths(paths)).to match_array(paths)
+  end
+
+  describe "#reload" do
+    it "force to forget about failed locations" do
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/inspectors/base_inspector_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/runner_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/deprecator_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb").
+        and_return(false)
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+        and_return(paths + other_paths)
+
+      allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*[_.]spec.rb").
+        and_return([])
+
+      allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*.feature").
+        and_return([])
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*.feature").
+        and_return([])
+
+      expect(inspector.paths(paths)).to eq(paths)
+      inspector.failed(failed_locations)
+
+      inspector.reload
+      expect(inspector.paths(other_paths)).to match_array(other_paths)
+    end
+  end
+end
+
+#
+#  FIXME uncomment when RSpec #952 will be resolved
+#
+#  This is correct spec for KeepingInspector class,
+#  bit it doesn't work because of bug with RSpec
+#  https://github.com/rspec/rspec-core/issues/952
+#
+# describe klass do
+#  include_examples 'inspector', klass
+#
+#  # Use real paths because BaseInspector#_clean will be used to clean them
+#  let(:other_paths) { [
+#    'spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb',
+#    'spec/lib/guard/rspec/runner_spec.rb'
+#  ] }
+#  let(:other_failed_locations) { [
+#    './spec/lib/guard/rspec/runner_spec.rb:12',
+#    './spec/lib/guard/rspec/runner_spec.rb:100',
+#    './spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb:12'
+#  ] }
+#
+#  it 'remembers failed paths and returns them along with new paths' do
+#    expect(inspector.paths(paths)).to eq(paths)
+#    inspector.failed(failed_locations)
+#
+#    # other_paths and failed_locations contain the same spec (runner_spec.rb)
+#    # so #paths should return that spec only once (omit location)
+#    expect(inspector.paths(other_paths)).to match_array(
+#      other_paths +
+#      %w[./spec/lib/guard/rspec/deprecator_spec.rb:55]
+#    )
+#    inspector.failed(other_failed_locations)
+#
+#    # Now it returns other failed locations
+#    expect(inspector.paths(%w[spec/lib/guard/rspec/deprecator_spec.rb])).to
+#    match_array(
+#      other_failed_locations +
+#      %w[spec/lib/guard/rspec/deprecator_spec.rb]
+#    )
+#    inspector.failed(other_failed_locations)
+#
+#    # It returns runner_spec.rb without locations in that spec
+#    expect(inspector.paths(%w[spec/lib/guard/rspec/runner_spec.rb])).
+#    to match_array([
+#      './spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb:12',
+#      'spec/lib/guard/rspec/runner_spec.rb'
+#    ])
+#    inspector.failed([])
+#
+#    # Now there is no failed locations
+#    expect(inspector.paths(paths)).to match_array(paths)
+#  end
+#
+#  describe '#reload' do
+#    it 'force to forget about failed locations' do
+#      expect(inspector.paths(paths)).to eq(paths)
+#      inspector.failed(failed_locations)
+#
+#      inspector.reload
+#      expect(inspector.paths(other_paths)).to match_array(other_paths)
+#    end
+#  end
+# end

data/spec/lib/guard/rspec/inspectors/shared_examples.rb

@@ -0,0 +1,121 @@
+RSpec.shared_examples "inspector" do |klass|
+  let(:spec_paths) { %w(spec myspec) }
+  let(:options) { { custom: "value", spec_paths: spec_paths } }
+  let(:inspector) { klass.new(options) }
+
+  # Use real paths because BaseInspector#_clean will be used to clean them
+  let(:paths) do
+    [
+      "spec/lib/guard/rspec/inspectors/base_inspector_spec.rb",
+      "spec/lib/guard/rspec/runner_spec.rb",
+      "spec/lib/guard/rspec/deprecator_spec.rb"
+    ]
+  end
+  let(:failed_locations) do
+    [
+      "./spec/lib/guard/rspec/runner_spec.rb:12",
+      "./spec/lib/guard/rspec/deprecator_spec.rb:55"
+    ]
+  end
+
+  describe ".initialize" do
+    it "sets options and spec_paths" do
+      expect(inspector.options).to include(:custom, :spec_paths)
+      expect(inspector.options[:custom]).to eq("value")
+      expect(inspector.spec_paths).to eq(spec_paths)
+    end
+  end
+
+  describe "#paths" do
+    before do
+      allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*[_.]spec.rb").
+        and_return([])
+
+      allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*.feature").
+        and_return([])
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*.feature").
+        and_return([])
+    end
+
+    it "returns paths when called first time" do
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/inspectors/base_inspector_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/runner_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/deprecator_spec.rb").
+        and_return(false)
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+        and_return(paths)
+
+      expect(inspector.paths(paths)).to match_array(paths)
+    end
+
+    it "does not return non-spec paths" do
+      paths = %w(not_a_spec_path.rb spec/not_exist_spec.rb)
+
+      allow(File).to receive(:directory?).with("not_a_spec_path.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).with("spec/not_exist_spec.rb").
+        and_return(false)
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+        and_return([])
+
+      expect(inspector.paths(paths)).to eq([])
+    end
+
+    it "uniq and compact paths" do
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/inspectors/base_inspector_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/runner_spec.rb").
+        and_return(false)
+
+      allow(File).to receive(:directory?).
+        with("spec/lib/guard/rspec/deprecator_spec.rb").
+        and_return(false)
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+        and_return(paths)
+
+      expect(inspector.paths(paths + paths + [nil, nil, nil])).
+        to match_array(paths)
+    end
+
+    # NOTE: I'm not sure that it is totally correct behaviour
+    it "return spec_paths and directories too" do
+      allow(File).to receive(:directory?).with("myspec").and_return(true)
+      allow(File).to receive(:directory?).with("lib/guard").and_return(true)
+      allow(File).to receive(:directory?).
+        with("not_exist_dir").and_return(false)
+
+      allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+        and_return([])
+
+      paths = %w(myspec lib/guard not_exist_dir)
+      expect(inspector.paths(paths)).to match_array(paths - ["not_exist_dir"])
+    end
+  end
+
+  describe "#failed" do
+    it "is callable" do
+      expect { inspector.failed(failed_locations) }.not_to raise_error
+    end
+  end
+
+  describe "#reload" do
+    it "is callable" do
+      expect { inspector.reload }.not_to raise_error
+    end
+  end
+end

data/spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb

@@ -0,0 +1,59 @@
+require "guard/compat/test/helper"
+
+require "lib/guard/rspec/inspectors/shared_examples"
+
+require "guard/rspec/inspectors/simple_inspector"
+
+klass = Guard::RSpec::Inspectors::SimpleInspector
+
+RSpec.describe klass do
+  include_examples "inspector", klass
+
+  # Use real paths because BaseInspector#_clean will be used to clean them
+  let(:other_paths) do
+    [
+      "spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb",
+      "spec/lib/guard/rspec/runner_spec.rb"
+    ]
+  end
+
+  it "returns paths and do not bothers about failed locations" do
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/inspectors/base_inspector_spec.rb").
+      and_return(false)
+
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/inspectors/simple_inspector_spec.rb").
+      and_return(false)
+
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/runner_spec.rb").
+      and_return(false)
+
+    allow(File).to receive(:directory?).
+      with("spec/lib/guard/rspec/deprecator_spec.rb").
+      and_return(false)
+
+    allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*[_.]spec.rb").
+      and_return(paths + other_paths)
+
+    allow(Dir).to receive(:[]).with("spec/**{,/*/**}/*.feature").
+      and_return([])
+
+    allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*[_.]spec.rb").
+      and_return([])
+
+    allow(Dir).to receive(:[]).with("myspec/**{,/*/**}/*.feature").
+      and_return([])
+
+    expect(inspector.paths(paths)).to eq(paths)
+    inspector.failed(failed_locations)
+    expect(inspector.paths(other_paths)).to eq(other_paths)
+    inspector.failed([])
+
+    expect(inspector.paths(paths)).to eq(paths)
+    inspector.failed(failed_locations)
+    expect(inspector.paths(other_paths)).to eq(other_paths)
+    inspector.failed([])
+  end
+end

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

@@ -0,0 +1,90 @@
+require "guard/compat/test/helper"
+
+require "guard/rspec/notifier"
+
+RSpec.describe Guard::RSpec::Notifier do
+  let(:options) { { notification: true, title: "RSpec results" } }
+  let(:notifier) { Guard::RSpec::Notifier.new(options) }
+
+  def expect_notification(message, image, priority, title = "RSpec results")
+    expect(Guard::Compat::UI).to receive(:notify).
+      with(message,  title: title, image: image, priority: priority)
+  end
+
+  describe "#notify_failure" do
+    it "notifies about failure" do
+      expect_notification("Failed", :failed, 2)
+      notifier.notify_failure
+    end
+
+    context "with a custom title" do
+      let(:options) { { notification: true, title: "Failure title" } }
+
+      it "notifies with the title" do
+        expect_notification("Failed", :failed, 2, "Failure title")
+        notifier.notify_failure
+      end
+    end
+  end
+
+  describe "#notify" do
+    it "notifies about success" do
+      expect_notification("This is summary", :success, -2)
+      notifier.notify("This is summary")
+    end
+
+    context "with pendings" do
+      let(:summary) { "5 examples, 0 failures (1 pending) in 4.0000 seconds" }
+
+      it "notifies about pendings" do
+        expect_notification(summary, :pending, -1)
+        notifier.notify(summary)
+      end
+    end
+
+    context "with failures" do
+      let(:summary) { "5 examples, 1 failures in 4.0000 seconds" }
+
+      it "notifies about failures" do
+        expect_notification(summary, :failed, 2)
+        notifier.notify(summary)
+      end
+
+      context "even if there is pendings" do
+        let(:summary) { "5 examples, 1 failures (1 pending) in 4.0000 seconds" }
+
+        it "still notifies about failures" do
+          expect_notification(summary, :failed, 2)
+          notifier.notify(summary)
+        end
+      end
+    end
+
+    context "with a custom title" do
+      let(:options) { { notification: true, title: "Custom title" } }
+
+      it "notifies with the title" do
+        expect_notification("This is summary", :success, -2, "Custom title")
+        notifier.notify("This is summary")
+      end
+    end
+  end
+
+  context "with notifications turned off" do
+    let(:options) { { notification: false } }
+
+    describe "#notify_failure" do
+      it "keeps quiet" do
+        expect(Guard::Compat::UI).not_to receive(:notify)
+        notifier.notify_failure
+      end
+    end
+
+    describe "#notify" do
+      it "keeps quiet" do
+        expect(Guard::Compat::UI).not_to receive(:notify)
+        notifier.notify("Summary")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require "guard/compat/test/helper"
+
+require "guard/rspec/results"
+
+RSpec.describe Guard::RSpec::Results do
+  subject do
+    described_class.new("foo/bar.txt")
+  end
+
+  before do
+    allow(File).to receive(:readlines).with("foo/bar.txt").and_return(data)
+  end
+
+  context "with valid data" do
+    let(:data) do
+      [
+        "5 examples, 2 failures (3 pending)\n",
+        "foo1/bar1_spec.rb\n",
+        "foo1/bar2_spec.rb\n"
+      ]
+    end
+
+    describe "#summary" do
+      it "sets a summary" do
+        expect(subject.summary).to eq("5 examples, 2 failures (3 pending)")
+      end
+    end
+
+    describe "#failures" do
+      it "sets a list of failures" do
+        expect(subject.failed_paths).
+          to eq(%w(foo1/bar1_spec.rb foo1/bar2_spec.rb))
+      end
+    end
+  end
+
+  context "with no data" do
+    let(:data) do
+      []
+    end
+
+    it "crashes" do
+      expect do
+        subject.load
+      end.to raise_error(
+        Guard::RSpec::Results::InvalidData,
+        "Invalid results in: foo/bar.txt, lines:\n[]\n"
+      )
+    end
+  end
+
+  context "with invalid data" do
+    let(:data) do
+      [""]
+    end
+
+    it "crashes" do
+      expect do
+        subject.load
+      end.to raise_error(
+        Guard::RSpec::Results::InvalidData,
+        "Invalid results in: foo/bar.txt, lines:\n[\"\"]\n"
+      )
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+require "guard/compat/test/helper"
+
+require "guard/rspec/rspec_process"
+
+RSpec.describe Guard::RSpec::RSpecProcess do
+  let(:results) { instance_double(Guard::RSpec::Results) }
+
+  let(:cmd) { "foo" }
+  let(:file) { "/tmp/foobar.txt" }
+  let(:pid) { 1234 }
+  let(:exit_code) { 0 }
+  let(:status) { instance_double(Process::Status, exitstatus: exit_code) }
+  let(:wait_result) { [pid, status] }
+
+  subject do
+    described_class.new(cmd, file)
+  end
+
+  before do
+    allow(Kernel).to receive(:spawn).
+      with({ "GUARD_RSPEC_RESULTS_FILE" => file }, cmd).and_return(pid)
+
+    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
+    before do
+      allow(Kernel).to receive(:spawn).
+        and_raise(Errno::ENOENT, "No such file or directory - foo")
+    end
+
+    it "fails" do
+      expect { subject }.
+        to raise_error(Guard::RSpec::RSpecProcess::Failure, /Failed: /)
+    end
+  end
+
+  context "with an existing command" do
+    before do
+      allow(Process).to receive(:wait2).with(pid).and_return(wait_result)
+    end
+
+    context "with an unknown failure" do
+      let(:exit_code) { 100 }
+
+      it "fails" do
+        expect { subject }.
+          to raise_error(Guard::RSpec::RSpecProcess::Failure, /Failed: /)
+      end
+    end
+
+    context "without any exit code" do
+      let(:exit_code) { nil }
+
+      it "fails" do
+        expect { subject }.
+          to raise_error(Guard::RSpec::RSpecProcess::Failure, /Failed: /)
+      end
+    end
+
+    context "with the failure code for normal test failures" do
+      let(:exit_code) { Guard::RSpec::Command::FAILURE_EXIT_CODE }
+
+      it "fails" do
+        expect { subject }.to_not raise_error
+      end
+
+      it { is_expected.to_not be_all_green }
+    end
+
+    context "with no failures" do
+      it "waits for process to end" do
+        expect(Process).to receive(:wait2).with(pid).and_return(wait_result)
+        subject
+      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
+
+    context "with bundler_env option" do
+      it "runs without Bunder changes when :inherit" do
+        expect(Bundler).to_not receive(:with_clean_env)
+        expect(Bundler).to_not receive(:with_original_env)
+
+        described_class.new(cmd, file, bundler_env: :inherit)
+      end
+
+      it "runs on clean Bunder changes when :clean_env" do
+        expect(Bundler).to receive(:with_clean_env)
+
+        described_class.new(cmd, file, bundler_env: :clean_env)
+      end
+
+      it "runs on original Bunder changes when :original_env" do
+        expect(Bundler).to receive(:with_original_env)
+
+        described_class.new(cmd, file, bundler_env: :original_env)
+      end
+    end
+
+    context "without bundler_env option" do
+      it "runs on original Bunder" do
+        expect(Bundler).to receive(:with_original_env)
+        subject
+      end
+    end
+  end
+end