rspec-mail_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d906f20ac4703840f42bc77bfd7795539fa14d9510c19679fa3c2ad3ac581e86
+  data.tar.gz: 9c3b524f9bf820f3cf3f65c5573b1a74349ed6e7082c32cf8a720a42b9db3a2b
+SHA512:
+  metadata.gz: 37a4b8a1c59ca033c56ce2608582493ad4251d9cdee1e87d9aa91c4e9e2262a450a2fd1fab88770e04e9848675b5eb9f24c91a2f995f562cb1ff89f430098383
+  data.tar.gz: 330c3aa163f3a628ea18081fab69ab5e48c5deb40930e59ae05f857261805121d7b5c3993b1bf51841064da48a65b33c9d5e6f17b53202189beff174b990d29f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant 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 shiro16@pepabo.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/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 rspec-mail_matcher.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    rspec-mail_matcher (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 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)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 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-support (3.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer (~> 5.1.4)
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-mail_matcher!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 shiro16
+
+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,64 @@
+# RSpec::MailMatcher
+
+This library provides RSpec matcher for testing ActionMailer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-mail_matcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-mail_matcher
+
+## Usage
+
+### Configuration
+
+```
+# spec/spec_helper.rb
+RSpec.configuration.include RSpec::MailMatcher
+```
+
+### Matcher
+
+see: [mail_matcher.rb](https://github.com/shiro16/rspec-mail_matcher/blob/master/lib/rspec/mail_matcher.rb)
+
+### Example
+
+```
+RSpec.describe RSpec::MailMatcher, type: :mailer do
+  let(:mail) { TestMailer.test_mail }
+
+  subject { mail }
+
+  describe '#deliver_to' do
+    it { is_expected.to deliver_to("deliver_to@example.com") }
+  end
+end
+```
+
+## 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/shiro16/rspec-mail_matcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RSpec::MailMatcher project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shiro16/rspec-mail_matcher/blob/master/CODE_OF_CONDUCT.md).

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,12 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'action_mailer'
+require "rspec/mail_matcher"
+
+# 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

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/rspec-mail_matcher.rb

@@ -0,0 +1 @@
+require "rspec/mail_matcher"

data/lib/rspec/mail_matcher.rb

@@ -0,0 +1,37 @@
+require "rspec/mail_matcher/version"
+require "rspec/mail_matcher/body_matcher"
+require "rspec/mail_matcher/address_matcher"
+require "rspec/mail_matcher/deliver_to_matcher"
+require "rspec/mail_matcher/deliver_from_matcher"
+require "rspec/mail_matcher/reply_to_matcher"
+require "rspec/mail_matcher/subject_matcher"
+require "rspec/mail_matcher/body_text_matcher"
+require "rspec/mail_matcher/body_html_matcher"
+
+module RSpec
+  module MailMatcher
+    def deliver_to(expected)
+     DeliverToMatcher.new(expected)
+    end
+
+    def deliver_from(expected)
+      DeliverFromMatcher.new(expected)
+    end
+
+    def reply_to(expected)
+      ReplyToMatcher.new(expected)
+    end
+
+    def have_subject(expected)
+      SubjectMatcher.new(expected)
+    end
+
+    def have_body_text(expected)
+      BodyTextMatcher.new(expected)
+    end
+
+    def have_body_html(expected)
+      BodyHtmlMatcher.new(expected)
+    end
+  end
+end

data/lib/rspec/mail_matcher/address_matcher.rb

@@ -0,0 +1,17 @@
+module RSpec::MailMatcher
+  class AddressMatcher
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(mail)
+      @mail = mail
+      mails.include?(@expected)
+    end
+
+    private
+    def mails
+      raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+    end
+  end
+end

data/lib/rspec/mail_matcher/body_html_matcher.rb

@@ -0,0 +1,12 @@
+require 'cgi'
+
+module RSpec::MailMatcher
+  class BodyHtmlMatcher < BodyMatcher
+    private
+    def mail_body
+      CGI.unescapeHTML(@mail.html_part.body.to_s)
+    rescue
+      ""
+    end
+  end
+end

data/lib/rspec/mail_matcher/body_matcher.rb

@@ -0,0 +1,45 @@
+module RSpec::MailMatcher
+  class BodyMatcher
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(mail)
+      @mail = mail
+      if @expected.kind_of?(String)
+        include?
+      else
+        match?
+      end
+    end
+
+    def description
+      if @expected.kind_of?(String)
+        "have body including #{@expected.inspect}"
+      else
+        "have body matching #{@expected.inspect}"
+      end
+    end
+
+    def failure_message
+      if @expected.kind_of?(String)
+        "expected the body to contain #{@expected.inspect} but was #{mail_body.inspect}"
+      else
+        "expected the body to match #{@expected.inspect}, but did not. Actual body was: #{mail_body.inspect}"
+      end
+    end
+
+    private
+    def mail_body
+      raise NotImplementedError, "You must implement #{self.class}##{__method__}"
+    end
+
+    def include?
+      mail_body.include?(@expected)
+    end
+
+    def match?
+      !!(mail_body =~ @expected)
+    end
+  end
+end

data/lib/rspec/mail_matcher/body_text_matcher.rb

@@ -0,0 +1,10 @@
+module RSpec::MailMatcher
+  class BodyTextMatcher < BodyMatcher
+    private
+    def mail_body
+      @mail.text_part.body.to_s
+    rescue
+      ""
+    end
+  end
+end

data/lib/rspec/mail_matcher/deliver_from_matcher.rb

@@ -0,0 +1,16 @@
+module RSpec::MailMatcher
+  class DeliverFromMatcher < AddressMatcher
+    def description
+      "have deliver from as #{@expected}"
+    end
+
+    def failure_message
+      "expected #{mails.inspect} not to deliver from #{@expected.inspect}, but it did"
+    end
+
+    private
+    def mails
+      @mail.from
+    end
+  end
+end

data/lib/rspec/mail_matcher/deliver_to_matcher.rb

@@ -0,0 +1,16 @@
+module RSpec::MailMatcher
+  class DeliverToMatcher < AddressMatcher
+    def description
+      "have deliver to as #{@expected}"
+    end
+
+    def failure_message
+      "expected #{mails.inspect} not to deliver to #{@expected.inspect}, but it did"
+    end
+
+    private
+    def mails
+      @mail.to
+    end
+  end
+end

data/lib/rspec/mail_matcher/reply_to_matcher.rb

@@ -0,0 +1,16 @@
+module RSpec::MailMatcher
+  class ReplyToMatcher < AddressMatcher
+    def description
+      "have reply to as #{@expected}"
+    end
+
+    def failure_message
+      "expected #{mails.inspect} not to reply to #{@expected.inspect}, but it did"
+    end
+
+    private
+    def mails
+      @mail.reply_to
+    end
+  end
+end

data/lib/rspec/mail_matcher/subject_matcher.rb

@@ -0,0 +1,32 @@
+module RSpec::MailMatcher
+  class SubjectMatcher
+    def initialize(expected)
+      @expected = expected
+    end
+
+    def matches?(mail)
+      @mail = mail
+      if @expected.kind_of?(String)
+        @mail.subject.include?(@expected)
+      else
+        !!(@mail.subject =~ @expected)
+      end
+    end
+
+    def description
+      if @expected.kind_of?(String)
+        "have subject including #{@expected.inspect}"
+      else
+        "have subject matching #{@expected.inspect}"
+      end
+    end
+
+    def failure_message
+      if @expected.kind_of?(String)
+        "expected the subject to contain #{@expected.inspect} but was #{@mail.subject.inspect}"
+      else
+        "expected the subject to match #{@expected.inspect}, but did not. Actual body was: #{@mail.subject.inspect}"
+      end
+    end
+  end
+end

data/lib/rspec/mail_matcher/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module MailMatcher
+    VERSION = "0.1.0"
+  end
+end

data/rspec-mail_matcher.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/mail_matcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-mail_matcher"
+  spec.version       = RSpec::MailMatcher::VERSION
+  spec.authors       = ["shiro16"]
+  spec.email         = ["nyanyanyawan24@gmail.com"]
+
+  spec.summary       = %q{This library provides RSpec matcher for testing ActionMailer.}
+  spec.description   = %q{RSpec matcher for testing ActionMailer}
+  spec.homepage      = "https://github.com/shiro16/rspec-mail_matcher"
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "actionmailer", '~> 5.1.4'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: rspec-mail_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shiro16
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+description: RSpec matcher for testing ActionMailer
+email:
+- nyanyanyawan24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec-mail_matcher.rb
+- lib/rspec/mail_matcher.rb
+- lib/rspec/mail_matcher/address_matcher.rb
+- lib/rspec/mail_matcher/body_html_matcher.rb
+- lib/rspec/mail_matcher/body_matcher.rb
+- lib/rspec/mail_matcher/body_text_matcher.rb
+- lib/rspec/mail_matcher/deliver_from_matcher.rb
+- lib/rspec/mail_matcher/deliver_to_matcher.rb
+- lib/rspec/mail_matcher/reply_to_matcher.rb
+- lib/rspec/mail_matcher/subject_matcher.rb
+- lib/rspec/mail_matcher/version.rb
+- rspec-mail_matcher.gemspec
+homepage: https://github.com/shiro16/rspec-mail_matcher
+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.7.3
+signing_key: 
+specification_version: 4
+summary: This library provides RSpec matcher for testing ActionMailer.
+test_files: []