rspec-activejob 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f57742790063ccf2ed6cd10e683e20389dbac437
-  data.tar.gz: 231a686b90f41591f5ad437e8beaec9421ae8144
+  metadata.gz: 5ec1b26448aaa3732cc1239e94ed67be18fdd034
+  data.tar.gz: 53d956546e042ad727cc3d02094c5fb9851c24ff
 SHA512:
-  metadata.gz: b95a86346e700b872030feb2d8046e9bfd6c33f9419709186caaee85a49807f72dc51a4e641e13e308fc740053731278b3fb4dc70f278824b44e01276137b8c6
-  data.tar.gz: 38fedfe32066a157dd1b8b5e77edc9221889acbadf4a81fdaf14309cb58e08bfaa5efad2ec8044afeb2f051764ba7587e2376e67dd8c47a69cea51a3b4d6ef0d
+  metadata.gz: 7dbbdb3029c97cb2c71fe0b57d112fece98190849934e26e861e01cb4f2f9a427921fa541cba527589f341f06a1a5629a7a5afd9fddceb7f59d06ec56fabfddf
+  data.tar.gz: ded3be79382e60bf7fa9c590da4f34a0732ff660c51236cba33153aae22da379b3144bcd7a8cf8b4f4193dc24b47e35fca75a920bde1eebdaae8396719a61ee2

data/.rubocop.yml

@@ -0,0 +1,33 @@
+# Limit lines to 90 characters.
+LineLength:
+  Max: 90
+
+ClassLength:
+  Enabled: false
+
+# Avoid single-line methods.
+SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+StringLiterals:
+  Enabled: false
+
+# Wants you to use the same argument names for every reduce. This seems kinda
+# naff compared to naming them semantically
+SingleLineBlockParams:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: 'only_raise'
+
+# Use trailing rather than leading dots on multi-line call chains
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Whatever
+Style/Documentation:
+  Enabled: false
+
+# RSpec argument matchers use ===. Sorry cop.
+Style/CaseEquality:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 - January 18, 2015
+
+- Added support for argument matchers (e.g. `instance_of`, `hash_including`), like the `receive` matcher.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-activejob (0.1.0)
+    rspec-activejob (0.2.0)
       activejob (>= 4.2)
       rspec-mocks
 

data/README.md

