sanitize_email 0.3.7 → 0.3.8

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 5ea66fb5f23e32fc62f9faa3390e03ba976de686
+  metadata.gz: 558b9904bb6cc7257c14065b7a49fc95a0a48317
+SHA512: 
+  data.tar.gz: 5cd8291a81b5cb7947ca90af7c823a0a66e3d6d054b8ea38fc1b6e06187f53d9bef865aadf0392df4d7dcba302519a3db9af6157a59940d0112127d0f4b17a9b
+  metadata.gz: b15485bf7dbac7a794f2ce9d80842c142f4e1b87c2b8ce3f0706173e20252ee0afffa136eb0d8748e5b9d3d7bd6807d637c51aad5e9545db89d80bf565ea1151

data/README.rdoc

@@ -1,10 +1,12 @@
 = sanitize_email
 
+NOTE ABOUT THIS VERSION: Sanitize email versions < 1 (i.e. major version 0) are to be kept compatible with Rails versions 3.1 and under.  They will be built and released from the rails_3_1_and_below branch.
+
 This gem allows you to globally override your mail delivery settings.  It's particularly helpful when you want to omit 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.
 
 It is a "configure it and forget it" type gem that requires very little setup.  It includes some very innocuous monkey patching of ActionMailer::Base to work its magic.
 
-It currently solves three common problems in ruby web applications that use ActionMailer:
+It currently solves five (3!) common problems in ruby web applications that use ActionMailer:
 
 === Working Locally with Production Data
 
