sanitize_email 1.0.3 → 1.0.4

data/CHANGELOG

@@ -1,3 +1,10 @@
+Version 1.0.4 - SEP.10.2012
+* Removes facets dependency, upgrades to rspec v2.11 by Peter Boling
+* REEK refactoring by Peter Boling
+* Improve handling of mal-formed calls to (un)sanitary (raises error) by Peter Boling
+* code cleanup by Peter Boling
+* Put some examples back in the README, until I improve and link to the wiki. :/
+
 Version 1.0.3 - AUG.12.2012
 - Accidentally broke spec suite with 1.0.2 - fixed
 - Expanded spec suite

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    sanitize_email (1.0.2)
-      facets (> 0)
+    sanitize_email (1.0.3)
 
 GEM
   remote: http://rubygems.org/
@@ -39,15 +38,8 @@ GEM
     builder (3.0.0)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    facets (2.9.3)
-    git (1.2.5)
     hike (1.2.1)
     i18n (0.6.0)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
     journey (1.0.4)
     json (1.7.3)
     launchy (2.1.0)
@@ -95,14 +87,14 @@ GEM
       sexp_processor (~> 3.0)
     roodi (2.1.0)
       ruby_parser
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    rspec-mocks (2.11.2)
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
@@ -125,13 +117,13 @@ PLATFORMS
 
 DEPENDENCIES
   actionmailer (> 3)
-  jeweler
   launchy
   letter_opener
   mail
   rails (> 3)
+  rake
   rdoc (>= 3.12)
   reek (>= 1.2.8)
   roodi (>= 2.1.0)
-  rspec
+  rspec (>= 2.11)
   sanitize_email!

data/README.rdoc

@@ -9,7 +9,7 @@ It currently solves five (3!) common problems in ruby web applications that use
 === #1 Working Locally with Production Data
 
 * I have a production site with live data.