@@ -1,15 +1,48 @@
 # RSpec ActiveJob matchers
 
 ```ruby
+# config/environments/test.rb
+config.active_job.queue_adapter = :test
+
+# spec/spec_helper.rb
 RSpec.configure do |config|
   config.include(RSpec::ActiveJob)
+
+  # clean out the queue after each spec
+  config.after(:each) do
+    ActiveJob::Base.queue_adapter.enqueued_jobs = []
+    ActiveJob::Base.queue_adapter.performed_jobs = []
+  end
 end
 
+# spec/controllers/my_controller_spec.rb
 RSpec.describe MyController do
   let(:user) { create(:user) }
   let(:params) { { user_id: user.id } }
   subject(:make_request) { described_class.make_request(params) }
 
-  specify { expect { make_request }.to enqueue_a(RequestMaker).with(user) }
+  specify { expect { make_request }.to enqueue_a(RequestMaker).with(global_id(user)) }
 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 until ActiveJob 4.2.1. See rails/rails#18266 for the improved
+test adapter.
+
+This gem defines two 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.
+
+* `global_id(model_or_class)`: an argument matcher, matching ActiveJob-serialized versions of model classes or
+  specific models (or any other class which implements `to_global_id`). If you pass a model class, it will match
+  the serialized version of any instance of that model; if you pass an instance, it will expect the serialized
+  version of that specific instance.
+
+
+With the `global_id` matcher it's important to note that it's specific to ActiveJob-serialized GlobalIDs.
+ActiveJob serializes them as a hash like `{ '_aj_global_id' => 'gid://my-app/MyModel/ID123' }`, to avoid
+clashes with plain strings which accidentally match the GlobalID syntax. This matcher will not work with
+other usages of GlobalID.

data/lib/rspec/active_job.rb

@@ -1,8 +1,14 @@
-require 'rspec/active_job/matchers'
+require 'rspec/active_job/enqueue_a'
+require 'rspec/active_job/global_id'
+
 module RSpec
   module ActiveJob
     def enqueue_a(job_class)
       Matchers::EnqueueA.new(job_class)
     end
+
+    def global_id(expected)
+      Matchers::GlobalID.new(expected)
+    end
   end
 end

data/lib/rspec/active_job/{matchers.rb → enqueue_a.rb}

@@ -27,10 +27,12 @@ module RSpec
           end
 
           unless enqueued_correct_class?
-            return "expected to enqueue a #{job_class}, enqueued a #{enqueued_jobs.last[:job]}"
+            return "expected to enqueue a #{job_class}, " \
+                   "enqueued a #{enqueued_jobs.last[:job]}"
           end
 
-          "expected to enqueue a #{job_class} with #{argument_list_matcher.expected_args}, but enqueued with " \
+          "expected to enqueue a #{job_class} with " \
+          "#{argument_list_matcher.expected_args}, but enqueued with " \
           "#{new_jobs_with_correct_class.first[:args]}"
         end
 
@@ -38,6 +40,12 @@ module RSpec
           true
         end
 
+        def description
+          return "enqueue a job" unless job_class
+          return "enqueue a #{job_class.name}" unless argument_list_matcher
+          "enqueue a #{job_class.name} with #{argument_list_matcher.expected_args}"
+        end
+
         private
 
         attr_reader :before_count, :after_count, :job_class, :argument_list_matcher
@@ -65,7 +73,8 @@ module RSpec
         end
 
         def new_jobs_with_correct_class_and_args
-          new_jobs_with_correct_class.select { |job| argument_list_matcher.args_match?(*job[:args]) }
+          new_jobs_with_correct_class.
+            select { |job| argument_list_matcher.args_match?(*job[:args]) }
         end
 
         def enqueued_jobs

data/lib/rspec/active_job/global_id.rb

@@ -0,0 +1,47 @@
+require 'global_id'
+
+module RSpec
+  module ActiveJob
+    module Matchers
+      class GlobalID
+        def initialize(expected)
+          unless valid_expected?(expected)
+            raise "expected argument must implement to_global_id"
+          end
+
+          @expected = expected
+        end
+
+        def ===(other)
+          other.is_a?(Hash) &&
+            other.keys == ['_aj_globalid'] &&
+            global_id_matches?(other['_aj_globalid'])
+        end
+
+        def description
+          "serialized global ID of #{@expected}" unless @expected.is_a?(Class)
+          "serialized global ID of #{@expected.name}"
+        end
+
+        private
+
+        def valid_expected?(expected)
+          return expected.instance_method(:to_global_id) if expected.is_a?(Class)
+          expected.respond_to?(:to_global_id)
+        end
+
+        def global_id_matches?(other)
+          parsed = ::GlobalID.parse(other)
+          return false unless parsed
+          return correct_class?(parsed) if @expected.is_a?(Class)
+          other == @expected.to_global_id.to_s
+        end
+
+        def correct_class?(other)
+          other.app == ::GlobalID.app &&
+            other.model_class == @expected
+        end
+      end
+    end
+  end
+end

data/lib/rspec/active_job/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module ActiveJob
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spec/rspec/active_job/{matchers_spec.rb → enqueue_a_spec.rb}

@@ -41,7 +41,7 @@ RSpec.describe RSpec::ActiveJob::Matchers::EnqueueA do
 
     context "when it enqueues two jobs" do
       let(:proc) do
-        -> { enqueued_jobs << { job: AJob, args: []} << { job: BJob, args: [] } }
+        -> { enqueued_jobs << { job: AJob, args: [] } << { job: BJob, args: [] } }
       end
 
       it { is_expected.to be(true) }
@@ -70,4 +70,4 @@ RSpec.describe RSpec::ActiveJob::Matchers::EnqueueA do
       end
     end
   end
-end
+end

data/spec/rspec/active_job/global_id_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+RSpec.describe RSpec::ActiveJob::Matchers::GlobalID do
+  class MyModel
+    def to_global_id
+      "gid://my-app/MyModel/ID123"
+    end
+  end
+
+  let(:instance) { described_class.new(expected) }
+  subject(:matches?) { instance === actual }
+
+  before { GlobalID.app = 'my-app' }
+
+  context "expecting a class" do
+    let(:expected) { MyModel }
+
+    context "serialized model" do
+      let(:actual) { { '_aj_globalid' => 'gid://my-app/MyModel/ID123' } }
+      it { is_expected.to be(true) }
+    end
+
+    context "actual model" do
+      let(:actual) { MyModel.new }
+      it { is_expected.to be(false) }
+    end
+
+    context "model class" do
+      let(:actual) { MyModel }
+      it { is_expected.to be(false) }
+    end
+
+    context "hash with extra stuff" do
+      let(:actual) do
+        { '_aj_globalid' => 'gid://my-app/MyModel/ID123', 'other' => 'stuff' }
+      end
+      it { is_expected.to be(false) }
+    end
+
+    context "invalid GlobalID" do
+      let(:actual) { { '_aj_globalid' => 'not://a/global/id' } }
+      it { is_expected.to be(false) }
+    end
+
+    context "nil" do
+      let(:actual) { nil }
+      it { is_expected.to be(false) }
+    end
+  end
+
+  context "expecting a specific instance" do
+    let(:expected) { MyModel.new }
+
+    context "serialized instance" do
+      let(:actual) { { '_aj_globalid' => 'gid://my-app/MyModel/ID123' } }
+      it { is_expected.to be(true) }
+    end
+
+    context "model class" do
+      let(:actual) { MyModel }
+      it { is_expected.to be(false) }
+    end
+
+    context "instance itself" do
+      let(:actual) { expected }
+      it { is_expected.to be(false) }
+    end
+
+    context "hash with extra stuff" do
+      let(:actual) do
+        { '_aj_globalid' => 'gid://my-app/MyModel/ID123', 'other' => 'stuff' }
+      end
+      it { is_expected.to be(false) }
+    end
+
+    context "mismatching app" do
+      let(:actual) { { '_aj_globalid' => 'gid://other-app/MyModel/ID123' } }
+      it { is_expected.to be(false) }
+    end
+
+    context "mismatching model" do
+      let(:actual) { { '_aj_globalid' => 'gid://my-app/OtherModel/ID123' } }
+      it { is_expected.to be(false) }
+    end
+
+    context "mismatching ID" do
+      let(:actual) { { '_aj_globalid' => 'gid://my-app/MyModel/ID456' } }
+      it { is_expected.to be(false) }
+    end
+  end
+
+  context "expecting a non-gid instance" do
+    let(:expected) { Object.new }
+    specify { expect { matches? }.to raise_error }
+  end
+
+  context "expecting a non-gid class" do
+    let(:expected) { Object }
+    specify { expect { matches? }.to raise_error }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-activejob
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Isaac Seymour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -76,14 +76,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - lib/rspec/active_job.rb
-- lib/rspec/active_job/matchers.rb
+- lib/rspec/active_job/enqueue_a.rb
+- lib/rspec/active_job/global_id.rb
 - lib/rspec/active_job/version.rb
 - rspec-activejob.gemspec
-- spec/rspec/active_job/matchers_spec.rb
+- spec/rspec/active_job/enqueue_a_spec.rb
+- spec/rspec/active_job/global_id_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/gocardless/rspec-activejob
 licenses: