rspec-sidekiq 0.5.1 → 1.0.0

data/lib/rspec/sidekiq/matchers/have_enqueued_jobs.rb

@@ -1,37 +1,12 @@
-module RSpec
-  module Sidekiq
-    module Matchers
-      def have_enqueued_jobs expected
-        HaveEnqueuedJobs.new expected
-      end
-
-      class HaveEnqueuedJobs
-        def initialize expected
-          @expected = expected
-        end
-
-        def description
-          "have #{@expected} enqueued #{@klass} job#{jobs_description}"
-        end
-
-        def failure_message
-          "expected #{@klass} to have #{@expected} enqueued job#{jobs_description} but got #{@actual}"
-        end
-
-        def jobs_description
-          "s" unless @expected == 1
-        end
-
-        def matches? klass
-          @klass = klass
-          @actual = klass.jobs.size
-          @actual == @expected
-        end
-
-        def negative_failure_message
-          "expected #{@klass} to not have #{@expected} enqueued job#{jobs_description}"
-        end
-      end
-    end
-  end
+module RSpec
+  module Sidekiq
+    module Matchers
+      def have_enqueued_jobs expected_number_of_jobs
+        raise RuntimeError, "have_enqueued_jobs matcher has been removed from rspec-sidekiq 1.x.x. Use \"expect(Job).to have(2).jobs\" instead. See https://github.com/philostler/rspec-sidekiq/wiki/FAQ-&-Troubleshooting"
+      end
+
+      class HaveEnqueuedJobs
+      end
+    end
+  end
 end

data/lib/rspec/sidekiq/matchers.rb

@@ -1,10 +1,11 @@
-require "rspec/core"
-require "rspec/sidekiq/matchers/be_processed_in"
-require "rspec/sidekiq/matchers/be_retryable"
-require "rspec/sidekiq/matchers/be_unique"
-require "rspec/sidekiq/matchers/have_enqueued_job"
-require "rspec/sidekiq/matchers/have_enqueued_jobs"
-
-RSpec.configure do |config|
-  config.include RSpec::Sidekiq::Matchers
+require "rspec/core"
+require "rspec/sidekiq/matchers/be_delayed"
+require "rspec/sidekiq/matchers/be_processed_in"
+require "rspec/sidekiq/matchers/be_retryable"
+require "rspec/sidekiq/matchers/be_unique"
+require "rspec/sidekiq/matchers/have_enqueued_job"
+require "rspec/sidekiq/matchers/have_enqueued_jobs"
+
+RSpec.configure do |config|
+  config.include RSpec::Sidekiq::Matchers
 end

data/lib/rspec/sidekiq/sidekiq.rb

@@ -1,21 +1,25 @@
-module RSpec
-  module Sidekiq
-    class << self
-      def configure &block
-        yield configuration
-
-        configuration
-      end
-
-      def configuration
-        @configuration ||= Configuration.new
-      end
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.before(:each) do
-    Sidekiq::Worker.clear_all if RSpec::Sidekiq.configuration.clear_all_enqueued_jobs
-  end
+module RSpec
+  module Sidekiq
+    class << self
+      def configure &block
+        yield configuration if block
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    message = "[rspec-sidekiq] WARNING! Sidekiq will *NOT* process jobs in this environment. See https://github.com/philostler/rspec-sidekiq/wiki/FAQ-&-Troubleshooting"
+    message = "\e[33m#{message}\e[0m" if RSpec::Sidekiq.configuration.enable_terminal_colours
+    puts message if RSpec::Sidekiq.configuration.warn_when_jobs_not_processed_by_sidekiq
+  end
+
+  config.before(:each) do
+    Sidekiq::Worker.clear_all if RSpec::Sidekiq.configuration.clear_all_enqueued_jobs
+  end
 end

data/lib/rspec/sidekiq/version.rb

@@ -1,5 +1,5 @@
-module RSpec
-  module Sidekiq
-    VERSION = "0.5.1"
-  end
+module RSpec
+  module Sidekiq
+    VERSION = "1.0.0"
+  end
 end

data/lib/rspec-sidekiq.rb

