guard-rspec 2.1.0 → 4.7.3

data/spec/lib/guard/rspec_formatter_spec.rb

@@ -0,0 +1,277 @@
+require "guard/rspec_formatter"
+
+RSpec.describe Guard::RSpecFormatter do
+  describe "#dump_summary" do
+    def rspec_summary_args(*args)
+      return args unless ::RSpec::Core::Version::STRING.start_with?("3.")
+
+      n = Struct.new(:duration, :example_count, :failure_count, :pending_count)
+      [n.new(*args)]
+    end
+
+    let(:example_dump_summary_args) { rspec_summary_args(123, 3, 1, 0) }
+    let(:summary_with_no_failures) { rspec_summary_args(123, 3, 0, 0) }
+    let(:summary_with_only_pending) { rspec_summary_args(123, 3, 0, 1) }
+
+    let(:failed_example) do
+      result =
+        if ::RSpec::Core::Version::STRING.start_with?("3.")
+          double(status: "failed")
+        else
+          { status: "failed" }
+        end
+
+      double(execution_result: result, metadata: { location: spec_filename })
+    end
+
+    let(:writer) do
+      StringIO.new
+    end
+
+    let(:stub_formatter) { true }
+
+    let(:formatter) do
+      described_class.new(StringIO.new).tap do |formatter_stub|
+        if stub_formatter
+          allow(formatter_stub).to receive(:_write) do |&block|
+            block.call writer
+          end
+        end
+      end
+    end
+
+    let(:result) do
+      writer.rewind
+      writer.read
+    end
+
+    context "without stubbed IO" do
+      let(:stub_formatter) { false }
+
+      around do |example|
+        env_var = "GUARD_RSPEC_RESULTS_FILE"
+        old = ENV[env_var]
+        ENV[env_var] = "foobar.txt"
+        example.run
+        ENV[env_var] = old
+      end
+
+      it "creates temporary file and and writes to it" do
+        file = File.expand_path("foobar.txt")
+
+        expect(FileUtils).to receive(:mkdir_p).
+          with(File.dirname(file)) {}
+
+        expect(File).to receive(:open).
+          with(file, "w") do |_, _, &block|
+          block.call writer
+        end
+
+        formatter.dump_summary(*example_dump_summary_args)
+      end
+
+      context "when writing file fails" do
+        it "outputs an error" do
+          allow(FileUtils).to receive(:mkdir_p).and_raise(Errno::EACCES)
+          expect do
+            formatter.dump_summary(*example_dump_summary_args)
+          end.to raise_error(Errno::EACCES)
+        end
+      end
+
+      context "when writer fails" do
+        it "outputs an error" do
+          allow(FileUtils).to receive(:mkdir_p).and_raise(TypeError, "foo")
+          expect do
+            formatter.dump_summary(*example_dump_summary_args)
+          end.to raise_error(TypeError, "foo")
+        end
+      end
+
+      context "when no env is passed" do
+        let(:file) { File.join(Dir.pwd, "tmp/rspec_guard_result") }
+
+        before do
+          ENV["GUARD_RSPEC_RESULTS_FILE"] = nil
+
+          allow(FileUtils).to receive(:mkdir_p).
+            with(File.dirname(file)) {}
+
+          allow(File).to receive(:open).
+            with(file, "w") do |_, _, &block|
+            block.call writer
+          end
+
+          allow(STDERR).to receive(:puts).with(/no environment/)
+        end
+
+        it "warns" do
+          expect(STDERR).to receive(:puts).with(/no environment/)
+          formatter.dump_summary(*example_dump_summary_args)
+        end
+
+        it "uses default file" do
+          expect(File).to receive(:open).
+            with(file, "w") do |_, _, &block|
+            block.call writer
+          end
+          formatter.dump_summary(*example_dump_summary_args)
+        end
+      end
+    end
+
+    context "with failures" do
+      let(:spec_filename) { "failed_location_spec.rb" }
+
+      def expected_output(spec_filename)
+        /^3 examples, 1 failures in 123\.0 seconds\n#{spec_filename}\n$/
+      end
+
+      it "writes summary line and failed location in tmp dir" do
+        allow(formatter).to receive(:examples) { [failed_example] }
+        formatter.dump_summary(*example_dump_summary_args)
+        expect(result).to match expected_output(spec_filename)
+      end
+
+      it "writes only uniq filenames out" do
+        allow(formatter).to receive(:examples).
+          and_return([failed_example, failed_example])
+
+        formatter.dump_summary(*example_dump_summary_args)
+        expect(result).to match expected_output(spec_filename)
+      end
+
+      let(:notification) { example_dump_summary_args }
+
+      it "writes summary line and failed location" do
+        allow(formatter).to receive(:examples) { [failed_example] }
+        formatter.dump_summary(*notification)
+        expect(result).to match expected_output(spec_filename)
+      end
+    end
+
+    it "should find the spec file for shared examples" do
+      metadata = {
+        location: "./spec/support/breadcrumbs.rb:75",
+        example_group: { location: "./spec/requests/breadcrumbs_spec.rb:218" }
+      }
+
+      result = described_class.extract_spec_location(metadata)
+      expect(result).to start_with "./spec/requests/breadcrumbs_spec.rb"
+    end
+
+    # Skip location because of rspec issue
+    # https://github.com/rspec/rspec-core/issues/1243
+    it "returns only the spec file without line number for shared examples" do
+      metadata = {
+        location: "./spec/support/breadcrumbs.rb:75",
+        example_group: { location: "./spec/requests/breadcrumbs_spec.rb:218" }
+      }
+      expect(described_class.extract_spec_location(metadata)).
+        to eq "./spec/requests/breadcrumbs_spec.rb"
+    end
+
+    context "when a shared examples has no location" do
+      it "should return location of the root spec" do
+        metadata = {
+          location: "./spec/support/breadcrumbs.rb:75",
+          example_group: {}
+        }
+
+        expect(STDERR).to receive(:puts).
+          with("no spec file location in #{metadata.inspect}")
+
+        expect(described_class.extract_spec_location(metadata)).
+          to eq metadata[:location]
+      end
+    end
+
+    context "when a shared examples are nested" do
+      it "should return location of the root spec" do
+        metadata = {
+          location: "./spec/support/breadcrumbs.rb:75",
+          example_group: {
+            example_group: {
+              location: "./spec/requests/breadcrumbs_spec.rb:218"
+            }
+          }
+        }
+
+        expect(described_class.extract_spec_location(metadata)).
+          to eq "./spec/requests/breadcrumbs_spec.rb"
+      end
+    end
+
+    context "when RSpec 3.0 metadata is present" do
+      it "should return location of the root spec" do
+        metadata = {
+          location: "./spec/support/breadcrumbs.rb:75",
+          parent_example_group: {
+            location: "./spec/requests/breadcrumbs_spec.rb:218"
+          }
+        }
+
+        expect(described_class.extract_spec_location(metadata)).
+          to eq "./spec/requests/breadcrumbs_spec.rb"
+      end
+    end
+
+    context "with only success" do
+      it "notifies success" do
+        formatter.dump_summary(*summary_with_no_failures)
+        expect(result).to match(/^3 examples, 0 failures in 123\.0 seconds\n$/)
+      end
+    end
+
+    context "with pending" do
+      it "notifies pending too" do
+        formatter.dump_summary(*summary_with_only_pending)
+        expect(result).to match(
+          /^3 examples, 0 failures \(1 pending\) in 123\.0 seconds\n$/
+        )
+      end
+    end
+
+    context "when RSpec 3.0 uses ext globs" do
+      before do
+        allow(::RSpec.configuration).to receive(:pattern).
+          and_return("**{,/*/**}/*_spec.rb")
+      end
+
+      context "when Ruby does not support ext glob matcher" do
+        before do
+          allow(File).to receive(:const_defined?).with(:FNM_EXTGLOB) { false }
+        end
+
+        let(:metadata) { { location: "./spec/foo_spec.rb:75" } }
+
+        it "fails" do
+          expect do
+            described_class.extract_spec_location(metadata)
+          end.to raise_error(
+            described_class::Error::UnsupportedPattern,
+            "Your RSpec.configuration.pattern uses characters unsupported "\
+            "by your Ruby version (File::FNM_EXTGLOB is undefined)"
+          )
+        end
+      end
+    end
+
+    context "when RSpec 3.0 is configured to use multiple patterns" do
+      before do
+        allow(::RSpec.configuration).to receive(:pattern).
+          and_return("**{,/*/**}/*_spec.rb,**/*.feature")
+      end
+
+      it "matches a spec file with the first pattern" do
+        expect(described_class.spec_path?("./spec/foo_spec.rb")).
+          to be_truthy
+      end
+
+      it "matches a spec file with the second pattern" do
+        expect(described_class.spec_path?("./spec/acceptance/bar.feature")).
+          to be_truthy
+      end
+    end
+  end
+end

