rspec-activejob 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8206ef4115ccb0283a36013a2b2bc43d73c3285
+  data.tar.gz: d001cf73f04e980b58d725a593807f4b80f826aa
+SHA512:
+  metadata.gz: 2aba60f994f30bdaa7099c0388674642961a98ff04da4caee1c801ce2f3846710a5be7b78e96b190ef6c4763256a69a4c96c4303c67f06b41e48e840d6e76181
+  data.tar.gz: c65123947482b545cc68c4cadfa8844afd219631231f087f859a98f914bcbca8515f107cee91c5d0c0350b8a4c2a75fa5565090ae1d5e90a10c3990a95148175

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    rspec-activejob (0.0.1)
+      activejob (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    globalid (0.3.0)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    method_source (0.8.2)
+    minitest (5.5.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-its (1.1.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec
+  rspec-activejob!
+  rspec-its

data/README.md

@@ -0,0 +1,15 @@
+# RSpec ActiveJob matchers
+
+```ruby
+RSpec.configure do |config|
+  config.include(RSpec::ActiveJob)
+end
+
+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) }
+end
+```

data/lib/rspec/active_job.rb

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

data/lib/rspec/active_job/matchers.rb

@@ -0,0 +1,75 @@
+module RSpec
+  module ActiveJob
+    module Matchers
+      class EnqueueA
+        def initialize(job_class = nil)
+          @job_class = job_class
+        end
+
+        def matches?(block)
+          @before_jobs = enqueued_jobs.dup
+          block.call
+          enqueued_something? && enqueued_correct_class? && with_correct_args?
+        end
+
+        def with(*args)
+          raise "Must specify the job class when specifying arguments" unless job_class
+
+          @expected_args = args
+          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
+
+          "expected to enqueue a #{job_class} with #{expected_args}, but enqueued with " \
+          "#{new_jobs_with_correct_class.first[:args]}"
+        end
+
+        def supports_block_expectations?
+          true
+        end
+
+        private
+
+        attr_reader :before_count, :after_count, :job_class, :expected_args
+
+        def enqueued_something?
+          new_jobs.any?
+        end
+
+        def enqueued_correct_class?
+          return true unless job_class
+          new_jobs_with_correct_class.any?
+        end
+
+        def with_correct_args?
+          return true unless expected_args
+          new_jobs_with_correct_class_and_args.any?
+        end
+
+        def new_jobs
+          enqueued_jobs - @before_jobs
+        end
+
+        def new_jobs_with_correct_class
+          new_jobs.select { |job| job[:job] == job_class }
+        end
+
+        def new_jobs_with_correct_class_and_args
+          new_jobs_with_correct_class.select { |job| job[:args] == expected_args }
+        end
+
+        def enqueued_jobs
+          ::ActiveJob::Base.queue_adapter.enqueued_jobs
+        end
+      end
+    end
+  end
+end

data/lib/rspec/active_job/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module ActiveJob
+    VERSION = '0.0.1'.freeze
+  end
+end

data/rspec-activejob.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/rspec/active_job/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'rspec-activejob'
+  s.version = RSpec::ActiveJob::VERSION
+  s.date = Date.today.strftime('%Y-%m-%d')
+  s.authors = ['Isaac Seymour']
+  s.email = ['isaac@isaacseymour.co.uk']
+  s.summary = 'RSpec matchers to test ActiveJob'
+  s.description = <<-EOL
+    RSpec matchers for ActiveJob:
+    * expect { method }.to enqueue_a(MyJob).with('some', 'arguments')
+  EOL
+  s.homepage = 'http://github.com/gocardless/rspec-activejob'
+  s.license = 'MIT'
+
+  s.has_rdoc = false
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = %w(lib)
+
+  s.add_runtime_dependency('activejob', '>= 4.2')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec-its')
+end

data/spec/rspec/active_job/matchers_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+RSpec.describe RSpec::ActiveJob::Matchers::EnqueueA do
+  class AJob; end
+  class BJob; end
+  let(:enqueued_jobs) { [] }
+  before do
+    allow(::ActiveJob::Base).
+      to receive(:queue_adapter).and_return(double(enqueued_jobs: enqueued_jobs))
+  end
+
+  let(:job_class) { nil }
+  let(:instance) { described_class.new(job_class) }
+  subject(:matches?) { instance.matches?(proc) }
+
+  context "when nothing gets enqueued" do
+    let(:proc) { -> {} }
+    it { is_expected.to be(false) }
+    specify do
+      matches?
+      expect(instance.failure_message).
+        to eq("expected to enqueue a job, enqueued nothing")
+    end
+  end
+
+  context "when something gets enqueued" do
+    let(:proc) { -> { enqueued_jobs << { job: AJob, args: [] } } }
+
+    it { is_expected.to be(true) }
+
+    context "when it enqueues the wrong job" do
+      let(:job_class) { BJob }
+
+      it { is_expected.to be(false) }
+      specify do
+        matches?
+        expect(instance.failure_message).
+          to eq("expected to enqueue a BJob, enqueued a AJob")
+      end
+    end
+
+    context "when it enqueues two jobs" do
+      let(:proc) do
+        -> { enqueued_jobs << { job: AJob, args: []} << { job: BJob, args: [] } }
+      end
+
+      it { is_expected.to be(true) }
+    end
+  end
+
+  context "with argument expectations" do
+    let(:job_class) { AJob }
+    let(:instance) { described_class.new(job_class).with(*arguments) }
+    let(:arguments) { ['thing', 'other_thing'] }
+
+    let(:proc) { -> { enqueued_jobs << { job: AJob, args: arguments } } }
+
+    it { is_expected.to be(true) }
+
+    context "with mismatching arguments" do
+      let(:proc) { -> { enqueued_jobs << { job: AJob, args: [] } } }
+
+      it { is_expected.to be(false) }
+      specify do
+        matches?
+        expect(instance.failure_message).
+          to eq("expected to enqueue a AJob with #{arguments}, but enqueued with []")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rspec/active_job'
+require 'pry'
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = :random
+  config.disable_monkey_patching!
+end
+
+module ActiveJob
+  class Base
+    def self.queue_adapter
+      Struct.new(:enqueued_jobs).new(enqueued_jobs: [])
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rspec-activejob
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Isaac Seymour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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('some', 'arguments')
+email:
+- isaac@isaacseymour.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/rspec/active_job.rb
+- lib/rspec/active_job/matchers.rb
+- lib/rspec/active_job/version.rb
+- rspec-activejob.gemspec
+- spec/rspec/active_job/matchers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gocardless/rspec-activejob
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: RSpec matchers to test ActiveJob
+test_files: []
+has_rdoc: false