@@ -1,6 +1,7 @@
-require "sidekiq/testing"
-
-require "rspec/sidekiq/configuration"
-require "rspec/sidekiq/matchers"
-require "rspec/sidekiq/sidekiq"
-require "rspec/sidekiq/batch"
+require "sidekiq/testing"
+
+require "rspec/sidekiq/batch"
+require "rspec/sidekiq/configuration"
+require "rspec/sidekiq/helpers"
+require "rspec/sidekiq/matchers"
+require "rspec/sidekiq/sidekiq"

data/rspec-sidekiq.gemspec

@@ -1,34 +1,35 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/rspec/sidekiq/version", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name        = "rspec-sidekiq"
-  s.version     = RSpec::Sidekiq::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.author      = "Phil Ostler"
-  s.email       = "github@philostler.com"
-  s.homepage    = "http://github.com/philostler/rspec-sidekiq"
-  s.summary     = "RSpec for Sidekiq"
-  s.description = "Simple testing of Sidekiq jobs via a collection of matchers and common tasks"
-  s.license     = "MIT"
-
-  s.add_dependency "rspec", "~> 2.0"
-  s.add_dependency "sidekiq", ">= 2.4.0"
-
-  s.add_development_dependency "coveralls", "~> 0.6.0"
-  s.add_development_dependency "fuubar", "~> 1.1"
-  s.add_development_dependency "rspec", "~> 2.0"
-  s.add_development_dependency "sidekiq", ">= 2.4.0"
-
-  s.files = Dir[".gitattributes"] +
-            Dir[".gitignore"] +
-            Dir[".rspec"] +
-            Dir[".travis"] +
-            Dir["CHANGES.md"] +
-            Dir["Gemfile"] +
-            Dir["LICENSE"] +
-            Dir["README.md"] +
-            Dir["rspec-sidekiq.gemspec"] +
-            Dir["**/*.rb"]
-  s.require_paths = ["lib"]
-end
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/rspec/sidekiq/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-sidekiq"
+  s.version     = RSpec::Sidekiq::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Phil Ostler"
+  s.email       = "github@philostler.com"
+  s.homepage    = "http://github.com/philostler/rspec-sidekiq"
+  s.summary     = "RSpec for Sidekiq"
+  s.description = "Simple testing of Sidekiq jobs via a collection of matchers and helpers"
+  s.license     = "MIT"
+
+  s.add_dependency "rspec", ">= 2.0.0"
+  s.add_dependency "sidekiq", ">= 2.4.0"
+
+  s.add_development_dependency "coveralls", "~> 0.7.0"
+  s.add_development_dependency "fuubar", ">= 1.1.0"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "sidekiq", ">= 2.4.0"
+
+  s.files = Dir[".gitattributes"] +
+            Dir[".gitignore"] +
+            Dir[".rspec"] +
+            Dir[".simplecov"] +
+            Dir[".travis"] +
+            Dir["CHANGES.md"] +
+            Dir["Gemfile"] +
+            Dir["LICENSE"] +
+            Dir["README.md"] +
+            Dir["rspec-sidekiq.gemspec"] +
+            Dir["**/*.rb"]
+  s.require_paths = ["lib"]
+end

data/spec/rspec/sidekiq/batch_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe "Batch" do
+  module Sidekiq
+    module Batch
+      class Status
+      end
+    end
+  end
+
+  load File.expand_path(File.join(File.dirname(__FILE__), "../../../lib/rspec/sidekiq/batch.rb"))
+
+  describe "NullStatus" do
+    describe "#total" do
+      it "returns 0 when no jobs" do
+        null_status = RSpec::Sidekiq::NullStatus.new
+        expect(null_status.total).to eq(0)
+      end
+
+      it "returns 1 when 1 job" do
+        null_status = RSpec::Sidekiq::NullStatus.new
+        TestWorker.perform_async('5')
+        expect(null_status.total).to eq(1)
+      end
+    end
+  end
+end

data/spec/rspec/sidekiq/helpers/retries_exhausted_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'Retries Exhausted block' do
+
+  class FooClass < TestWorkerAlternative
+    sidekiq_retries_exhausted do |msg|
+      bar('hello')
+    end
+
+    def self.bar(input)
+    end
+  end
+
+  it 'executes whatever is within the block' do
+    FooClass.within_sidekiq_retries_exhausted_block { expect(FooClass).to receive(:bar).with('hello') }
+  end
+
+end

