activejob_spec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f672c901cf70f80191d1393ef34d10398b5308f
+  data.tar.gz: f9c9b95e2093fd255e72989e971c1c7cc5c3a374
+SHA512:
+  metadata.gz: 3722c62dc3832e81034d0ecd893a0824dc7ba4ab05af54891f2d59c0f5d48a81c7225643cbd52135607ba27d1ba2c28307962c685abe85f8262c3931d15feb42
+  data.tar.gz: 2b8e4d554a1cb5acf1b6db08e9d270b92212c495b3f2f639db8abb796646b64a2d73264c0a28ca1673fd244cead2b956f456e1003f9f5045d481e49a52c35e73

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activejob_spec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Peter Negrei
+
+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,151 @@
+# ActiveJobSpec
+
+A test double of ActiveJob for RSpec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activejob_spec'
+```
+
+or
+
+```ruby
+  group :development, :test do
+    gem 'activejob_spec'
+  end
+```
+
+## Usage
+
+Given this scenario
+
+    Given a payment
+    When I process
+    Then the payment has process queued
+
+And I write this spec using the `activejob_spec` matcher
+
+```ruby
+describe '#process' do
+  before do
+    ActiveJobSpec.reset!
+  end
+
+  it 'adds payment.process to the Payment queue' do
+    payment.process
+    expect(Payment).to have_queued(payment.id)
+
+    # also possible with :once and :times methods
+    # expect(Payment).to have_queued(payment.id).once
+  end
+end
+```
+
+And I see that the `have_queued` assertion is asserting that the `Payment` queue has a job with arguments `payment.id` and `:process`
+
+And I take note of the `before` block that is calling `reset!` for every spec.
+
+You can check the size of the queue in your specs too.
+
+```ruby
+describe '#process' do
+  before do
+    ActiveJobSpec.reset!
+  end
+
+  it 'adds an entry to the Payment queue' do
+    payment.process
+    expect(Payment).to have_queue_size_of(1)
+  end
+end
+```
+
+## Scheduled Jobs
+
+Given this scenario
+
+    Given a payment
+    When I schedule a process
+    Then the payment has process scheduled
+
+And I write this spec using the `activejob_spec` matcher
+
+```ruby
+describe '#process' do
+  before do
+    ActiveJobSpec.reset!
+  end
+
+  it 'adds payment.process to the Payment queue' do
+    payment.process
+
+    expect(Payment).to have_scheduled(payment.id)
+  end
+end
+```
+
+And I might use the `at` statement to specify the time:
+
+```ruby
+describe "#process" do
+  before do
+    ResqueSpec.reset!
+  end
+
+  it 'adds payment.process to the Payment queue' do
+    payment.process
+
+    # Is it scheduled to be executed at 2010-02-14 06:00:00 ?
+    expect(Payment).to have_scheduled(payment.id).at(Time.mktime(2010,2,14,6,0,0))
+  end
+end
+```
+
+And I might use the `in` statement to specify time interval (in seconds):
+
+```ruby
+describe '#process' do
+  before do
+    ResqueSpec.reset!
+  end
+
+  it 'adds payment.process to the Payment queue' do
+    payment.process
+
+    # Is it scheduled to be executed in 5 minutes?
+    expect(Payment).to have_scheduled(payment.id).in(5 * 60)
+  end
+end
+```
+
+You can also check the size of the schedule:
+
+```ruby
+describe "#process" do
+  before do
+    ResqueSpec.reset!
+  end
+
+  it "adds payment.calculate to the Payment queue" do
+    payment.process
+
+    expect(Payment).to have_schedule_size_of(1)
+  end
+end
+```
+
+(And I take note of the `before` block that is calling `reset!` for every spec)
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it.
+* Send a pull request.
+
+## License
+
+Copyright (c) 2015 Peter Negrei. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activejob_spec.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activejob_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob_spec"
+  spec.version       = ActiveJobSpec::VERSION
+  spec.authors       = ["Peter Negrei"]
+  spec.email         = ["negrei.petru@gmail.com"]
+
+  spec.summary       = %q{RSpec matcher for ActiveJob}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/noku/activejob_spec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_development_dependency 'actionpack'
+  spec.add_development_dependency 'activesupport'
+  spec.add_development_dependency 'pry'
+end

data/lib/activejob_spec.rb

@@ -0,0 +1,9 @@
+require "activejob_spec/version"
+require "activejob_spec/matchers"
+
+module ActiveJobSpec
+  def self.reset!
+    ActiveJob::Base.queue_adapter.enqueued_jobs = []
+    ActiveJob::Base.queue_adapter.performed_jobs = []
+  end
+end

data/lib/activejob_spec/matchers.rb

@@ -0,0 +1,183 @@
+require 'rspec/core'
+require 'rspec/expectations'
+require 'rspec/mocks'
+
+module ArgsHelper
+  def match_job(job, klass)
+    job.fetch(:job) == klass
+  end
+
+  def match_args(expected_args, args)
+    arg_list_matcher = RSpec::Mocks::ArgumentListMatcher.new(expected_args)
+    arg_list_matcher.args_match?(args)
+  end
+end
+
+module ActiveJobHelper
+  def enqueued_jobs
+    ::ActiveJob::Base.queue_adapter.enqueued_jobs
+  end
+end
+
+module QueueHelper
+  include ArgsHelper
+  include ActiveJobHelper
+
+  def find_matching_jobs(actual, expected_args)
+    enqueued_jobs.select do |entry|
+      match_job(entry, actual) && match_args(expected_args, entry.fetch(:args))
+    end
+  end
+
+  def queue_size_for(actual)
+    enqueued_jobs.select { |job| match_job(job, actual) }.size
+  end
+
+  def check_size_for(matched_jobs, times)
+    if times
+      matched_jobs.size == times
+    else
+      matched_jobs.size > 0
+    end
+  end
+end
+
+module ScheduleQueueHelper
+  include QueueHelper
+
+  def check_for_scheduled(actual, expected_args)
+    scheduled_jobs.any? do |entry|
+      class_matches = match_job(entry, actual)
+      args_match = match_args(expected_args, entry.fetch(:args))
+
+      class_matches && args_match && time_matches(entry)
+    end
+  end
+
+  def time_matches(entry)
+    return compare_time(entry) if @time
+    return compare_interval(entry) if @interval
+
+    true
+  end
+
+  def compare_time(entry)
+    entry[:at].to_i == @time.to_i
+  end
+
+  def compare_interval(entry)
+    entry[:at].to_i == (Time.now + @interval).to_i
+  end
+
+  def scheduled_jobs
+    enqueued_jobs.select { |job| job.key?(:at) }
+  end
+
+  def scheduled_size_for(actual)
+    scheduled_jobs.select { |job| match_job(job, actual) }.size
+  end
+end
+
+RSpec::Matchers.define :have_queued do |*expected_args|
+  include QueueHelper
+
+  chain :times do |num_times_queued|
+    @times = num_times_queued
+    @times_info = (@times == 1 ? ' once' : " #{@times} times")
+  end
+
+  chain :once do
+    @times = 1
+    @times_info = ' once'
+  end
+
+  match do |actual|
+    matched_jobs = find_matching_jobs(actual, expected_args)
+
+    check_size_for(matched_jobs, @times)
+  end
+
+  failure_message do |actual|
+    "expected that #{actual} would have [#{expected_args.join(', ')}] queued#{@times_info}"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected that #{actual} would not have [#{expected_args.join(', ')}] queued#{@times_info}"
+  end
+
+  description do
+    "have queued arguments of [#{expected_args.join(', ')}]#{@times_info}"
+  end
+end
+
+RSpec::Matchers.define :have_queue_size_of do |size|
+  include QueueHelper
+
+  match do |actual|
+    queue_size_for(actual) == size
+  end
+
+  failure_message do |actual|
+    "expected that #{actual} would have #{size} entries queued, but got #{queue_size_for(actual)} instead"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected that #{actual} would not have #{size} entries queued, but got #{queue_size_for(actual)} instead"
+  end
+
+  description do
+    "have a queue size of #{size}"
+  end
+end
+
+RSpec::Matchers.define :have_scheduled do |*expected_args|
+  include ScheduleQueueHelper
+
+  chain :at do |timestamp|
+    @interval = nil
+    @time = timestamp
+    @time_info = "at #{@time}"
+  end
+
+  chain :in do |interval|
+    @time = nil
+    @interval = interval
+    @time_info = "in #{@interval} seconds"
+  end
+
+  match do |actual|
+    check_for_scheduled(actual, expected_args)
+  end
+
+  failure_message do |actual|
+    ["expected that #{actual} would have [#{expected_args.join(', ')}] scheduled", @time_info].join(' ')
+  end
+
+  failure_message_when_negated do |actual|
+    ["expected that #{actual} would not have [#{expected_args.join(', ')}] scheduled", @time_info].join(' ')
+  end
+
+  description do
+    "have scheduled arguments"
+  end
+end
+
+RSpec::Matchers.define :have_schedule_size_of do |size|
+  include ScheduleQueueHelper
+
+  match do |actual|
+    scheduled_size_for(actual) == size
+  end
+
+  failure_message do |actual|
+    "expected that #{actual} would have #{size} entries scheduled, but got #{queue_size_for(actual)} instead"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected that #{actual} would not have #{size} entries scheduled, but got #{queue_size_for(actual)} instead"
+  end
+
+  description do
+    "have a scheduled queue size of #{size}"
+  end
+end

data/lib/activejob_spec/version.rb

@@ -0,0 +1,3 @@
+module ActiveJobSpec
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: activejob_spec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Negrei
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: actionpack
+  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: activesupport
+  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: pry
+  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: ''
+email:
+- negrei.petru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activejob_spec.gemspec
+- lib/activejob_spec.rb
+- lib/activejob_spec/matchers.rb
+- lib/activejob_spec/version.rb
+homepage: https://github.com/noku/activejob_spec
+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.8
+signing_key: 
+specification_version: 4
+summary: RSpec matcher for ActiveJob
+test_files: []