sanitize_email 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dad83c2fc389a4b7fc0c71bad51a426385cb7f3b
-  data.tar.gz: 381499e8ecdfa1e68e8dc6dcec6424a5f70cc692
+  metadata.gz: 8f2dcec848cb80945d5c1e1401891002dc28fb62
+  data.tar.gz: b1b05a2965281e341720c78ceac9b66e10cdbf71
 SHA512:
-  metadata.gz: c19005b057992350619501523f542e55a62d7eca91f9fac6260989c831e204cc46b9f7be96e3856c44144e4cff086e283439598e9ec4e680cf4e0aeb30cedd4a
-  data.tar.gz: e22805701740b748658f462799b640e04b0ab13c8b4eaa0e62c38c56c2979a7e0697ef605f2daec810f644561d6a774523f430b24c0cce9403065d2b13b54063
+  metadata.gz: 0755c678a8004229ee7f5368798bfe5f33c5ab55170a99b4b8ebb65d2132b8d99bade1ab6e448df6b556c3eca9582e93a667c5ada1799b0bb1b03030677b266d
+  data.tar.gz: ad9ae2126562b3beec645ca2cc2bb48d233cf5cbd1013162c60c509ebfe0c3dcf685a009954db92b259593a0a754c2f4d6f3ff322be666fc3d75e2c4a75e2e5d

data/.travis.yml

@@ -1,22 +1,27 @@
 language: ruby
+cache: bundler
+sudo: false
 rvm:
-  - 2.0.0
-  - 2.1.7
-  - 2.2.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
 gemfile:
   - gemfiles/Gemfile.rails-3.2.x
   - gemfiles/Gemfile.rails-4.0.x
   - gemfiles/Gemfile.rails-4.1.x
   - gemfiles/Gemfile.rails-4.2.x
 matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: 1.9
   exclude:
-    - rvm: 2.0.0
+    - rvm: 2.0
       gemfile: gemfiles/Gemfile.rails-4.2.x
-    - rvm: 2.1.7
+    - rvm: 2.1
       gemfile: gemfiles/Gemfile.rails-4.2.x
-matrix:
   include:
-    - rvm: 1.9.3
+    - rvm: 1.9
       gemfile: gemfiles/Gemfile.rails-3.0.x
-    - rvm: 1.9.3
+    - rvm: 1.9
       gemfile: gemfiles/Gemfile.rails-3.1.x

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 HEAD
 