data/spec/rspec/sidekiq/matchers/be_delayed_spec.rb

@@ -0,0 +1,238 @@
+require "spec_helper"
+
+describe RSpec::Sidekiq::Matchers::BeDelayed do
+  let(:delay_subject) { RSpec::Sidekiq::Matchers::BeDelayed.new }
+  let(:delay_with_arguments_subject) { RSpec::Sidekiq::Matchers::BeDelayed.new Object }
+  let(:delay_for_subject) { RSpec::Sidekiq::Matchers::BeDelayed.new.for 3600 }
+  let(:delay_for_with_arguments_subject) { RSpec::Sidekiq::Matchers::BeDelayed.new(Object).for 3600 }
+  let(:delay_until_subject) { RSpec::Sidekiq::Matchers::BeDelayed.new.until Time.now + 3600 }
+  let(:delay_until_with_arguments_subject) { RSpec::Sidekiq::Matchers::BeDelayed.new(Object).until Time.now + 3600 }
+  before(:each) do
+    delay_subject.matches? Object.method :nil?
+    delay_with_arguments_subject.matches? Object.method :is_a?
+
+    delay_for_subject.matches? Object.method :nil?
+    delay_for_with_arguments_subject.matches? Object.method :is_a?
+
+    delay_until_subject.matches? Object.method :nil?
+    delay_until_with_arguments_subject.matches? Object.method :is_a?
+  end
+
+  describe "expected usage" do
+    it "matches" do
+      Object.delay_for(3600).is_a? Object
+
+      expect(Object.method :is_a?).to be_delayed(Object).for 3600
+    end
+  end
+
+  describe "#be_delayed_job" do
+    it "returns instance" do
+      expect(be_delayed).to be_a RSpec::Sidekiq::Matchers::BeDelayed
+    end
+  end
+
+  describe "#description" do
+    context "when expected is a delay" do
+      it "returns description" do
+        expect(delay_subject.description).to eq "be delayed"
+      end
+    end
+
+    context "when expected is a delay with arguments" do
+      it "returns description" do
+        expect(delay_with_arguments_subject.description).to eq "be delayed with arguments [Object]"
+      end
+    end
+
+    context "when expected is a delay for" do
+      it "returns description" do
+        expect(delay_for_subject.description).to eq "be delayed for 3600 seconds"
+      end
+    end
+
+    context "when expected is a delay for with arguments" do
+      it "returns description" do
+        expect(delay_for_with_arguments_subject.description).to eq "be delayed for 3600 seconds with arguments [Object]"
+      end
+    end
+
+    context "when expected is a delay until" do
+      it "returns description" do
+        expect(delay_until_subject.description).to eq "be delayed until #{Time.now + 3600}"
+      end
+    end
+
+    context "when expected is a delay until with arguments" do
+      it "returns description" do
+        expect(delay_until_with_arguments_subject.description).to eq "be delayed until #{Time.now + 3600} with arguments [Object]"
+      end
+    end
+  end
+
+  describe "#failure_message" do
+    context "when expected is a delay" do
+      it "returns message" do
+        expect(delay_subject.failure_message).to eq "expected Object.nil? to be delayed"
+      end
+    end
+
+    context "when expected is a delay with arguments" do
+      it "returns message" do
+        expect(delay_with_arguments_subject.failure_message).to eq "expected Object.is_a? to be delayed with arguments [Object]"
+      end
+    end
+
+    context "when expected is a delay for" do
+      it "returns message" do
+        expect(delay_for_subject.failure_message).to eq "expected Object.nil? to be delayed for 3600 seconds"
+      end
+    end
+
+    context "when expected is a delay for with arguments" do
+      it "returns message" do
+        expect(delay_for_with_arguments_subject.failure_message).to eq "expected Object.is_a? to be delayed for 3600 seconds with arguments [Object]"
+      end
+    end
+
+    context "when expected is a delay until" do
+      it "returns message" do
+        expect(delay_until_subject.failure_message).to eq "expected Object.nil? to be delayed until #{Time.now + 3600}"
+      end
+    end
+
+    context "when expected is a delay until with arguments" do
+      it "returns message" do
+        expect(delay_until_with_arguments_subject.failure_message).to eq "expected Object.is_a? to be delayed until #{Time.now + 3600} with arguments [Object]"
+      end
+    end
+  end
+
+  describe "#matches?" do
+    context "when condition matches" do
+      context "when expected is a delay" do
+        it "returns true" do
+          Object.delay.nil?
+
+          expect(delay_subject.matches? Object.method :nil?).to be true
+        end
+      end
+
+      context "when expected is a delay with arguments" do
+        it "returns true" do
+          Object.delay.is_a? Object
+
+          expect(delay_with_arguments_subject.matches? Object.method :is_a?).to be true
+        end
+      end
+
+      context "when expected is a delay for" do
+        it "returns true" do
+          Object.delay_for(3600).nil?
+
+          expect(delay_for_subject.matches? Object.method :nil?).to be true
+        end
+      end
+
+      context "when expected is a delay for with arguments" do
+        it "returns true" do
+          Object.delay_for(3600).is_a? Object
+
+          expect(delay_for_with_arguments_subject.matches? Object.method :is_a?).to be true
+        end
+      end
+
+      context "when expected is a delay until" do
+        it "returns true" do
+          Object.delay_until(Time.now + 3600).nil?
+
+          expect(delay_until_subject.matches? Object.method :nil?).to be true
+        end
+      end
+
+      context "when expected is a delay until with arguments" do
+        it "returns true" do
+          Object.delay_until(Time.now + 3600).is_a? Object
+
+          expect(delay_until_with_arguments_subject.matches? Object.method :is_a?).to be true
+        end
+      end
+    end
+
+    context "when condition does not match" do
+      context "when expected is a delay" do
+        it "returns false" do
+          expect(delay_subject.matches? Object.method :nil?).to be false
+        end
+      end
+
+      context "when expected is a delay with arguments" do
+        it "returns false" do
+          expect(delay_with_arguments_subject.matches? Object.method :is_a?).to be false
+        end
+      end
+
+      context "when expected is a delay for" do
+        it "returns false" do
+          expect(delay_for_subject.matches? Object.method :nil?).to be false
+        end
+      end
+
+      context "when expected is a delay for with arguments" do
+        it "returns false" do
+          expect(delay_for_with_arguments_subject.matches? Object.method :is_a?).to be false
+        end
+      end
+
+      context "when expected is a delay until" do
+        it "returns false" do
+          expect(delay_until_subject.matches? Object.method :nil?).to be false
+        end
+      end
+
+      context "when expected is a delay until with arguments" do
+        it "returns false" do
+          expect(delay_until_with_arguments_subject.matches? Object.method :is_a?).to be false
+        end
+      end
+    end
+  end
+
+  describe "#negative_failure_message" do
+    context "when expected is a delay" do
+      it "returns message" do
+        expect(delay_subject.negative_failure_message).to eq "expected Object.nil? to not be delayed"
+      end
+    end
+
+    context "when expected is a delay with arguments" do
+      it "returns message" do
+        expect(delay_with_arguments_subject.negative_failure_message).to eq "expected Object.is_a? to not be delayed with arguments [Object]"
+      end
+    end
+
+    context "when expected is a delay for" do
+      it "returns message" do
+        expect(delay_for_subject.negative_failure_message).to eq "expected Object.nil? to not be delayed for 3600 seconds"
+      end
+    end
+
+    context "when expected is a delay for with arguments" do
+      it "returns message" do
+        expect(delay_for_with_arguments_subject.negative_failure_message).to eq "expected Object.is_a? to not be delayed for 3600 seconds with arguments [Object]"
+      end
+    end
+
+    context "when expected is a delay until" do
+      it "returns message" do
+        expect(delay_until_subject.negative_failure_message).to eq "expected Object.nil? to not be delayed until #{Time.now + 3600}"
+      end
+    end
+
+    context "when expected is a delay until with arguments" do
+      it "returns message" do
+        expect(delay_until_with_arguments_subject.negative_failure_message).to eq "expected Object.is_a? to not be delayed until #{Time.now + 3600} with arguments [Object]"
+      end
+    end
+  end
+end