mail_safe 0.1.0 → 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/README.rdoc

@@ -10,36 +10,45 @@ with a note stating where the email was originally intended to go.
 
 == Download
 
-Github: http://github.com/myronmarston/mail_safe/tree/master
+Github: http://github.com/myronmarston/mail_safe
 
 Gem:
-  gem install myronmarston-mail_safe --source http://gems.github.com
+  gem install mail_safe --source http://gemcutter.org
 
-== Usage
+== Installation
 
 Load the gem in your non-production environments using Rails' 2.1+ gem support.  For example, I'm loading this in
 config/environments/development.rb and config/environments/staging.rb:
 
-  config.gem 'myronmarston-mail_safe', :lib => 'mail_safe', :source => 'http://gems.github.com'
+  config.gem 'mail_safe', :source => 'http://gemcutter.org'
 
-Be sure not to load this in your production or test environment, otherwise, your emails won't be sent to the proper
-recipients.  (The Rails test environment ensures that no emails are ever sent.)
+IMPORTANT: Be sure not to load this in your production environment, otherwise, your emails won't be sent to the proper
+recipients.  In your test environment, you probably won't want this, either--rails ensures that no emails are ever sent in the
+test environment, and tests that check outbound email recipients may fail.
 
-Next, configure mail safe.  Create a file at config/initializers/mail_safe.rb, similar to the following:
+== Configuration
+
+In many cases, no configuration is necessary.  If you have git installed, and you've registered your email address
+with it (check with "git config user.email" in your shell), mail safe will use this.  All emails will be sent to this address.
+
+Otherwise, you can configure mail safe's behavior.  Create a file at config/initializers/mail_safe.rb, similar to the following:
 
   if defined?(MailSafe::Config)
     MailSafe::Config.internal_address_definition = /.*@my-domain\.com/i
     MailSafe::Config.replacement_address = 'me@my-domain.com'
   end
 
-The internal address definition determines which addresses will be ignored (i.e. sent normally) and which will be replaced.  Email being sent to internal
-addresses will be sent normally; all other email addresses will be replaced by the replacement address.
+The internal address definition determines which addresses will be ignored (i.e. sent normally) and which will be replaced.  Email
+being sent to internal addresses will be sent normally; all other email addresses will be replaced by the replacement address.
 
 These settings can also take procs if you need something more flexible:
 
   if defined?(MailSafe::Config)
-    # Emails sent to addresses longer than 15 characters long will be sent to the replacement address instead.
-    MailSafe::Config.internal_address_definition = lambda { |address| address.size <= 15 }
+    MailSafe::Config.internal_address_definition = lambda { |address|
+      address =~ /.*@domain1\.com/i ||
+      address =~ /.*@domain2\.com/i ||
+      address == 'full-address@domain.com'
+    }
 
     # Useful if your mail server allows + dynamic email addresses like gmail.
     MailSafe::Config.replacement_address = lambda { |address| "my-address+#{address.gsub(/[\w\-.]/, '_')}@gmail.com" }

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mail_safe"
+    gem.summary = %Q{Keep your ActionMailer emails from escaping into the wild during development.}
+    gem.email = "myron.marston@gmail.com"
+    gem.homepage = "http://github.com/myronmarston/mail_safe"
+    gem.authors = ["Myron Marston"]
+
+    gem.add_dependency 'activesupport'
+    gem.add_dependency 'actionmailer'
+
+    gem.add_development_dependency 'Shoulda'
+    gem.add_development_dependency 'mocha'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mail_safe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:minor: 1
-:patch: 0
 :major: 0
+:minor: 2
+:patch: 0
+:build: 

data/lib/mail_safe/config.rb

@@ -8,7 +8,9 @@ module MailSafe
       case internal_address_definition
         when Regexp then address =~ internal_address_definition
         when Proc   then internal_address_definition.call(address)
-        else raise InvalidConfigSettingError.new("internal_address_definition must be a Regexp or Proc, but was: #{internal_address_definition.class.to_s}")
+        else
+          return address.downcase == developer_email_address.downcase if developer_email_address
+          raise InvalidConfigSettingError.new("internal_address_definition must be a Regexp or Proc, but was: #{internal_address_definition.class.to_s}")
       end
     end
 
@@ -18,8 +20,22 @@ module MailSafe
       case replacement_address
         when String then replacement_address
         when Proc   then replacement_address.call(original_address)
-        else raise InvalidConfigSettingError.new("replacement_address must be a String or Proc, but was: #{replacement_address.class.to_s}")
+        else
+          return developer_email_address if developer_email_address
+          raise InvalidConfigSettingError.new("replacement_address must be a String or Proc, but was: #{replacement_address.class.to_s}")
       end
     end
+
+    def self.developer_email_address
+      unless defined?(@@developer_email_address)
+        @@developer_email_address = begin
+          `git config user.email`.chomp
+        rescue
+          nil
+        end
+      end
+
+      @@developer_email_address
+    end
   end
 end

