sanitize_email 1.2.0 → 1.2.1

data/lib/sanitize_email/rspec_matchers.rb

@@ -1,24 +1,30 @@
 # Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
-require 'sanitize_email/test_helpers'
-require 'sanitize_email/mail_ext'
+# Note: the RspecMatchers are composed matchers:
+# See: http://www.relishapp.com/rspec/rspec-expectations/v/3-5/docs/composing-matchers
+
+require "sanitize_email/mail_ext"
 
 module SanitizeEmail
-  # Provides matchers that can be used in Rspec tests to assert the behavior of email
+  # Provides matchers that can be used in
+  #   Rspec tests to assert the behavior of email
   module RspecMatchers
-    include SanitizeEmail::TestHelpers
-    [:from, :to, :cc, :bcc, :reply_to].each do |attribute|
+    [:from, :to, :cc, :bcc, :subject, :reply_to].each do |attribute|
       RSpec::Matchers.define "have_#{attribute}" do |matcher|
         match do |actual|
-          email_matching(matcher, attribute, actual)
+          @actual = actual.send(attribute)
+          @actual = @actual.join(", ") if @actual.respond_to?(:join)
+          expect(@actual).to match(matcher)
         end
       end
     end
 
-    [:subject].each do |attribute|
-      RSpec::Matchers.define "have_#{attribute}" do |matcher|
+    [:from, :to, :cc, :bcc, :subject, :reply_to].each do |attribute|
+      RSpec::Matchers.define "match_#{attribute}" do |matcher|
         match do |actual|
-          string_matching_attribute(matcher, attribute, actual)
+          @actual = actual.send(attribute)
+          @actual = @actual.join(", ") if @actual.respond_to?(:join)
+          expect(@actual).to match(matcher)
         end
       end
     end
@@ -26,46 +32,59 @@ module SanitizeEmail
     [:from, :to, :cc, :bcc, :subject, :reply_to].each do |attribute|
       RSpec::Matchers.define "be_#{attribute}" do |matcher|
         match do |actual|
-          string_matching(matcher, attribute, actual)
+          @actual = actual.send(attribute)
+          @actual = @actual.join(", ") if @actual.respond_to?(:join)
+          expect(@actual).to be(matcher)
         end
       end
     end
 
     RSpec::Matchers.define "have_to_username" do |matcher|
-      def get_username(email_message)
+      def get_to_username(email_message)
+        username_header = email_message.header["X-Sanitize-Email-To"]
+        return username_header unless username_header.is_a?(Mail::Field)
         email_message.header.fields[3].value
       end
       match do |actual|
-        string_matching(matcher, :to_username, get_username(actual))
+        @actual = get_to_username(actual)
+        expect(@actual).to match(matcher)
+      end
+    end
+
+    RSpec::Matchers.define "have_cc_username" do |matcher|
+      def get_cc_username(email_message)
+        username_header = email_message.header["X-Sanitize-Email-Cc"]
+        return username_header unless username_header.is_a?(Mail::Field)
+        email_message.header.fields[3].value
+      end
+      match do |actual|
+        @actual = get_cc_username(actual)
+        expect(@actual).to match(matcher)
       end
     end
 
     # Cribbed from email_spec gem
     RSpec::Matchers.define "have_body_text" do |matcher|
+      def get_fuzzy_body(email_message)
+        email_message.default_part_body.to_s.gsub(/\s+/, " ")
+      end
+
+      def get_fuzzy_matcher(to_fuzz)
+        to_fuzz.gsub(/\s+/, " ")
+      end
       match do |actual|
-        # Normalize all the whitespace, to improve match fuzz
-        if matcher.is_a?(String)
-          actual_text =  actual.default_part_body.to_s.gsub(/\s+/, " ")
-          matcher_text = matcher.gsub(/\s+/, " ")
-          raise SanitizeEmail::TestHelpers::UnexpectedMailType, "Cannot find #{matcher} in body" unless actual_text.respond_to?(:include?)
-          actual_text.include?(matcher_text)
-        else
-          actual_text =  actual.default_part_body.to_s
-          raise SanitizeEmail::TestHelpers::UnexpectedMailType, "Cannot find #{matcher} in body" unless actual_text.respond_to?(:=~)
-          !!(actual_text =~ matcher)
-        end
+        @actual = get_fuzzy_body(actual)
+        fuzzy_matcher = get_fuzzy_matcher(matcher)
+        expect(@actual).to match(fuzzy_matcher)
       end
     end
 
     # Cribbed from email_spec gem
     RSpec::Matchers.define "have_header" do |name, matcher|
       match do |actual|
-        header = actual.header
-        if matcher.is_a?(String)
-          header[name].to_s == matcher
-        else
-          header[name].to_s =~ matcher
-        end
+        @actual = actual.header[name]
+        @actual = @actual.value unless @actual.nil?
+        expect(@actual).to match(matcher)
       end
     end
 

data/lib/sanitize_email/test_helpers.rb

@@ -1,5 +1,7 @@
 # Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+# Note: the RspecMatchers no longer use these methods.  Instead they are composed matchers:
+# See: http://www.relishapp.com/rspec/rspec-expectations/v/3-5/docs/composing-matchers
 
 module SanitizeEmail
   # Helpers for test-unit
@@ -8,16 +10,16 @@ module SanitizeEmail
     # Error raised when unable to match an expected part of email in order to fail the test
     class UnexpectedMailType < StandardError; end
 
