mail_assertions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41bfc48b60ca04314ec559fc1b5a1f7cb274c556
+  data.tar.gz: 581befd87857b83f3e606e9c5092dd64df6f9457
+SHA512:
+  metadata.gz: d9bd9eae9a53164bec0c446e790d1a1aee03a35237ddf44bbfd5cdc25fa8c2974ad9401a83fb2cc34e107f9c9265fe6176f458f6ceae79193dc1d7e7988730a8
+  data.tar.gz: 1024127b7e0e0b4db49e31eca0c96b14e288dcea644d183de048ce7c64bf7a7c3621a4f19dcf89a793ca1dcaaf2b9c2be1af2fb57bf04120f7d4e2a70fd6e4b1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Magnus Hult
+
+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,108 @@
+# MailAssertions
+
+This gem provides two new minitest assertions, `assert_mail` and
+`refute_mail` for easily testing whether a specific email has been
+sent by your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mail_assertions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mail_assertions
+
+## Usage
+
+You need to include the module `MailAssertions` in
+`ActiveSupport::TestCase`.
+
+Also, you almost certainly want to empty the deliveries list between
+every test (otherwise it's hard to know which emails came from this
+test).
+
+Therefore, in your `test_helper.rb`:
+
+```ruby
+class ActiveSupport::TestCase
+  include MailAssertions
+
+  def setup
+    ActionMailer::Base.deliveries.clear
+  end
+end
+```
+
+### `assert_mail(conditions, &block)`
+
+Conditions is a hash of attributes on the message object and the
+value you're looking for.
+
+```ruby
+# Fails unless there was exactly email sent with the subject
+# Hello World
+assert_mail subject: 'Hello World'
+```
+
+You can also specify several conditions, in which case all must apply
+for the email to match:
+
+```ruby
+# Fails unless there was exactly one email with the subject Hello World
+# sent to hello@example.com.
+assert_mail subject: 'Hello World', to: ['hello@example.com']
+```
+
+Optionally, the values may be regular expressions in which case the
+email's value will need to match it
+
+```ruby
+# Fails unless there was exactly one email with a subject starting
+# with an A
+assert_mail subject: /^A/
+```
+
+The optional block is invoked with the matching mail
+
+```ruby
+assert_mail subject: 'Hello World' do |mail|
+  # Further assertions about the email here
+end
+```
+
+As a convenience, if the block accepts two arguments, the second
+will be the HTML body of the email (`mail.html_part.body.to_s`)
+
+```ruby
+assert_mail subject: 'Hello World' do |mail, html|
+  # Further assertions about the email or its html here
+end
+```
+
+### `refute_mail(conditions)`
+
+Works similarly to `assert_mail` but fails unless no emails matching
+the conditions have been sent.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/hult/mail_assertions.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mail_assertions"
+
+# 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/lib/mail_assertions.rb

@@ -0,0 +1,2 @@
+require "mail_assertions/version"
+require 'mail_assertions/asserts'

data/lib/mail_assertions/asserts.rb

@@ -0,0 +1,44 @@
+require 'action_mailer'
+require 'active_support'
+
+module MailAssertions
+  def assert_mail(conditions = {}, &block)
+    emails = list_with_conditions(ActionMailer::Base.deliveries, conditions)
+    unless emails.count == 1
+      all_subjects = ActionMailer::Base.deliveries.map(&:subject)
+      if emails.count == 0
+        assert false, "The mail '#{conditions}' was not sent: <#{all_subjects.join(', ')}>"
+      else
+        assert false, "More than one mail '#{conditions}' was sent: <#{all_subjects.join(', ')}>"
+      end
+    end
+    mail = emails.first
+    if block_given?
+      case block.arity
+        when 2
+          yield mail, mail.html_part.body.to_s
+        else
+          yield mail
+      end
+    end
+  end
+
+  def refute_mail(conditions = {})
+    assert_empty list_with_conditions(ActionMailer::Base.deliveries, conditions)
+  end
+
+  private
+
+  def list_with_conditions(list, conditions)
+    raise ArgumentError.new("specify at least one condition") if conditions.blank?
+    list.select do |item|
+      conditions.map do |name, value|
+        if value.kind_of? Regexp
+          item.send(name) =~ value
+        else
+          item.send(name) == value
+        end
+      end.all?
+    end
+  end
+end

data/lib/mail_assertions/version.rb

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

data/mail_assertions.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail_assertions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail_assertions"
+  spec.version       = MailAssertions::VERSION
+  spec.authors       = ["Magnus Hult"]
+  spec.email         = ["magnus@magnushult.se"]
+
+  spec.summary       = %q{Minitest asserts for checking that specific emails were (or were not) sent.}
+  spec.homepage      = "https://github.com/hult/mail_assertions"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "active_support", "~> 5.0"
+  spec.add_development_dependency "action_mailer", "~> 5.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: mail_assertions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Magnus Hult
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: action_mailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- magnus@magnushult.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mail_assertions.rb
+- lib/mail_assertions/asserts.rb
+- lib/mail_assertions/version.rb
+- mail_assertions.gemspec
+homepage: https://github.com/hult/mail_assertions
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Minitest asserts for checking that specific emails were (or were not) sent.
+test_files: []