email_spec 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6953e2bb1e960ed248a93cd7cbf47dbc0dedbfa3
-  data.tar.gz: 48595daa6d8a485acae168fd690261db13e39216
+SHA256:
+  metadata.gz: 4e0a37bd9d3d9eaa30f18b427930baa52d8b895b50d4d7b831650d621a9c955e
+  data.tar.gz: 4193090888bee1123f782507dc6c8496b9bca6ff0aea94612624a48f9d45d65b
 SHA512:
-  metadata.gz: edf125d376b91ba678cb815c18413618d8062bd89b39a039629ce304c1f5ec057cd07f9ad37e38f6ef4f2debbba226310075f0b72ff72e795d9e757dc5a052f8
-  data.tar.gz: 82794056b0200b35691a1e359a5c5b23c58abb09fa25c3798b1f3b18ee3145256115ffc615cedd5aedabedd66ab80bb81adbdf3c840901a92c4b0a2d8ad9ef81
+  metadata.gz: 97b61a1089f4c29bdcfffca000405a5d66bc2430dca4c9e293090cea5a12ebae9bacc108c3663b9a3961a5f955d59a0870a28c53a19d0782ed9d66ff6cfea15a
+  data.tar.gz: b38641514a7ceace6ea75f178865dffd9b910cebbc2eb28fea8c1ea3a7f64786e248900f34dd881f722c251ceb12e5f52f071257cf10b15eb316ad1a2e9e9427

data/Changelog.md

