sanitize_email 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c390a96c6347527bd9d4b0833a65ad16e3a837
-  data.tar.gz: 02b106a696439a87a0001370d25316d7df494340
+  metadata.gz: dad83c2fc389a4b7fc0c71bad51a426385cb7f3b
+  data.tar.gz: 381499e8ecdfa1e68e8dc6dcec6424a5f70cc692
 SHA512:
-  metadata.gz: 8854adb0d44027a38fde49d390c1d9f1e43e149800ff0f87e67f110427f646ae355e18bf42880d1f5449f9df2c4b621ec707c1f5db8560a2f85041bdf5041906
-  data.tar.gz: 2b13251443bf8ad2f63dd7e4bdb41d721e373842907e3d3913bd1b8f952eddd258ac66a447bee79c3d3cacbf0745cdbd593eb7e269b0fd84f6c69d8c92de7cce
+  metadata.gz: c19005b057992350619501523f542e55a62d7eca91f9fac6260989c831e204cc46b9f7be96e3856c44144e4cff086e283439598e9ec4e680cf4e0aeb30cedd4a
+  data.tar.gz: e22805701740b748658f462799b640e04b0ab13c8b4eaa0e62c38c56c2979a7e0697ef605f2daec810f644561d6a774523f430b24c0cce9403065d2b13b54063

data/.reek

@@ -0,0 +1,9 @@
+# attr_accessor is, in many cases, better than @instance variables which fail silently on typos, IMO
+Attribute:
+  enabled: false
+# One line methods are awesome, but need to focus on bigger problems first.  Will lower this number as the code improves.
+TooManyStatements:
+  max_statements: 8
+FeatureEnvy:
+  exclude:
+  - delivering_email

data/.travis.yml

@@ -1,22 +1,22 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.1.5
-  - jruby-19mode
-#  - rbx-19mode
-#  - ruby-head
+  - 2.1.7
+  - 2.2.3
 gemfile:
-  - gemfiles/Gemfile.rails-3.0.x
-  - gemfiles/Gemfile.rails-3.1.x
   - 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:
   exclude:
-    - rvm: 1.8.7
-      gemfile: gemfiles/Gemfile.rails-4.0.x
-    - rvm: 1.9.2
-      gemfile: gemfiles/Gemfile.rails-4.0.x
-    - rvm: jruby-19mode
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.rails-4.2.x
+    - rvm: 2.1.7
+      gemfile: gemfiles/Gemfile.rails-4.2.x
+matrix:
+  include:
+    - rvm: 1.9.3
       gemfile: gemfiles/Gemfile.rails-3.0.x
+    - rvm: 1.9.3
+      gemfile: gemfiles/Gemfile.rails-3.1.x

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+HEAD
+
+Version 1.1.7 - AUG.30.2015
+* No API changes
+* General improvement to the code base by Peter Boling
+  - small refactorings
+  - documentation
+  - setup reek properly
+  - Fixed travis build matrix, added latest Ruby and Rails, and bumped patch releases
+
 Version 1.1.6 - AUG.29.2015
 * spec run as default rake task & improve Rakefile syntax by Peter Boling
 * prevent direct configuration via `DEFAULTS` from working, as that is not the API by Peter Boling

data/README.md

@@ -303,7 +303,7 @@ bundle exec rake test:all
 If the tests pass refresh the `reek` list:
 
 ```
-bundle exec rake reek > REEK
+bundle exec reek > REEK
 ```
 
 Follow the instructions for "Contributing" below.
@@ -331,7 +331,7 @@ dependency on this gem using the [Pessimistic Version Constraint][pvc] with two
 
 For example:
 
-    spec.add_dependency 'sanitize_email', '~> 1.0.8'
+    spec.add_dependency 'sanitize_email', '~> 1.1'
 
 ## References
 
@@ -343,7 +343,7 @@ For example:
 ## Legal
 
 * MIT License - See LICENSE file in this project
