rspec-activejob 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c1648df6c71008bec37d636f453239f8b32528
-  data.tar.gz: 7007b7ad633537d0a2e7d2e0e6842db92babf40b
+  metadata.gz: 67fc94e6b07a0f9566fa7fc4687563affa38629a
+  data.tar.gz: 5650bb54c6add28bd7b7ae830e3fec9d2a7ae925
 SHA512:
-  metadata.gz: 752a896cd5bb286546514d5d96f2277877e98238a6979f4540c8787be59b6ea3ce7476b2c8df4d16ece2086c3cf53cf21d301972e74a19418c91042e5018423a
-  data.tar.gz: 8a8712194227772f71ebc15be8a82bf33356333949b64930b3572088920202884d3423eb3e75e55ef989e1fb248c2e3cbb833079961cef28e5df92bad1999fa2
+  metadata.gz: 32f2e4850d9ce2f45f6639d1a656a4045f91d1158a1a822b3686ed588e4219c491489fc27900bd0dff99e02dfa0dd83bd6299ff18757d7172af0a3c14a81d03b
+  data.tar.gz: 50c75b3434f3033d92129f09e99d2b09346c45444f33348f97a816a00303ee8f6a2b3fa430e86523fd8ad4fea0acc73b811fd871e1fa5e7c3204350968b79e3f