+Version 1.2.0- JUL.24.2016
+* No longer registers instance of SanitizeEmail::Bleach to avoid the dev env reloading problem (fixes #12)
+* Instead registers SanitizeEmail::Bleach class.
+* Deprecate sending arguments to SanitizeEmail::Bleach.new
+
 Version 1.1.7 - AUG.30.2015
 * No API changes
 * General improvement to the code base by Peter Boling

data/README.md

@@ -6,17 +6,18 @@ This gem allows you to override your mail delivery settings, globally or in a lo
 |------------------------ | ----------------- |
 | gem name                |  sanitize_email   |
 | license                 |  MIT              |
-| moldiness               |  [![Maintainer Status](http://stillmaintained.com/pboling/sanitize_email.png)](http://stillmaintained.com/pboling/sanitize_email) |
-| version                 |  [![Gem Version](https://badge.fury.io/rb/sanitize_email.png)](http://badge.fury.io/rb/sanitize_email) |
+| expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
+| download rank               |  [![Total Downloads](https://img.shields.io/gem/rt/sanitize_email.svg)](https://rubygems.org/gems/sanitize_email) |
+| version                 |  [![Version](https://img.shields.io/gem/v/sanitize_email.svg)](https://rubygems.org/gems/sanitize_email) |
 | dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/sanitize_email.png)](https://gemnasium.com/pboling/sanitize_email) |
-| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/sanitize_email.png)](https://codeclimate.com/github/pboling/sanitize_email) |
-| inline documenation     |  [![Inline docs](http://inch-ci.org/github/pboling/sanitize_email.png)](http://inch-ci.org/github/pboling/sanitize_email) |
-| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/sanitize_email.png?branch=master)](https://travis-ci.org/pboling/sanitize_email) |
+| code quality            |  [![Code Quality](https://img.shields.io/codeclimate/github/pboling/sanitize_email.svg)](https://codeclimate.com/github/pboling/sanitize_email) |
+| inline documenation     |  [![Documentation](http://inch-ci.org/github/pboling/sanitize_email.png)](http://inch-ci.org/github/pboling/sanitize_email) |
+| continuous integration  |  [![Build](https://img.shields.io/travis/pboling/sanitize_email.svg)](https://travis-ci.org/pboling/sanitize_email) |
 | test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/sanitize_email/badge.png)](https://coveralls.io/r/pboling/sanitize_email) |
-| homepage                |  [https://github.com/pboling/sanitize_email][homepage] |
+| homepage                |  [http://www.railsbling.com/tags/sanitize_email/][homepage] |
 | documentation           |  [http://rdoc.info/github/pboling/sanitize_email/frames][documentation] |
-| author                  |  [Peter Boling](https://coderbits.com/pboling) |
-| Spread ~♡ⓛⓞⓥⓔ♡~      |  [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
+| live chat               |  [![Join the chat at https://gitter.im/pboling/sanitize_email](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/sanitize_email?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [on Coderbits](https://coderbits.com/pboling), [on Coderwall](http://coderwall.com/pboling) |
 
 ## Summary
 
@@ -58,41 +59,47 @@ SanitizeEmail comes with some lightweight RspecMatchers covering most of what em
 
 In Gemfile:
 
-    gem 'sanitize_email'
+```ruby
+gem 'sanitize_email'
+```
 
 Then:
 
-    $ bundle install
+```bash
+$ bundle install
+```
 
 ## Setup with Ruby
 
 *keep scrolling for Rails, but read this for a better understanding of Magic*
 
-There are four ways SanitizeEmail can be turned on; in order of precedence they are:
-
-1. Only useful for local context.  Inside a method where you will be sending an email, set SanitizeEmail.force_sanitize = true just prior to delivering it.  Also useful in the console.
-
-        SanitizeEmail.force_sanitize = true # by default it is nil
+There are three ways SanitizeEmail can be turned on; in order of precedence they are:
 
-2. If SanitizeEmail seems to not be sanitizing you have probably not registered the interceptor.  SanitizeEmail tries to do this for you. *Note*: If you are working in an environment that has a Mail or Mailer class that uses the register_interceptor API, the interceptor will already have been registered by SanitizeEmail (however, note lack of `:engage => true):
+1. Only useful for local context.  Inside a method where you will be sending an email, set `SanitizeEmail.force_sanitize = true` just prior to delivering it.  Also useful in the console.
 
-        Mail.register_interceptor(SanitizeEmail::Bleach.new(:engage => true)) # by default :engage is nil
+    ```ruby
+    SanitizeEmail.force_sanitize = true # by default it is nil
+    ```
 
-    Without :engage => true the interceptor is inactive, and will require engaging via one of the other methods.
+2. If SanitizeEmail seems to not be sanitizing you have probably not registered the interceptor.  SanitizeEmail tries to do this for you. *Note*: If you are working in an environment that has a Mail or Mailer class that uses the register_interceptor API, the interceptor will already have been registered by SanitizeEmail:
 
-        Mail.register_interceptor(SanitizeEmail::Bleach.new)
+    ```ruby
+    # The gem will probably have already done this for you, but some really old versions of Rails may need you to do this manually:
+    Mail.register_interceptor(SanitizeEmail::Bleach)
+    ```
 
-    As an example you could do the following to engage SanitizeEmail:
+    Once registered, SanitizeEmail needs to be engaged:
 
-        SanitizeEmail::Config.configure {|config| config[:engage] = true }
+    ```ruby
+    # in config/initializers/sanitize_email.rb
+    SanitizeEmail::Config.configure {|config| config[:engage] = true }
+    ```
 
-3. If you don't need to compute anything, then don't use this option, go with the next option.
+3. If you don't need to compute anything, then don't use this option, go with the previous option.
 
-        SanitizeEmail::Config.configure {|config| config[:activation_proc] = Proc.new { true } } # by default :activation_proc is false
-
-4. This will turn it on.  Period.
-
-        SanitizeEmail::Config.configure {|config| config[:engage] = true } # by default :engage is nil
+    ```ruby
+    SanitizeEmail::Config.configure {|config| config[:activation_proc] = Proc.new { true } } # by default :activation_proc is false
+    ```
 
 ### Notes
 
@@ -103,7 +110,11 @@ If installed but not configured, sanitize_email DOES NOTHING.  Until configured
 
 IMPORTANT: You may need to setup your own register_interceptor.  If sanitize_email doesn't seem to be working for you find your Mailer/Mail class and try this:
 
-        Mail.register_interceptor(SanitizeEmail::Bleach.new(:engage => true))
+```ruby
+# in config/initializers/sanitize_email.rb
+Mail.register_interceptor(SanitizeEmail::Bleach)
+SanitizeEmail::Config.configure {|config| config[:engage] = true }
+```
 
 If that causes an error you will know why sanitize_email doesn't work.
 Otherwise it will start working according to the rest of the configuration.
@@ -112,7 +123,7 @@ Otherwise it will start working according to the rest of the configuration.
 
 Create an initializer, if you are using rails, or otherwise configure:
 
-```
+```ruby
 SanitizeEmail::Config.configure do |config|
   config[:sanitized_to] =         'to@sanitize_email.org'
   config[:sanitized_cc] =         'cc@sanitize_email.org'
@@ -133,7 +144,7 @@ Let's say you have a method in your model that you can call to test the signup e
 
 To override the environment based switch use `force_sanitize`, which is normally `nil`, and ignored by default. When set to `true` or `false` it will turn sanitization on or off:
 
-```
+```ruby
   SanitizeEmail.force_sanitize = true
 ```
 
@@ -141,7 +152,7 @@ There are also two methods that take a block and turn SanitizeEmail on or off:
 
 Regardless of the Config settings of SanitizeEmail you can do a local override to force unsanitary email in any environment.
 
-```
+```ruby
   SanitizeEmail.unsanitary do
     Mail.deliver do
       from      'from@example.org'
@@ -154,9 +165,9 @@ Regardless of the Config settings of SanitizeEmail you can do a local override t
 
 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.configure` block.
 
-```
+```ruby
   SanitizeEmail.sanitary({:sanitized_to => 'boo@example.com'}) do # these config options are merged with the globals
     Mail.deliver do
       from      'from@example.org'
@@ -173,114 +184,128 @@ SanitizeEmail.configure block.
 
 In your `spec_helper.rb`:
 
-        require 'sanitize_email'
-        # rspec matchers are *not* loaded by default in sanitize_email, as it is not primarily a gem for test suites.
-        require 'sanitize_email/rspec_matchers'
-
-        SanitizeEmail::Config.configure do |config|
-          config[:sanitized_to] =         'sanitize_email@example.org'
-          config[:sanitized_cc] =         'sanitize_email@example.org'
-          config[:sanitized_bcc] =        'sanitize_email@example.org'
-          # run/call whatever logic should turn sanitize_email on and off in this Proc.
-          # config[:activation_proc] =      Proc.new { true }
-          # Since this configuration is *inside* the spec_helper, it might be assumed that we always want to sanitize.  If we don't want to it can be easily manipulated with SanitizeEmail.unsanitary and SanitizeEmail.sanitary block helpers.
-          # Thus instead of using the Proc (slower) we just engage it always:
-          config[:engage] = true
-          config[:use_actual_email_prepended_to_subject] = true         # or false
-          config[:use_actual_environment_prepended_to_subject] = true   # or false
-          config[:use_actual_email_as_sanitized_user_name] = true       # or false
-        end
-
-        # If your mail system is not one that sanitize_email automatically configures an interceptor for (ActionMailer, Mail) then you will need to do the equivalent for whatever Mail system you are using:
-        # Mail.register_interceptor(SanitizeEmail::Bleach.new)
-
-        RSpec.configure do |config|
-          # ...
-          # From sanitize_email gem
-          config.include SanitizeEmail::RspecMatchers
-        end
-
-        context "an email test" do
-          subject { Mail.deliver(@message_hash) }
-          it { should have_to "sanitize_email@example.org" }
-        end
+```ruby
+require 'sanitize_email'
+# rspec matchers are *not* loaded by default in sanitize_email, as it is not primarily a gem for test suites.
+require 'sanitize_email/rspec_matchers'
+
+SanitizeEmail::Config.configure do |config|
+  config[:sanitized_to] =         'sanitize_email@example.org'
+  config[:sanitized_cc] =         'sanitize_email@example.org'
+  config[:sanitized_bcc] =        'sanitize_email@example.org'
+  # run/call whatever logic should turn sanitize_email on and off in this Proc.
+  # config[:activation_proc] =      Proc.new { true }
+  # Since this configuration is *inside* the spec_helper, it might be assumed that we always want to sanitize.  If we don't want to it can be easily manipulated with SanitizeEmail.unsanitary and SanitizeEmail.sanitary block helpers.
+  # Thus instead of using the Proc (slower) we just engage it always:
+  config[:engage] = true
+  config[:use_actual_email_prepended_to_subject] = true         # or false
+  config[:use_actual_environment_prepended_to_subject] = true   # or false
+  config[:use_actual_email_as_sanitized_user_name] = true       # or false
+end
+
+# If your mail system is not one that sanitize_email automatically configures an interceptor for (ActionMailer, Mail) 
+# then you will need to do the equivalent for whatever Mail system you are using.
+
+RSpec.configure do |config|
+  # ...
+  # From sanitize_email gem
+  config.include SanitizeEmail::RspecMatchers
+end
+
+context "an email test" do
+  subject { Mail.deliver(@message_hash) }
+  it { should have_to "sanitize_email@example.org" }
+end
+```
 
 #### have_* matchers
 
 These will look for an email address in any of the following
 
-        :from, :to, :cc, :bcc, :subject, :reply_to
+```ruby
+:from, :to, :cc, :bcc, :subject, :reply_to
+```
 
 Example:
 
-        context "the subject line must have the email address sanitize_email@example.org" do
-          subject { Mail.deliver(@message_hash) }
-          it { should have_subject "sanitize_email@example.org" }
-        end
+```ruby
+context "the subject line must have the email address sanitize_email@example.org" do
+  subject { Mail.deliver(@message_hash) }
+  it { should have_subject "sanitize_email@example.org" }
+end
+```
 
 #### be_* matchers
 
 These will look for a matching string in any of the following
 
-        :from, :to, :cc, :bcc, :subject, :reply_to
+```ruby
+:from, :to, :cc, :bcc, :subject, :reply_to
+```
 
 Example:
 
-        context "the subject line must have the string 'foobarbaz'" do
-          subject { Mail.deliver(@message_hash) }
-          it { should be_subject "foobarbaz" }
-        end
+```ruby
+context "the subject line must have the string 'foobarbaz'" do
+  subject { Mail.deliver(@message_hash) }
+  it { should be_subject "foobarbaz" }
+end
+```
 
 #### have_to_username matcher
 
 The `username` in the `:to` field is when the `:to` field is formatted like this:
 
-        Peter Boling <sanitize_email@example.org>
+`Peter Boling <sanitize_email@example.org>`
 
 Example:
 
-        context "the to field must have the username 'Peter Boling'" do
-          subject { Mail.deliver(@message_hash) }
-          it { should have_to_username "Peter Boling" }
-        end
+```ruby
+context "the to field must have the username 'Peter Boling'" do
+  subject { Mail.deliver(@message_hash) }
+  it { should have_to_username "Peter Boling" }
+end
+```
 
 ### non-rspec (Test::Unit, mini-test, etc)
 
 In your setup file:
 
-        require 'sanitize_email'
-        # test helpers are *not* loaded by default in sanitize_email, as it is not primarily a gem for test suites.
-        require 'sanitize_email/test_helpers'
-
-        SanitizeEmail::Config.configure do |config|
-          config[:sanitized_to] =         'sanitize_email@example.org'
-          config[:sanitized_cc] =         'sanitize_email@example.org'
-          config[:sanitized_bcc] =        'sanitize_email@example.org'
-          # run/call whatever logic should turn sanitize_email on and off in this Proc.
-          # config[:activation_proc] =      Proc.new { true }
-          # Since this configuration is *inside* the spec_helper, it might be assumed that we always want to sanitize.  If we don't want to it can be easily manipulated with SanitizeEmail.unsanitary and SanitizeEmail.sanitary block helpers.
-          # Thus instead of using the Proc (slower) we just engage it always:
-          config[:engage] = true
-          config[:use_actual_email_prepended_to_subject] = true         # or false
-          config[:use_actual_environment_prepended_to_subject] = true   # or false
-          config[:use_actual_email_as_sanitized_user_name] = true       # or false
-        end
-
-        # If your mail system is not one that sanitize_email automatically configures an interceptor for (ActionMailer, Mail) then you will need to do the equivalent for whatever Mail system you are using:
-        # Mail.register_interceptor(SanitizeEmail::Bleach.new)
-
-        # You need to know what to do here... somehow get the methods into rhw scope of your tests.
-        # Something like this maybe?
-        include SanitizeEmail::TestHelpers
-        # Look here to see what it gives you:
-        # https://github.com/pboling/sanitize_email/blob/master/lib/sanitize_email/test_helpers.rb
+```ruby
+require 'sanitize_email'
+# test helpers are *not* loaded by default in sanitize_email, as it is not primarily a gem for test suites.
+require 'sanitize_email/test_helpers'
+
+SanitizeEmail::Config.configure do |config|
+  config[:sanitized_to] =         'sanitize_email@example.org'
+  config[:sanitized_cc] =         'sanitize_email@example.org'
+  config[:sanitized_bcc] =        'sanitize_email@example.org'
+  # run/call whatever logic should turn sanitize_email on and off in this Proc.
+  # config[:activation_proc] =      Proc.new { true }
+  # Since this configuration is *inside* the spec_helper, it might be assumed that we always want to sanitize.  If we don't want to it can be easily manipulated with SanitizeEmail.unsanitary and SanitizeEmail.sanitary block helpers.
+  # Thus instead of using the Proc (slower) we just engage it always:
+  config[:engage] = true
+  config[:use_actual_email_prepended_to_subject] = true         # or false
+  config[:use_actual_environment_prepended_to_subject] = true   # or false
+  config[:use_actual_email_as_sanitized_user_name] = true       # or false
+end
+
+# If your mail system is not one that sanitize_email automatically configures an interceptor for (ActionMailer, Mail) 
+# then you will need to do the equivalent for whatever Mail system you are using.
+
+# You need to know what to do here... somehow get the methods into rhw scope of your tests.
+# Something like this maybe?
+include SanitizeEmail::TestHelpers
+# Look here to see what it gives you:
+# https://github.com/pboling/sanitize_email/blob/master/lib/sanitize_email/test_helpers.rb
+```
 
 ## Deprecations
 
 Sometimes things get deprecated (meaning they still work, but are noisy about it).  If this happens to you, and you like your head in the sand, call this number:
 
-```
-  SanitizeEmail::Deprecation.deprecate_in_silence = true
+```ruby
+SanitizeEmail::Deprecation.deprecate_in_silence = true
 ```
 
 ## Authors
@@ -296,15 +321,11 @@ See the [Network View](https://github.com/pboling/sanitize_email/network) and th
 
 Take a look at the `reek` list which is the file called `REEK` and stat fixing things.  Once you complete a change, run the tests:
 
-```
-bundle exec rake test:all
-```
+`bundle exec rake test:all`
 
 If the tests pass refresh the `reek` list:
 
-```
-bundle exec reek > REEK
-```
+`bundle exec reek > REEK`
 
 Follow the instructions for "Contributing" below.
 
@@ -331,7 +352,9 @@ dependency on this gem using the [Pessimistic Version Constraint][pvc] with two
 
 For example:
 
-    spec.add_dependency 'sanitize_email', '~> 1.1'
+```ruby
+spec.add_dependency 'sanitize_email', '~> 1.1'
+```
 
 ## References
 
@@ -351,8 +374,4 @@ For example:
 [railsbling]: http://www.railsbling.com
 [peterboling]: http://www.peterboling.com
 [documentation]: http://rdoc.info/github/pboling/sanitize_email/frames
-[homepage]: https://github.com/pboling/sanitize_email
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/pboling/sanitize_email/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-
+[homepage]: http://www.railsbling.com/tags/sanitize_email/

data/gemfiles/Gemfile.rails-3.0.x

@@ -4,3 +4,4 @@ gemspec :path => '..'
 
 gem "rails", "~> 3.0.0"
 gem "reek", "~> 2.0" # for Ruby < 2.0
+gem "tins", "~> 1.6.0" # for Ruby < 2.0

data/gemfiles/Gemfile.rails-3.1.x

@@ -5,3 +5,4 @@ gemspec :path => '..'
 gem "actionmailer", "~> 3.1.0"
 gem "railties", "~> 3.1.0"
 gem "reek", "~> 2.0" # for Ruby < 2.0
+gem "tins", "~> 1.6.0" # for Ruby < 2.0

data/gemfiles/Gemfile.rails-3.2.x

@@ -4,3 +4,6 @@ gemspec :path => '..'
 
 gem "actionmailer", "~> 3.2.0"
 gem "railties", "~> 3.2.0"
+
+# reek >= 4.0 requires Ruby 2.1 minimum
+gem "reek", "3.11"

data/gemfiles/Gemfile.rails-4.0.x

@@ -4,3 +4,6 @@ gemspec :path => '..'
 
 gem "actionmailer", "~> 4.0.0"
 gem "railties", "~> 4.0.0"
+
+# reek >= 4.0 requires Ruby 2.1 minimum
+gem "reek", "3.11"

data/gemfiles/Gemfile.rails-4.1.x

@@ -4,3 +4,6 @@ gemspec :path => '..'
 
 gem "actionmailer", "~> 4.1.0"
 gem "railties", "~> 4.1.0"
+
+# reek >= 4.0 requires Ruby 2.1 minimum
+gem "reek", "3.11"

data/lib/sanitize_email/bleach.rb

@@ -1,24 +1,31 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
-  # SanitizeEmail::Bleach determines whether to sanitize the headers of an email, and does so when appropriate.
+  # Determines whether to sanitize the headers of an email,
+  #   and does so when appropriate.
   class Bleach
+    extend SanitizeEmail::Deprecation
+    attr_accessor :overridden_addresses # TODO: Just a stub, not implemented
 
-    # Can override global configs at the instance level.
-    attr_accessor :engage, # Turn sanitization on or off just for this instance
-                  :overridden_addresses # TODO: Just a stub.  Needs actual implementation
-
-    def initialize(args = {})
-      # Not using extract_options! because non-rails compatibility is a goal
-      @engage = args[:engage] || SanitizeEmail::Config.config[:engage]
+    def initialize(*args)
+      deprecation_message = <<EOS
+SanitizeEmail:
+  Passing arguments to SanitizeEmail::Bleach.new is deprecated.
+  SanitizeEmail::Bleach.new now takes no arguments.
+EOS
+      if !args.empty?
+        self.class.deprecation_warning_message(deprecation_message)
+      end
     end
 
     # If all recipient addresses are white-listed the field is left alone.
-    def delivering_email(message)
+    def self.delivering_email(message)
       if self.sanitize_engaged?(message)
-        SanitizeEmail::MailHeaderTools.add_original_addresses_as_headers(message)
-        SanitizeEmail::MailHeaderTools.prepend_custom_subject(message)
+        SanitizeEmail::MailHeaderTools.
+          add_original_addresses_as_headers(message)
+        SanitizeEmail::MailHeaderTools.
+          prepend_custom_subject(message)
 
         overridden = SanitizeEmail::OverriddenAddresses.new(message)
 
@@ -28,28 +35,47 @@ module SanitizeEmail
       end
     end
 
-    # This method will be called by the Hook to determine if an override should occur
-    # There are four ways SanitizeEmail can be turned on; in order of precedence they are:
+    # Will be called by the Hook to determine if an override should occur
+    # There are three ways SanitizeEmail can be turned on;
+    #   in order of precedence they are:
     #
     # 1. SanitizeEmail.force_sanitize = true # by default it is nil
-    #   Only useful for local context.  Inside a method where you will be sending an email,
-    #   set SanitizeEmail.force_sanitize = true just prior to delivering it.  Also useful in the console.
-    # 2. Mail.register_interceptor(SanitizeEmail::Bleach.new(:engage => true)) # by default it is nil
-    #   If SanitizeEmail seems to not be sanitizing you have probably not registered the interceptor.  SanitizeEmail tries to do this for you.
-    #   Note: If you are working in an environment that has a Mail or Mailer class that uses the register_interceptor API, the interceptor will already have been registered by SanitizeEmail (however, note lack of :engage => true):
-    #     Mail.register_interceptor(SanitizeEmail::Bleach.new
-    #   Without :engage => true the interceptor is inactive, and will require engaging via one of the other methods.
-    #   As an example you could do the following to engage SanitizeEmail:
+    #   Only useful for local context.
+    #   Inside a method where you will be sending an email, set
+    #
+    #     SanitizeEmail.force_sanitize = true
+    #
+    #   just prior to delivering it.  Also useful in the console.
+    #
+    # 2. If SanitizeEmail seems to not be sanitizing,
+    #     you have probably not registered the interceptor.
+    #   SanitizeEmail tries to do this for you.
+    #   *Note*: If you are working in an environment that has
+    #           a Mail or Mailer class that uses the register_interceptor API,
+    #           the interceptor will already have been registered.
+    #   The gem will probably have already done this for you,
+    #   but some really old versions of Rails may need you to do this manually:
+    #
+    #     Mail.register_interceptor(SanitizeEmail::Bleach)
+    #
+    #   Once registered, SanitizeEmail needs to be engaged:
+    #
+    #     # in config/initializers/sanitize_email.rb
     #     SanitizeEmail::Config.configure {|config| config[:engage] = true }
-    # 3. SanitizeEmail::Config.configure {|config| config[:activation_proc] = Proc.new { true } } # by default it is false
-    #   If you don't need to compute anything, then don't use the Proc, go with the next option.
-    # 4. SanitizeEmail::Config.configure {|config| config[:engage] = true } # by default it is nil
+    #
+    # 3. SanitizeEmail::Config.configure do |config|
+    #      config[:activation_proc] = Proc.new { true }
+    #    end
+    #
+    #   If you don't need to compute anything,
+    #     then don't use the Proc, go with the previous option.
     #
     # Note: Number 1 is the method used by the SanitizeEmail.sanitary block
-    # Note: Number 2 See note accompanying 2: you may need to setup your own register_interceptor
+    # Note: Number 2 You may need to setup your own register_interceptor
     #
-    # If installed but not configured, sanitize_email DOES NOTHING.  Until configured the defaults leave it turned off.
-    def sanitize_engaged?(message)
+    # If installed but not configured, sanitize_email DOES NOTHING.
+    # Until configured the defaults leave it turned off.
+    def self.sanitize_engaged?(message)
 
       # Don't sanitize the message if it will not be delivered
       return false unless message.perform_deliveries
@@ -59,7 +85,7 @@ module SanitizeEmail
       return forced unless forced.nil?
 
       # Is this particular instance of Bleach engaged
-      engaged = self.engage
+      engaged = SanitizeEmail::Config.config[:engage]
       return engaged unless engaged.nil?
 
       # Should we sanitize due to the activation_proc?

data/lib/sanitize_email/config.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail

data/lib/sanitize_email/deprecation.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail

data/lib/sanitize_email/engine.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
@@ -6,7 +6,7 @@ module SanitizeEmail
   class Engine < ::Rails::Engine
 
     config.to_prepare do
-      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach.new)
+      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach)
     end
 
   end

data/lib/sanitize_email/mail_header_tools.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail

data/lib/sanitize_email/overridden_addresses.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail

data/lib/sanitize_email/railtie.rb

@@ -1,12 +1,12 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
-# For Rails 3.0, which didn't yet support Engines
+  # For Rails 3.0, which didn't yet support Engines
   class Railtie < ::Rails::Railtie
 
     config.after_initialize do
-      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach.new)
+      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach)
     end
 
   end

data/lib/sanitize_email/rspec_matchers.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# 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'

data/lib/sanitize_email/test_helpers.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail

data/lib/sanitize_email/version.rb

@@ -1,6 +1,6 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
-  VERSION = '1.1.7'
+  VERSION = '1.2.0'
 end

data/lib/sanitize_email.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
@@ -28,7 +28,7 @@ module SanitizeEmail
       mailer = Mail
     end
     if mailer.respond_to?(:register_interceptor)
-      mailer.register_interceptor(SanitizeEmail::Bleach.new)
+      mailer.register_interceptor(SanitizeEmail::Bleach)
     else
       warn "SanitizeEmail was unable to detect a compatible Mail class to register an interceptor on."
     end

data/sanitize_email.gemspec

@@ -33,6 +33,7 @@ EOS
   #s.add_runtime_dependency("facets", ["> 0"])
 
   # Development Dependencies
+  s.add_development_dependency "bundler"
   s.add_development_dependency("rails", [">= 3.0"])
   s.add_development_dependency("actionmailer", [">= 3.0"])
   s.add_development_dependency("letter_opener", [">= 0"])

data/spec/sanitize_email_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 require 'spec_helper'
 
@@ -56,7 +56,7 @@ describe SanitizeEmail do
       config[:sanitized_recipients] = options[:sanitized_recipients] if options[:sanitized_recipients]
       config[:force_sanitize] = options[:force_sanitize] unless options[:force_sanitize].nil?
     end
-    Mail.register_interceptor(SanitizeEmail::Bleach.new)
+    Mail.register_interceptor(SanitizeEmail::Bleach)
   end
 
   def funky_config
@@ -70,7 +70,7 @@ describe SanitizeEmail do
       config[:use_actual_environment_prepended_to_subject] = true
       config[:use_actual_email_as_sanitized_user_name] = false
     end
-    Mail.register_interceptor(SanitizeEmail::Bleach.new)
+    Mail.register_interceptor(SanitizeEmail::Bleach)
   end
 
   def sanitary_mail_delivery(config_options = {})

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-16 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 require 'launchy'
 require 'mail'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Peter Boling
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rails
   requirement: !ruby/object:Gem::Requirement