sanitize_email 1.0.10 → 1.0.11

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
@@ -17,3 +18,5 @@ matrix:
       gemfile: gemfiles/Gemfile.rails-4.0.x
     - rvm: 1.9.2
       gemfile: gemfiles/Gemfile.rails-4.0.x
+    - rvm: jruby-19mode
+      gemfile: gemfiles/Gemfile.rails-3.0.x

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+Version 1.0.11 - DEC.30.2013
+* Fix travis build by Peter Boling
+* Fix test suite to run on Ruby 1.8.7 again, add back to Travis by Peter Boling
+* Add mode badges to Readme by Peter Boling
+* Improve Readme by Peter Boling
+
 Version 1.0.10 - NOV.24.2013
 * Expand test suite to test against all supported versions of ActionMailer and Railties gems by Peter Boling
 * Add Coveralls by Peter Boling

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2013 Peter H. Boling of 9thBit LLC
+Copyright (c) 2008-2013 Peter H. Boling of RailsBling.com
 
 MIT License
 

data/README.md

@@ -1,28 +1,32 @@
-# sanitize_email [![Gem Version](https://badge.fury.io/rb/sanitize_email.png)](http://badge.fury.io/rb/sanitize_email)  [![Build Status](https://secure.travis-ci.org/pboling/sanitize_email.png?branch=master)](https://travis-ci.org/pboling/sanitize_email) [![Code Climate](https://codeclimate.com/github/pboling/sanitize_email.png)](https://codeclimate.com/github/pboling/sanitize_email) [![Coverage Status](https://coveralls.io/repos/pboling/sanitize_email/badge.png)](https://coveralls.io/r/pboling/sanitize_email) [![Dependency Status](https://gemnasium.com/pboling/sanitize_email.png)](https://gemnasium.com/pboling/sanitize_email) [![Endorse Me](http://api.coderwall.com/pboling/endorsecount.png)](http://api.coderwall.com/pboling/endorsecount.png)
+# sanitize_email
 
