inaction_mailer 0.6

data/README.markdown

@@ -0,0 +1,11 @@
+## Usage:
+
+Add the following lines to the appropriate `config/environments/*.rb` file:
+
+    config.gem "cwninja-inaction_mailer", :lib => 'inaction_mailer/force_load', :source => 'http://gems.github.com'
+
+As an extra step, for the sake of paranoia, you can check the delivery mechanism with:
+
+    ./script/runner 'p ActionMailer::Base.delivery_method'
+
+Now when you app send e-mails, it will deliver them to `RAILS_ROOT/tmp/sent_mails/mail.*.txt`.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'date'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the inaction_mailer plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name        = %q{inaction_mailer}
+  s.version     = "0.6"
+  s.summary     = %q{An ActionMailer delivery mechanism to save mails as files in a directory.}
+  s.description = %q{An ActionMailer delivery mechanism to save mails as files in a directory.}
+
+  s.files        = FileList['[A-Z]*', 'lib/**/*.rb', 'test/**/*.rb', 'rails/*']
+  s.require_path = 'lib'
+  s.test_files   = Dir[*['test/**/*_test.rb']]
+
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.markdown"]
+  s.rdoc_options = ['--line-numbers', '--inline-source', "--main", "README.markdown"]
+
+  s.authors = ["Tom Lea"]
+  s.email   = %q{commits@tomlea.co.uk}
+
+  s.platform = Gem::Platform::RUBY
+end
+
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/lib/inaction_mailer.rb

@@ -0,0 +1,38 @@
+module InactionMailer
+
+  def perform_delivery_inaction_file(mail)
+    mail.ready_to_send
+    InactionMailer.new_mail_file do |file|
+      file.write mail.encoded
+    end
+  end
+
+  class << self
+    def hook!
+      ActionMailer::Base.__send__(:include, self) if defined? ActionMailer::Base
+    end
+
+    def new_mail_file(&block)
+      ensure_output_dir_exists
+      id = 0
+      id += 1 while File.exist? "#{output_dir}/mail.#{id}.txt"
+      File.open("#{output_dir}/mail.#{id}.txt", "w", &block)
+    end
+
+    protected
+    def output_dir
+      if defined? Rails.root
+        "#{Rails.root}/tmp/sent_mails"
+      else
+        "sent_mails"
+      end
+    end
+
+    def ensure_output_dir_exists
+      Dir.mkdir output_dir unless File.directory? output_dir
+    end
+  end
+
+end
+
+InactionMailer.hook!

data/lib/inaction_mailer/force_load.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "..", "inaction_mailer")
+
+module InactionMailer::ForceLoad
+  # Overide the default mechanism rails uses to determine delivery method, 
+  # and force it to always use :inaction_file
+  def self.hook!
+    ActionMailer::Base.instance_eval do
+      def delivery_method
+        :inaction_file
+      end
+    end
+  end
+end
+
+InactionMailer::ForceLoad.hook!

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib inaction_mailer])

data/test/functional_test.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class InactionMailerTest < Test::Unit::TestCase
+  class Mailer
+    include InactionMailer
+  end
+
+  def test_should_write_mail_to_file
+    with_stubbed_file_store do
+      mailer = Mailer.new
+      mail_content = "Hello world, this is an e-mail!\n"*10
+      mail = stub(:ready_to_send => nil, :encoded => mail_content)
+      mailer.perform_delivery_inaction_file(mail)
+      assert_equal File.read("sent_mails/mail.0.txt"), mail_content
+    end
+  end
+
+  def test_should_write_two_mails_to_files
+    with_stubbed_file_store do
+      mailer = Mailer.new
+      mail_1_content = "Hello world, this is an e-mail!"
+      mail_2_content = "I am a pirate, yarrr!"
+      mail1 = stub(:ready_to_send => nil, :encoded => mail_1_content)
+      mail2 = stub(:ready_to_send => nil, :encoded => mail_2_content)
+      mailer.perform_delivery_inaction_file(mail1)
+      mailer.perform_delivery_inaction_file(mail2)
+      assert_equal File.read("sent_mails/mail.0.txt"), mail_1_content
+      assert_equal File.read("sent_mails/mail.1.txt"), mail_2_content
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "inaction_mailer"
+require "test/unit"
+gem "mocha"
+require "mocha"
+
+class Test::Unit::TestCase
+  class FileSystemStub
+    attr_reader :fake_file_system
+    
+    def initialize(fake_file_system = {})
+      @fake_file_system = fake_file_system
+    end
+    
+    def open(filename, mode = "r")
+      @fake_file_system[filename] ||= StringIO.new if mode == "w"
+      raise Errno::ENOENT, "No such file or directory - #{filename}" unless @fake_file_system[filename]
+      @fake_file_system[filename].rewind
+      if block_given?
+        yield @fake_file_system[filename]
+      else
+        @fake_file_system[filename]
+      end
+    end
+    
+    def read(filename)
+      File.open(filename, "r") do |io|
+        io.read
+      end
+    end
+    
+    def exist?(filename)
+      @fake_file_system.has_key? filename
+    end
+    
+    def directory?(d)
+      @fake_file_system.has_key?(d.split("/").join("/") + "/")
+    end
+
+    def mkdir(d)
+      @fake_file_system[d.split("/").join("/") + "/"] = :directory
+    end
+    
+    def method_missing(m, *args)
+      raise NotImplementedError, "You are using a stubbed file system, and File.#{m} was called, but the stubbed file system does not understand that menthod. Sorry."
+    end
+  end
+  
+  def with_stubbed_file_store(fake_file_system = {}, &block)
+    file_class = File
+    dir_class = Dir
+    Object.send :remove_const, :File
+    Object.const_set(:File, FileSystemStub.new(fake_file_system))
+    Object.send :remove_const, :Dir
+    Object.const_set(:Dir, File)
+    yield
+  ensure
+    Object.send :remove_const, :File
+    Object.const_set(:File, file_class)
+    Object.send :remove_const, :Dir
+    Object.const_set(:Dir, dir_class)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: inaction_mailer
+version: !ruby/object:Gem::Version 
+  version: "0.6"
+platform: ruby
+authors: 
+- Tom Lea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: An ActionMailer delivery mechanism to save mails as files in a directory.
+email: commits@tomlea.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- Rakefile
+- README.markdown
+- lib/inaction_mailer/force_load.rb
+- lib/inaction_mailer.rb
+- test/functional_test.rb
+- test/test_helper.rb
+- rails/init.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An ActionMailer delivery mechanism to save mails as files in a directory.
+test_files: 
+- test/functional_test.rb