sanitize_email 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d655a119fcfed21733da3b6d086904bed64ee290930b63cd2ef36c7f918e882
-  data.tar.gz: '08de77ba87e5f93b0096b3646aa7512dee49ada51b4972b68dc3ca37c700109a'
+  metadata.gz: ab280a496e5f7c676c9f34a0d9c947e79015cc1001fb64dd9c9d7240d140eeea
+  data.tar.gz: 455e2718f6bc3cf995b444768c2fcb855ff15685077d234c4887c829cb3b36ca
 SHA512:
-  metadata.gz: 8304c15db70e464ad886a752b91d3b60444e36b8865f62442fe642eb687afea0ea00741e685537b1d3bd87cd50f70501a5890de0b946dbae2e50ce5c9dcc7b94
-  data.tar.gz: 1c693f4d770f5517e4b904e73edcd814a71b2ab6e4fa96fc1eff734d9d0db0246a64282257cf16eeb69d68b46980cb149cce9e27fae5635e60ab0cb8a51e856e
+  metadata.gz: 847a73eb85a827ff002f26e0108f3bd5ad4f9750d3de08e8461363e6effe31058fe92dee7ea7b1d3fa0260ad4f00b0f52d6df285ab0dc9fc029faac34ccca380
+  data.tar.gz: 1e53fb956e7bb1223192164e151509c45c6f2c7e653c5b9d194925164e1141ae969a8364209e3fd5a7db4c5d833146016a9fbdfe2c7b8f38a17be1b4c6d04004

data/CHANGELOG.md

@@ -10,6 +10,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Removed
 
+## [2.0.6] - 2024-04-25 ([tag][2.0.6t])
+### Added
+* Appraisals & Combustion for comprehensive testing across versions of Rails (@pboling)
+* Rails 3.0 to Test Matrix (@pboling)
+* Rails 3.1 to Test Matrix (@pboling)
+* Rails 3.2 to Test Matrix (@pboling)
+* Rails 4.0 to Test Matrix (@pboling)
+* Rails 4.1 to Test Matrix (@pboling)
+* Rails 4.2 to Test Matrix (@pboling)
+* Rails 5.0 to Test Matrix (@pboling)
+* Rails 5.1 to Test Matrix (@pboling)
+* More Documentation (@pboling)
+### Fixed
+* Compatibility with Rails 3.0, 3.1, 3.2 (@pboling)
+* Compatibility with Rails 6.0, 6.1, 7.0, 7.1 (@pboling)
+
 ## [2.0.5] - 2024-04-18 ([tag][2.0.5t])
 ### Added
 * New RSpec matcher (@pboling)
@@ -275,7 +291,11 @@ Old version?
 * Fixed require paths
 * added about.yml and this CHANGELOG
 
-[Unreleased]: https://github.com/pboling/sanitize_email/compare/v2.0.4...HEAD
+[Unreleased]: https://github.com/pboling/sanitize_email/compare/v2.0.6...HEAD
+[2.0.6]: https://github.com/pboling/sanitize_email/compare/v2.0.5...v2.0.6
+[2.0.6t]: https://github.com/pboling/sanitize_email/tags/v2.0.6
+[2.0.5]: https://github.com/pboling/sanitize_email/compare/v2.0.4...v2.0.5
+[2.0.5t]: https://github.com/pboling/sanitize_email/tags/v2.0.5
 [2.0.4]: https://github.com/pboling/sanitize_email/compare/v2.0.3...v2.0.4
 [2.0.4t]: https://github.com/pboling/sanitize_email/tags/v2.0.4
 [2.0.3]: https://github.com/pboling/sanitize_email/compare/v2.0.2...v2.0.3

data/CONTRIBUTING.md

@@ -7,6 +7,14 @@ the [code of conduct][🤝conduct].
 To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request
 and post a message to the [gitter chat][🏘chat].
 
+## Appraisal & Combustion
+
+### Generate a new set of Appraisal gemfiles:
+
+```sh
+BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal generate
+```
+
 ## Release
 
 To release a new version:

data/README.md

@@ -63,13 +63,15 @@ then this is the gem for you.
 
 ## Compatibility
 
-⚙️ Compatible with all versions of Ruby >= 2.3.
+⚙️ Compatible with all versions of Ruby >= 2.3, plus JRuby and Truffleruby.
 ⚙️ Compatible with all Ruby web Frameworks (Hanami, Roda, Sinatra, Rails).
 ⚙️ Compatible with all versions of Rails from 3.0 - 7.1+.
 ⚙️ Compatible with scripted usage of Mail gem outside a web framework.
 ⚙️ Compatible with [`sendgrid-actionmailer`](https://github.com/eddiezane/sendgrid-actionmailer)'s support for personalizations, and will override email addresses there according to the configuration.
 ⚙️ If this gem is not compatible with your use case, and you'd like it to be, I'd like to hear about it!
 
+It was a slog getting (very nearly) the entire compatibility matrix working with Github Actions, [`appraisal`](https://github.com/thoughtbot/appraisal), and [`combustion`](https://github.com/pat/combustion), and I'm very interested in hearing about ways to improve it!
+
 ## 🛞 DVCS
 
 This project does not trust any one version control system,
@@ -228,7 +230,7 @@ The link tokens in the following sections should be kept ordered by the row and
 It's particularly helpful when you want to prevent the delivery of email (e.g. in development/test environments) or alter the to/cc/bcc (e.g. in staging or demo environments) of all email generated from your application.
 
 * compatible without Rails!  Can work with just the `mail` gem.
-* compatible with Rails >= 4.2.  See gem versions 1.x for older versions of Rails.
+* compatible with Rails >= 3.0.  See gem versions 1.x for older versions of Rails.
 * compatible with Ruby >= 2.3.  See gem versions 1.x for older versions of Ruby.
 * compatible with any Ruby app with a mail handler that uses the `register_interceptor` API (a la ActionMailer and `mail` gems)
 * configure it and forget it
@@ -674,15 +676,18 @@ Learn more about, or become one of, our 🎖 contributors on:
 ## Running Specs
 
 The basic compatibility matrix:
-```
+```sh
 appraisal install
 appraisal rake test
 ```
 
 Sometimes also:
+```sh
+BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal update
 ```
-appraisal update
-```
+
+Except, is unlikely to be possible to install all of the supported Rubies & Railsies in a single container...
+See the various github action workflows for more inspiration on running certain oldies.
 
 ### Code Coverage
 

data/lib/sanitize_email/engine_v5.rb

@@ -2,6 +2,7 @@
 
 # Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+require "rails/engine"
 
 module SanitizeEmail
   # For Rails >= 3.1, < 6.0

data/lib/sanitize_email/engine_v6.rb

@@ -2,14 +2,15 @@
 
 # Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+require "rails/engine"
 
 module SanitizeEmail
   # For Rails >= 6.0
-  class EngineV5 < ::Rails::Engine
+  class EngineV6 < ::Rails::Engine
     config.to_prepare do
       # For the reasoning behind the difference between v5 and v6 engines,
       #   - see: https://github.com/rails/rails/issues/36546#issuecomment-850888284
-      config.action_mailer.register_interceptor(SanitizeEmail::Bleach)
+      Rails.application.config.action_mailer.register_interceptor(SanitizeEmail::Bleach)
     end
   end
 end

data/lib/sanitize_email/mail_ext.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 require "mail"
 
 # Cribbed from email_spec gem

data/lib/sanitize_email/overridden_addresses.rb

@@ -55,10 +55,15 @@ module SanitizeEmail
       @overridden_cc = tempmail[:cc].decoded
       @overridden_bcc = tempmail[:bcc].decoded
 
-      if message["personalizations"].nil?
+      actual_personalizations = message["personalizations"]
+      if actual_personalizations.nil?
         raise MissingRecipients, "No recipients left post-sanitization" if (tempmail.to + tempmail.cc + tempmail.bcc).empty?
+      elsif actual_personalizations.respond_to?(:unparsed_value)
+        @overridden_personalizations = personalizations_override(actual_personalizations)
       else
-        @overridden_personalizations = personalizations_override(message["personalizations"])
+        # TODO: Remove check when dropping Rails 3.x
+        #       undefined method `unparsed_value' for #<Mail::OptionalField>
+        raise MissingRecipients, "Mail version is too old to use personalizations"
       end
     end
 

data/lib/sanitize_email/railtie.rb

@@ -2,6 +2,7 @@
 
 # Copyright (c) 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+require "rails/railtie"
 
 module SanitizeEmail
   # For Rails 3.0, which didn't yet support Engines

data/lib/sanitize_email/version.rb

@@ -5,6 +5,6 @@
 
 module SanitizeEmail
   module Version
-    VERSION = "2.0.5"
+    VERSION = "2.0.6"
   end
 end

data/lib/sanitize_email.rb

@@ -18,6 +18,9 @@ module SanitizeEmail
   # Error is raised when a block parameter is required and not provided to a method
   class MissingBlockParameter < StandardError; end
 
+  # Load order matters here!
+  # This gem must be loaded **after** Rails in order for the Engine/Railtie to register itself automatically.
+  # Otherwise, you'd have to manually require what you need from below.
   # Allow non-rails implementations to use this gem
   if defined?(::Rails) && defined?(::Rails::VERSION)
     if defined?(::Rails::Engine)
@@ -48,95 +51,101 @@ module SanitizeEmail
     end
   end
 
-  def self.[](key)
-    return unless key.respond_to?(:to_sym)
-    SanitizeEmail::Config.config[key.to_sym]
-  end
+  class << self
+    extend SanitizeEmail::Deprecation
 
-  def self.method_missing(name, *_args)
-    SanitizeEmail[name]
-  end
+    attr_accessor :force_sanitize
 
-  # NOTE: Deprecated method
-  # We have to actually define because we can't deprecate methods that are hooked up via method_missing
-  def self.sanitized_recipients
-    # NOOP - This method is never actually executed, because the deprecations redirects the call to sanitized_to
-  end
+    def [](key)
+      return unless key.respond_to?(:to_sym)
+      SanitizeEmail::Config.config[key.to_sym]
+    end
 
-  # NOTE: Deprecated method
-  # We have to actually define because we can't deprecate methods that are hooked up via method_missing
-  def self.local_environments
-    SanitizeEmail::Config.config[:local_environments]
-  end
+    def method_missing(name, *_args)
+      if name
+        SanitizeEmail[name]
+      else
+        super
+      end
+    end
 
-  def self.activate?(message)
-    proc = SanitizeEmail::Config.config[:activation_proc]
-    proc.call(message) if proc.respond_to?(:call)
-  end
+    def respond_to_missing?(method_name, include_private = false)
+      method_name ? method_name : super
+    end
 
-  class << self
-    attr_accessor :force_sanitize
-  end
-  @force_sanitize = nil
+    # NOTE: Deprecated method
+    # We have to actually define because we can't deprecate methods that are hooked up via method_missing
+    def sanitized_recipients
+      # NOOP - This method is never actually executed, because the deprecations redirects the call to sanitized_to
+    end
 
-  # 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
-  #   Mail.deliver do
-  #     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
-  #
-  def self.sanitary(config_options = {})
-    raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given?
-    janitor(forcing: true) do
-      original = SanitizeEmail::Config.config.dup
-      SanitizeEmail::Config.config.merge!(config_options)
-      yield
-      SanitizeEmail::Config.config = original
+    # NOTE: Deprecated method
+    # We have to actually define because we can't deprecate methods that are hooked up via method_missing
+    def local_environments
+      SanitizeEmail::Config.config[:local_environments]
     end
-  end
 
-  # 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"
-  #   end
-  # end
-  #
-  def self.unsanitary
-    raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
-    janitor(forcing: false) do
-      yield
+    def activate?(message)
+      proc = SanitizeEmail::Config.config[:activation_proc]
+      proc.call(message) if proc.respond_to?(:call)
     end
-  end
 
-  def self.janitor(options)
-    raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given?
-    original = SanitizeEmail.force_sanitize
-    SanitizeEmail.force_sanitize = options[:forcing]
-    yield
-    SanitizeEmail.force_sanitize = original
-  end
+    # 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
+    #   Mail.deliver do
+    #     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
+    #
+    def sanitary(config_options = {})
+      raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given?
+      janitor(forcing: true) do
+        original = SanitizeEmail::Config.config.dup
+        SanitizeEmail::Config.config.merge!(config_options)
+        yield
+        SanitizeEmail::Config.config = original
+      end
+    end
+
+    # 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"
+    #   end
+    # end
+    #
+    def unsanitary
+      raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
+      janitor(forcing: false) do
+        yield
+      end
+    end
+
+    def janitor(options)
+      raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given?
+      original = SanitizeEmail.force_sanitize
+      SanitizeEmail.force_sanitize = options[:forcing]
+      yield
+      SanitizeEmail.force_sanitize = original
+    end
 
-  # Setup Deprecations!
-  class << self
-    extend SanitizeEmail::Deprecation
     deprecated_alias :sanitized_recipients, :sanitized_to
     deprecated :local_environments, :activation_proc
   end
+  @force_sanitize = nil
 end
 
 SanitizeEmail::Version.class_eval do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Peter Boling
@@ -38,7 +38,7 @@ cert_chain:
   KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
   pF8dMA==
   -----END CERTIFICATE-----
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -74,82 +74,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.4
-- !ruby/object:Gem::Dependency
-  name: actionmailer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 1.7.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '8'
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -237,10 +217,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/pboling/sanitize_email
-  source_code_uri: https://github.com/pboling/sanitize_email/tree/v2.0.5
-  changelog_uri: https://github.com/pboling/sanitize_email/blob/v2.0.5/CHANGELOG.md
+  source_code_uri: https://github.com/pboling/sanitize_email/tree/v2.0.6
+  changelog_uri: https://github.com/pboling/sanitize_email/blob/v2.0.6/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/sanitize_email/issues
-  documentation_uri: https://www.rubydoc.info/gems/sanitize_email/2.0.5
+  documentation_uri: https://www.rubydoc.info/gems/sanitize_email/2.0.6
   wiki_uri: https://github.com/pboling/sanitize_email/wiki
   funding_uri: https://liberapay.com/pboling
   rubygems_mfa_required: 'true'