data/spec/lib/guard/rspec_spec.rb

@@ -0,0 +1,91 @@
+require "guard/compat/test/helper"
+require "guard/rspec"
+
+RSpec.describe Guard::RSpec do
+  let(:default_options) { Guard::RSpec::Options::DEFAULTS }
+  let(:options) { {} }
+  let(:plugin) { Guard::RSpec.new(options) }
+  let(:runner) { instance_double(Guard::RSpec::Runner) }
+
+  before do
+    allow(Guard::Compat::UI).to receive(:info)
+    allow(Guard::RSpec::Deprecator).to receive(:warns_about_deprecated_options)
+    allow(Guard::RSpec::Runner).to receive(:new) { runner }
+  end
+
+  describe ".initialize" do
+    it "instanciates with default and custom options" do
+      guard_rspec = Guard::RSpec.new(foo: :bar)
+      expect(guard_rspec.options).to eq(default_options.merge(foo: :bar))
+    end
+
+    it "instanciates Runner with all default and custom 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
+      allow(runner).to receive(: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
+      allow(runner).to receive(:run) { false }
+      expect(plugin).to receive(:throw).with(:task_has_failed)
+      plugin.run_on_modifications(paths)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,145 @@
+require "rspec"
+
+# To help produce better bug reports in Rubinius
+if RUBY_ENGINE == "rbx"
+  $DEBUG = true # would be nice if this didn't fail ... :(
+  require "rspec/matchers"
+  require "rspec/matchers/built_in/be"
+end
+
+if ENV["CI"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+rspec_version = ::RSpec::Version::STRING.to_f
+old_rspec = (rspec_version < 3)
+
+if old_rspec
+  module RSpec
+    module Core
+      class ExampleGroup
+        def instance_double(*args)
+          double(*args)
+        end
+      end
+    end
+  end
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.register_ordering :global do |examples|
+    examples.partition { |ex| ex.metadata[:type] != :acceptance }.flatten(1)
+  end
+
+  # Use global for running acceptance tests last
+  config.order = :global
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+
+    unless old_rspec
+      if rspec_version > 3.0
+        expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+      end
+    end
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true unless old_rspec
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run focus: ENV["CI"] != "true"
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+
+  config.disable_monkey_patching! unless old_rspec
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.raise_errors_for_deprecations!
+
+  config.before do
+    %w(exist?).each do |meth|
+      allow(Dir).to receive(meth.to_sym) do |*args|
+        abort "stub me: Dir.#{meth}(#{args.map(&:inspect) * ','})!"
+      end
+    end
+
+    allow(Dir).to receive(:[]) do |*args|
+      abort "stub me: Dir[#{args.first}]!"
+    end
+
+    unless RUBY_ENGINE == "rbx"
+      # RBX uses cache in ~/.rbx
+      %w(directory?).each do |meth|
+        allow(File).to receive(meth.to_sym) do |*args|
+          abort "stub me: File.#{meth}(#{args.map(&:inspect) * ','})!"
+        end
+      end
+    end
+
+    %w(delete readlines).each do |meth|
+      allow(File).to receive(meth.to_sym) do |*args|
+        abort "stub me: File.#{meth}(#{args.map(&:inspect) * ','})!"
+      end
+    end
+
+    %w(mkdir mkdir_p).each do |meth|
+      allow(FileUtils).to receive(meth.to_sym) do |*args|
+        abort "stub me: FileUtils.#{meth}(#{args.map(&:inspect) * ','})!"
+      end
+    end
+
+    %w(spawn system).each do |meth|
+      allow(Kernel).to receive(meth.to_sym) do |*args|
+        abort "stub me: Kernel.#{meth}(#{args.map(&:inspect) * ','})!"
+      end
+    end
+  end
+end