action_mailer_cache_delivery 0.3.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+## Action Mailer Cache Delivery
+
+[![Build Status](https://secure.travis-ci.org/p0deje/action_mailer_cache_delivery.png)](http://travis-ci.org/p0deje/action_mailer_cache_delivery)
+
+Enhances ActionMailer to support the `:cache` delivery method, which behaves like `:test`, except that the deliveries are marshalled to a temporary cache file, thus making them available to other processes.
+
+You'll want to use this gem if you're testing with Selenium (or any other tool which distinct processes).
+
+## Installation
+
+Add to Gemfile
+
+```ruby
+gem 'action_mailer_cache_delivery'
+```
+
+Now run `bundle install`
+
+## Usage
+
+Change delivery method in your `config/environments/test.rb`
+
+```ruby
+config.action_mailer.delivery_method = :cache
+```
+
+You can optionally specify location for cache file.
+
+```ruby
+config.action_mailer.cache_settings = { :location => "#{Rails.root}/tmp/mail.cache" }
+```
+
+To access the cached deliveries in another process, just do
+
+```ruby
+ActionMailer::Base.cached_deliveries
+```
+
+## Use with parallel_tests
+
+If you use [parallel_tests](https://github.com/grosser/parallel_tests "parallel_tests") to run your tests in parallel, you may get unexpected errors like `EOFError`. If so, make sure cache files differ for processes. Change you `config/environment/test.rb`
+
+```ruby
+config.action_mailer.cache_settings = { :location => "#{Rails.root}/tmp/cache/action_mailer_cache_delivery#{ENV['TEST_ENV_NUMBER']}.cache" }
+```
+
+## Contributors
+
+I tried to list there everyone who forked original version on GitHub. If you're not here, just send pull request.
+
+* ngty (Ng Tze Yang)
+* robinsp (Robin Spainhour)
+* thibaudgg (Thibaud Guillaume-Gentil)
+* liangzan (Wong Liang Zan)
+* railssignals (Kurt Kowar)
+* esdras (Esdras Mayrink)
+* nicolasochem (Nicolas Ochem)
+* reactualize
+* ragaskar (Rajan Agaskar)
+* marhan (Markus Hanses)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/action_mailer_cache_delivery.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'action_mailer_cache_delivery/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'action_mailer_cache_delivery'
+  s.homepage    = 'https://github.com/p0deje/action_mailer_cache_delivery'
+  s.version     = ActionMailerCacheDelivery::VERSION
+
+  s.authors     = 'Alex Rodionov'
+  s.email       = 'p0deje@gmail.com'
+
+  s.summary     = 'Cache delivery method for ActionMailer'
+  s.description = 'Cache delivery method for ActionMailer for testing emails with Selenium'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_dependency 'actionmailer', '~> 3.0'
+
+  s.add_development_dependency 'rspec' , '~> 2.8'
+  s.add_development_dependency 'rake'  , '~> 0.9'
+end

data/lib/action_mailer_cache_delivery.rb

@@ -0,0 +1,16 @@
+require 'action_mailer_cache_delivery/version'
+require 'action_mailer_cache_delivery/mail/cache_delivery'
+require 'action_mailer_cache_delivery/action_mailer/base'
+require 'action_mailer_cache_delivery/railtie' if defined?(Rails)
+
+module ActionMailerCacheDelivery
+  class << self
+
+    def install
+      default_path = 'cache/action_mailer_cache_deliveries.cache'
+      ActionMailer::Base.add_delivery_method :cache, Mail::CacheDelivery,
+        location: defined?(Rails) ? "#{Rails.root}/tmp/#{default_path}" : "#{Dir.tmpdir}/#{default_path}"
+    end
+
+  end # << self
+end # ActionMailerCacheDelivery

data/lib/action_mailer_cache_delivery/action_mailer/base.rb

@@ -0,0 +1,31 @@
+module ActionMailer
+  class Base
+    class << self
+
+      #
+      # Returns an array of delivered mails.
+      #
+      # @return [Array] array of mails (each mail is an instance of Mail.)
+      #
+      def cached_deliveries
+        File.open(cache_settings[:location], 'r') do |file|
+          Marshal.load(file)
+        end
+      end
+
+      #
+      # Clears delivered mails.
+      #
+      # It also cleans ActionMailer::Base.deliveries
+      #
+      def clear_cache
+        deliveries.clear
+
+        File.open(cache_settings[:location], 'w') do |file|
+          Marshal.dump(deliveries, file)
+        end
+      end
+
+    end # << self
+  end # Base
+end # ActionMailer

data/lib/action_mailer_cache_delivery/mail/cache_delivery.rb

@@ -0,0 +1,49 @@
+module Mail
+  #
+  # Performs deliveries to temporary cache file, so mails can accessed from
+  # other processes.
+  #
+  # Default location of files is:
+  #   -  "tmp/cache/action_mailer_cache_deliveries.cache" if you use Rails
+  #   - "/tmp/cache/action_mailer_cache_deliveries.cache" if you don't use Rails
+  #
+  # However, you can overwrite location in configuration:
+  #
+  # @example
+  #   config.action_mailer.cache_settings = { location: "custom/path" }
+  #
+  class CacheDelivery
+
+    # @attr [Hash] settings Settings for CacheDelivery
+    attr_accessor :settings
+
+    # @api private
+    def initialize(settings)
+      @settings = settings
+
+      # create the cache directory if it doesn't exist
+      cache_dir = File.dirname(@settings[:location])
+      FileUtils.mkdir_p(cache_dir) unless File.directory?(cache_dir)
+    end
+
+    # @api private
+    def deliver!(mail)
+      # write empty array to cache file if doesn't exist
+      unless File.exists?(@settings[:location])
+        File.open(@settings[:location], 'w') do |file|
+          Marshal.dump([], file)
+        end
+      end
+
+      # get delivered mails
+      mails = ActionMailer::Base.cached_deliveries
+      # append new one
+      mails << mail
+      # write all emails to cache file
+      File.open(@settings[:location], 'w') do |file|
+        Marshal.dump(mails, file)
+      end
+    end
+
+  end # CacheDelivery
+end # Mail

data/lib/action_mailer_cache_delivery/railtie.rb

@@ -0,0 +1,16 @@
+module ActionMailerCacheDelivery
+  class Railtie < Rails::Railtie
+
+    #
+    # Make settings available before configuration:
+    #
+    # @example
+    #   config.action_mailer.delivery_method = :cache
+    #   config.action_mailer.cache_settings = { location: "#{Rails.root}/tmp/mail.cache" }
+    #
+    config.before_configuration do
+      ActionMailerCacheDelivery.install
+    end
+
+  end # Railtie
+end # ActionMailerCacheDelivery

data/lib/action_mailer_cache_delivery/version.rb

@@ -0,0 +1,5 @@
+module ActionMailerCacheDelivery
+
+  VERSION = '0.3.2'
+
+end # ActionMailerCacheDelivery

data/spec/action_mailer_cache_delivery_spec.rb

@@ -0,0 +1,76 @@
+require_relative 'spec_helper'
+
+describe ActionMailerCacheDelivery do
+
+  context 'with Mailer' do
+    let(:mail) do
+      Mailer.test_mail
+    end
+
+    before(:each) do
+      ActionMailerCacheDelivery.install
+      ActionMailer::Base.delivery_method = :cache
+    end
+
+    describe 'clear_cache' do
+      it 'should clear cache file' do
+        mail.deliver
+        ActionMailer::Base.clear_cache
+        File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
+          Marshal.load(file)
+        end.should == []
+      end
+
+      it 'should clear ActionMailer::Base.deliveries' do
+        mail.deliver
+        ActionMailer::Base.clear_cache
+        ActionMailer::Base.deliveries.should == []
+      end
+    end
+
+    describe 'cached_deliveries' do
+      before(:each) do
+        ActionMailer::Base.clear_cache
+      end
+
+      it 'should return array' do
+        mail.deliver
+        ActionMailer::Base.cached_deliveries.should be_an(Array)
+      end
+
+      it 'should return all the sent emails' do
+        5.times do
+          mail.deliver
+        end
+        ActionMailer::Base.cached_deliveries.length.should == 5
+      end
+    end
+  end
+
+  context 'without Mailer' do
+    describe 'extend ActionMailer' do
+      it 'should add cached_deliveries method to ActionMailer' do
+        ActionMailerCacheDelivery.install
+        ActionMailer::Base.should respond_to(:cached_deliveries)
+      end
+
+      it 'should add clear_cache method to ActionMailer' do
+        ActionMailerCacheDelivery.install
+        ActionMailer::Base.should respond_to(:clear_cache)
+      end
+    end
+
+    describe 'install' do
+      it 'should add :cache delivery method to ActionMailer' do
+        ActionMailerCacheDelivery.install
+        ActionMailer::Base.delivery_methods.should include(:cache)
+      end
+
+      it 'should set cache path to /tmp when Rails is not defined' do
+        ActionMailerCacheDelivery.install
+        ActionMailer::Base.delivery_method = :cache
+        ActionMailer::Base.cache_settings[:location].should == '/tmp/cache/action_mailer_cache_deliveries.cache'
+      end
+    end
+  end
+end # ActionMailerCacheDelivery

data/spec/cache_delivery_spec.rb

@@ -0,0 +1,39 @@
+require_relative 'spec_helper'
+
+describe Mail::CacheDelivery do
+  let(:mail) do
+    Mailer.test_mail
+  end
+
+  before(:each) do
+    ActionMailerCacheDelivery.install
+    ActionMailer::Base.delivery_method = :cache
+    ActionMailer::Base.clear_cache
+  end
+
+  describe 'settings' do
+    it 'should allow setting custom location' do
+      ActionMailer::Base.cache_settings = { location: '/tmp/mail.cache' }
+      mail.deliver
+      File.exists?('/tmp/mail.cache').should be_true
+    end
+  end
+
+  describe 'deliver' do
+    it 'should write mail to cache file' do
+      mail.deliver
+      File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
+        Marshal.load(file)
+      end.should == [mail]
+    end
+
+    it 'should append mail to cache file' do
+      5.times do
+        mail.deliver
+      end
+      File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
+        Marshal.load(file)
+      end.length.should == 5
+    end
+  end
+end # Mail::CachedDelivery

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'action_mailer'
+require 'action_mailer_cache_delivery'
+
+#
+# Simple mailer.
+#
+class Mailer < ActionMailer::Base
+  def test_mail
+    mail(from: 'from@test.com', to: 'to@test.com', subject: 'Test email')
+  end
+end # Mailer

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: action_mailer_cache_delivery
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+  prerelease: 
+platform: ruby
+authors:
+- Alex Rodionov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &12576240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12576240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12575740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *12575740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12575280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *12575280
+description: Cache delivery method for ActionMailer for testing emails with Selenium
+email: p0deje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- action_mailer_cache_delivery.gemspec
+- lib/action_mailer_cache_delivery.rb
+- lib/action_mailer_cache_delivery/action_mailer/base.rb
+- lib/action_mailer_cache_delivery/mail/cache_delivery.rb
+- lib/action_mailer_cache_delivery/railtie.rb
+- lib/action_mailer_cache_delivery/version.rb
+- spec/action_mailer_cache_delivery_spec.rb
+- spec/cache_delivery_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/p0deje/action_mailer_cache_delivery
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Cache delivery method for ActionMailer
+test_files:
+- spec/action_mailer_cache_delivery_spec.rb
+- spec/cache_delivery_spec.rb
+- spec/spec_helper.rb
+has_rdoc: