action_mailer_matchers 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d72ebf5f6f23281bf769f5fd31700cb3de13329
-  data.tar.gz: e604f1a52b0b76d580ee93f900d364cba799d53c
+SHA256:
+  metadata.gz: 3ea0ac17a513073551406e4ad8b1377070f6bfda1ee4fe423b1e11a577dd1b06
+  data.tar.gz: b75e043109da0dbaf5fd6925893c35a045e237a41561cdfb5f1af7a3075f3293
 SHA512:
-  metadata.gz: 22491b9b43ff02beef5c56b7dd71195506c45591120dcaa88113163b1068418fec3c46ff3b1b594e7634047a0234c409027291927629a587a6949f2f1c4b1cd6
-  data.tar.gz: 7501d3af82c7f6c9bbcc0de317b36b3879eced146b2177ed369f2f8a5a28794b4073fc4f5c6f30ba3e533836d882484ab7fd3981dd50709a9a8547b252e346e4
+  metadata.gz: 36fa17b7ee1d1d9261892d5c947f3d630b4a6e4f83a9b9a32388e46ba7132b13844e1aac9e42d908be95b2d72cf1cd4bb2ee37060dac998b9327c72f5adcb8e6
+  data.tar.gz: 394b847a27d9f9c0dd8e79dc7ccbeb22519611a0acbfcd733e84bb644df253ffa1d67b4c2cefc2be7c4f3b441600664bb9c1d39855357f926fb26176c39bb68d

data/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make by creating an issue.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at devops@contently.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 TODO: Write your name
+Copyright (c) 2016 Contently
 
 MIT License
 

data/README.md

@@ -1,28 +1,72 @@
 # ActionMailerMatchers
 
-TODO: Write a gem description
+ActionMailerMatchers provides RSpec matchers to test common ActionMailer functionality.
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'action_mailer_matchers'
+```ruby
+group :test do
+  gem 'action_mailer_matchers', '~> 1.0'
+end
+```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install action_mailer_matchers
 
+Include ActionMailerMatchers in your RSpec config by requiring it and including in your configuration block.
+
+```ruby
+require "action_mailer_matchers"
+
+...
+
+RSpec.configure do |config|
+  config.include ActionMailerMatchers
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+ActionMailer allows you to send emails in your Rails application, ActionMailerMatchers provides you with RSpec one-liners that help you to test this functionality. 
+
+It is typical to test that an email has been delivered by doing the following: 
+
+```ruby
+expect { some_action.execute }
+ .to change { ActionMailer::Base.deliveries.count }.by(1)
+```
+
+However, this does not specify what email was sent and to where. ActionMailerMatchers solves this problem by providing the `have_received_email` matcher, which ensures that the passed email address or user (which must respond `.email`) was the email's "to" address. You may also use the optional subject and body arguments to check that content matches the email you were expecting to send.
+
+```ruby
+expect(some_user).to have_received_email(subject: "My great subject")
+expect("address@email.com").to have_received_email(body: "Wonderful email body")
+```
+
+You can also test that someone has not received an email.
+
+```ruby
+expect(some_user).not_to have_received_email
+```
+
+Emails sent to users using `bcc` or `cc` can be tested using:
+
+```ruby
+expect("cc@email.com").to have_received_cc_email(body: "Wonderful email body")
+expect("bcc@email.com").to have_received_bcc_email(body: "Wonderful email body")
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/action_mailer_matchers/fork )
+1. Fork it ( https://github.com/contently/action_mailer_matchers/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/action_mailer_matchers.gemspec

@@ -6,7 +6,7 @@ require 'action_mailer_matchers/version'
 Gem::Specification.new do |spec|
   spec.name          = "action_mailer_matchers"
   spec.version       = ActionMailerMatchers::VERSION
-  spec.authors       = ["Alexandra Ackerman, Kevin Curtin"]
+  spec.authors       = ["Alexandra Ackerman, Kevin Curtin, Andy Klimczak"]
   spec.email         = ["aaackerman.dev@gmail.com"]
   spec.summary       = %q{ActionMailerMatchers provides rspec matchers to test Rails' common ActionMailer functionality.}
   spec.description   = %q{ActionMailerMatchers provides rspec matchers to test Rails' common ActionMailer functionality.}

data/lib/action_mailer_matchers.rb

@@ -5,36 +5,52 @@ module ActionMailerMatchers
 
   matcher :have_received_email do |email_or_user|
     match do |email_or_user|
-      expected_attrs = expected.present? ? expected : {}
-      email = email_or_user.try(:email) || email_or_user
-      email_subject = expected_attrs[:subject]
-      body = expected_attrs[:body]
+      received_email?(email_or_user, expected)
+    end
+  end
 
-      matching_email = matching_mail_for(email, body, email_subject)
+  matcher :have_received_cc_email do |email_or_user|
+    match do |email_or_user|
+      received_email?(email_or_user, expected, :cc)
+    end
+  end
 
-      expect(matching_email.present?).to eql(true)
+  matcher :have_received_bcc_email do |email_or_user|
+    match do |email_or_user|
+      received_email?(email_or_user, expected, :bcc)
     end
+  end
 
-    def matching_mail_for(email, body, email_subject)
-      deliveries.detect do |mail|
-        has_expected_email = mail.to.include?(email)
-        has_expected_body = body ? body_for(mail).include?(body) : true
-        has_expected_subject = email_subject ? mail.subject.include?(email_subject) : true
+  def received_email?(email_or_user, expected, email_method = :to)
+    expected_attrs = expected.present? ? expected : {}
+    email = email_or_user.try(:email) || email_or_user
+    email_subject = expected_attrs[:subject]
+    body = expected_attrs[:body]
 
-        has_expected_email && has_expected_body && has_expected_subject
-      end
-    end
+    matching_email = matching_mail_for(email, body, email_subject, email_method)
+
+    expect(matching_email.present?).to eql(true)
+  end
+
+  def matching_mail_for(email, body, email_subject, email_method)
+    deliveries.detect do |mail|
+      has_expected_email = mail.send(email_method).include?(email)
+      has_expected_body = body ? body_for(mail).include?(body) : true
+      has_expected_subject = email_subject ? mail.subject.include?(email_subject) : true
 
-    def body_for(mail)
-      if mail.try(:parts).present?
-        mail.try(:parts).try(:first).try(:body).try(:raw_source)
-      else
-        mail.try(:body).try(:raw_source)
-      end
+      has_expected_email && has_expected_body && has_expected_subject
     end
+  end
 
-    def deliveries
-      ActionMailer::Base.deliveries
+  def body_for(mail)
+    if mail.try(:parts).present?
+      mail.try(:parts).try(:first).try(:body).try(:raw_source)
+    else
+      mail.try(:body).try(:raw_source)
     end
   end
+
+  def deliveries
+    ActionMailer::Base.deliveries
+  end
 end

data/lib/action_mailer_matchers/version.rb

@@ -1,3 +1,3 @@
 module ActionMailerMatchers
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_mailer_matchers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Alexandra Ackerman, Kevin Curtin
+- Alexandra Ackerman, Kevin Curtin, Andy Klimczak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-14 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ActionMailerMatchers provides rspec matchers to test Rails' common ActionMailer