-* I dump the live data and securely transfer it to another machine (rync -e ssh), and import it using a few rake tasks here: http://github.com/pboling/sir-du-bob
+* I dump the live data and securely transfer it to another machine (rync -e ssh), and import it using a {few rake tasks}[http://github.com/pboling/sir-du-bob]
 * On this separate machine (staging, or development) I run tests, and test various features which often send out email (registration/signup, order placement, etc.)
 * I usually want the emails to get sent from these non-production environments so I can verify what they look like when sent, but I don't ever want to risk them getting sent to addresses that are not mine.
 
@@ -30,7 +30,7 @@ If you install this gem on a production server (which I don't always do), you ca
 Customize and add to an initializer:
 
   SanitizeEmail::Config.configure do |config|
-    config[:sanitized_recipients] = 'to@sanitize_email.org'
+    config[:sanitized_to] = 'to@sanitize_email.org'
     config[:sanitized_cc] =         'cc@sanitize_email.org'
     config[:sanitized_bcc] =        'bcc@sanitize_email.org'
     # sanitize emails from development and test, or set whatever logic should turn sanitize_email on and off here:
@@ -49,13 +49,38 @@ To override the environment based switch use force_sanitize, which is normally n
 
   SanitizeEmail.force_sanitize = true
 
+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.
+
+  SanitizeEmail.unsanitary do
+    Mail.deliver do
+      from      'from@example.org'
+      to        'to@example.org' # Will actually be sent to the specified address, not sanitized
+      reply_to  'reply_to@example.org'
+      subject   'subject'
+    end
+  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 # these config options are merged with the globals
+    Mail.deliver do
+      from      'from@example.org'
+      to        'to@example.org' # Will actually be sent to the override addresses, in this case: boo@example.com
+      reply_to  'reply_to@example.org'
+      subject   'subject'
+    end
+  end
+
 == 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
 
-
 == Authors
 
 Peter Boling is the original author of the code, and current maintainer of both the rails 2 and rails 3 development tracks.
@@ -66,11 +91,14 @@ John Trupiano did the initial gemification and some refactoring.
 George Anderson's work / improvements have been pulled in, along with several other contributors, which can be seen in the Network view on github. Thanks!
 
 == References
+
 * {Source Code}[http://github.com/pboling/sanitize_email]
 * {Gem Release Announcement}[http://blog.smartlogicsolutions.com/2009/04/25/reintroducing-sanitize_email-work-with-production-email-without-fear/]
 * {Peter's Original Writeup}[http://galtzo.blogspot.com/2008/11/sanitize-email-never-worry-about.html]
 * {Using sanitize_email to Preview HTML Emails Locally}[http://blog.smartlogicsolutions.com/2009/04/30/using-sanitize-email-to-preview-html-emails-locally/]
 
-Copyright (c) 2008-2012 {Peter H. Boling}[http://www.peterboling.com/about.html] of {9thBit LLC}[http://www.peterboling.com/]
-Copyright (c) 2009 {John Trupiano}[http://smartlogicsolutions.com/wiki/John_Trupiano] of {SmartLogic Solutions, LLC}[http://www.smartlogicsolutions.com]
-Released under the MIT license
+== Legal Stuff
+
+* Copyright (c) 2008-2012 {Peter H. Boling}[http://www.peterboling.com/about.html] of {9thBit LLC}[http://www.peterboling.com/]
+* Copyright (c) 2009 {John Trupiano}[http://smartlogicsolutions.com/wiki/John_Trupiano] of {SmartLogic Solutions, LLC}[http://www.smartlogicsolutions.com]
+* Released under the MIT license

data/REEK

@@ -0,0 +1,37 @@
+lib/sanitize_email.rb -- 1 warning:
+  SanitizeEmail#self.sanitary calls SanitizeEmail::Config.config twice (DuplicateMethodCall)
+lib/sanitize_email/bleach.rb -- 14 warnings:
+  SanitizeEmail::Bleach has no descriptive comment (IrresponsibleModule)
+  SanitizeEmail::Bleach#activate? calls SanitizeEmail.activation_proc twice (DuplicateMethodCall)
+  SanitizeEmail::Bleach#activate? doesn't depend on instance state (UtilityFunction)
+  SanitizeEmail::Bleach#delivering_email calls message.to twice (DuplicateMethodCall)
+  SanitizeEmail::Bleach#inject_user_names contains iterators nested 2 deep (NestedIterators)
+  SanitizeEmail::Bleach#inject_user_names doesn't depend on instance state (UtilityFunction)
+  SanitizeEmail::Bleach#inject_user_names refers to real_recipient more than self (FeatureEnvy)
+  SanitizeEmail::Bleach#override_email has approx 10 statements (TooManyStatements)
+  SanitizeEmail::Bleach#subject_override doesn't depend on instance state (UtilityFunction)
+  SanitizeEmail::Bleach#subject_override refers to actual_addresses more than self (FeatureEnvy)
+  SanitizeEmail::Bleach::MissingTo has no descriptive comment (IrresponsibleModule)
+  SanitizeEmail::Bleach::UnknownOverride has no descriptive comment (IrresponsibleModule)
+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 -- 3 warnings:
+  SanitizeEmail::Deprecation declares the class variable @@deprecate_in_silence (ClassVariable)
+  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/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

data/lib/sanitize_email.rb

@@ -7,7 +7,10 @@ module SanitizeEmail
   require 'sanitize_email/config'
   require 'sanitize_email/bleach'
 
+  class MissingBlockParameter < StandardError; end
+
   # Allow non-rails implementations to use this gem
+  # TODO: Prepare this for Rails 4
   if defined?(Rails) && ::Rails::VERSION::MAJOR >= 3
     if ::Rails::VERSION::MINOR >= 1
       require 'sanitize_email/engine'
@@ -41,24 +44,26 @@ module SanitizeEmail
     SanitizeEmail[:local_environments]
   end
 
-  mattr_reader :force_sanitize
-  mattr_writer :force_sanitize
-  self.force_sanitize = nil
+  class << self
+    attr_accessor :force_sanitize
+  end
+  @force_sanitize = nil
 
   # Regardless of the Config settings of SanitizeEmail you can do a local override to send sanitary email in any environment.
   # You have access to all the same configuration options in the parameter hash as you can set in the actual
   # SanitizeEmail.configure block.
   #
-  # SanitizeEmail.sanitary(config_options = {}) do
+  # SanitizeEmail.sanitary({:sanitized_to => 'boo@example.com'}) do # these config options are merged with the globals
   #   Mail.deliver do
   #     from      'from@example.org'
-  #     to        'to@example.org' # Will actually be sent to the override addresses setup in Config
+  #     to        'to@example.org' # Will actually be sent to the override addresses, in this case: boo@example.com
   #     reply_to  'reply_to@example.org'
   #     subject   'subject'
   #   end
   # end
   #
   def self.sanitary(config_options = {}, &block)
+    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)
@@ -79,13 +84,14 @@ module SanitizeEmail
   # end
   #
   def self.unsanitary &block
+    raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given?
     janitor({:forcing => false}) do
       yield
     end
   end
 
   def self.janitor(options, &block)
-    return false unless block_given?
+    raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given?
     original = SanitizeEmail.force_sanitize
     SanitizeEmail.force_sanitize = options[:forcing]
     yield

data/lib/sanitize_email/bleach.rb

@@ -4,10 +4,6 @@
 module SanitizeEmail
   class Bleach
 
-    mattr_reader :deprecate_in_silence
-    mattr_writer :deprecate_in_silence
-    self.deprecate_in_silence = false
-
     class MissingTo < StandardError; end
     class UnknownOverride < StandardError; end
 
@@ -56,17 +52,14 @@ module SanitizeEmail
     def sanitize_engaged?
 
       # Has it been forced via the force_sanitize mattr?
-      forced = !SanitizeEmail.force_sanitize.nil?
-      #puts "forced: #{SanitizeEmail.force_sanitize.inspect}" if forced
-      return SanitizeEmail.force_sanitize if forced
+      forced = SanitizeEmail.force_sanitize
+      return forced unless forced.nil?
 
-     # Is this particular instance of Bleach engaged
-      engaged = !self.engage.nil?
-      #puts "engaged: #{self.engage.inspect}" if engaged
-      return self.engage if engaged
+      # Is this particular instance of Bleach engaged
+      engaged = self.engage
+      return engaged unless engaged.nil?
 
       # Should we sanitize due to the activation_proc?
-      #puts "activated: #{self.activate?}"
       return self.activate?
 
     end
@@ -177,7 +170,7 @@ module SanitizeEmail
       return with_user_names
     end
 
-  end # end Class Hook
+  end # end Class Bleach
 end # end Module SanitizeEmail
 
 

data/lib/sanitize_email/config.rb

@@ -1,10 +1,12 @@
-require 'facets/module/mattr' # gives cattr
-
 module SanitizeEmail
   class Config
 
     extend SanitizeEmail::Deprecation
 
+    class << self
+      attr_accessor :config
+    end
+
     DEFAULTS = {
       # Specify the BCC addresses for the messages that go out in 'local' environments
       :sanitized_bcc => nil,
@@ -33,30 +35,27 @@ module SanitizeEmail
       :activation_proc => Proc.new { false }
     }
 
-    cattr_reader :config
-    cattr_writer :config
-
-    self.config ||= DEFAULTS
+    @config ||= DEFAULTS
     def self.configure &block
-      yield @@config
+      yield @config
 
       # Gracefully handle deprecated config values.
       # Actual deprecation warnings are thrown in the top SanitizeEmail module thanks to our use of dynamic methods.
-      if @@config[:local_environments] && defined?(Rails)
-        @@config[:activation_proc] = Proc.new { SanitizeEmail.local_environments.include?(Rails.env) }
+      if @config[:local_environments] && defined?(Rails)
+        @config[:activation_proc] = Proc.new { SanitizeEmail.local_environments.include?(Rails.env) }
       end
-      if @@config[:sanitized_recipients]
+      if @config[:sanitized_recipients]
         SanitizeEmail.sanitized_recipients # calling it to trigger the deprecation warning.
                                            #Won't actually be set with any value,
                                            # because we are still inside the configure block.
-        @@config[:sanitized_to] = @@config[:sanitized_recipients]
+        @config[:sanitized_to] = @config[:sanitized_recipients]
       end
-      if !@@config[:force_sanitize].nil?
+      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)
-        SanitizeEmail.force_sanitize = @@config[:force_sanitize]
+        SanitizeEmail.force_sanitize = @config[:force_sanitize]
       end
     end
 

data/lib/sanitize_email/deprecation.rb

@@ -1,12 +1,14 @@
 # See http://www.seejohncode.com/2012/01/09/deprecating-methods-in-ruby/
-require 'facets/module/mattr' # gives cattr
+#require 'facets/module/mattr' # gives cattr
 
 module SanitizeEmail
   module Deprecation
 
-    mattr_reader :deprecate_in_silence
-    mattr_writer :deprecate_in_silence
-    self.deprecate_in_silence = false
+    class << self
+      attr_accessor :deprecate_in_silence
+    end
+
+    @deprecate_in_silence = false
 
     # Define a deprecated alias for a method
     # @param [Symbol] name - name of method to define
@@ -14,7 +16,7 @@ module SanitizeEmail
     def deprecated_alias(name, replacement)
       # Create a wrapped version
       define_method(name) do |*args, &block|
-        warn "SanitizeEmail: ##{name} deprecated (please use ##{replacement})" unless @@deprecate_in_silence
+        warn "SanitizeEmail: ##{name} deprecated (please use ##{replacement})" unless SanitizeEmail::Deprecation.deprecate_in_silence
         send replacement, *args, &block
       end
     end
@@ -34,7 +36,7 @@ module SanitizeEmail
     end
 
     def deprecation(name, replacement = nil)
-      unless @@deprecate_in_silence
+      unless SanitizeEmail::Deprecation.deprecate_in_silence
         if replacement
           warn "SanitizeEmail: ##{name} deprecated#{replacement}"
         else

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
 module SanitizeEmail
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/sanitize_email.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling", "John Trupiano", "George Anderson"]
-  s.date = "2012-08-08"
+  s.date = "2012-08-12"
   s.summary = "Rails/Sinatra/Mail gem: Test email abilities without ever sending a message to actual live addresses"
   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.email = ["peter.boling@gmail.com", "jtrupiano@gmail.com", "george@benevolentcode.com"]
@@ -26,18 +26,18 @@ Gem::Specification.new do |s|
 
   # Runtime Dependencies
   # to replace the cattr_accessor method we lost when removing rails from run time dependencies
-  s.add_runtime_dependency(%q<facets>, ["> 0"])
+  #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<jeweler>, [">= 0"])
   s.add_development_dependency(%q<letter_opener>, [">= 0"])
   s.add_development_dependency(%q<launchy>, [">= 0"])
-  s.add_development_dependency(%q<rspec>, [">= 0"])
+  s.add_development_dependency(%q<rspec>, [">= 2.11"])
   s.add_development_dependency(%q<mail>, [">= 0"])
   s.add_development_dependency(%q<rdoc>, [">= 3.12"])
   s.add_development_dependency(%q<reek>, [">= 1.2.8"])
   s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
+  s.add_development_dependency(%q<rake>, [">= 0"])
 end
 

data/spec/spec_helper.rb

@@ -13,7 +13,7 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
-  #config.filter_run :focus
+  config.filter_run :focus
 
   config.include SanitizeEmail::RspecMatchers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,24 +11,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: facets
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>'
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>'
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -61,22 +45,6 @@ dependencies:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: letter_opener
   requirement: !ruby/object:Gem::Requirement
@@ -116,7 +84,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -124,7 +92,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +157,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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.'
@@ -211,6 +195,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.rdoc
+- REEK
 - Rakefile
 - init.rb
 - lib/sanitize_email.rb
@@ -254,3 +239,4 @@ summary: ! 'Rails/Sinatra/Mail gem: Test email abilities without ever sending a
 test_files:
 - spec/sanitize_email_spec.rb
 - spec/spec_helper.rb
+has_rdoc: