action_mailer_cache_delivery 0.3.7 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b32f90df212b794281209543071116b5033563133727fed9136111757edee925
+  data.tar.gz: 4dd8d0a28b2d22fee4904d98826472fdaff49338e1e7522d9b8fb95431d7796a
+SHA512:
+  metadata.gz: c27d4453849af80f682435fddae8c738f844627da25bc46f38a55a397e42f163c40728fa138b32ca5f5e5408f7e467266483d070fdd4c1b8e38936acc6020c5e
+  data.tar.gz: 16c2c5ef19d1157290c3b314eded5f5ac4e99b34a4d69fcc2bfda1822e1ae611de8c293dfdd964f5e20c1a0d66007d2de321bcc828073dc2d479c4b9c0584609

data/README.md

@@ -2,7 +2,7 @@
 
 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).
+You'll want to use this gem if you're testing with Selenium (or any other tool which distinct processes). Another approach would be to [share deliveries between threads](https://gist.github.com/p0deje/ffc833630ee70f2af5ff) (in this case, this gem is not needed at all).
 
 ## Installation
 

data/lib/action_mailer_cache_delivery/action_mailer/base.rb

@@ -8,12 +8,14 @@ module ActionMailer
       # @return [Array] array of mails (each mail is an instance of Mail.)
       #
       def cached_deliveries
-        if File.exists?(cache_settings[:location])
-          File.open(cache_settings[:location], 'r') do |file|
-            Marshal.load(file)
+        with_cache_lock("#{cache_settings[:location]}.lock") do
+          if File.exist?(cache_settings[:location])
+            File.open(cache_settings[:location], 'r') do |file|
+              Marshal.load(file)
+            end
+          else
+            []
           end
-        else
-          []
         end
       end
 
@@ -23,15 +25,30 @@ module ActionMailer
       # It also cleans ActionMailer::Base.deliveries
       #
       def clear_cache
-        deliveries.clear
+        with_cache_lock("#{cache_settings[:location]}.lock") do
+          deliveries.clear
 
-        if File.exists?(cache_settings[:location])
-          File.open(cache_settings[:location], 'w') do |file|
-            Marshal.dump(deliveries, file)
+          if File.exist?(cache_settings[:location])
+            File.open(cache_settings[:location], 'w') do |file|
+              Marshal.dump(deliveries, file)
+            end
           end
         end
       end
 
+      #
+      # Locks file to prevent concurrent mail jobs from race condition.
+      # @api private
+      #
+      def with_cache_lock(file)
+        lockfile = File.open(file, 'w')
+        lockfile.flock(File::LOCK_EX)
+        yield
+      ensure
+        lockfile.flock(File::LOCK_UN)
+        lockfile.close
+      end
+
     end # << self
   end # Base
 end # ActionMailer

data/lib/action_mailer_cache_delivery/mail/cache_delivery.rb

@@ -27,23 +27,27 @@ module Mail
 
     # @api private
     def deliver!(mail)
-      # write empty array to cache file if doesn't exist
-      unless File.exists?(@settings[:location])
+      ActionMailer::Base.with_cache_lock("#{@settings[:location]}.lock") do
+        # write empty array to cache file if doesn't exist
+        unless File.exist?(@settings[:location])
+          File.open(@settings[:location], 'w') do |file|
+            Marshal.dump([], file)
+          end
+        end
+
+        # get delivered mails
+        mails = File.open(@settings[:location], 'r') do |file|
+          Marshal.load(file)
+        end
+        # append new one
+        mails << mail
+        # write all emails to cache file
         File.open(@settings[:location], 'w') do |file|
-          Marshal.dump([], file)
+          Marshal.dump(mails, 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)
+        Mail::TestMailer.deliveries << mail
       end
-
-      Mail::TestMailer.deliveries << mail
     end
 
   end # CacheDelivery

data/lib/action_mailer_cache_delivery/version.rb

@@ -1,3 +1,3 @@
 module ActionMailerCacheDelivery
-  VERSION = '0.3.7'
+  VERSION = '0.4.0'
 end # ActionMailerCacheDelivery

data/spec/action_mailer_cache_delivery_spec.rb

@@ -10,26 +10,28 @@ describe ActionMailerCacheDelivery do
     before(:each) do
       ActionMailerCacheDelivery.install
       ActionMailer::Base.delivery_method = :cache
+      ActionMailer::Base.cache_settings[:location] = "#{Dir.tmpdir}/test.cache"
     end
 
     describe 'clear_cache' do
       it 'allows clearing cache before cache file is created' do
-        ActionMailer::Base.cache_settings[:location] = 'test_dir/test_dir/test.cache'
-        lambda { ActionMailer::Base.clear_cache }.should_not raise_error
+        ActionMailer::Base.cache_settings[:location] = ''
+        expect { ActionMailer::Base.clear_cache }.not_to raise_error
       end
 
       it 'should clear cache file' do
         mail.deliver
         ActionMailer::Base.clear_cache
-        File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
+        mails = File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
           Marshal.load(file)
-        end.should == []
+        end
+        expect(mails).to eq([])
       end
 
       it 'should clear ActionMailer::Base.deliveries' do
         mail.deliver
         ActionMailer::Base.clear_cache
-        ActionMailer::Base.deliveries.should == []
+        expect(ActionMailer::Base.deliveries).to eq([])
       end
     end
 
@@ -39,20 +41,19 @@ describe ActionMailerCacheDelivery do
       end
 
       it 'returns empty array if cache has not been created yet' do
-        ActionMailer::Base.cache_settings[:location] = 'test_dir/test_dir/test.cache'
-        ActionMailer::Base.cached_deliveries.should == []
+        expect(ActionMailer::Base.cached_deliveries).to eq([])
       end
 
       it 'should return array' do
         mail.deliver
-        ActionMailer::Base.cached_deliveries.should be_an(Array)
+        expect(ActionMailer::Base.cached_deliveries).to 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
+        expect(ActionMailer::Base.cached_deliveries.length).to eq(5)
       end
     end
   end
@@ -61,25 +62,27 @@ describe ActionMailerCacheDelivery do
     describe 'extend ActionMailer' do
       it 'should add cached_deliveries method to ActionMailer' do
         ActionMailerCacheDelivery.install
-        ActionMailer::Base.should respond_to(:cached_deliveries)
+        expect(ActionMailer::Base).to respond_to(:cached_deliveries)
       end
 
       it 'should add clear_cache method to ActionMailer' do
         ActionMailerCacheDelivery.install
-        ActionMailer::Base.should respond_to(:clear_cache)
+        expect(ActionMailer::Base).to 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)
+        expect(ActionMailer::Base.delivery_methods).to include(:cache)
       end
 
       it 'should set cache path to /tmp when Rails is not defined' do
+        hide_const('Rails')
         ActionMailerCacheDelivery.install
         ActionMailer::Base.delivery_method = :cache
-        ActionMailer::Base.cache_settings[:location].should == "#{Dir.tmpdir}/cache/action_mailer_cache_deliveries.cache"
+        expect(ActionMailer::Base.cache_settings[:location])
+          .to eq("#{Dir.tmpdir}/cache/action_mailer_cache_deliveries.cache")
       end
     end
   end

data/spec/cache_delivery_spec.rb

@@ -15,30 +15,32 @@ describe Mail::CacheDelivery 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
+      expect(File.exist?('/tmp/mail.cache')).to eq(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|
+      mails = File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
         Marshal.load(file)
-      end.should == [mail]
+      end
+      expect(mails).to eq([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|
+      mails = File.open(ActionMailer::Base.cache_settings[:location], 'r') do |file|
         Marshal.load(file)
-      end.length.should == 5
+      end
+      expect(mails.length).to eq(5)
     end
 
     it 'should append mail to TestMailer deliveries' do
       mail.deliver
-      Mail::TestMailer.deliveries.should == [mail]
+      expect(Mail::TestMailer.deliveries).to eq([mail])
     end
   end
 end # Mail::CachedDelivery

data/spec/spec_helper.rb

@@ -9,3 +9,10 @@ class Mailer < ActionMailer::Base
     mail(from: 'from@test.com', to: 'to@test.com', subject: 'Test email', body: 'Hello.')
   end
 end # Mailer
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_const('Rails', Module.new)
+    allow(Rails).to receive(:root).and_return(Dir.pwd)
+  end
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: action_mailer_cache_delivery
 version: !ruby/object:Gem::Version
-  version: 0.3.7
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Rodionov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Cache delivery method for ActionMailer for testing emails with Selenium
@@ -65,7 +58,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -82,33 +75,25 @@ files:
 homepage: https://github.com/p0deje/action_mailer_cache_delivery
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 583340984348986686
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 583340984348986686
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
 summary: Cache delivery method for ActionMailer
 test_files:
 - spec/action_mailer_cache_delivery_spec.rb