effective_resources 1.12.4 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78a62dc6fc911b14bbf9972a75a5a4efcb8c1be89f049c67698a8eef4d3c4c65
-  data.tar.gz: 236d6cd2e737b360d0678ca861804f7a07f841b88bf6180befef3f55e2a5194d
+  metadata.gz: 4196a26392312c2343b4ae31d4580a7c8b84a8f37d8e74c77e17d34016314b9c
+  data.tar.gz: 93d48690d2be56b1f5068bf815055de47446599b82aaf4444e52583208f368b3
 SHA512:
-  metadata.gz: 0f3030caa00296cc2aa2af8c33eeaf77ad6a7b3a08bd601a563c422e605f75f0d8ce8070f5c389c2267aca25d62fba94f391404ca8d6b2de9ce8182f0ce005cb
-  data.tar.gz: 0ceda0d79b3f8a0c9783c997c3ca40b05e00e046f4f22917560bf983b021a4b963fe7d8fc37ffcd8e996e671bdc67a9b31d0390a2fa6b074f221a7c3a17d500d
+  metadata.gz: b25bc7b63e988fe7198cdd2e5b44d79cbee612fb18839b088feb7e3c53c6b00a8c27ac76f0de796278f147e93b27d64f374cae0c00e1419350146243cfc4f9ae
+  data.tar.gz: 159c99e620737423d67963b28feefa1bda55dfd645a25835892bded90a4d616dd52e659913f3f97f246c6274a5ad5cae615c33d43c795c576a8fe6465235487a

data/app/mailers/concerns/effective_mailer.rb

@@ -0,0 +1,52 @@
+# Includes some shared mailer methods for effective_* gem mailers
+
+module EffectiveMailer
+  extend ActiveSupport::Concern
+
+  included do
+    default from: -> { mailer_settings.mailer_sender }
+    layout -> { mailer_settings.mailer_layout }
+  end
+
+  protected
+
+  def mailer_admin
+    mailer_settings.mailer_admin
+  end
+
+  def subject_for(action, subject, resource, opts = {})
+    mailer_subject = mailer_settings.mailer_subject
+
+    if mailer_subject.respond_to?(:call)
+      subject = self.instance_exec(action, subject, resource, opts, &mailer_subject)
+    end
+
+    subject
+  end
+
+  def headers_for(resource, opts = {})
+    (resource.respond_to?(:log_changes_datatable) ? opts.merge(log: resource) : opts)
+  end
+
+  private
+
+  # This returns the top level gem, EffectiveOrders or EffectiveResources
+  def mailer_settings
+    name = self.class.name.sub('::', '').sub('Mailer', '')
+
+    # If this is in a gem mailer like Effective::OrdersMailer we use constantize
+    # Otherwise this could be included in an ApplicationMailer, so we defer to EffectiveResources
+    klass = if name.start_with?('Effective')
+      name.constantize
+    else
+      name.safe_constantize || EffectiveResources
+    end
+
+    raise('expected mailer settings to respond to mailer_subject') unless klass.respond_to?(:mailer_subject)
+    raise('expected mailer settings to respond to mailer_sender') unless klass.respond_to?(:mailer_sender)
+    raise('expected mailer settings to respond to mailer_layout') unless klass.respond_to?(:mailer_layout)
+
+    klass
+  end
+
+end

data/config/effective_resources.rb

@@ -30,7 +30,7 @@ EffectiveResources.setup do |config|
   # Supported values: 'Save', 'Continue', and 'Add New'
   config.default_submits = ['Save', 'Continue', 'Add New']
 
-  # Email Settings
+  # Mailer Settings
   #
   # The default mailer settings for all effective gems
   #
@@ -43,9 +43,12 @@ EffectiveResources.setup do |config|
   # Default layout
   # config.mailer_layout = 'effective_mailer_layout'
 
+  # Customize the Subject
+  # config.mailer_subject = Proc.new { |action, subject, resource, opts = {}| subject }
+
   # Default From
-  config.mailer_sender = "no-reply@example.com"
+  config.mailer_sender = '"Info" <info@example.com>'
 
   # Send Admin correspondence To
-  config.mailer_admin = "admin@example.com"
+  config.mailer_admin = '"Admin" <admin@example.com>'
 end

data/lib/effective_resources/effective_gem.rb

@@ -3,13 +3,24 @@
 module EffectiveGem
   extend ActiveSupport::Concern
 
+  EXCLUDED_GETTERS = [
+    :config, :setup, :send_email, :parent_mailer_class,
+    :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject
+  ]
+
   included do
     raise("expected self.config_keys method") unless respond_to?(:config_keys)
 