-    def string_matching_attribute(matcher, part, mail_or_part)
-      string_matching(matcher, part, mail_or_part.send(part))
+    def string_matching_attribute(matcher, part, attribute)
+      string_matching(matcher, part, attribute)
     end
 
-    def string_matching(matcher, part, mail_or_part)
-      if mail_or_part.respond_to?(:=~) # Can we match a regex against it?
+    def string_matching(matcher, part, attribute)
+      if attribute.respond_to?(:=~) # Can we match a regex against it?
         if matcher.is_a?(Regexp)
-          mail_or_part =~ matcher
+          attribute =~ matcher
         else
-          mail_or_part =~ Regexp.new(Regexp.escape(matcher))
+          attribute =~ Regexp.new(Regexp.escape(matcher))
         end
       else
         raise UnexpectedMailType, "Cannot match #{matcher} for #{part}"
@@ -25,13 +27,17 @@ module SanitizeEmail
     end
 
     # Normalize arrays to strings
-    def array_matching(matcher, part, mail_or_part)
-      mail_or_part = mail_or_part.join(', ') if mail_or_part.respond_to?(:join)
-      string_matching(matcher, part, mail_or_part)
+    def array_matching(matcher, part, attribute)
+      attribute = attribute.join(", ") if attribute.respond_to?(:join)
+      string_matching(matcher, part, attribute)
     end
 
     def email_matching(matcher, part, mail_or_part)
-      array_matching(matcher, part, mail_or_part.send(part))
+      email_attribute_matching(matcher, part, mail_or_part.send(part))
+    end
+
+    def email_attribute_matching(matcher, part, attribute)
+      array_matching(matcher, part, attribute)
     end
 
   end

data/lib/sanitize_email/version.rb

@@ -2,5 +2,5 @@
 # Released under the MIT license
 
 module SanitizeEmail
-  VERSION = '1.2.0'
+  VERSION = "1.2.1".freeze
 end

data/lib/sanitize_email.rb

@@ -2,12 +2,12 @@
 # Released under the MIT license
 
 module SanitizeEmail
-  require 'sanitize_email/version'
-  require 'sanitize_email/deprecation'
-  require 'sanitize_email/config'
-  require 'sanitize_email/mail_header_tools'
-  require 'sanitize_email/overridden_addresses'
-  require 'sanitize_email/bleach'
+  require "sanitize_email/version"
+  require "sanitize_email/deprecation"
+  require "sanitize_email/config"
+  require "sanitize_email/mail_header_tools"
+  require "sanitize_email/overridden_addresses"
+  require "sanitize_email/bleach"
 
   # Error is raised when a block parameter is required and not provided to a method
   class MissingBlockParameter < StandardError; end
@@ -15,9 +15,9 @@ module SanitizeEmail
   # Allow non-rails implementations to use this gem
   if defined?(::Rails)
     if defined?(::Rails::Engine)
-      require 'sanitize_email/engine'
+      require "sanitize_email/engine"
     elsif ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
-      require 'sanitize_email/railtie'
+      require "sanitize_email/railtie"
     else
       raise "Please use the 0.X.X versions of sanitize_email for Rails 2.X and below."
     end
@@ -65,16 +65,18 @@ module SanitizeEmail
   end
   @force_sanitize = nil
 
-  # Regardless of the Config settings of SanitizeEmail you can do a local override to send sanitary email in any environment.
-  # You have access to all the same configuration options in the parameter hash as you can set in the actual
-  # SanitizeEmail.configure block.
+  # Regardless of the Config settings of SanitizeEmail you can do a local
+  # override to send sanitary email in any environment.
+  # You have access to all the same configuration options in the parameter hash
+  # as you can set in the actual SanitizeEmail.configure block.
   #
-  # SanitizeEmail.sanitary({:sanitized_to => 'boo@example.com'}) do # these config options are merged with the globals
+  # SanitizeEmail.sanitary({:sanitized_to => "boo@example.com"}) do
   #   Mail.deliver do
-  #     from      'from@example.org'
-  #     to        'to@example.org' # Will actually be sent to the override addresses, in this case: boo@example.com
-  #     reply_to  'reply_to@example.org'
-  #     subject   'subject'
+  #     from      "from@example.org"
+  #     # Will actually be sent to the override addresses, not this one:
+  #     to        "to@example.org"
+  #     reply_to  "reply_to@example.org"
+  #     subject   "subject"
   #   end
   # end
   #
@@ -88,14 +90,15 @@ module SanitizeEmail
     end
   end
 
-  # Regardless of the Config settings of SanitizeEmail you can do a local override to force unsanitary email in any environment.
+  # Regardless of the Config settings of SanitizeEmail you can do a local
+  # override to force unsanitary email in any environment.
   #
   # SanitizeEmail.unsanitary do
   #   Mail.deliver do
-  #     from      'from@example.org'
-  #     to        'to@example.org'
-  #     reply_to  'reply_to@example.org'
-  #     subject   'subject'
+  #     from      "from@example.org"
+  #     to        "to@example.org"
+  #     reply_to  "reply_to@example.org"
+  #     subject   "subject"
   #   end
   # end
   #

data/sanitize_email.gemspec

@@ -45,5 +45,7 @@ EOS
   s.add_development_dependency("roodi", [">= 2.1.0"])
   s.add_development_dependency("rake", [">= 0"])
   s.add_development_dependency("pry", [">= 0"])
+  s.add_development_dependency("appraisal")
+  s.add_development_dependency("wwtd")
   s.add_development_dependency("coveralls")
 end