@@ -27,37 +29,9 @@ If you install this gem on a production server (which I don't always do), you ca
 
 Pick standard or source install below.
 
-* Standard Install:
-
-  [sudo] gem install sanitize_email
+Standard Install (releases on the rails_3_1_and_below branch will remain within major version 0... FOREVER):
 
-* Source Install:
-
-  mkdir -p ~/src
-  cd ~/src
-  git clone git://github.com/pboling/sanitize_email.git
-  cd sanitize_email
-  gem build sanitize_email.gemspec
-  sudo gem install sanitize_email-0.3.7.gem # (Or whatever version gets built)
-
-Then in your environment.rb (if you are just going to use it from the console, you can require it as needed there, and skip the config.gem):
-
-  config.gem 'sanitize_email'
-
-Then cd to your rails app to optionally freeze the gem into your app (if you roll this way):
-
-  rake gems:freeze GEM=sanitize_email
-
-== Install as a Plugin
-
-Plugin using Git:
-
-  # Installation as plugin works too! (let me know if you find any bugs, as I don't ever run it this way.)
-  ./script/plugin install git://github.com/pboling/sanitize_email.git
-
-== Install as a Git Submodule (plugin)
-
-  git submodule add git://github.com/pboling/sanitize_email.git vendor/plugins/sanitize_email
+  [sudo] gem install sanitize_email -v 0.3.8
 
 == Setup
 
@@ -135,13 +109,53 @@ Then if you want to send it to the actual user, instead of yourself
 
     > User.find(4).test_signup_email_user_only
 
+== Alternate Installation Methods
+
+Some of these are Rails version dependent.
+
+Source Install:
+
+  mkdir -p ~/src
+  cd ~/src
+  git clone git://github.com/pboling/sanitize_email.git
+  cd sanitize_email
+  gem build sanitize_email.gemspec
+  sudo gem install sanitize_email-X.X.X.gem # (whatever version gets built)
+
+Then in your environment.rb (if you are just going to use it from the console, you can require it as needed there, and skip the config.gem):
+
+  config.gem 'sanitize_email'
+
+Then cd to your rails app to optionally freeze the gem into your app (if you roll this way):
+
+  rake gems:freeze GEM=sanitize_email
+
+== Install as a Plugin
+
+Plugin using Git:
+
+  # Installation as plugin works too! (let me know if you find any bugs, as I don't ever run it this way.)
+  ./script/plugin install git://github.com/pboling/sanitize_email.git
+
+== Install as a Git Submodule (plugin)
+
+  git submodule add git://github.com/pboling/sanitize_email.git vendor/plugins/sanitize_email
+
+== Run the Test Suite
+
+The test suite must be run against Rails 2.3.X or below as it is coded to expect the Tmail objects under the hood.
+
+  rake test
+
 == Authors
 
-Peter Boling is the author of the gem/plugin.  John Trupiano did the initial conversion from plugin to gem as well as improving the code.
+Peter Boling is the original author of the code.
+John Trupiano gemified and improved the code.
+John kindly returned gem ownership to Peter, who currently maintains it.
 
 == Contributors
 
-George Anderson's work / improvements have been pulled in.
+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]
@@ -149,6 +163,6 @@ George Anderson's work / improvements have been pulled in.
 * {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-2010 {Peter H. Boling}[http://www.peterboling.com/about.html] of {9thBit LLC}[http://www.peterboling.com/]
+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/Rakefile

@@ -1,34 +1,5 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "sanitize_email"
-    gemspec.summary = "Tool to aid in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses."
-    gemspec.description = %q{Test an application's email abilities without ever sending a message to actual live addresses}
-    gemspec.email = ['peter.boling@gmail.com', 'jtrupiano@gmail.com', 'george@benevolentcode.com']
-    gemspec.homepage = "http://github.com/pboling/sanitize_email"
-    gemspec.authors = ["Peter Boling", "John Trupiano", "George Anderson"]
-    gemspec.add_dependency 'actionmailer'
-    gemspec.files = ["lib/sanitize_email/custom_environments.rb",
-             "lib/sanitize_email/sanitize_email.rb",
-             "lib/sanitize_email.rb",
-             "init.rb",
-             "MIT-LICENSE",
-             "Rakefile",
-             "README.rdoc",
-             "sanitize_email.gemspec",
-             "VERSION.yml",
-             "test/test_helper.rb",
-             "test/sample_mailer.rb",
-             "test/sanitize_email_test.rb"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
 
 desc 'Default: run unit tests.'
 task :default => :test
@@ -39,40 +10,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end
-
-desc 'Generate documentation for the sanitize_email plugin.'
-Rake::RDocTask.new do |rdoc|
-  config = YAML.load(File.read('VERSION.yml'))
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "sanitize_email #{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-# Rubyforge documentation task
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-    
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-    
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-          File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/johntrupiano/sanitize_email/"
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end

data/VERSION.yml

@@ -1,5 +1,5 @@
---- 
-:build: 
+---
 :major: 0
 :minor: 3
-:patch: 7
+:patch: 8
+:build: 

data/lib/sanitize_email/custom_environments.rb

@@ -13,7 +13,7 @@ module NinthBit
 
     module ClassMethods
       def consider_local?
-        local_environments.include?(defined?(Rails) ? Rails.env : RAILS_ENV)
+        local_environments.include?(defined?(Rails) && Rails.respond_to?(:env) ? Rails.env : RAILS_ENV)
       end
     end
     

data/lib/sanitize_email/sanitize_email.rb

@@ -76,7 +76,11 @@ module NinthBit
         #######
 
         def override_subject
-          real_recipients.nil? ? real_subject : "(#{real_recipients}) #{real_subject}"
+          if real_recipients.nil? || !self.class.use_actual_email_prepended_to_subject
+            real_subject
+          else
+            "(#{real_recipients}) #{real_subject}"
+          end
         end
 
         def override_email(type)
@@ -95,6 +99,8 @@ module NinthBit
           return nil if real_addresses.nil?
           return sanitized_addresses if sanitized_addresses.nil? || !self.class.use_actual_email_as_sanitized_user_name
 
+          real_addresses = real_addresses.respond_to?(:inject) ? real_addresses : [real_addresses]
+          sanitized_addresses = sanitized_addresses.respond_to?(:map) ? sanitized_addresses : [sanitized_addresses]
           out = real_addresses.inject([]) do |result, real_recipient|
             result << sanitized_addresses.map{|sanitized| "#{real_recipient} <#{sanitized}>"}
             result

data/sanitize_email.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sanitize_email}
-  s.version = "0.3.7"
+  s.version = "0.3.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling", "John Trupiano", "George Anderson"]

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+# Note tests require tmail to be the underlying message handler, so need to be run with Rails 2.3 or below
 require 'rubygems'
 
 vendored_rails = File.dirname(__FILE__) + '/../../../../vendor/rails'

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanitize_email
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 7
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors: 
 - Peter Boling
@@ -17,20 +11,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-08 00:00:00 -04:00
-default_executable: 
+date: 2010-07-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - &id002 
+      - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -58,37 +48,26 @@ files:
 - test/sample_mailer.rb
 - test/sanitize_email_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/pboling/sanitize_email
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id002
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id002
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 3
 summary: Tool to aid in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses.