rspec-que 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c87929df7a2ab03510e1653ccb1ba7fa9ff111a2
+  data.tar.gz: 287d5af413397c3b36ee0f829bdedcef80516680
+SHA512:
+  metadata.gz: 1dc9f76fa67c0d436178467558280eb4f8341022519e57a78f37aec92d15e8be246bc0c949205f89e22706d399466fe18cd6cc00dc94a6890cbec88276acb35a
+  data.tar.gz: b5d2acb3261a82ed8883d4318c97578fe39f45ae7df048250c24d881578239f816f613044a83f8fa233ab5b7a80e9254aeb8cc14ecfea5d1ea86ad0363549020

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015-2016 GOCARDLESS LTD
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# RSpec Que matchers
+
+This gem defines a matcher for checking that Que jobs have been enqueued,
+in the style of [rspec-activejob](https://github.com/gocardless/rspec-activejob).
+
+## Usage
+The matcher expects a block of code, and will expect that code to enqueue a job
+in Que. The matcher can take a class for the job as its arguments. It can also
+expect the job to be queued with arguments via `.with(arg1, arg2)` or at a
+specific time via `.at(time)`.
+
+If the matcher does not match, it will display informations about jobs queued
+at the last stage of the matcher which did match. (For instance, if you specify
+a job class, arguments, and a time, the matcher will display information about
+jobs of the right class and arguments but at the wrong time.)
+
+```ruby
+# spec/spec_helper.rb
+require 'rspec/que'
+
+RSpec.configure do |config|
+  config.include(RSpec::Que)
+
+  # clean out the queue after each spec
+  config.after(:each) do
+    RSpec::Que.purge_jobs
+  end
+end
+
+# spec/controllers/my_controller_spec.rb
+RSpec.describe MyController do
+  let(:user) { create(:user) }
+  let(:params) { { user_id: user.id } }
+  let(:later_time) { DateTime.parse("2038-01-01T01:02:03+00:00").utc }
+  subject(:make_request) { described_class.make_request(params) }
+
+  specify { expect { make_request }.to queue_up(RequestMaker).with(user) }
+  specify { expect { make_request }.to queue_up(DelayedRequest).at(later_time) }
+end
+```
+
+## Development
+
+Setup:
+``` shell
+bundle install
+```
+
+Run tests:
+
+``` shell
+bundle exec rake
+
+```

data/lib/rspec/que.rb

@@ -0,0 +1,13 @@
+require 'rspec/que/queue_up'
+
+module RSpec
+  module Que
+    def queue_up(job_class)
+      Matchers::QueueUp.new(job_class)
+    end
+
+    def purge_jobs
+      ::Que.execute "DELETE FROM que_jobs"
+    end
+  end
+end

data/lib/rspec/que/queue_up.rb

@@ -0,0 +1,168 @@
+require 'rspec/mocks/argument_list_matcher'
+require 'time'
+
+module RSpec
+  module Que
+    module Matchers
+      class QueueUp
+        include RSpec::Matchers::Composable
+
+        def initialize(job_class = nil)
+          @matchers = [QueuedSomething.new]
+          @matchers << QueuedClass.new(job_class) if job_class
+          @job_class = job_class
+          @stages = []
+        end
+
+        def matches?(block)
+          before_jobs = enqueued_jobs.dup
+          block.call
+
+          @matched_jobs = enqueued_jobs - before_jobs
+          @matchers.each do |matcher|
+            @stages << { matcher: matcher, candidates: @matched_jobs.dup }
+            @matched_jobs.delete_if { |job| !matcher.matches?(job) }
+          end
+          @matched_jobs.any?
+        end
+
+        def with(*args)
+          @matchers << QueuedArgs.new(args)
+          self
+        end
+
+        def at(the_time)
+          matcher = QueuedAt.new(the_time)
+          @matchers << matcher
+          self
+        end
+
+        def failure_message
+          # last stage to have any candidate jobs
+          failed_stage = @stages.reject do |s|
+            s[:candidates].empty?
+          end.last || @stages.first
+          failed_matcher = failed_stage[:matcher]
+          failed_candidates = failed_stage[:candidates]
+          found_instead = failed_matcher.failed_msg(failed_candidates)
+
+          "expected to enqueue #{job_description}, but found #{found_instead}"
+        end
+
+        def failure_message_when_negated
+          format "expected not to enqueue #{job_description}, got %d enqueued: %s",
+                 @matched_jobs.length,
+                 @matched_jobs.map { |j| format_job(j) }.join(", ")
+        end
+
+        def supports_block_expectations?
+          true
+        end
+
+        def description
+          "queues up a #{job_description}"
+        end
+
+        private
+
+        attr_reader :before_count, :after_count, :job_class, :argument_list_matcher
+
+        def enqueued_jobs
+          ::Que.execute "SELECT * FROM que_jobs"
+        end
+
+        def job_description
+          @matchers.map(&:desc).join(" ")
+        end
+
+        def format_job(job)
+          "#{job[:job_class]}[" + job[:args].join(", ") + "]"
+        end
+
+        class QueuedSomething
+          def matches?(_job)
+            true
+          end
+
+          def desc
+            "a job"
+          end
+
+          def failed_msg(_last_found)
+            "nothing"
+          end
+        end
+
+        class QueuedClass
+          attr_reader :job_class
+          def initialize(job_class)
+            @job_class = job_class
+          end
+
+          def matches?(job)
+            job[:job_class] == job_class.to_s
+          end
+
+          def desc
+            "of class #{job_class}"
+          end
+
+          def failed_msg(candidates)
+            classes = candidates.map { |c| c[:job_class] }
+            if classes.length == 1
+              classes.first
+            else
+              "#{classes.length} jobs of class [#{classes.join(', ')}]"
+            end
+          end
+        end
+
+        class QueuedArgs
+          def initialize(args)
+            @args = args
+            @argument_list_matcher = RSpec::Mocks::ArgumentListMatcher.new(*args)
+          end
+
+          def matches?(job)
+            @argument_list_matcher.args_match?(*job[:args])
+          end
+
+          def desc
+            "with args #{@args}"
+          end
+
+          def failed_msg(candidates)
+            if candidates.length == 1
+              "job enqueued with #{candidates.first[:args]}"
+            else
+              "#{candidates.length} jobs with args: " +
+                candidates.map { |j| j[:args] }.to_s
+            end
+          end
+        end
+
+        class QueuedAt
+          def initialize(the_time)
+            @time = the_time
+          end
+
+          def matches?(job)
+            job[:run_at] == @time
+          end
+
+          def desc
+            "at #{@time}"
+          end
+
+          def failed_msg(candidates)
+            if candidates.length == 1
+              "job at #{candidates.first[:run_at]}"
+            else
+              "jobs at #{candidates.map { |c| c[:run_at] }}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/que/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Que
+    VERSION = '1.0.2'.freeze
+  end
+end

data/rspec-que.gemspec

@@ -0,0 +1,27 @@
+require File.expand_path('../lib/rspec/que/version', __FILE__)
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = 'rspec-que'
+  s.version = RSpec::Que::VERSION
+  s.date = Date.today.strftime('%Y-%m-%d')
+  s.authors = ['GoCardless Engineering']
+  s.email = ['developers@gocardless.com']
+  s.summary = 'RSpec matchers to test Que'
+  s.description = <<-EOL
+    RSpec matchers for Que:
+    * expect { method }.to queue_up(MyJob).with(some_arguments)
+  EOL
+  s.homepage = 'http://github.com/gocardless/rspec-que'
+  s.license = 'MIT'
+
+  s.has_rdoc = false
+  s.files = `git ls-files lib README.md LICENSE *.gemspec -z`.split("\x0")
+  s.require_paths = %w(lib)
+
+  s.add_runtime_dependency('rspec-mocks')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec-its')
+  s.add_development_dependency('rubocop')
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rspec-que
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- GoCardless Engineering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !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 Que:
+      * expect { method }.to queue_up(MyJob).with(some_arguments)
+email:
+- developers@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rspec/que.rb
+- lib/rspec/que/queue_up.rb
+- lib/rspec/que/version.rb
+- rspec-que.gemspec
+homepage: http://github.com/gocardless/rspec-que
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: RSpec matchers to test Que
+test_files: []