-* Copyright (c) 2008-2014 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
+* Copyright (c) 2008-2015 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
 * Copyright (c) 2009 [John Trupiano](http://smartlogicsolutions.com/wiki/John_Trupiano) of [SmartLogic Solutions, LLC](http://www.smartlogicsolutions.com)
 
 [semver]: http://semver.org/

data/REEK

@@ -1,48 +1,37 @@
-lib/sanitize_email.rb -- 3 warnings:
-  SanitizeEmail#self.sanitary calls SanitizeEmail::Config.config twice (DuplicateMethodCall)
-  SanitizeEmail#self.sanitary has approx 6 statements (TooManyStatements)
-  SanitizeEmail::MissingBlockParameter has no descriptive comment (IrresponsibleModule)
-lib/sanitize_email/bleach.rb -- 5 warnings:
-  SanitizeEmail::Bleach#delivering_email has approx 6 statements (TooManyStatements)
-  SanitizeEmail::Bleach#delivering_email has the variable name 'o' (UncommunicativeVariableName)
-  SanitizeEmail::Bleach#delivering_email refers to message more than self (FeatureEnvy)
-  SanitizeEmail::Bleach#delivering_email refers to o more than self (FeatureEnvy)
-  SanitizeEmail::Bleach#sanitize_engaged? has approx 6 statements (TooManyStatements)
-lib/sanitize_email/config.rb -- 4 warnings:
-  SanitizeEmail::Config has no descriptive comment (IrresponsibleModule)
-  SanitizeEmail::Config#self.configure calls @config[:force_sanitize] twice (DuplicateMethodCall)
-  SanitizeEmail::Config#self.configure calls @config[:sanitized_recipients] twice (DuplicateMethodCall)
-  SanitizeEmail::Config#self.configure has approx 7 statements (TooManyStatements)
-lib/sanitize_email/deprecation.rb -- 2 warnings:
-  SanitizeEmail::Deprecation takes parameters [name, replacement] to 3 methods (DataClump)
-  SanitizeEmail::Deprecation#deprecation is controlled by argument replacement (ControlParameter)
-lib/sanitize_email/engine.rb -- 1 warning:
-  SanitizeEmail::Engine has no descriptive comment (IrresponsibleModule)
-lib/sanitize_email/mail_header_tools.rb -- 8 warnings:
-  SanitizeEmail::MailHeaderTools#self.add_original_addresses_as_headers has the variable name 'k' (UncommunicativeVariableName)
-  SanitizeEmail::MailHeaderTools#self.add_original_addresses_as_headers has the variable name 'v' (UncommunicativeVariableName)
-  SanitizeEmail::MailHeaderTools#self.prepend_environment_to_subject calls Rails.env twice (DuplicateMethodCall)
-  SanitizeEmail::MailHeaderTools#self.update_header calls (index + 1) twice (DuplicateMethodCall)
-  SanitizeEmail::MailHeaderTools#self.update_header has the parameter name 'k' (UncommunicativeParameterName)
-  SanitizeEmail::MailHeaderTools#self.update_header has the parameter name 'v' (UncommunicativeParameterName)
-  SanitizeEmail::MailHeaderTools#self.update_header has the variable name 'a' (UncommunicativeVariableName)
-  SanitizeEmail::MailHeaderTools#self.update_header is controlled by argument v (ControlParameter)
+lib/sanitize_email/bleach.rb -- 1 warning:
+  [59]:SanitizeEmail::Bleach#sanitize_engaged? performs a nil-check (NilCheck)
+lib/sanitize_email/config.rb -- 3 warnings:
+  [64, 72]:SanitizeEmail::Config#self.configure calls @config[:force_sanitize] 2 times (DuplicateMethodCall)
+  [58, 62]:SanitizeEmail::Config#self.configure calls @config[:sanitized_recipients] 2 times (DuplicateMethodCall)
+  [64]:SanitizeEmail::Config#self.configure performs a nil-check (NilCheck)
+lib/sanitize_email/deprecation.rb -- 1 warning:
+  [18, 29, 40]:SanitizeEmail::Deprecation takes parameters [name, replacement] to 3 methods (DataClump)
+lib/sanitize_email/mail_header_tools.rb -- 1 warning:
+  [41, 42]:SanitizeEmail::MailHeaderTools#self.prepend_custom_subject calls message.subject 2 times (DuplicateMethodCall)
 lib/sanitize_email/overridden_addresses.rb -- 7 warnings:
-  SanitizeEmail::OverriddenAddresses has no descriptive comment (IrresponsibleModule)
-  SanitizeEmail::OverriddenAddresses#inject_user_names contains iterators nested 2 deep (NestedIterators)
-  SanitizeEmail::OverriddenAddresses#inject_user_names doesn't depend on instance state (UtilityFunction)
-  SanitizeEmail::OverriddenAddresses#inject_user_names refers to real_recipient more than self (FeatureEnvy)
-  SanitizeEmail::OverriddenAddresses#override_email has approx 10 statements (TooManyStatements)
-  SanitizeEmail::OverriddenAddresses::MissingTo has no descriptive comment (IrresponsibleModule)
-  SanitizeEmail::OverriddenAddresses::UnknownOverride has no descriptive comment (IrresponsibleModule)
-lib/sanitize_email/railtie.rb -- 1 warning:
-  SanitizeEmail::Railtie has no descriptive comment (IrresponsibleModule)
-lib/sanitize_email/rspec_matchers.rb -- 2 warnings:
-  SanitizeEmail::RspecMatchers#get_username doesn't depend on instance state (UtilityFunction)
-  SanitizeEmail::RspecMatchers#get_username refers to email_message more than self (FeatureEnvy)
-lib/sanitize_email/test_helpers.rb -- 4 warnings:
-  SanitizeEmail::TestHelpers takes parameters [mail_or_part, matcher, part] to 3 methods (DataClump)
-  SanitizeEmail::TestHelpers#array_matching refers to mail_or_part more than self (FeatureEnvy)
-  SanitizeEmail::TestHelpers#string_matching refers to mail_or_part more than self (FeatureEnvy)
-  SanitizeEmail::TestHelpers::UnexpectedMailType has no descriptive comment (IrresponsibleModule)
-lib/sanitize_email/version.rb -- 0 warnings
+  [6]:SanitizeEmail::OverriddenAddresses has at least 8 instance variables (TooManyInstanceVariables)
+  [25, 26, 27, 28, 29]:SanitizeEmail::OverriddenAddresses#initialize calls SanitizeEmail::Config.config 5 times (DuplicateMethodCall)
+  [109]:SanitizeEmail::OverriddenAddresses#inject_user_names contains iterators nested 2 deep (NestedIterators)
+  [103]:SanitizeEmail::OverriddenAddresses#inject_user_names doesn't depend on instance state (UtilityFunction)
+  [105]:SanitizeEmail::OverriddenAddresses#inject_user_names performs a nil-check (NilCheck)
+  [56]:SanitizeEmail::OverriddenAddresses#override_email has approx 10 statements (TooManyStatements)
+  [125]:SanitizeEmail::OverriddenAddresses#sanitize_addresses is controlled by argument type (ControlParameter)
+lib/sanitize_email/rspec_matchers.rb -- 1 warning:
+  [35]:SanitizeEmail::RspecMatchers#get_username doesn't depend on instance state (UtilityFunction)
+lib/sanitize_email/test_helpers.rb -- 3 warnings:
+  [11, 15, 28, 33]:SanitizeEmail::TestHelpers takes parameters [mail_or_part, matcher, part] to 4 methods (DataClump)
+  [29, 29]:SanitizeEmail::TestHelpers#array_matching refers to mail_or_part more than self (FeatureEnvy)
+  [16, 18, 20]:SanitizeEmail::TestHelpers#string_matching refers to mail_or_part more than self (FeatureEnvy)
+lib/sanitize_email.rb -- 1 warning:
+  [84, 85]:SanitizeEmail#self.sanitary calls SanitizeEmail::Config.config 2 times (DuplicateMethodCall)
+spec/sanitize_email_spec.rb -- 9 warnings:
+  [57, 57]:configure_sanitize_email calls options[:force_sanitize] 2 times (DuplicateMethodCall)
+  [55, 55]:configure_sanitize_email calls options[:local_environments] 2 times (DuplicateMethodCall)
+  [56, 56]:configure_sanitize_email calls options[:sanitized_recipients] 2 times (DuplicateMethodCall)
+  [41]:configure_sanitize_email doesn't depend on instance state (UtilityFunction)
+  [41]:configure_sanitize_email has approx 15 statements (TooManyStatements)
+  [57]:configure_sanitize_email performs a nil-check (NilCheck)
+  [68]:funky_config contains iterators nested 2 deep (NestedIterators)
+  [62]:funky_config doesn't depend on instance state (UtilityFunction)
+  [62]:funky_config has approx 10 statements (TooManyStatements)
+27 total warnings

data/Rakefile

@@ -27,8 +27,36 @@ namespace :test do
   desc "Test against all supported Rails versions"
   task :all do
     %w(3.0.x 3.1.x 3.2.x 4.0.x).each do |version|
-      sh %[BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet]
-      sh %[BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec]
+      system(<<-EOS
+          bash -i -c "rvm use 1.9.3"
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
+      EOS
+      )
+    end
+    %w(3.2.x 4.0.x 4.1.x).each do |version|
+      system(<<-EOS
+          bash -i -c "rvm use 2.0.0"
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
+        EOS
+      )
+    end
+    %w(3.2.x 4.0.x 4.1.x).each do |version|
+      system(<<-EOS
+          bash -i -c "rvm use 2.1.7"
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
+      EOS
+      )
+    end
+    %w(3.2.x 4.0.x 4.1.x 4.2.x).each do |version|
+      system(<<-EOS
+          bash -i -c "rvm use 2.2.3"
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
+          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
+      EOS
+      )
     end
   end
 end

data/gemfiles/Gemfile.rails-3.0.x

@@ -2,4 +2,5 @@ source "http://rubygems.org"
 
 gemspec :path => '..'
 
-gem "rails", "~> 3.0"
+gem "rails", "~> 3.0.0"
+gem "reek", "~> 2.0" # for Ruby < 2.0

data/gemfiles/Gemfile.rails-3.1.x

@@ -2,5 +2,6 @@ source "http://rubygems.org"
 
 gemspec :path => '..'
 
-gem "actionmailer", "~> 3.1"
-gem "railties", "~> 3.1"
+gem "actionmailer", "~> 3.1.0"
+gem "railties", "~> 3.1.0"
+gem "reek", "~> 2.0" # for Ruby < 2.0

data/gemfiles/Gemfile.rails-3.2.x

@@ -2,5 +2,5 @@ source "http://rubygems.org"
 
 gemspec :path => '..'
 
-gem "actionmailer", "~> 3.2"
-gem "railties", "~> 3.2"
+gem "actionmailer", "~> 3.2.0"
+gem "railties", "~> 3.2.0"

data/gemfiles/Gemfile.rails-4.0.x

@@ -2,5 +2,5 @@ source "http://rubygems.org"
 
 gemspec :path => '..'
 
-gem "actionmailer", "~> 4.0"
-gem "railties", "~> 4.0"
+gem "actionmailer", "~> 4.0.0"
+gem "railties", "~> 4.0.0"

data/gemfiles/Gemfile.rails-4.1.x

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "actionmailer", "~> 4.1.0"
+gem "railties", "~> 4.1.0"

data/gemfiles/Gemfile.rails-4.2.x

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec :path => '..'
+
+gem "actionmailer", "~> 4.2.0"
+gem "railties", "~> 4.2.0"

data/lib/sanitize_email.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
@@ -9,6 +9,7 @@ module SanitizeEmail
   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
 
   # Allow non-rails implementations to use this gem
@@ -38,7 +39,7 @@ module SanitizeEmail
     SanitizeEmail::Config.config[key.to_sym]
   end
 
-  def self.method_missing(name, *args)
+  def self.method_missing(name, *_)
     SanitizeEmail[name]
   end
 

data/lib/sanitize_email/bleach.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
@@ -7,7 +7,7 @@ module SanitizeEmail
 
     # Can override global configs at the instance level.
     attr_accessor :engage, # Turn sanitization on or off just for this instance
-                  :overridden_addresses
+                  :overridden_addresses # TODO: Just a stub.  Needs actual implementation
 
     def initialize(args = {})
       # Not using extract_options! because non-rails compatibility is a goal
@@ -20,11 +20,11 @@ module SanitizeEmail
         SanitizeEmail::MailHeaderTools.add_original_addresses_as_headers(message)
         SanitizeEmail::MailHeaderTools.prepend_custom_subject(message)
 
-        o = SanitizeEmail::OverriddenAddresses.new(message)
+        overridden = SanitizeEmail::OverriddenAddresses.new(message)
 
-        message.to = o.overridden_to
-        message.cc = o.overridden_cc
-        message.bcc = o.overridden_bcc
+        message.to = overridden.overridden_to
+        message.cc = overridden.overridden_cc
+        message.bcc = overridden.overridden_bcc
       end
     end
 

data/lib/sanitize_email/config.rb

@@ -1,7 +1,9 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 
 module SanitizeEmail
+  # The API for configuring SanitizeEmail is via `SanitizeEmail.config`
+  # Available configuration options are listed in the `DEFAULTS`` constant.
   class Config
 
     extend SanitizeEmail::Deprecation
@@ -60,10 +62,13 @@ module SanitizeEmail
         @config[:sanitized_to] = @config[:sanitized_recipients]
       end
       if !@config[:force_sanitize].nil?
-        replacement = "
-  Please use SanitizeEmail.force_sanitize or SanitizeEmail.sanitary instead.
-  Refer to https://github.com/pboling/sanitize_email/wiki for examples."
-        deprecation("SanitizeEmail::Config.config[:force_sanitize]", replacement)
+        deprecation_warning_message(
+            <<-EOS
+              SanitizeEmail::Config.config[:force_sanitize] is deprecated.
+              Please use SanitizeEmail.force_sanitize or SanitizeEmail.sanitary instead.
+              Refer to https://github.com/pboling/sanitize_email/wiki for examples.
+            EOS
+        )
         SanitizeEmail.force_sanitize = @config[:force_sanitize]
       end
     end

data/lib/sanitize_email/deprecation.rb

@@ -1,9 +1,9 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
-# See http://www.seejohncode.com/2012/01/09/deprecating-methods-in-ruby/
-#require 'facets/module/mattr' # gives cattr
 
 module SanitizeEmail
+  # Provides tools that allow methods to be deprecated with new releases of the gem.
+  # See http://www.seejohncode.com/2012/01/09/deprecating-methods-in-ruby/
   module Deprecation
 
     class << self
@@ -38,14 +38,15 @@ module SanitizeEmail
     end
 
     def deprecation(name, replacement = nil)
-      unless SanitizeEmail::Deprecation.deprecate_in_silence
-        if replacement
-          warn "SanitizeEmail: ##{name} deprecated#{replacement}"
-        else
-          warn "SanitizeEmail: ##{name} deprecated"
-        end
+      if replacement
+        deprecation_warning_message("SanitizeEmail: ##{name} deprecated#{replacement}")
+      else
+        deprecation_warning_message("SanitizeEmail: ##{name} deprecated")
       end
     end
 
+    def deprecation_warning_message(message)
+      warn message unless SanitizeEmail::Deprecation.deprecate_in_silence
+    end
   end
 end

data/lib/sanitize_email/engine.rb

@@ -1,7 +1,8 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
-# For Rails >= 3.1
+
 module SanitizeEmail
+  # For Rails >= 3.1
   class Engine < ::Rails::Engine
 
     config.to_prepare do

data/lib/sanitize_email/mail_header_tools.rb

@@ -1,6 +1,8 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+
 module SanitizeEmail
+  # Tools for modifying the header of an email
   module MailHeaderTools
 
     def self.prepend_subject_array(message)
@@ -29,9 +31,9 @@ module SanitizeEmail
         'X-Sanitize-Email-To' => Array(message.to).uniq, # can be an array, so casting it as an array
         'X-Sanitize-Email-Cc' => Array(message.cc).uniq  # can be an array, so casting it as an array
         # Don't write out the BCC, as those addresses should not be visible in message headers for obvious reasons
-      }.each { |k, v|
+      }.each { |header_key, header_value|
         # For each type of address line
-        SanitizeEmail::MailHeaderTools.update_header(k, v, message)
+        SanitizeEmail::MailHeaderTools.update_header(header_key, header_value, message)
       }
     end
 
