outbox-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16b0ef1c8739ebb7a5111e9f21ae02cf5d7f6cb9
-  data.tar.gz: 35e6634f4ce96b930cfbd8707f1895a292824554
+  metadata.gz: 91a62722084b298ce8cc71b4225743d1ded08c8f
+  data.tar.gz: 4c282c245537e0b0b56e2c325fd50e5ed168814e
 SHA512:
-  metadata.gz: 0486bee46a316dd4e87de33b70319d7f32939e1bbdc61efd99e3bcb85364757a3a319c6c50ae791b128ec6a0bc43c7ab71d4e50dd8364653a202868197081d70
-  data.tar.gz: 5e2b1ceff8710a8d5ab5b6d5933226791c2bef7196f3eea3c8de1b0f2f9dfeffc39c81409639a517dac11f812bb0c43e6ebbb9867a2ec4d5e14ff350de5ced96
+  metadata.gz: b4f52277e2f943095288ca66c3365799a1ee3785f673cf5aae89858c3958b69d7b829d2bce60eb6d0b8e3c0cd53c06f1e9abc8a5bdfb2c2e70b63874de299e97
+  data.tar.gz: a26a2fb0b2f945f694dfa6e4eb17a32e0d3dd44d0d50f0f38225db33233d6f272969076814bc67989073565f8bb66a360f4260de041a21afb8a818ccc58aeb90

data/README.md

