guard-rspec 3.1.0 → 4.0.0

data/lib/guard/rspec/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module RSpecVersion
-    VERSION = "3.1.0"
+    VERSION = '4.0.0'
   end
 end

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

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'launchy'
+
+describe Guard::RSpec::Command do
+  let(:options) { { } }
+  let(:paths) { %w[path1 path2] }
+  let(:command) { Guard::RSpec::Command.new(paths, options) }
+
+  describe '.initialize' do
+
+    it "sets paths at the end" do
+      expect(command).to match /path1 path2$/
+    end
+
+    it "sets custom failure exit code" do
+      expect(command).to match /--failure-exit-code 2/
+    end
+
+    it "sets notifier formatter" do
+      expect(command).to match %r{-r .*/lib/guard/rspec/formatters/notifier.rb -f Guard::RSpec::Formatters::Notifier}
+    end
+
+    it "sets focuser formatter" do
+      expect(command).to match %r{-r .*/lib/guard/rspec/formatters/focuser.rb -f Guard::RSpec::Formatters::Focuser}
+    end
+
+    context "with custom cmd" do
+      let(:options) { { cmd: 'rspec -t ~slow' } }
+
+      it "uses custom cmd" do
+        expect(command).to match  /^rspec -t ~slow/
+      end
+    end
+
+    context "with RSpec defined formatter" do
+      let(:formatters) { [['doc','output']] }
+      before { RSpec::Core::ConfigurationOptions.stub(:new) { double(parse_options: { formatters: formatters }) } }
+
+      it "uses them" do
+        expect(command).to match %r{-f doc -o output}
+      end
+    end
+
+    context "with no RSpec defined formatter" do
+      it "sets default progress formatter" do
+        expect(command).to match %r{-f progress}
+      end
+    end
+
+    context "with formatter in cmd" do
+      let(:options) { { cmd: 'rspec -f doc' } }
+
+      it "sets no other formatters" do
+        expect(command).to match %r{-f doc}
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Guard::RSpec::Deprecator do
+  let(:options) { {} }
+  let(:deprecator) { Guard::RSpec::Deprecator.new(options) }
+
+  describe '#warns_about_deprecated_options' do
+
+    describe 'handling of environment variable SPEC_OPTS' do
+      it "shows warning if SPEC_OPTS is set" do
+        ENV['SPEC_OPTS'] = '-f p'
+        expect(Guard::UI).to receive(:warning).with(
+          'The SPEC_OPTS environment variable is present. This can conflict with guard-rspec, particularly notifications.')
+        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::UI).to_not receive(:warning).with(
+          'The SPEC_OPTS environment variable is present. This can conflict with guard-rspec, particularly notifications.')
+        deprecator.warns_about_deprecated_options
+      end
+    end
+
+    describe "with version option" do
+      let(:options) { { version: 1 } }
+
+      it "shows deprecation warning" do
+        expect(Guard::UI).to receive(:warning).with(
+          'Guard::RSpec DEPRECATION WARNING: The :version option is deprecated. Only RSpec ~> 2.14 is now supported.')
+        deprecator.warns_about_deprecated_options
+      end
+    end
+
+    describe "with exclude option" do
+      let(:options) { { exclude: "**" } }
+
+      it "shows deprecation warning" do
+        expect(Guard::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')
+        deprecator.warns_about_deprecated_options
+      end
+    end
+
+    %w[color drb fail_fast formatter env bundler binstubs rvm cli spring turnip zeus foreman].each do |option|
+      describe "with #{option} option" do
+        let(:options) { { option.to_sym => 1 } }
+
+        it "shows deprecation warning" do
+          expect(Guard::UI).to receive(:warning).with(
+            "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
+    end
+
+  end
+end

data/spec/lib/guard/rspec/formatters/focuser_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper.rb'
+
+require 'guard/rspec/formatters/focuser'
+
+describe Guard::RSpec::Formatters::Focuser do
+  let(:formatter) { Guard::RSpec::Formatters::Focuser.new(StringIO.new) }
+
+  describe "#dump_summary" do
+    context "with failures" do
+      let(:example) { double(
+        execution_result: { status: 'failed' },
+        metadata: { location: 'failed_location' }
+      ) }
+      after { File.delete('./tmp/rspec_guard_result') }
+
+      it "writes failed location in tmp dir" do
+        formatter.stub(:examples) { [example] }
+        formatter.dump_summary(123, 3, 1, 0)
+        result = File.open('./tmp/rspec_guard_result').read
+        expect(result).to eq "failed_location\n"
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,34 @@
+require 'spec_helper.rb'
+
+require 'guard/rspec/formatters/notifier'
+
+describe Guard::RSpec::Formatters::Notifier do
+  let(:formatter) { Guard::RSpec::Formatters::Notifier.new(StringIO.new) }
+
+  describe "#dump_summary" do
+    context "with only success" do
+      it "notifies success" do
+        expect(Guard::Notifier).to receive(:notify).with(
+          "3 examples, 0 failures\nin 123.0 seconds", title: "RSpec results", image: :success, priority:-2)
+        formatter.dump_summary(123, 3, 0, 0)
+      end
+    end
+
+    context "with pending" do
+      it "notifies pending too" do
+        expect(Guard::Notifier).to receive(:notify).with(
+          "3 examples, 0 failures (1 pending)\nin 123.0 seconds", title: "RSpec results", image: :pending, priority:-1)
+        formatter.dump_summary(123, 3, 0, 1)
+      end
+    end
+
+    context "with failures" do
+      it "notifies failures too" do
+        expect(Guard::Notifier).to receive(:notify).with(
+          "3 examples, 1 failures\nin 123.0 seconds", title: "RSpec results", image: :failed, priority:2)
+        formatter.dump_summary(123, 3, 1, 0)
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Guard::RSpec::Inspector do
+  let(:options) { { } }
+  let(:inspector) { Guard::RSpec::Inspector.new(options) }
+  before { Guard::UI.stub(:warning) }
+
+  describe '.initialize' do
+    it "sets empty failed paths" do
+      expect(inspector.failed_paths).to be_empty
+    end
+  end
+
+  describe "#paths" do
+    let(:paths) { %w[spec/lib/guard/rspec/inspector_spec.rb] }
+
+    it "returns spec paths if no args" do
+      expect(inspector.paths).to eq %w[spec]
+    end
+
+    context "with custom spec_paths" do
+      let(:options) { { spec_paths: %w[custom_spec] } }
+
+      it "returns custom spec paths if no args" do
+        expect(inspector.paths).to eq %w[custom_spec]
+      end
+    end
+
+    it "returns new paths" do
+      expect(inspector.paths(paths)).to eq paths
+    end
+
+    it "returns uniq new paths" do
+      expect(inspector.paths(paths + paths)).to eq paths
+    end
+
+    it "returns compact new paths" do
+      expect(inspector.paths(paths + [nil])).to eq paths
+    end
+
+    it "returns only rspec file" do
+      expect(inspector.paths(paths + %w[foo])).to eq paths
+    end
+
+    context "with focused paths" do
+      before {
+        FileUtils.mkdir_p('tmp')
+        File.open(Guard::RSpec::Inspector::FOCUSED_FILE_PATH,'w') { |f|
+          f.puts 'spec/lib/guard/rspec/command_spec.rb'
+        }
+      }
+
+      it "returns them" do
+        expect(inspector.paths(paths)).to eq %w[spec/lib/guard/rspec/command_spec.rb]
+      end
+    end
+
+    context "without focused paths" do
+      it "returns new paths" do
+        expect(inspector.paths(paths)).to eq paths
+      end
+    end
+
+    context "with keep_failed options and failed_paths" do
+      let(:options) { { keep_failed: true } }
+      let(:failed_paths) { %w[spec/lib/guard/rspec/command_spec.rb] }
+      before { inspector.failed_paths = failed_paths }
+
+      it "returns failed paths alongs new paths" do
+        expect(inspector.paths(paths)).to eq failed_paths + paths
+      end
+
+      it "adds new paths to failed_paths" do
+        inspector.paths(paths)
+        expect(inspector.failed_paths).to eq failed_paths + paths
+      end
+    end
+  end
+
+  describe "#clear_paths" do
+    before { inspector.failed_paths = %w[failed_path1 failed_path2] }
+
+    it "clears all failed_paths if no args" do
+      inspector.clear_paths
+      expect(inspector.failed_paths).to be_empty
+    end
+
+    it "clears given failed_path" do
+      inspector.clear_paths(%w[failed_path1 failed_path3])
+      expect(inspector.failed_paths).to eq %w[failed_path2]
+    end
+  end
+
+end

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

@@ -0,0 +1,136 @@
+require 'spec_helper'
+require 'launchy'
+
+describe Guard::RSpec::Runner do
+  let(:default_options) { {
+    all_after_pass:  false,
+    notification: true,
+    run_all: { message: 'Running all specs' },
+    launchy: nil,
+  } }
+  let(:options) { {} }
+  let(:runner) { Guard::RSpec::Runner.new(options) }
+  let(:inspector) { double(Guard::RSpec::Inspector) }
+  before {
+    Guard::UI.stub(:info)
+    Kernel.stub(:system) { true }
+    Guard::RSpec::Inspector.stub(:new) { inspector }
+    Guard::RSpec::Command.stub(:new) { 'rspec' }
+  }
+
+  describe '.initialize' do
+    it 'instanciates inspector with options' do
+      expect(Guard::RSpec::Inspector).to receive(:new).with(default_options.merge(foo: :bar))
+      Guard::RSpec::Runner.new(foo: :bar)
+    end
+  end
+
+  describe "#reloads" do
+    it "clears inspector failed_paths" do
+      expect(inspector).to receive(:clear_paths)
+      runner.reload
+    end
+  end
+
+  describe "#run_all" do
+    before {
+      inspector.stub(:paths) { %w[spec1 spec2] }
+      inspector.stub(:clear_paths) { true }
+    }
+
+    it "prints default message" do
+      expect(Guard::UI).to receive(:info).with(default_options[:run_all][:message], reset: true)
+      runner.run_all
+    end
+
+    context "with custom message" do
+      let(:options) { { run_all: { message: 'Custom message' } } }
+
+      it "prints custom message" do
+        expect(Guard::UI).to receive(:info).with('Custom message', reset: true)
+        runner.run_all
+      end
+    end
+
+    context "with custom cmd" do
+      let(:options) { { run_all: { cmd: 'rspec -t ~slow' } } }
+
+      it "builds command with custom options" do
+        expect(Guard::RSpec::Command).to receive(:new).with(kind_of(Array), hash_including(cmd: 'rspec -t ~slow'))
+        runner.run_all
+      end
+    end
+
+    it "builds commands with all spec paths" do
+      expect(Guard::RSpec::Command).to receive(:new).with(%w[spec1 spec2], kind_of(Hash))
+      runner.run_all
+    end
+
+    it "clears inspector paths if run is success" do
+      expect(inspector).to receive(:clear_paths)
+      runner.run_all
+    end
+  end
+
+  describe "#run" do
+    let(:paths) { %w[spec_path1 spec_path2] }
+    before {
+      inspector.stub(:failed_paths) { [] }
+      inspector.stub(:paths) { paths }
+      inspector.stub(:clear_paths) { true }
+    }
+
+    it "prints running message" do
+      expect(Guard::UI).to receive(:info).with('Running: spec_path1 spec_path2', reset: true)
+      runner.run(paths)
+    end
+
+    it "returns if no paths are given" do
+      inspector.stub(:paths) { [] }
+      expect(Guard::UI).to_not receive(:info)
+      runner.run([])
+    end
+
+    it "builds commands with spec paths" do
+      expect(Guard::RSpec::Command).to receive(:new).with(%w[spec_path1 spec_path2], kind_of(Hash))
+      runner.run(paths)
+    end
+
+    it "clears inspector paths if run is success" do
+      expect(inspector).to receive(:clear_paths).with(paths)
+      runner.run(paths)
+    end
+
+    it "notifies failure" do
+      Kernel.stub(:system) { false }
+      expect(Guard::Notifier).to receive(:notify).with('Failed', title: 'RSpec results', image: :failed, priority: 2)
+      runner.run(paths)
+    end
+
+    context "with all_after_pass option and old failed spec paths" do
+      let(:options) { { all_after_pass: true } }
+      before {
+        inspector.stub(:failed_paths) { %w[failed_path] }
+        inspector.stub(:paths).with(paths) { paths }
+      }
+
+      it "re-runs all if run is success" do
+        expect(runner).to receive(:run_all)
+        runner.run(paths)
+      end
+    end
+
+    context "with launchy option" do
+      let(:options) { { launchy: 'launchy_path' } }
+      before {
+        Pathname.stub(:new).with('launchy_path') { double(exist?: true) }
+      }
+
+      it "opens Launchy" do
+        expect(Launchy).to receive(:open).with('launchy_path')
+        runner.run(paths)
+      end
+    end
+  end
+
+end

data/spec/lib/guard/rspec_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Guard::RSpec do
+  let(:default_options) { { all_on_start: false } }
+  let(:options) { { } }
+  let(:plugin) { Guard::RSpec.new(options) }
+  let(:runner) { double(Guard::RSpec::Runner) }
+  before {
+    Guard::UI.stub(:info)
+    Guard::RSpec::Deprecator.stub(:warns_about_deprecated_options)
+    Guard::RSpec::Runner.stub(:new) { runner }
+  }
+
+  describe '.initialize' do
+    it 'instanciates Runner with options' do
+      expect(Guard::RSpec::Runner).to receive(:new).with(default_options.merge(foo: :bar))
+      Guard::RSpec.new(foo: :bar)
+    end
+
+    it 'warns deprecated options' do
+      expect(Guard::RSpec::Deprecator).to receive(:warns_about_deprecated_options).with(default_options.merge(foo: :bar))
+      Guard::RSpec.new(foo: :bar)
+    end
+  end
+
+  describe '#start' do
+    it "doesn't call #run_all by default" do
+      expect(plugin).to_not receive(:run_all)
+      plugin.start
+    end
+
+    context 'with all_on_start at true' do
+      let(:options) { { all_on_start: true } }
+
+      it 'calls #run_all' do
+        expect(plugin).to receive(:run_all)
+        plugin.start
+      end
+    end
+  end
+
+  describe '#run_all' do
+    it "runs all specs via runner" do
+      expect(runner).to receive(:run_all) { true }
+      plugin.run_all
+    end
+
+    it "throws task_has_failed if runner return false" do
+      runner.stub(:run_all) { false }
+      expect(plugin).to receive(:throw).with(:task_has_failed)
+      plugin.run_all
+    end
+  end
+
+  describe '#reload' do
+    it "reloads via runner" do
+      expect(runner).to receive(:reload)
+      plugin.reload
+    end
+  end
+
+  describe '#run_on_modifications' do
+    let(:paths) { %w[path1 path2] }
+    it "runs all specs via runner" do
+      expect(runner).to receive(:run).with(paths) { true }
+      plugin.run_on_modifications(paths)
+    end
+
+    it "does nothing if paths empty" do
+      expect(runner).to_not receive(:run)
+      plugin.run_on_modifications([])
+    end
+
+    it "throws task_has_failed if runner return false" do
+      runner.stub(:run) { false }
+      expect(plugin).to receive(:throw).with(:task_has_failed)
+      plugin.run_on_modifications(paths)
+    end
+  end
+
+end
+