redis_cache_mailer_delivery 0.0.4 → 0.0.5

data/Guardfile

@@ -6,6 +6,7 @@ guard :rspectacle, :cli => '--format documentation --backtrace' do
   watch('spec/spec_helper.rb')                        { %w(spec/spec_helper spec) }
 
   watch(%r{^spec/.+_spec\.rb$})
-
-  watch(%r{^lib/(.+)\.rb$})                           { |m| ["lib/#{m[1]}.rb", "spec/lib/#{m[1]}_spec.rb"] }
+  watch('lib/redis_cache_mailer_delivery.rb')  { ['spec/redis_cache_mailer_delivery_spec.rb', 'lib/redis_cache_mailer_delivery.rb' ] }
+  watch(/lib\/redis_cache_mailer_delivery\/converters\/(.+).rb/)  {|m| ["spec/redis_cache_mailer_delivery/converters/#{m[1]}_spec.rb", "lib/redis_cache_mailer_delivery/converters/#{m[1]}.rb" ] }
+  watch(/lib\/redis_cache_mailer_delivery\/(.+).rb/)  {|m| ["spec/redis_cache_mailer_delivery/#{m[1]}_spec.rb", "lib/redis_cache_mailer_delivery/#{m[1]}.rb" ] }
 end

data/README.md

@@ -31,15 +31,20 @@ In a Rails project, in your environment files such as config/environments/cucumb
 
 ```ruby
 config.action_mailer.delivery_method = :redis_cache
-config.action_mailer.redis_cache_settings = { :redis_key_name => "a_key_name_for_all_stored_emails" }
+config.action_mailer.redis_cache_settings = { :redis_key_name => "a_key_name_for_all_stored_emails",
+:marshallable_converters => [:sequel_record_marshallable, Marshallable::Attrubute1] }
 ```
 
-You don't have to define the redis_key_name, the default is 
+You don't have to define the settings, the default ```redis_key_name``` is 
 
 ```ruby
 "redis_cache_mailer_delivery:mail_messages"
 ```
 
