deliver_later_matchers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2390b8181ab6b828ce686ed4091ad2aec7ecec65
+  data.tar.gz: 740290eb55e57d069d58ba24058130667b7fdf80
+SHA512:
+  metadata.gz: d7ad3f6a8692b0997f08c4d714a3c6af1f1a9d12923ede18a0ebb0bd773ae9a5be528e29976993c2b871c31651c90cf9afda3fa9a85fe7566a298aa4d88919fe
+  data.tar.gz: 71af183e20ff4aed6687c71f443c3ae1b785ac2404918f997e9e94ccc5a4904c0a4c75148181190b5c6d820550b2e7e25d9bb8b742479376f28375482bb0e4d1

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/**/*.swp
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=70a915ebf6718702f018a3f04a7d02164380caaea3fe1093c227432dac6756af
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in deliver_later_matchers.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    deliver_later_matchers (0.1.0)
+      actionmailer (~> 5.0.0)
+      activejob (~> 5.0.0)
+      rspec-expectations (~> 3.0)
+      rspec-mocks (~> 3.0)
+      rspec-rails (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (5.0.6)
+      actionpack (= 5.0.6)
+      actionview (= 5.0.6)
+      activejob (= 5.0.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.6)
+      actionview (= 5.0.6)
+      activesupport (= 5.0.6)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.6)
+      activesupport (= 5.0.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.6)
+      activesupport (= 5.0.6)
+      globalid (>= 0.3.6)
+    activesupport (5.0.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    byebug (9.1.0)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    erubis (2.7.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.1)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.6)
+      actionpack (= 5.0.6)
+      activesupport (= 5.0.6)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 9.1.0)
+  deliver_later_matchers!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.15.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Joel Lubrano
+
+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,78 @@
+# DeliverLaterMatchers
+
+[![Build Status](https://travis-ci.org/jdlubrano/deliver_later_matchers.svg?branch=master)](https://travis-ci.org/jdlubrano/deliver_later_matchers)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d7f9f4691169769b1ac6/maintainability)](https://codeclimate.com/github/jdlubrano/deliver_later_matchers/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d7f9f4691169769b1ac6/test_coverage)](https://codeclimate.com/github/jdlubrano/deliver_later_matchers/test_coverage)
+
+RSpec matchers for testing that ActionMailer deliver_later is called for your
+email messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deliver_later_matchers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deliver_later_matchers
+
+## Usage
+Setup in `rails_helper.rb` or `spec_helper.rb`
+
+```ruby
+require 'deliver_later_matchers'
+
+RSpec.configure do |config|
+  config.include DeliverLaterMatchers
+end
+```
+
+Use the matchers in your tests
+
+```ruby
+user = User.create
+
+expect {
+  MyMailer.welcome(user).deliver_later
+}.to deliver_later(MyMailer, :welcome).with(user)
+
+# or
+
+user = User.create
+
+expect {
+  MyMailer.welcome(user).deliver_later
+}.to enqueue_email(MyMailer, :welcome).with(user)
+
+# or
+
+user = User.create
+
+expect {
+  MyMailer.welcome(user).deliver_later
+}.to have_enqueued_email(MyMailer, :welcome).with(user)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jdlubrano/deliver_later_matchers.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deliver_later_matchers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deliver_later_matchers.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deliver_later_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deliver_later_matchers'
+  spec.version       = DeliverLaterMatchers::VERSION
+  spec.authors       = ['Joel Lubrano']
+  spec.email         = ['joel.lubrano@gmail.com']
+
+  spec.summary       = 'RSpec matchers for testing that ActionMailers deliver_later'
+  spec.homepage      = 'https://github.com/jdlubrano/deliver_later_matchers'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionmailer', '~> 5.0.0'
+  spec.add_dependency 'activejob', '~> 5.0.0'
+  spec.add_dependency 'rspec-expectations', '~> 3.0'
+  spec.add_dependency 'rspec-mocks', '~> 3.0'
+  spec.add_dependency 'rspec-rails', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 9.1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15.1'
+end

data/lib/deliver_later_matchers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'deliver_later_matchers/version'
+require 'deliver_later_matchers/deliver_later'
+
+module DeliverLaterMatchers
+  extend RSpec::Matchers::DSL
+
+  matcher :deliver_later do |mailer_class, method_name|
+    matcher = DeliverLater.new(mailer_class, method_name)
+
+    match do |block|
+      matcher.matches?(block)
+    end
+
+    description do
+      matcher.description
+    end
+
+    chain :with do |*args|
+      matcher.with(*args)
+    end
+
+    failure_message do |block|
+      matcher.failure_message(block)
+    end
+
+    supports_block_expectations
+  end
+
+  RSpec::Matchers.alias_matcher :enqueue_email, :deliver_later
+  RSpec::Matchers.alias_matcher :have_enqueued_email, :deliver_later
+end

data/lib/deliver_later_matchers/deliver_later.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module DeliverLaterMatchers
+  class DeliverLater
+    def initialize(mailer_class, method_name)
+      @mailer_class = mailer_class
+      @method_name = method_name
+      @args = []
+    end
+
+    def description
+      "deliver #{@mailer_class.name}.#{@method_name} later"
+    end
+
+    def matches?(block)
+      raise ArgumentError, 'DeliverLater only works with block arguments' unless block.respond_to?(:call)
+      check_job_adapter
+
+      existing_jobs_count = enqueued_jobs.size
+      block.call
+      jobs_from_block = enqueued_jobs[existing_jobs_count..-1]
+
+      matching_job_exists?(jobs_from_block)
+    end
+
+    def with(*args)
+      @args = args
+      self
+    end
+
+    def failure_message(block)
+      "expected #{@mailer_class.name}.#{@method_name} to be delivered later"
+    end
+
+    private
+
+    def matching_job_exists?(jobs)
+      jobs.any? { |job| mailer_job?(job) && arguments_match?(job) }
+    end
+
+    def mailer_job?(job)
+      job[:job] == ActionMailer::DeliveryJob
+    end
+
+    def arguments_match?(job)
+      RSpec::Mocks::ArgumentListMatcher.new(*mailer_args).args_match?(*job_args(job))
+    end
+
+    # In the case where we match a mailer method that accepts
+    # arguments but the test does not call `with` on the matcher,
+    # we want to ignore the extra arguments passed to ActiveJob
+    # when we are trying to find our `deliver_later` job.
+    def job_args(job)
+      ::ActiveJob::Arguments.deserialize(job[:args])[0...mailer_args.size]
+    end
+
+    def mailer_args
+      [@mailer_class.name, @method_name.to_s, 'deliver_now'] + @args
+    end
+
+    def enqueued_jobs
+      queue_adapter.enqueued_jobs
+    end
+
+    def queue_adapter
+      ::ActiveJob::Base.queue_adapter
+    end
+
+    def check_job_adapter
+      return if queue_adapter.is_a?(::ActiveJob::QueueAdapters::TestAdapter)
+
+      raise RuntimeError, "To use DeliverLaterMatchers, set `ActiveJob::Base.queue_adpater = :test`."
+    end
+  end
+end

data/lib/deliver_later_matchers/version.rb

@@ -0,0 +1,3 @@
+module DeliverLaterMatchers
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: deliver_later_matchers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Lubrano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: 
+email:
+- joel.lubrano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deliver_later_matchers.gemspec
+- lib/deliver_later_matchers.rb
+- lib/deliver_later_matchers/deliver_later.rb
+- lib/deliver_later_matchers/version.rb
+homepage: https://github.com/jdlubrano/deliver_later_matchers
+licenses: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for testing that ActionMailers deliver_later
+test_files: []