-This gem allows you to override your mail delivery settings, globally or in a local context.  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 with Rails >= 3.X (since v1.0.5)
-* 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
-* little configuration required
-* solves common problems in ruby web applications that use email
-* provides test helpers and spec matchers to assist with testing email content delivery
-
-## Summary
+This gem allows you to override your mail delivery settings, globally or in a local context.
 
 | Project                 |  Sanitize Email   |
 |------------------------ | ----------------- |
 | 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) |
 | 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) |
 | continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/sanitize_email.png?branch=master)](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] |
 | documentation           |  [http://rdoc.info/github/pboling/sanitize_email/frames][documentation] |
-| author                  |  [Peter Boling](https://coderbits.com/pboling) [![Endorse Me](http://api.coderwall.com/pboling/endorsecount.png)](http://api.coderwall.com/pboling/endorsecount.png) |
+| author                  |  [Peter Boling](https://coderbits.com/pboling) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
+
+## Summary
 
+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 with Rails >= 3.X (since v1.0.5)
+* 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
+* little configuration required
+* solves common problems in ruby web applications that use email
+* provides test helpers and spec matchers to assist with testing email content delivery
 
 ## Working Locally with Production Data
 
@@ -130,6 +134,22 @@ John Trupiano did the initial gemification and some refactoring.
 
 See the [Network View](https://github.com/pboling/sanitize_email/network) and the [CHANGELOG](https://github.com/pboling/sanitize_email/blob/master/CHANGELOG.md)
 
+## How you can help!
+
+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
+```
+
+If the tests pass refresh the `reek` list:
+
+```
+bundle exec rake reek > REEK
+```
+
+Follow the instructions for "Contributing" below.
+
 ## Contributing
 
 1. Fork it
@@ -174,3 +194,7 @@ For example:
 [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")
+

data/REEK

@@ -1,6 +1,13 @@
-lib/sanitize_email/bleach.rb -- 2 warnings:
-  SanitizeEmail::Bleach::MissingTo has no descriptive comment (IrresponsibleModule)
-  SanitizeEmail::Bleach::UnknownOverride has no descriptive comment (IrresponsibleModule)
+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)
@@ -11,20 +18,23 @@ lib/sanitize_email/deprecation.rb -- 2 warnings:
   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 -- 7 warnings:
+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/overridden_addresses.rb -- 5 warnings:
+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:

data/lib/sanitize_email.rb

@@ -1,5 +1,5 @@
-#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
-#Released under the MIT license
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 
 module SanitizeEmail
   require 'sanitize_email/version'

data/lib/sanitize_email/bleach.rb

@@ -1,5 +1,5 @@
-#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
-#Released under the MIT license
+# Copyright (c) 2008-13 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.

data/lib/sanitize_email/config.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
+
 module SanitizeEmail
   class Config
 

data/lib/sanitize_email/deprecation.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2008-13 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
 

data/lib/sanitize_email/engine.rb

@@ -1,5 +1,5 @@
-#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
-#Released under the MIT license
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 # For Rails >= 3.1
 module SanitizeEmail
   class Engine < ::Rails::Engine

data/lib/sanitize_email/mail_header_tools.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 module SanitizeEmail
   module MailHeaderTools
 

data/lib/sanitize_email/overridden_addresses.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 module SanitizeEmail
   class OverriddenAddresses
 

data/lib/sanitize_email/railtie.rb

@@ -1,6 +1,6 @@
-#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
-#Released under the MIT license
-# For Rails 3.0, which didn't yet support Engines'
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
+# For Rails 3.0, which didn't yet support Engines
 module SanitizeEmail
   class Railtie < ::Rails::Railtie
 

data/lib/sanitize_email/rspec_matchers.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 require 'sanitize_email/test_helpers'
 
 module SanitizeEmail

data/lib/sanitize_email/test_helpers.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 module SanitizeEmail
   module TestHelpers
     class UnexpectedMailType < StandardError; end

data/lib/sanitize_email/version.rb

@@ -1,5 +1,5 @@
-#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
-#Released under the MIT license
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 module SanitizeEmail
-  VERSION = '1.0.10'
+  VERSION = '1.0.11'
 end

data/sanitize_email.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |s|
   #s.add_runtime_dependency(%q<facets>, ["> 0"])
 
   # Development Dependencies
-  s.add_development_dependency(%q<rails>, ["> 3"])
-  s.add_development_dependency(%q<actionmailer>, ["> 3"])
+  s.add_development_dependency(%q<rails>, [">= 3.0"])
+  s.add_development_dependency(%q<actionmailer>, [">= 3.0"])
   s.add_development_dependency(%q<letter_opener>, [">= 0"])
   s.add_development_dependency(%q<launchy>, [">= 0"])
   s.add_development_dependency(%q<rspec>, [">= 2.11"])

data/spec/sanitize_email_spec.rb

@@ -1,3 +1,5 @@
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 require 'spec_helper'
 
 #
@@ -21,7 +23,9 @@ describe SanitizeEmail do
   after(:each) do
     SanitizeEmail::Config.config = SanitizeEmail::Config::DEFAULTS
     SanitizeEmail.force_sanitize = nil
-    Mail.class_variable_get(:@@delivery_interceptors).pop
+    # The following works with Ruby > 1.9, but to make the test suite run on 18.7 we need a little help
+    # Mail.class_variable_get(:@@delivery_interceptors).pop
+    Mail.send(:class_variable_get, :@@delivery_interceptors).pop
   end
 
   def sanitize_spec_dryer(rails_env = 'test')

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'sanitize_email'
-require 'sanitize_email/rspec_matchers'
+# Copyright (c) 2008-13 Peter H. Boling of RailsBling.com
+# Released under the MIT license
 require 'launchy'
 require 'mail'
 require 'rails'
@@ -7,6 +7,13 @@ require 'letter_opener'
 require 'action_mailer'
 require 'email_spec'
 
+# For code coverage, must be required before all application / gem / library code.
+require 'coveralls'
+Coveralls.wear!
+
+require 'sanitize_email'
+require 'sanitize_email/rspec_matchers'
+
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -11,40 +11,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: letter_opener
   requirement: !ruby/object:Gem::Requirement