+the default ```marshallable_converters``` is an empty array
+
+The meaning of ```marshallable_converters``` will be discussed in the next section.
+
 All the mails being delivered will be written into the redis storage. You can use
 
 ```ruby
@@ -48,13 +53,31 @@ RedisCacheMailerDelivery::Deliveries.all
 
 to access all the mails
 
-## Sequel
+## Marshallable Converters
+
+If you use Sequel and you set a sequel record into the Mail::Message (```mail.record = record```), the chances are you will encounter an error where you cannot serialize the message since the record might be a singleton.
+
+The remedy provided by this gem is to provide a mechanism to make the mail to be marshallable before it marshals it, as well as some built-in class for making the object to be marshallable.
+
+```marshallable_converters``` setting accepts an array. Each element could be a symbol, or a class. 
+
+When it is a class, the class must have a class method ```marshallable``` which accpets the mail object as the only param. The method will take the mail and convert it into a marshallable object.
 
-If you use Sequel and you set a sequel record into the Mail::Message (```mail.record = record```), the chances are you will encounter an error where you cannot serialize the message since the record might be a singleton. The gem has a builtin fix for this by using marshallable! method provied by Sequel since 3.6.0
+When it is a symbol, it means it is a built-in converter. For example ```:sequel_record_marshallable``` will convert a Mail::Message containg a singlton Sequel record into marshallable one by use Sequel's ```marshallable!``` method.
 
-## Other unmarshallable objects
+Currently the built-in only converter is ```:sequel_record_marshallable```
 
-The code will find if the mail being passed in responds to ```marshallable``` method, if it does, the code will call ```marshallable``` method before send it to the redis store
+The order of the ```:marshallable_converters``` could be important. The gem always goes through the converters in the order.
+
+So for example, if you have:
+
+```ruby
+config.action_mailer.redis_cache_settings = { :marshallable_converters => [Marshallable::Attrubute2, Marshallable::Attrubute1] }
+```
+
+The gem calls: ```object1 = Marshallable::Attrubute2.marshallable(mail)```, then it calls ```object2 = Marshallable::Attrubute1.marshallable(object1)```
+ 
+So if you must have ```attrubute1``` to be marshallable first, then make the ```attrubute2``` marshallable. You have to switch the order in this example.
 
 ## Contributing
 

data/lib/redis_cache_mailer_delivery.rb

@@ -1,14 +1,16 @@
 require 'action_mailer'
 require 'redis_cache_mailer_delivery/version'
-require 'redis_cache_mailer_delivery/mail/cache_delivery'
-require 'redis_cache_mailer_delivery/mail/sequel_marshallable_mail_message'
+require 'redis_cache_mailer_delivery/marshallable_converter_setting'
+require 'redis_cache_mailer_delivery/cache_delivery'
+require 'redis_cache_mailer_delivery/converters/sequel_marshallable_mail_message'
 require 'redis_cache_mailer_delivery/deliveries'
 
 module RedisCacheMailerDelivery
   class << self
     def install
-      ActionMailer::Base.add_delivery_method :redis_cache, Mail::CacheDelivery,
-        :redis_key_name => "redis_cache_mailer_delivery:mail_messages"
+      ActionMailer::Base.add_delivery_method :redis_cache, RedisCacheMailerDelivery::CacheDelivery,
+        :redis_key_name => "redis_cache_mailer_delivery:mail_messages",
+        :marshallable_converters => []
     end
 
   end # << self

data/lib/redis_cache_mailer_delivery/{mail/cache_delivery.rb → cache_delivery.rb}

@@ -1,4 +1,4 @@
-module Mail
+module RedisCacheMailerDelivery
   #
   # Performs deliveries to redis storage, so mails can accessed from
   # other processes.
@@ -17,9 +17,10 @@ module Mail
     # @api private
     def deliver!(mail)
       list = Redis::List.new settings[:redis_key_name], :marshal => true
-      mail = SequelMarshallableMailMessage.marshallable mail
-      object = mail.respond_to?(:marshallable) ? mail.marshallable : mail
-      list << object
+      settings[:marshallable_converters].each do |setting|
+        mail = MarshallableConverterSetting.new(setting).marshallable_class.marshallable(mail)
+      end
+      list << mail
     end
 
   end # CacheDelivery

data/lib/redis_cache_mailer_delivery/converters/sequel_marshallable_mail_message.rb

@@ -0,0 +1,13 @@
+module RedisCacheMailerDelivery
+  module Converters
+    module SequelMarshallableMailMessage
+      class << self
+        def marshallable(object)
+          return object unless object.respond_to?(:record)
+          object.record.marshallable! if object.record.respond_to?(:marshallable!)
+          object
+        end
+      end
+    end
+  end
+end

data/lib/redis_cache_mailer_delivery/marshallable_converter_setting.rb

@@ -0,0 +1,19 @@
+module RedisCacheMailerDelivery
+  class MarshallableConverterSetting
+    attr_reader :converter_name
+    class << self
+      def builtin_settings
+        { :sequel_record_marshallable => RedisCacheMailerDelivery::Converters::SequelMarshallableMailMessage }
+      end
+    end
+
+    def initialize(converter_name)
+      @converter_name = converter_name
+    end
+
+    def marshallable_class
+      builtin_class = self.class.builtin_settings[converter_name]
+      builtin_class.nil? ? converter_name : builtin_class
+    end
+  end
+end

data/lib/redis_cache_mailer_delivery/version.rb

@@ -1,3 +1,3 @@
 module RedisCacheMailerDelivery
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/redis_cache_mailer_delivery/cache_delivery_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+module RedisCacheMailerDelivery
+  describe CacheDelivery do
+    subject {described_class.new :redis_key_name => "a-name", :marshallable_converters => []}
+    describe "#deliver!" do
+      let(:object) {Mail::Message.new}
+
+      after(:each) do
+        Redis.current.del "a-name"
+      end
+      it "puts a object into the redis store" do
+        subject.deliver!(object)
+        Redis::List.new("a-name", :marshal => true).values[0].should eq(object)
+      end
+
+      context "with marshallable_converters" do
+        let(:class1) {double :class1, :marshallable => object1}
+        let(:class2) {double :class1, :marshallable => object2}
+        subject {described_class.new :redis_key_name => "a-name", :marshallable_converters => [class1, class2]}
+        let(:object1) {double :object1}
+        let(:object2) {Mail::Message.new}
+        it "calls the converters and marshal the last object" do
+          subject.deliver!(object)
+          Redis::List.new("a-name", :marshal => true).values[0].should eq(object2)
+        end
+      end
+    end
+  end
+end

data/spec/redis_cache_mailer_delivery/{mail → converters}/sequel_marshallable_mail_message_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Mail::SequelMarshallableMailMessage do
+describe RedisCacheMailerDelivery::Converters::SequelMarshallableMailMessage do
   let(:object) {Class.new.new}
   describe "#marshallable" do
     context "when the message responds to the record message" do

data/spec/redis_cache_mailer_delivery/marshallable_converter_setting_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+module RedisCacheMailerDelivery
+  describe MarshallableConverterSetting do
+    describe ".builtin_settings" do
+      it "returns the hash of builtin marshallable converters" do
+        described_class.builtin_settings.should eq({:sequel_record_marshallable => RedisCacheMailerDelivery::Converters::SequelMarshallableMailMessage})
+      end
+    end
+    describe "#marshallable_class" do
+      before(:each) do
+        described_class.stub(:builtin_settings) {{:name => Object}}
+      end
+      context "when the converter name is one of builtins" do
+        subject {described_class.new :name}
+        it "returns the corresponding class" do
+          subject.marshallable_class.should eq(Object)
+        end
+      end
+      context "when the converter name is not one of builtins" do
+        subject {described_class.new Module}
+        it "returns the name" do
+          subject.marshallable_class.should eq(Module)
+        end
+      end
+    end
+  end
+end
+

data/spec/redis_cache_mailer_delivery_spec.rb

@@ -4,7 +4,17 @@ describe RedisCacheMailerDelivery do
   describe ".install" do
     it "adds a delivery method to the ActionMailer" do
       described_class.install
-      ActionMailer::Base.delivery_methods.should include(:redis_cache => Mail::CacheDelivery)
+      ActionMailer::Base.delivery_methods.should include(:redis_cache => RedisCacheMailerDelivery::CacheDelivery)
+    end
+
+    it "defaults the redis_key_name to redis_cache_mailer_delivery:mail_messages" do
+      described_class.install
+      ActionMailer::Base.redis_cache_settings[:redis_key_name].should eq('redis_cache_mailer_delivery:mail_messages')
+    end
+
+    it "defaults the marshallable converters to empty array" do
+      described_class.install
+      ActionMailer::Base.redis_cache_settings[:marshallable_converters].should eq([])
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redis_cache_mailer_delivery
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Yi Wen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-25 00:00:00 Z
+date: 2012-03-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redis
@@ -150,15 +150,17 @@ files:
 - README.md
 - Rakefile
 - lib/redis_cache_mailer_delivery.rb
+- lib/redis_cache_mailer_delivery/cache_delivery.rb
+- lib/redis_cache_mailer_delivery/converters/sequel_marshallable_mail_message.rb
 - lib/redis_cache_mailer_delivery/deliveries.rb
-- lib/redis_cache_mailer_delivery/mail/cache_delivery.rb
-- lib/redis_cache_mailer_delivery/mail/sequel_marshallable_mail_message.rb
+- lib/redis_cache_mailer_delivery/marshallable_converter_setting.rb
 - lib/redis_cache_mailer_delivery/railtie.rb
 - lib/redis_cache_mailer_delivery/version.rb
 - redis_cache_mailer_delivery.gemspec
+- spec/redis_cache_mailer_delivery/cache_delivery_spec.rb
+- spec/redis_cache_mailer_delivery/converters/sequel_marshallable_mail_message_spec.rb
 - spec/redis_cache_mailer_delivery/deliveries_spec.rb
-- spec/redis_cache_mailer_delivery/mail/cache_delivery_spec.rb
-- spec/redis_cache_mailer_delivery/mail/sequel_marshallable_mail_message_spec.rb
+- spec/redis_cache_mailer_delivery/marshallable_converter_setting_spec.rb
 - spec/redis_cache_mailer_delivery_spec.rb
 - spec/spec_helper.rb
 - spec/support/faked_rails.rb
@@ -197,9 +199,10 @@ signing_key:
 specification_version: 3
 summary: Use Redis to store the Mail::Message when using in Rails
 test_files: 
+- spec/redis_cache_mailer_delivery/cache_delivery_spec.rb
+- spec/redis_cache_mailer_delivery/converters/sequel_marshallable_mail_message_spec.rb
 - spec/redis_cache_mailer_delivery/deliveries_spec.rb
-- spec/redis_cache_mailer_delivery/mail/cache_delivery_spec.rb
-- spec/redis_cache_mailer_delivery/mail/sequel_marshallable_mail_message_spec.rb
+- spec/redis_cache_mailer_delivery/marshallable_converter_setting_spec.rb
 - spec/redis_cache_mailer_delivery_spec.rb
 - spec/spec_helper.rb
 - spec/support/faked_rails.rb

data/lib/redis_cache_mailer_delivery/mail/sequel_marshallable_mail_message.rb

@@ -1,11 +0,0 @@
-module Mail
-  module SequelMarshallableMailMessage
-    class << self
-      def marshallable(object)
-        return object unless object.respond_to?(:record)
-        object.record.marshallable! if object.record.respond_to?(:marshallable!)
-        object
-      end
-    end
-  end
-end

data/spec/redis_cache_mailer_delivery/mail/cache_delivery_spec.rb

@@ -1,36 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
-
-module Mail
-  describe CacheDelivery do
-    subject {described_class.new :redis_key_name => "a-name"}
-    describe "#deliver!" do
-      let(:object) {Mail::Message.new}
-
-      after(:each) do
-        Redis.current.del "a-name"
-      end
-      it "puts a object into the redis store" do
-        subject.deliver!(object)
-        Redis::List.new("a-name", :marshal => true).values[0].should eq(object)
-      end
-
-      it "tries to make it marshallable first by passing it through SequelMarshallableMailMessage" do
-        SequelMarshallableMailMessage.should_receive(:marshallable).with(object).and_return object
-        subject.deliver!(object)
-      end
-
-      context "when the object respond to marshallable" do
-        before(:each) do
-          def object.marshallable
-            Mail::Message.new
-          end
-        end
-        
-        it "calls the method before send to redis" do
-          object.should_receive(:marshallable).and_return Mail::Message.new
-          subject.deliver!(object)
-        end
-      end
-    end
-  end
-end