@@ -66,6 +66,22 @@ Send a message using the `deliver` method:
 AccountNotifier.welcome.deliver email: 'user@gmail.com', sms: '+15557654321'
 ```
 
+### Variants (New with Rails 4.1)
+
+You can have different templates for each message type using [variants](http://edgeguides.rubyonrails.org/4_1_release_notes.html#action-pack-variants). *Right now, only the implicit template rendering is supported.*
+
+``` html+ruby
+<!-- app/views/account_notifier/welcome.html+email.erb -->
+<h1>Welcome!</h1>
+
+<!-- app/views/account_notifier/welcome.text+email.erb -->
+Welcome! (email)
+
+<!-- app/views/account_notifier/welcome.text+sms.erb -->
+Welcome! (sms)
+```
+
+
 Configuration
 -------------
 

data/lib/outbox/notifier.rb

@@ -38,13 +38,18 @@ module Outbox
 
     def initialize(method_name = nil, *args) # :nodoc:
       super()
-      # Make sure we don't ever get a NullMail object.
-      @_mail_was_called = true
       @_message_rendered = false
       @_message = build_message
       process(method_name, *args) if method_name
     end
 
+    def process(*args) # :nodoc:
+      original_message = @_message
+      super
+      # Make sure we don't ever get a NullMail object.
+      @_message = original_message
+    end
+
     # The composed Outbox::Message instance.
     def message
       render_message unless message_rendered?
@@ -61,25 +66,9 @@ module Outbox
     # #message object is retrieved.
     def render_message(options = {}, &block)
       @_message_rendered = true
-      if @_message.email
-        email = @_message.email
-        skip_email = false
-      else
-        email = Outbox::Messages::Email.new
-        skip_email = true
-      end
-
-      # Render an email using the #mail interface so we don't have
-      # to rewrite the template logic. Even if we aren't sending an email
-      # we can still use the rendered templates in other messages types.
-      begin
-        render_email(email, options, &block)
-      rescue ActionView::MissingTemplate => error
-        raise error unless skip_email
-      end
-
+      render_email(@_message.email, options, &block) if @_message.email
+      render_message_types(options)
       @_message.assign_message_type_values(options)
-      assign_body_from_email(email)
       @_message
     end
 
@@ -101,6 +90,10 @@ module Outbox
 
     protected
 
+    def details_for_lookup
+      { variants: message_types }
+    end
+
     def build_message
       message = Outbox::Message.new(self.class.default_params.dup)
       Outbox::Message.message_types.each_key do |message_type|
@@ -109,16 +102,6 @@ module Outbox
       message
     end
 
-    def assign_body_from_email(email)
-      text_part = email.parts.find { |p| p.mime_type == 'text/plain' }
-      if text_part
-        @_message.each_message_type do |message_type, message|
-          next if message.nil? || message_type == :email
-          message.body = text_part.body.raw_source
-        end
-      end
-    end
-
     def render_email(email, options, &block)
       email_options = options.extract!(
         :content_type, :charset, :parts_order,
@@ -137,6 +120,46 @@ module Outbox
       email
     end
 
+    def render_message_types(options)
+      templates = find_message_type_templates(options)
+      templates.each do |template|
+        variants = (template.try(:variants) || []).compact
+        body = render(template: template)
+        assign_body(body, variants.empty? ? nil : variants)
+      end
+    end
+
+    def find_message_type_templates(options)
+      template_path = options[:template_path] || self.class.mailer_name
+      template_name = options[:template_name] || action_name
+      lookup_context.find_all(
+        template_name, Array(template_path), false, [],
+        formats: [:text],
+        variants: message_types_without_email
+      )
+    end
+
+    def assign_body(body, only_message_types = nil)
+      if only_message_types
+        only_message_types = only_message_types.map(&:to_sym)
+      else
+        only_message_types = message_types_without_email
+      end
+      @_message.each_message_type do |message_type, message|
+        if message && message.body.nil? && message_type.in?(only_message_types)
+          message.body = body
+        end
+      end
+    end
+
+    def message_types
+      Outbox::Message.message_types.keys
+    end
+
+    def message_types_without_email
+      message_types - [:email]
+    end
+
     ActiveSupport.run_load_hooks(:outbox_notifier, self)
   end
 end

data/lib/outbox/rails/version.rb

@@ -1,5 +1,5 @@
 module Outbox
   module Rails
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/outbox-rails.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'outbox', '~> 0.2.0'
-  spec.add_runtime_dependency 'rails', '~> 4.0.0'
+  spec.add_runtime_dependency 'rails', ['>= 4.0', '<= 4.2']
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/spec/internal/app/notifiers/base_notifier.rb

@@ -28,4 +28,7 @@ class BaseNotifier < Outbox::Notifier
       body 'Explicit Message'
     end
   end
+
+  def implicit_variants
+  end
 end

data/spec/internal/app/views/base_notifier/implicit_variants.text+email.erb

@@ -0,0 +1 @@
+Email Variant

data/spec/internal/app/views/base_notifier/implicit_variants.text+sms.erb

@@ -0,0 +1 @@
+SMS Variant

data/spec/outbox/notifier_spec.rb

@@ -97,5 +97,13 @@ describe Outbox::Notifier do
         BaseNotifier.explicit_sms_message
       }.to raise_error(ActionView::MissingTemplate)
     end
+
+    if Rails.version >= '4.1'
+      it 'supports implicit variants by message type' do
+        message = BaseNotifier.implicit_variants
+        expect(message.email.body.encoded.strip).to eql('Email Variant')
+        expect(message.sms.body.strip).to eql('SMS Variant')
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outbox-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pete Browne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: outbox
@@ -28,16 +28,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - <=
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - <=
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +180,8 @@ files:
 - spec/internal/app/views/base_notifier/custom_headers.erb
 - spec/internal/app/views/base_notifier/implicit_multipart.html.erb
 - spec/internal/app/views/base_notifier/implicit_multipart.text.erb
+- spec/internal/app/views/base_notifier/implicit_variants.text+email.erb
+- spec/internal/app/views/base_notifier/implicit_variants.text+sms.erb
 - spec/internal/app/views/base_notifier/welcome.erb
 - spec/internal/app/views/customized_notifier/with_defaults.erb
 - spec/internal/config/database.yml
@@ -218,6 +226,8 @@ test_files:
 - spec/internal/app/views/base_notifier/custom_headers.erb
 - spec/internal/app/views/base_notifier/implicit_multipart.html.erb
 - spec/internal/app/views/base_notifier/implicit_multipart.text.erb
+- spec/internal/app/views/base_notifier/implicit_variants.text+email.erb
+- spec/internal/app/views/base_notifier/implicit_variants.text+sms.erb
 - spec/internal/app/views/base_notifier/welcome.erb
 - spec/internal/app/views/customized_notifier/with_defaults.erb
 - spec/internal/config/database.yml