data/mail_safe.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mail_safe}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Myron Marston"]
+  s.date = %q{2009-11-06}
+  s.email = %q{myron.marston@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/mail_safe.rb",
+     "lib/mail_safe/action_mailer.rb",
+     "lib/mail_safe/address_replacer.rb",
+     "lib/mail_safe/config.rb",
+     "mail_safe.gemspec",
+     "test/config_test.rb",
+     "test/mailer_test.rb",
+     "test/mailers/test_mailer.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/myronmarston/mail_safe}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Keep your ActionMailer emails from escaping into the wild during development.}
+  s.test_files = [
+    "test/config_test.rb",
+     "test/mailer_test.rb",
+     "test/mailers/test_mailer.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<actionmailer>, [">= 0"])
+      s.add_development_dependency(%q<Shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<actionmailer>, [">= 0"])
+      s.add_dependency(%q<Shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<actionmailer>, [">= 0"])
+    s.add_dependency(%q<Shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/test/config_test.rb

@@ -1,74 +1,177 @@
 require 'test_helper'
 
 class ConfigTest < Test::Unit::TestCase
-  context 'When internal_address_definition is set to a regexp, #is_internal_address?' do
-    setup do
-      MailSafe::Config.internal_address_definition = /.*@example\.com/
+  context '#developer_email_address' do
+    teardown do
+      # clear class variable caching...
+      MailSafe::Config.class_eval do
+        remove_class_variable(:@@developer_email_address)
+      end
     end
 
-    should 'return true if the address matches the regexp' do
-      assert MailSafe::Config.is_internal_address?('someone@example.com')
-    end
+    context 'when git is installed' do
+      setup do
+        backtick_call_count = 0
+        # mock out the ` method.  I can't find a simpler way to do this with mocha.
+        Kernel.class_eval do
+          define_method '`'.to_sym do |cmd|
+            backtick_call_count += 1
+            return "too many calls" if backtick_call_count > 1
+            if cmd == 'git config user.email'
+              "developer@domain.com\n"
+            end
+          end
+        end
+      end
 
-    should 'return false if the address does not match the regexp' do
-      assert !MailSafe::Config.is_internal_address?('someone@another-domain.com')
-    end
-  end
+      should "guess the developer's email address using git" do
+        assert_equal 'developer@domain.com', MailSafe::Config.developer_email_address
+      end
 
-  context 'When internal_address_definition is set to a lambda, #is_internal_address?' do
-    setup do
-      MailSafe::Config.internal_address_definition = lambda { |address| address.size < 15 }
+      should "cache the developer's email address so multiple system calls aren't made" do
+        assert_equal MailSafe::Config.developer_email_address, MailSafe::Config.developer_email_address
+      end
     end
 
-    should 'return true if the lambda returns true for the given address' do
-      assert MailSafe::Config.is_internal_address?('abc@foo.com')
-    end
+    context 'when git is not installed' do
+      setup do
+        backtick_call_count = 0
+        # mock out the ` method.  I can't find a simpler way to do this with mocha.
+        Kernel.class_eval do
+          define_method '`'.to_sym do |cmd|
+            backtick_call_count += 1
+            return "too many calls" if backtick_call_count > 1
+            if cmd == 'git config user.email'
+              raise RuntimeError.new("Git is not installed")
+            end
+          end
+        end
+      end
+
+      should "return nil" do
+        assert_nil MailSafe::Config.developer_email_address
+      end
 
-    should 'return false if the lambda returns false for the given address' do
-      assert !MailSafe::Config.is_internal_address?('a-long-address@example.com')
+      should "cache the developer's email address so multiple system calls aren't made" do
+        assert_equal MailSafe::Config.developer_email_address, MailSafe::Config.developer_email_address
+      end
     end
   end
 
-  context 'When internal_address_definition is not set, #is_internal_address?' do
-    setup do
-      MailSafe::Config.internal_address_definition = nil
-    end
+  context '#is_internal_address?' do
+    context 'when internal_address_definition is not set' do
+      setup do
+        MailSafe::Config.internal_address_definition = nil
+      end
+
+      context 'and #developer_email_address has a value' do
+        setup do
+          @developer_address = 'developer@domain.com'
+          MailSafe::Config.expects(:developer_email_address).at_least_once.returns(@developer_address)
+        end
+
+        should 'return true when passed the developer email address' do
+          assert MailSafe::Config.is_internal_address?(@developer_address)
+        end
+
+        should 'return true when passed the developer email address with different casing' do
+          assert MailSafe::Config.is_internal_address?(@developer_address.upcase)
+        end
 
-    should 'raise an error' do
-      assert_raise MailSafe::InvalidConfigSettingError do
-        MailSafe::Config.is_internal_address?('abc@foo.com')
+        should 'return false when passed another email address' do
+          assert !MailSafe::Config.is_internal_address?('another-address@domain.com')
+        end
+      end
+
+      context 'and #developer_email_address has no value' do
+        setup do
+          MailSafe::Config.expects(:developer_email_address).returns(nil)
+        end
+
+        should 'raise an error' do
+          assert_raise MailSafe::InvalidConfigSettingError do
+            MailSafe::Config.is_internal_address?('abc@foo.com')
+          end
+        end
       end
     end
-  end
 
-  context 'When replacement_address is set to a string, #get_replacement_address' do
-    setup do
-      MailSafe::Config.replacement_address = 'me@mydomain.com'
+    context 'when internal_address_definition is set to a regexp' do
+      setup do
+        MailSafe::Config.internal_address_definition = /.*@example\.com/
+      end
+
+      should 'return true if the address matches the regexp' do
+        assert MailSafe::Config.is_internal_address?('someone@example.com')
+      end
+
+      should 'return false if the address does not match the regexp' do
+        assert !MailSafe::Config.is_internal_address?('someone@another-domain.com')
+      end
     end
 
-    should 'return the configured replacement address' do
-      assert_equal 'me@mydomain.com', MailSafe::Config.get_replacement_address('you@example.com')
+    context 'When internal_address_definition is set to a lambda, #is_internal_address?' do
+      setup do
+        MailSafe::Config.internal_address_definition = lambda { |address| address.size < 15 }
+      end
+
+      should 'return true if the lambda returns true for the given address' do
+        assert MailSafe::Config.is_internal_address?('abc@foo.com')
+      end
+
+      should 'return false if the lambda returns false for the given address' do
+        assert !MailSafe::Config.is_internal_address?('a-long-address@example.com')
+      end
     end
   end
 
-  context 'When replacement_address is set to a proc, #get_replacement_address' do
-    setup do
-      MailSafe::Config.replacement_address = lambda { |address| "me+#{address.split('@').first}@mydomain.com" }
-    end
+  context '#get_replacement_address' do
+    context 'when replacement_address is set to a string' do
+      setup do
+        MailSafe::Config.replacement_address = 'me@mydomain.com'
+      end
 
-    should 'return the configured replacement address' do
-      assert_equal 'me+you@mydomain.com', MailSafe::Config.get_replacement_address('you@example.com')
+      should 'return the configured replacement address' do
+        assert_equal 'me@mydomain.com', MailSafe::Config.get_replacement_address('you@example.com')
+      end
     end
-  end
 
-  context 'When replacement_address is not set, #get_replacement_address' do
-    setup do
-      MailSafe::Config.replacement_address = nil
+    context 'when replacement_address is set to a proc' do
+      setup do
+        MailSafe::Config.replacement_address = lambda { |address| "me+#{address.split('@').first}@mydomain.com" }
+      end
+
+      should 'return the configured replacement address' do
+        assert_equal 'me+you@mydomain.com', MailSafe::Config.get_replacement_address('you@example.com')
+      end
     end
 
-    should 'raise an error' do
-      assert_raise MailSafe::InvalidConfigSettingError do
-        MailSafe::Config.get_replacement_address('you@example.com')
+    context 'when replacement_address is not set' do
+      setup do
+        MailSafe::Config.replacement_address = nil
+      end
+
+      context 'and #developer_email_address has a value' do
+        setup do
+          @developer_address = 'developer@domain.com'
+          MailSafe::Config.expects(:developer_email_address).at_least_once.returns(@developer_address)
+        end
+
+        should 'return the developer address' do
+          assert_equal @developer_address, MailSafe::Config.get_replacement_address('you@example.com')
+        end
+      end
+
+      context 'and #developer_email_address has no value' do
+        setup do
+          MailSafe::Config.expects(:developer_email_address).returns(nil)
+        end
+
+        should 'raise an error' do
+          assert_raise MailSafe::InvalidConfigSettingError do
+            MailSafe::Config.get_replacement_address('you@example.com')
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mail_safe
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Myron Marston
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-28 00:00:00 -07:00
+date: 2009-11-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,27 +59,30 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
 - LICENSE
+- README.rdoc
 files: 
+- .document
+- .gitignore
+- LICENSE
 - README.rdoc
+- Rakefile
 - VERSION.yml
+- lib/mail_safe.rb
 - lib/mail_safe/action_mailer.rb
 - lib/mail_safe/address_replacer.rb
 - lib/mail_safe/config.rb
-- lib/mail_safe.rb
+- mail_safe.gemspec
 - test/config_test.rb
 - test/mailer_test.rb
 - test/mailers/test_mailer.rb
 - test/test_helper.rb
-- LICENSE
 has_rdoc: true
 homepage: http://github.com/myronmarston/mail_safe
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -100,7 +103,10 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Keep your ActionMailer emails from escaping into the wild during development.
-test_files: []
-
+test_files: 
+- test/config_test.rb
+- test/mailer_test.rb
+- test/mailers/test_mailer.rb
+- test/test_helper.rb