@@ -41,20 +43,15 @@ module SanitizeEmail
     end
 
     # According to https://github.com/mikel/mail this is the correct way to update headers.
-    def self.update_header(k, v, message)
-      # For each address, as v can be an array of addresses
-      Array(v).each_with_index { |a, index|
+    def self.update_header(header_key, header_value, message)
+      # For each address, as header_value can be an array of addresses
+      Array(header_value).each_with_index { |elem, index|
         num = index + 1
-        header_key = num > 1 ?
-          "#{k}-#{index+1}" :
-          k
-        #puts "for #{num}: #{header_key}"
-        message.header[header_key] = a.to_s
-        # Old way
-        # Add headers by string concat. Setting hash values on message.headers does nothing, strangely. http://goo.gl/v46GY
-        #message.header = message.header.to_s.strip + "\n#{k}: #{a}"
-      } if v
-      #puts "\nafter message.header:\n #{message.header}\n"
+        new_header_key = num > 1 ?
+          "#{header_key}-#{num}" :
+          header_key
+        message.header[new_header_key] = elem.to_s
+      } if header_value
     end
 
   end

data/lib/sanitize_email/overridden_addresses.rb

@@ -1,13 +1,20 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+
 module SanitizeEmail
+  # Tools for overriding addresses
   class OverriddenAddresses
 
-    class MissingTo < StandardError;
-    end
-    class UnknownOverride < StandardError;
-    end
+    # Raised when after applying all sanitization rules there are no addresses to send the email to.
+    class MissingTo < StandardError; end
+
+    # Raised if there is a recipient type that sanitize_email doesn't recognize.
+    # If you get this error please report it.
+    # recognized recipient types are: TO, CC, and BCC
+    class UnknownOverride < StandardError; end
 
+    REPLACE_AT = [/@/, " at "]
+    REPLACE_ALLIGATOR = [/[<>]/, "~"]
     attr_accessor :overridden_to, :overridden_cc, :overridden_bcc,
                   :good_list, # White-listed addresses will not be molested as to, cc, or bcc
                   :bad_list, # Black-listed addresses will be removed from to, cc and bcc when sanitization is engaged
@@ -99,7 +106,7 @@ module SanitizeEmail
           new_recipient = sanitized_addresses
         else
           #puts "SANITIZED: #{sanitized_addresses}"
-          new_recipient = sanitized_addresses.map { |sanitized| "#{real_recipient.gsub(/@/, ' at ').gsub(/[<>]/, '~')} <#{sanitized}>" }
+          new_recipient = sanitized_addresses.map { |sanitized| "#{real_recipient.gsub(REPLACE_AT[0], REPLACE_AT[1]).gsub(/[<>]/, '~')} <#{sanitized}>" }
         end
         result << new_recipient
         result

data/lib/sanitize_email/railtie.rb

@@ -1,7 +1,8 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
-# For Rails 3.0, which didn't yet support Engines
+
 module SanitizeEmail
+# For Rails 3.0, which didn't yet support Engines
   class Railtie < ::Rails::Railtie
 
     config.after_initialize do

data/lib/sanitize_email/rspec_matchers.rb

@@ -1,9 +1,10 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
 require 'sanitize_email/test_helpers'
 require 'sanitize_email/mail_ext'
 
 module SanitizeEmail
+  # 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|

data/lib/sanitize_email/test_helpers.rb

@@ -1,7 +1,11 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 Peter H. Boling of RailsBling.com
 # Released under the MIT license
+
 module SanitizeEmail
+  # Helpers for test-unit
   module TestHelpers
+
+    # 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)

data/lib/sanitize_email/version.rb

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

data/sanitize_email.gemspec

@@ -7,7 +7,10 @@ Gem::Specification.new do |s|
 
   s.authors = ["Peter Boling", "John Trupiano", "George Anderson"]
   s.summary = "Email Condom for your Ruby Server"
-  s.description = "In Rails, Sinatra, or simply the mail gem: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses."
+  s.description = <<EOS
+  Email Condom for your Ruby Server.
+In Rails, Sinatra, et al, or simply the mail gem: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses.
+EOS
   s.email = ["peter.boling@gmail.com"]
   s.extra_rdoc_files = [
     "CHANGELOG.md",

data/spec/sanitize_email_spec.rb

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

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Copyright (c) 2008-15 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.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Peter Boling
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -180,9 +180,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'In Rails, Sinatra, or simply the mail gem: Aids in development, testing,
-  qa, and production troubleshooting of email issues without worrying that emails
-  will get sent to actual live addresses.'
+description: |2
+    Email Condom for your Ruby Server.
+  In Rails, Sinatra, et al, or simply the mail gem: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses.
 email: peter.boling@gmail.com
 executables: []
 extensions: []
@@ -193,6 +193,7 @@ extra_rdoc_files:
 files:
 - ".coveralls.yml"
 - ".gitignore"
+- ".reek"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -207,6 +208,8 @@ files:
 - gemfiles/Gemfile.rails-3.1.x
 - gemfiles/Gemfile.rails-3.2.x
 - gemfiles/Gemfile.rails-4.0.x
+- gemfiles/Gemfile.rails-4.1.x
+- gemfiles/Gemfile.rails-4.2.x
 - init.rb
 - lib/sanitize_email.rb
 - lib/sanitize_email/bleach.rb