-    config_keys.each do |key|
+    # Define getters
+    (config_keys - EXCLUDED_GETTERS).each do |key|
       self.singleton_class.define_method(key) { config()[key] }
+    end
+
+    # Define setters
+    config_keys.each do |key|
       self.singleton_class.define_method("#{key}=") { |value| config()[key] = value }
     end
+
   end
 
   module ClassMethods
@@ -39,13 +50,37 @@ module EffectiveGem
       true
     end
 
-    # This is included into every gem
-    # The gem may not have a mailer or use effective email templates
+    # Mailer Settings
+    # These methods are intended to flow through to the default EffectiveResources settings
+    def parent_mailer_class
+      config[:parent_mailer].presence&.constantize || EffectiveResources.parent_mailer_class
+    end
+
+    def deliver_method
+      config[:deliver_method].presence || EffectiveResources.deliver_method
+    end
+
+    def mailer_layout
+      config[:mailer_layout].presence || EffectiveResources.mailer_layout
+    end
+
+    def mailer_sender
+      config[:mailer_sender].presence || EffectiveResources.mailer_sender
+    end
+
+    def mailer_admin
+      config[:mailer_admin].presence || EffectiveResources.mailer_admin
+    end
+
+    def mailer_subject
+      config[:mailer_subject].presence || EffectiveResources.mailer_subject
+    end
+
     def send_email(email, *args)
       raise('gem does not respond to mailer_class') unless respond_to?(:mailer_class)
       raise('expected args to be an Array') unless args.kind_of?(Array)
 
-      mailer_class.send(email, *args).send(EffectiveResources.deliver_method)
+      mailer_class.send(email, *args).send(deliver_method)
     end
 
   end

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.12.4'.freeze
+  VERSION = '1.15.0'.freeze
 end

data/lib/effective_resources.rb

@@ -3,11 +3,12 @@ require 'effective_resources/version'
 require 'effective_resources/effective_gem'
 
 module EffectiveResources
+  MAILER_SUBJECT_PROC = Proc.new { |action, subject, resource, opts = {}| subject }
 
   def self.config_keys
     [
       :authorization_method, :default_submits,
-      :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :parent_mailer
+      :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject
     ]
   end
 
@@ -34,7 +35,9 @@ module EffectiveResources
     (['Save', 'Continue', 'Add New'] & Array(config.default_submits)).inject({}) { |h, v| h[v] = true; h }
   end
 
-  # Email
+  # Mailer Settings
+  # These serve as the default mailer settings for all effective_* gems
+  # They can be overriden on a per-gem basis.
   def self.deliver_method
     return config[:deliver_method] if config[:deliver_method].present?
 
@@ -42,10 +45,19 @@ module EffectiveResources
     (rails.respond_to?(:active_job) && rails.active_job.queue_adapter) ? :deliver_later : :deliver_now
   end
 
+  def self.parent_mailer_class
+    return config[:parent_mailer].constantize if config[:parent_mailer].present?
+    '::ApplicationMailer'.safe_constantize || 'ActionMailer::Base'.constantize
+  end
+
   def self.mailer_layout
     config[:mailer_layout] || 'effective_mailer_layout'
   end
 
+  def self.mailer_subject
+    config[:mailer_subject] || MAILER_SUBJECT_PROC
+  end
+
   def self.mailer_sender
     config[:mailer_sender] || raise('effective resources mailer_sender missing. Add it to config/initializers/effective_resources.rb')
   end
@@ -54,11 +66,6 @@ module EffectiveResources
     config[:mailer_admin] || raise('effective resources mailer_admin missing. Add it to config/initializers/effective_resources.rb')
   end
 
-  def self.parent_mailer_class
-    return config[:parent_mailer].constantize if config[:parent_mailer].present?
-    '::ApplicationMailer'.safe_constantize || 'ActionMailer::Base'.constantize
-  end
-
   # Utilities
 
   # This looks up the best class give the name
@@ -109,7 +116,6 @@ module EffectiveResources
     end
   end
 
-
   def self.advance_date(date, business_days: 1, holidays: [:ca, :observed])
     raise('business_days must be an integer <= 365') unless business_days.kind_of?(Integer) && business_days <= 365
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.12.4
+  version: 1.15.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -152,6 +152,7 @@ files:
 - app/helpers/effective_resources_helper.rb
 - app/helpers/effective_resources_private_helper.rb
 - app/helpers/effective_resources_wizard_helper.rb
+- app/mailers/concerns/effective_mailer.rb
 - app/models/concerns/acts_as_archived.rb
 - app/models/concerns/acts_as_email_form.rb
 - app/models/concerns/acts_as_purchasable_wizard.rb