@@ -1,3 +1,21 @@
+## 2.3.0 2024-07-21
+
+* [Support the specified name and address for bcc_to and cc_to matchers](https://github.com/email-spec/email-spec/pull/212)
+* [Allow launchy 3.x versions](https://github.com/email-spec/email-spec/pull/226)
+* [Replace deprecated/removed File.exists? alias](https://github.com/email-spec/email-spec/pull/223)
+* [Extend have_body_text matcher to be able to specify which part in multipart to check](https://github.com/email-spec/email-spec/pull/196)
+
+## 2.2.2 2023-06-26
+
+* [Defer accommodating different delivery methods to runtime](https://github.com/email-spec/email-spec/pull/224)
+
+## 2.2.1 2022-09-12
+
+* [Support to decode part in EmailSpec::MailExt#default_part_body](https://github.com/email-spec/email-spec/pull/211)
+* [Drop rubyforge_project from gemspec](https://github.com/email-spec/email-spec/pull/215)
+* [Avoid eagerly loading ActionMailer::Base](https://github.com/email-spec/email-spec/pull/219)
+* [README: use SVG badges](https://github.com/email-spec/email-spec/pull/217)
+
 ## 2.2.0 2018-04-03
 
 * Support for `spinach` (@pedantic-git)

data/README.md

@@ -1,5 +1,4 @@
-
-[![Build Status](https://secure.travis-ci.org/email-spec/email-spec.png)](http://travis-ci.org/email-spec/email-spec)
+[![Build Status](https://secure.travis-ci.org/email-spec/email-spec.svg)](http://travis-ci.org/email-spec/email-spec)
 
 ## Email Spec
 
@@ -303,6 +302,15 @@ expect(email).to have_body_text(/Hi Jojo Binks,/)
 ```
 
 
+You can specify which part in multipart to check with `in_html_part` or
+`in_text_part`.
+
+```ruby
+email = UserMailer.("jojo@yahoo.com", "Jojo Binks")
+expect(email).to have_body_text(/This is html/).in_html_part
+expect(email).to have_body_text(/This is text/).in_text_part
+```
+
 ##### have_header(key, value)
 
 This checks that the expected key/value pair is in the headers of the email.
@@ -339,6 +347,10 @@ email = UserMailer.create_signup "jojo@yahoo.com", "Jojo Binks"
 assert_must deliver_to("jojo@yahoo.com"), email
 ```
 
+## Issue triage [![Open Source Helpers](https://www.codetriage.com/email-spec/email-spec/badges/users.svg)](https://www.codetriage.com/email-spec/email-spec)
+
+You can contribute by triaging issues which may include reproducing bug reports or asking for vital information, such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to [subscribe to email-spec on CodeTriage](https://www.codetriage.com/email-spec/email-spec).
+
 ## Original Authors
 
 Ben Mabey, Aaron Gibralter, Mischa Fierer

data/features/step_definitions/app_steps.rb

@@ -6,13 +6,13 @@ Given /^the (\w+) app is setup with the latest email steps$/ do |app_name|
                                'email_steps.rb')
   latest_specs_path = File.join(root_dir, 'lib', 'generators', 'email_spec',
                                 'steps', 'templates','email_steps.rb')
-  FileUtils.rm(email_specs_path) if File.exists?(email_specs_path)
+  FileUtils.rm(email_specs_path) if File.exist?(email_specs_path)
   FileUtils.cp_r(latest_specs_path, email_specs_path)
 end
 
 Then /^the (\w+) app should have the email steps in place$/ do |app_name|
   email_specs_path = "#{root_dir}/examples/#{app_name}_root/features/step_definitions/email_steps.rb"
-  expect(File.exists?(email_specs_path)).to be true
+  expect(File.exist?(email_specs_path)).to be true
 end
 
 Then /^I should see the following summary report:$/ do |expected_report|
@@ -22,7 +22,7 @@ end
 Given /^the (\w+) app is setup with the latest generators$/ do |app_name|
   app_dir= File.join(root_dir,'examples',"#{app_name}_root")
   email_specs_path = File.join(app_dir,'features','step_definitions','email_steps.rb')
-  FileUtils.rm(email_specs_path) if File.exists?(email_specs_path)
+  FileUtils.rm(email_specs_path) if File.exist?(email_specs_path)
 
   if app_name == 'rails4'
     #Testing using the gem
@@ -46,7 +46,7 @@ When /^I run "([^\"]*)" in the (\w+) app$/ do |cmd, app_name|
   app_specific_gemfile = File.join(app_path,'Gemfile')
   Dir.chdir(app_path) do
     #hack to fight competing bundles (email specs vs rails4_root's
-    if File.exists? app_specific_gemfile
+    if File.exist? app_specific_gemfile
       orig_gemfile = ENV['BUNDLE_GEMFILE']
       ENV['BUNDLE_GEMFILE'] = app_specific_gemfile
       @output = `#{cmd}`

data/lib/email_spec/deliveries.rb

@@ -1,5 +1,5 @@
 module EmailSpec
-  module MailerDeliveries
+  module Deliveries
     def all_emails
       deliveries
     end
@@ -9,7 +9,9 @@ module EmailSpec
     end
 
     def reset_mailer
-      if defined?(ActionMailer) && ActionMailer::Base.delivery_method == :cache
+      if defined?(ActionMailer) && ActionMailer::Base.delivery_method == :activerecord
+        Email.delete_all
+      elsif defined?(ActionMailer) && ActionMailer::Base.delivery_method == :cache
         mailer.clear_cache
       else
         deliveries.clear
@@ -23,36 +25,22 @@ module EmailSpec
     protected
 
     def deliveries
-      if ActionMailer::Base.delivery_method == :cache
+      if defined?(Pony)
+        Pony.deliveries
+      elsif ActionMailer::Base.delivery_method == :activerecord
+        Email.all.map { |email| parse_ar_to_mail(email) }
+      elsif ActionMailer::Base.delivery_method == :cache
         mailer.cached_deliveries
       else
         mailer.deliveries
       end
     end
-  end
-
-  module ARMailerDeliveries
-    def all_emails
-      Email.all.map{ |email| parse_to_mail(email) }
-    end
 
-    def last_email_sent
-      if email = Email.last
-        parse_to_mail(email)
-      else
-        raise("No email has been sent!")
-      end
+    def mailer
+      ActionMailer::Base
     end
 
-    def reset_mailer
-      Email.delete_all
-    end
-
-    def mailbox_for(address)
-      Email.all.select { |email| email.destinations.include?(address) }.map{ |email| parse_to_mail(email) }
-    end
-
-    def parse_to_mail(email)
+    def parse_ar_to_mail(email)
       Mail.read(email.mail)
     end
   end
@@ -68,17 +56,4 @@ module EmailSpec
       end
     end
   end
-
-  module Deliveries
-    if defined?(Pony)
-      def deliveries; Pony::deliveries ; end
-      include EmailSpec::MailerDeliveries
-    elsif ActionMailer::Base.delivery_method == :activerecord
-      include EmailSpec::ARMailerDeliveries
-    else
-      def mailer; ActionMailer::Base; end
-      include EmailSpec::MailerDeliveries
-    end
-  end
 end
-

data/lib/email_spec/extractors.rb

@@ -0,0 +1,45 @@
+module EmailSpec
+  module Extractors
+    class Base
+      attr_accessor :mail
+
+      def initialize(mail)
+        @mail = mail
+      end
+
+      def call
+        part_body ? HTMLEntities.new.decode(part_body) : ''
+      end
+
+      private
+
+      def part_body
+        raise NotImplementedError
+      end
+    end
+
+    class DefaultPartBody < Base
+      private
+
+      def part_body
+        (mail.html_part || mail.text_part || mail).body
+      end
+    end
+
+    class HtmlPartBody < Base
+      private
+
+      def part_body
+        mail.html_part ? mail.html_part.body : nil
+      end
+    end
+
+    class TextPartBody < Base
+      private
+
+      def part_body
+        mail.text_part ? mail.text_part.body : nil
+      end
+    end
+  end
+end

data/lib/email_spec/mail_ext.rb

@@ -5,11 +5,11 @@ module EmailSpec::MailExt
 
   def default_part_body
     # Calling to_str as we want the actual String object
-    HTMLEntities.new.decode(default_part.body.to_s.to_str)
+    HTMLEntities.new.decode(default_part.decoded.to_s.to_str)
   end
 
   def html
-    html_part ? html_part.body.raw_source : nil
+    html_part ? html_part.decoded : nil
   end
 end
 

data/lib/email_spec/matchers.rb

@@ -1,3 +1,5 @@
+require_relative 'extractors'
+
 module EmailSpec
   module Matchers
     class EmailMatcher
@@ -128,7 +130,7 @@ module EmailSpec
 
       def matches?(email)
         @email = email
-        @actual_recipients = address_array{ email.bcc }.sort
+        @actual_recipients = address_array { email[:bcc].formatted }.sort
         @actual_recipients == @expected_email_addresses
       end
 
@@ -162,7 +164,7 @@ module EmailSpec
 
       def matches?(email)
         @email = email
-        @actual_recipients = address_array { email.cc }.sort
+        @actual_recipients = address_array { email[:cc].formatted }.sort
         @actual_recipients == @expected_email_addresses
       end
 
@@ -274,6 +276,7 @@ module EmailSpec
 
       def initialize(text)
         @expected_text = text
+        @extractor = EmailSpec::Extractors::DefaultPartBody
       end
 
       def description
@@ -284,13 +287,23 @@ module EmailSpec
         end
       end
 
+      def in_html_part
+        @extractor = EmailSpec::Extractors::HtmlPartBody
+        self
+      end
+
+      def in_text_part
+        @extractor = EmailSpec::Extractors::TextPartBody
+        self
+      end
+
       def matches?(email)
         if @expected_text.is_a?(String)
-          @given_text = email.default_part_body.to_s.gsub(/\s+/, " ")
+          @given_text = @extractor.new(email).call.to_s.gsub(/\s+/, " ")
           @expected_text = @expected_text.gsub(/\s+/, " ")
           @given_text.include?(@expected_text)
         else
-          @given_text = email.default_part_body.to_s
+          @given_text = @extractor.new(email).call.to_s
           !!(@given_text =~ @expected_text)
         end
       end
@@ -358,7 +371,14 @@ module EmailSpec
       alias negative_failure_message failure_message_when_negated
 
       def mail_headers_hash(email_headers)
-        email_headers.fields.inject({}) { |hash, field| hash[field.field.class::FIELD_NAME] = field.to_s; hash }
+        email_headers.fields.inject({}) do |hash, field|
+          if field.field.class.const_defined?('FIELD_NAME')
+            hash[field.field.class::FIELD_NAME] = field.to_s
+          else
+            hash[field.field.class::NAME.downcase] = field.to_s
+          end
+          hash
+        end
       end
     end
 

data/lib/email_spec/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EmailSpec
-  VERSION = '2.2.0'
+  VERSION = "2.3.0"
 end

data/spec/email_spec/mail_ext_spec.rb

@@ -35,6 +35,14 @@ describe EmailSpec::MailExt do
       email = Mail.new(:body => ActiveSupport::SafeBuffer.new("bacon & pancake"))
       expect(email.default_part_body).to eq ("bacon & pancake")
     end
+
+    it "decodes parts before return" do
+      email = Mail.new(:body => "hello\r\nquoted-printable")
+      email.content_transfer_encoding = 'quoted-printable'
+      
+      expect(email.encoded).to include("hello\r\nquoted-printable=")
+      expect(email.default_part_body).to eq("hello\nquoted-printable")
+    end
   end
 
   describe "#html" do

data/spec/email_spec/matchers_spec.rb

@@ -137,7 +137,7 @@ describe EmailSpec::Matchers do
     end
 
     it "should not match when the email does not have a sender" do
-      email = Mail::Message.new(:from => nil)
+      email = Mail::Message.new(:from => "johnshow@yahoo.com")
       expect(deliver_from("jimmy_bean@yahoo.com")).not_to match(email)
     end
 
@@ -178,6 +178,12 @@ describe EmailSpec::Matchers do
       expect(bcc_to("jimmy_bean@yahoo.com")).to match(email)
     end
 
+    it "should match when the email is set to deliver to the specified name and address" do
+      email = Mail::Message.new(:bcc => "Jimmy Bean <jimmy_bean@yahoo.com>")
+
+      expect(bcc_to("Jimmy Bean <jimmy_bean@yahoo.com>")).to match(email)
+    end
+
     it "should match when a list of emails is exact same as all of the email's recipients" do
       email = Mail::Message.new(:bcc => ["james@yahoo.com", "karen@yahoo.com"])
 
@@ -214,6 +220,12 @@ describe EmailSpec::Matchers do
       expect(cc_to("jimmy_bean@yahoo.com")).to match(email)
     end
 
+    it "should match when the email is set to deliver to the specified name and address" do
+      email = Mail::Message.new(:cc => "Jimmy Bean <jimmy_bean@yahoo.com>")
+
+      expect(cc_to("Jimmy Bean <jimmy_bean@yahoo.com>")).to match(email)
+    end
+
     it "should match when a list of emails is exact same as all of the email's recipients" do
       email = Mail::Message.new(:cc => ["james@yahoo.com", "karen@yahoo.com"])
 
@@ -454,6 +466,106 @@ describe EmailSpec::Matchers do
     end
   end
 
+  describe "#have_body_text", ".in_html_part" do
+    describe 'when html part is definded in mulitpart' do
+      it 'should match when the body matches regexp' do
+        email = Mail.new do
+          html_part do
+            body 'This is html'
+          end
+        end
+
+        expect(have_body_text(/This is html/).in_html_part).to match(email)
+      end
+    end
+
+    describe 'when text part is definded in mulitpart' do
+      it 'should not look at text part' do
+        email = Mail.new do
+          text_part do
+            body 'This is text'
+          end
+        end
+
+        expect(have_body_text(/This is text/).in_html_part).not_to match(email)
+      end
+    end
+
+    describe 'when html and text parts are definded in mulitpart' do
+      it 'should look at html part' do
+        email = Mail.new do
+          html_part do
+            body 'This is html'
+          end
+          text_part do
+            body 'This is text'
+          end
+        end
+
+        expect(have_body_text(/This is html/).in_html_part).to match(email)
+        expect(have_body_text(/This is text/).in_html_part).not_to match(email)
+      end
+    end
+
+    describe 'when nothing is defined in mulitpart' do
+      it 'should not look at any parts' do
+        email = Mail.new(body: 'This is body')
+
+        expect(have_body_text(/This is body/).in_html_part).not_to match(email)
+      end
+    end
+  end
+
+  describe "#have_body_text", ".in_text_part" do
+    describe 'when text part is definded in mulitpart' do
+      it 'should match when the body matches regexp' do
+        email = Mail.new do
+          text_part do
+            body 'This is text'
+          end
+        end
+
+        expect(have_body_text(/This is text/).in_text_part).to match(email)
+      end
+    end
+
+    describe 'when text and html parts are definded in mulitpart' do
+      it 'should look at text part' do
+        email = Mail.new do
+          text_part do
+            body 'This is text'
+          end
+
+          html_part do
+            body 'This is html'
+          end
+        end
+
+        expect(have_body_text(/This is text/).in_text_part).to match(email)
+        expect(have_body_text(/This is html/).in_text_part).not_to match(email)
+      end
+    end
+
+    describe 'when html part is definded in mulitpart' do
+      it 'should not look at html part' do
+        email = Mail.new do
+          html_part do
+            body "This is html"
+          end
+        end
+
+        expect(have_body_text(/This is html/).in_text_part).not_to match(email)
+      end
+    end
+
+    describe 'when nothing is defined in mulitpart' do
+      it 'should not look at any parts' do
+        email = Mail.new(body: 'This is body')
+
+        expect(have_body_text(/This is body/).in_text_part).not_to match(email)
+      end
+    end
+  end
   describe "#have_header" do
     describe "when regexps are used" do
       it "should match when header matches passed in regexp" do

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: email_spec
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Ben Mabey
 - Aaron Gibralter
 - Mischa Fierer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -30,16 +30,22 @@ dependencies:
   name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -82,20 +88,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.17
-- !ruby/object:Gem::Dependency
-  name: actionmailer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +171,6 @@ files:
 - README.md
 - Rakefile
 - examples/rails4_root/Gemfile
-- examples/rails4_root/Gemfile.lock
 - examples/rails4_root/README
 - examples/rails4_root/Rakefile
 - examples/rails4_root/app/controllers/application_controller.rb
@@ -223,7 +214,6 @@ files:
 - examples/rails4_root/db/migrate/20141119224309_add_queue_to_delayed_jobs.rb
 - examples/rails4_root/db/schema.rb
 - examples/rails4_root/db/seeds.rb
-- examples/rails4_root/db/test.sqlite3
 - examples/rails4_root/doc/README_FOR_APP
 - examples/rails4_root/features/attachments.feature
 - examples/rails4_root/features/delayed_job.feature
@@ -238,8 +228,6 @@ files:
 - examples/rails4_root/lib/notifier_job.rb
 - examples/rails4_root/lib/tasks/cucumber.rake
 - examples/rails4_root/lib/tasks/rspec.rake
-- examples/rails4_root/log/development.log
-- examples/rails4_root/log/test.log
 - examples/rails4_root/public/404.html
 - examples/rails4_root/public/422.html
 - examples/rails4_root/public/500.html
@@ -262,7 +250,6 @@ files:
 - examples/rails4_root/test/mailers/user_mailer_spec_test.rb
 - examples/rails4_root/test/test_helper.rb
 - examples/sinatra_root/Gemfile
-- examples/sinatra_root/Gemfile.lock
 - examples/sinatra_root/config.ru
 - examples/sinatra_root/features/errors.feature
 - examples/sinatra_root/features/example.feature
@@ -283,6 +270,7 @@ files:
 - lib/email_spec/deliveries.rb
 - lib/email_spec/email_viewer.rb
 - lib/email_spec/errors.rb
+- lib/email_spec/extractors.rb
 - lib/email_spec/helpers.rb
 - lib/email_spec/mail_ext.rb
 - lib/email_spec/matchers.rb
@@ -301,7 +289,7 @@ homepage: http://github.com/email-spec/email-spec/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -316,9 +304,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: email-spec
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.5.10
+signing_key:
 specification_version: 4
 summary: Easily test email in RSpec, Cucumber or Minitest
 test_files: []