data/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 # Limit lines to 90 characters.
 LineLength:
   Max: 90

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9
+  - jruby-19mode
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.0 - September 16, 2015
+
+- Add `to_run_at` modifier - patch by [@vidmantas](https://github.com/vidmantas)
+
 ## 0.4.2 - August 19, 2015
 
 - Improve `failure_message_negated` - patch by [@swastik](https://github.com/swastik)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-activejob (0.4.2)
+    rspec-activejob (0.5.0)
       activejob (>= 4.2)
       rspec-mocks
 
@@ -17,6 +17,9 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     coderay (1.1.0)
     diff-lcs (1.2.5)
     globalid (0.3.3)
@@ -25,10 +28,14 @@ GEM
     json (1.8.2)
     method_source (0.8.2)
     minitest (5.5.1)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    rainbow (2.0.0)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -45,6 +52,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    rubocop (0.34.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
     slop (3.6.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
@@ -59,6 +73,7 @@ DEPENDENCIES
   rspec
   rspec-activejob!
   rspec-its
+  rubocop
 
 BUNDLED WITH
    1.10.6

data/README.md

@@ -1,4 +1,5 @@
-# Instalation
+![TravisCI status](https://travis-ci.org/gocardless/rspec-activejob.svg?branch=master)
+# Installation
 
 ```gem install rspec-activejob ```
 
@@ -39,7 +40,7 @@ RSpec.describe MyController do
   subject(:make_request) { described_class.make_request(params) }
 
   specify { expect { make_request }.to enqueue_a(RequestMaker).with(global_id(user)) }
-  
+
   # or
   make_request
   expect(RequestMaker).to have_been_enqueued.with(global_id(user))
@@ -48,7 +49,7 @@ end
 
 rspec-activejob expects the current queue adapter to expose an array of `enqueued_jobs`, like the included
 test adapter. The test adapter included in ActiveJob 4.2.0 does not fully serialize its arguments, so you
-will not need to use the GlobalID matcher unless you're using ActiveJob 4.2.1. See rails/rails#18266 for 
+will not need to use the GlobalID matcher unless you're using ActiveJob 4.2.1. See rails/rails#18266 for
 the improved test adapter.
 
 This gem defines four matchers:
@@ -56,6 +57,7 @@ This gem defines four matchers:
 * `enqueue_a`: for a block or proc, expects that to enqueue an job to the ActiveJob test adapter. Optionally
   takes the job class as its argument, and can be modified with a `.with(*args)` call to expect specific arguments.
   This will use the same argument list matcher as rspec-mocks' `receive(:message).with(*args)` matcher.
+  If your job uses `set(wait_until: time)`, you can use `.to_run_at(time)` chain after `enqueue_a` call as well.
 
 * `have_been_enqueued`: expects to have enqueued an job in the ActiveJob test adapter. Can be modified with a `.with(*args)` call to expect specific arguments. This will use the same argument list matcher as rspec-mocks' `receive(:message).with(*args)` matcher.
 

data/lib/rspec/active_job.rb

@@ -8,9 +8,11 @@ module RSpec
       Matchers::EnqueueA.new(job_class)
     end
 
+    # rubocop:disable Style/PredicateName
     def have_been_enqueued
       Matchers::EnqueueA.new
     end
+    # rubocop:enable Style/PredicateName
 
     def global_id(expected)
       Matchers::GlobalID.new(expected)

data/lib/rspec/active_job/enqueue_a.rb

@@ -14,11 +14,11 @@ module RSpec
           if actual.is_a?(Proc)
             @before_jobs = enqueued_jobs.dup
             actual.call
-            enqueued_something? && enqueued_correct_class? && with_correct_args?
+            all_checks_pass?
           else
             @job_class = actual
             @before_jobs = []
-            enqueued_something? && enqueued_correct_class? && with_correct_args?
+            all_checks_pass?
           end
         end
 
@@ -27,19 +27,16 @@ module RSpec
           self
         end
 
-        def failure_message
-          unless enqueued_something?
-            return "expected to enqueue a #{job_class || 'job'}, enqueued nothing"
-          end
-
-          unless enqueued_correct_class?
-            return "expected to enqueue a #{job_class}, " \
-                   "enqueued a #{enqueued_jobs.last[:job]}"
-          end
+        def to_run_at(time)
+          @run_time = time.to_f
+          self
+        end
 
-          "expected to enqueue a #{job_class} with " \
-          "#{argument_list_matcher.expected_args}, but enqueued with " \
-          "#{new_jobs_with_correct_class.first[:args]}"
+        def failure_message
+          enqueued_nothing_message ||
+            enqueued_wrong_class_message ||
+            enqueued_at_wrong_time_message ||
+            wrong_arguments_message
         end
 
         def failure_message_when_negated
@@ -69,7 +66,15 @@ module RSpec
 
         private
 
-        attr_reader :before_count, :after_count, :job_class, :argument_list_matcher
+        attr_reader :before_count, :after_count, :job_class, :argument_list_matcher,
+                    :run_time
+
+        def all_checks_pass?
+          enqueued_something? &&
+            enqueued_correct_class? &&
+            with_correct_args? &&
+            at_correct_time?
+        end
 
         def enqueued_something?
           new_jobs.any?
@@ -85,6 +90,29 @@ module RSpec
           new_jobs_with_correct_class_and_args.any?
         end
 
+        def enqueued_nothing_message
+          return if enqueued_something?
+          "expected to enqueue a #{job_class || 'job'}, enqueued nothing"
+        end
+
+        def enqueued_wrong_class_message
+          return if enqueued_correct_class?
+          "expected to enqueue a #{job_class}, enqueued a " \
+            "#{enqueued_jobs.last[:job]}"
+        end
+
+        def enqueued_at_wrong_time_message
+          return if at_correct_time?
+          "expected to run job at #{Time.at(run_time).utc}, but enqueued to " \
+            "run at #{format_enqueued_times}"
+        end
+
+        def wrong_arguments_message
+          "expected to enqueue a #{job_class} with " \
+          "#{argument_list_matcher.expected_args}, but enqueued with " \
+          "#{new_jobs_with_correct_class.first[:args]}"
+        end
+
         def new_jobs
           enqueued_jobs - @before_jobs
         end
@@ -101,6 +129,16 @@ module RSpec
         def enqueued_jobs
           ::ActiveJob::Base.queue_adapter.enqueued_jobs
         end
+
+        def at_correct_time?
+          return true unless run_time
+
+          !new_jobs_with_correct_class.find { |job| job[:at] == run_time }.nil?
+        end
+
+        def format_enqueued_times
+          new_jobs_with_correct_class.map { |job| Time.at(job[:at]).utc.to_s }.join(', ')
+        end
       end
     end
   end

data/lib/rspec/active_job/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module ActiveJob
-    VERSION = '0.4.2'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/rspec-activejob.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rspec')
   s.add_development_dependency('rspec-its')
   s.add_development_dependency('activesupport')
+  s.add_development_dependency('rubocop')
 end

data/spec/rspec/active_job/enqueue_a_spec.rb

@@ -148,4 +148,31 @@ RSpec.describe RSpec::ActiveJob::Matchers::EnqueueA do
       end
     end
   end
+
+  context "with run time expectations" do
+    let(:instance) { described_class.new }
+    let(:run_time) { Time.parse('2015-09-10 00:00:00 UTC').to_f }
+    subject(:matches?) { instance.to_run_at(run_time).matches?(AJob) }
+
+    let(:enqueued_jobs) do
+      [{ job: AJob, args: [], at: time }]
+    end
+
+    context "correct time" do
+      let(:time) { run_time }
+      it { is_expected.to be(true) }
+    end
+
+    context "wrong time" do
+      let(:time) { run_time + 1 }
+      it { is_expected.to be(false) }
+
+      specify do
+        matches?
+        expect(instance.failure_message).
+          to eq("expected to run job at 2015-09-10 00:00:00 UTC, " \
+            "but enqueued to run at 2015-09-10 00:00:01 UTC")
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-activejob
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       RSpec matchers for ActiveJob:
       * expect { method }.to enqueue_a(MyJob).with(global_id(some_model),
@@ -92,7 +106,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock

data/.rubocop_todo.yml

@@ -1,23 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-05-05 20:58:29 +0100 using RuboCop version 0.27.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 16
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 8
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 9
-
-# Offense count: 1
-# Configuration parameters: NamePrefix, NamePrefixBlacklist.
-Style/PredicateName:
-  Enabled: false