effective_resources 2.23.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5203021d6f8cd741603bcf0459f4277f6227c56fde16fd21fb99cae45564667
-  data.tar.gz: 505149510d60183e7b0935a043f6be30d96dbb79099225a89c6fdc136ad1100d
+  metadata.gz: 3a0aa5a3bcbd09397c6cd7815465cdfe0882045fba170ced84f6dbf59732db87
+  data.tar.gz: 0f78f2cce168bbda0d6221d6f8ea41b143c080d97b52ad78c7193c659d1aafa7
 SHA512:
-  metadata.gz: 5efcc14c75d711551ae84574fd1bb64970273a170c7135a645af656b55be45ea8b71520827950933b13d636a32c51c5b0a4a58326666bbcf8722394ae086b6ad
-  data.tar.gz: ca89163745a47fe5be4342149df505800565cf6afc6991a9d765de4099d8b2efe17f570f27026eadaa5f7c6629edcd6d7f25c4f0ba5e6a13ea6b840f52c49f15
+  metadata.gz: 035ca01e53c2d094b2174048e9a1f27f01b64e9cf12539587ac94350402b4569562e3be33322eb44f23182a88d5eb2fa68df4d8ff491ad0b6cbc95f2d2da3c09
+  data.tar.gz: 1df2b4a3f3ba19cd4e3d2b1875cd1d58627f3ab181bdb8cf0ebf268fcec8ea8e161754ec7a1f91618dbecb71e6d8c94ee7f5163aa833444a1e616c8c066712cf

data/app/controllers/concerns/effective/crud_controller/actions.rb

@@ -28,6 +28,10 @@ module Effective
           params[resource_name].to_unsafe_h
         end
 
+        to_assign ||= if params[effective_resource_name].present? && params[effective_resource_name].respond_to?(:to_unsafe_h)
+          params[effective_resource_name].to_unsafe_h
+        end
+
         to_assign ||= if params.present?
           params.to_unsafe_h.except(:controller, :action, :id, :duplicate_id)
         end

data/app/controllers/concerns/effective/crud_controller.rb

@@ -103,6 +103,10 @@ module Effective
       effective_resource.name
     end
 
+    def effective_resource_name # effective_notification
+      effective_resource.resource_name
+    end
+
     def resource_name_id
       (effective_resource.name + '_id').to_sym
     end

data/app/controllers/concerns/effective/wizard_controller.rb

@@ -69,7 +69,7 @@ module Effective
 
     def build_wizard_resource
       resource = resource_scope.new
-      resource.strict_loading!(false) if resource.respond_to?(:strict_loading!)
+      (resource.strict_loading!(false) rescue false) if resource.respond_to?(:strict_loading!)
       resource
     end
 

data/app/helpers/effective_resources_email_helper.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module EffectiveResourcesEmailHelper
+  def mailer_froms_collection(froms: nil)
+    froms ||= EffectiveResources.mailer_froms
+
+    froms.map do |from|
+      html = content_tag(:span, escape_once(from))
+      [from, from, 'data-html': html]
+    end
+  end
+
+  # acts_as_email_form
+  def email_form_fields(form, action = nil, skip: true, to: nil, variables: nil, partial: nil)
+    raise('expected a form') unless form.respond_to?(:object)
+
+    resource = form.object
+
+    # Intended for acts_as_email_form but sometimes we use a duck typed object to save these fields as well
+    unless resource.class.respond_to?(:acts_as_email_form?) || resource.respond_to?("email_form_action=")
+      raise('expected an acts_as_email_form resource or one that responds to email_form_action') 
+    end
+
+    # Load the template.
+    email_template = if action.present? && defined?(EffectiveEmailTemplates)
+      action.kind_of?(Effective::EmailTemplate) ? action : Effective::EmailTemplate.where(template_name: action).first!
+    end
+
+    # These defaults are only used when there is no email_template
+    email_defaults = form.object.email_form_defaults(action) unless email_template.present?
+
+    from = email_template&.from || email_defaults[:from] || EffectiveResources.mailer_froms.first
+    subject = email_template&.subject || email_defaults[:subject] || ''
+    body = email_template&.body || email_defaults[:body] || ''
+    content_type = email_template&.content_type || email_defaults[:content_type] || ''
+
+    locals = {
+      form: form,
+      email_to: to,
+      email_from: from,
+      email_subject: subject,
+      email_body: body,
+      email_content_type: content_type,
+      email_skip: skip,
+      email_action: (action || true),
+      email_template: email_template,
+      email_variables: variables
+    }
+
+    render(partial: (partial || 'effective/acts_as_email_form/fields'), locals: locals)
+  end
+
+  # acts_as_email_notification
+  def email_notification_fields(form, action, partial: nil, variables: nil)
+    raise('expected a form') unless form.respond_to?(:object)
+
+    resource = form.object
+
+    # Intended for acts_as_email_notification
+    raise('expected an acts_as_email_notification resource') unless resource.class.respond_to?(:acts_as_email_notification?)
+
+    # Load the template.
+    email_template = if action.present? && defined?(EffectiveEmailTemplates)
+      action.kind_of?(Effective::EmailTemplate) ? action : Effective::EmailTemplate.where(template_name: action).first!
+    end
+
+    raise('expected an Effective::EmailTemplate') unless email_template.kind_of?(Effective::EmailTemplate)
+
+    locals = {
+      form: form,
+
+      email_from: email_template.try(:from),
+      email_subject: email_template.try(:subject),
+      email_body: email_template.try(:body),
+      email_cc: email_template.try(:cc),
+      email_bcc: email_template.try(:bcc),
+      email_content_type: email_template.try(:content_type),
+
+      email_template: email_template,
+      email_variables: variables
+    }
+
+    render(partial: (partial || 'effective/acts_as_email_notification/fields'), locals: locals)
+  end
+
+  def email_message_html?(message)
+    message.parts.find { |part| part.content_type.start_with?('text/html') }.present?
+  end
+
+  def email_message_plain?(message)
+    message.parts.find { |part| part.content_type.start_with?('text/html') }.blank?
+  end
+
+  def email_message_body(message)
+    html_body = message.parts.find { |part| part.content_type.start_with?('text/html') }.try(:body).to_s
+    plain_body = message.parts.find { |part| part.content_type.start_with?('text/plain') }.try(:body).to_s
+    message_body = message.body.to_s
+
+    html_body.presence || plain_body.presence || message_body.presence
+  end
+
+end

data/app/models/concerns/acts_as_email_form.rb

@@ -49,24 +49,24 @@ module ActsAsEmailForm
       validates :email_form_subject, liquid: true
       validates :email_form_body, liquid: true
     end
+  end
 
-    def email_form_params
-      { from: email_form_from, subject: email_form_subject, body: email_form_body }.compact
-    end
-
-    def email_form_skip?
-      EffectiveResources.truthy?(email_form_skip)
-    end
+  module ClassMethods
+    def acts_as_email_form?; true; end
+  end
 
-    # Only considered when not using an effective email template
-    def email_form_defaults(action)
-      { from: nil, subject: nil, body: nil, content_type: 'text/plain' }
-    end
+  # Instance methods
+  def email_form_params
+    { from: email_form_from, subject: email_form_subject, body: email_form_body }.compact
+  end
 
+  def email_form_skip?
+    EffectiveResources.truthy?(email_form_skip)
   end
 
-  module ClassMethods
-    def acts_as_email_form?; true; end
+  # Only considered when not using an effective email template
+  def email_form_defaults(action)
+    { from: nil, subject: nil, body: nil, content_type: 'text/plain' }
   end
 
 end

data/app/models/concerns/acts_as_email_notification.rb

@@ -0,0 +1,124 @@
+# ActsAsEmailNotification
+# Used for email notification resources that are initialized from an effective_email_template but save their own liquid template content.
+# Effective::EventNotification, Effective::PollNotification, Effective::Notification
+
+module ActsAsEmailNotification
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_email_notification
+      include ::ActsAsEmailNotification
+    end
+  end
+
+  included do
+    if respond_to?(:effective_resource)
+      effective_resource do
+        from              :string
+        cc                :string
+        bcc               :string
+
+        subject           :string
+        body              :text
+
+        content_type      :string
+      end
+    end
+
+    validates :from, presence: true, email: true
+    validates :cc, email_cc: true
+    validates :bcc, email_cc: true
+
+    validates :subject, presence: true
+    validates :body, presence: true
+
+    validates :content_type, presence: true, inclusion: { in: ['text/plain', 'text/html'] }
+
+    validates :email_template, presence: true
+
+    with_options(if: -> { defined?(EffectiveEmailTemplates) }) do
+      validates :body, liquid: true
+      validates :subject, liquid: true
+    end
+
+    validate(if: -> { email_notification_html? && body.present? }) do
+      errors.add(:body, 'expected html tags in body') if email_notification_body_plain?
+    end
+
+    validate(if: -> { email_notification_plain? && body.present? }) do
+      errors.add(:body, 'unexpected html tags found in body') if email_notification_body_html?
+    end
+
+    validate(if: -> { email_notification_subject_template.present? }) do
+      if(invalid = email_notification_subject_variables - email_template_variables).present?
+        errors.add(:subject, "Invalid variable: #{invalid.to_sentence}")
+      end
+    end
+
+    validate(if: -> { email_notification_body_template.present? }) do
+      if(invalid = email_notification_body_variables - email_template_variables).present?
+        errors.add(:body, "Invalid variable: #{invalid.to_sentence}")
+      end
+    end
+  end
+
+  module ClassMethods
+    def acts_as_email_notification?; true; end
+  end
+
+  # To be overrided
+  def email_template
+    raise('to be implemented')
+  end
+
+  def email_template_variables
+    raise('to be implemented')
+  end
+
+  def email_notification_params
+    { from: from, cc: cc.presence, bcc: bcc.presence, subject: subject, body: body, content_type: content_type }
+  end
+
+  def email_notification_html?
+    content_type == 'text/html'
+  end
+
+  def email_notification_plain?
+    content_type == 'text/plain'
+  end
+
+  def email_notification_body_html?
+    body.present? && (body.include?('</p>') || body.include?('</div>'))
+  end
+
+  def email_notification_body_plain?
+    body.present? && !(body.include?('</p>') || body.include?('</div>'))
+  end
+
+  def email_notification_body_template
+    Liquid::Template.parse(body) rescue nil
+  end
+
+  def email_notification_subject_template
+    Liquid::Template.parse(subject) rescue nil
+  end
+
+  def email_notification_body_variables
+    template = email_notification_body_template()
+    return unless template.present?
+
+    Liquid::ParseTreeVisitor.for(template.root).add_callback_for(Liquid::VariableLookup) do |node|
+      [node.name, *node.lookups].join('.')
+    end.visit.flatten.uniq.compact
+  end
+
+  def email_notification_subject_variables
+    template = email_notification_subject_template()
+    return unless template.present?
+
+    Liquid::ParseTreeVisitor.for(template.root).add_callback_for(Liquid::VariableLookup) do |node|
+      [node.name, *node.lookups].join('.')
+    end.visit.flatten.uniq.compact
+  end
+
+end

data/app/views/effective/acts_as_email_form/_fields.html.haml

@@ -4,24 +4,35 @@
   = form.check_box :email_form_skip, label: 'Do not send email'
 
 = form.hide_if :email_form_skip, true do
-  - errors = form.object.errors.present?
-
   - if email_to.present?
     = form.static_field :email_form_to, label: 'To', value: (email_to.try(:email) || email_to)
 
-  = form.select :email_form_from, mailer_froms_collection(), label: 'From', value: (email_from unless errors)
-  = form.text_field :email_form_subject, label: 'Subject', value: (email_subject unless errors)
-
-  - if email_content_type == 'text/html'
-    = form.article_editor :email_form_body, label: 'Body', mode: :email, value: (email_body unless errors)
-  - else
-    = form.text_area :email_form_body, label: 'Body', rows: 10, value: (email_body unless errors)
+  - # With errors
+  - if form.object.errors.present?
+    = form.select :email_form_from, mailer_froms_collection(), label: 'From'
+    = form.text_field :email_form_subject, label: 'Subject'
+
+    - if email_content_type == 'text/html'
+      = form.article_editor :email_form_body, label: 'Body', mode: :email
+    - else
+      = form.text_area :email_form_body, label: 'Body', rows: 10
+  
+  - # With no errors
+  - if form.object.errors.blank?
+    = form.select :email_form_from, mailer_froms_collection(), label: 'From', value: email_from
+    = form.text_field :email_form_subject, label: 'Subject', value: email_subject
+
+    - if email_content_type == 'text/html'
+      = form.article_editor :email_form_body, label: 'Body', mode: :email, value: email_body
+    - else
+      = form.text_area :email_form_body, label: 'Body', rows: 10, value: email_body
 
   - if email_variables.present?
-    %p The available variables are:
+    = card do
+      %p The available variables are:
 
-    %ul
-      - email_variables.each do |variable|
-        %li {{ #{variable} }}
+      %ul
+        - email_variables.each do |variable|
+          %li {{ #{variable} }}
 
-    %small.text-muted Please contact us to add additional variables
+      %small.text-muted Please contact us to add additional variables

data/app/views/effective/acts_as_email_notification/_fields.html.haml

@@ -0,0 +1,53 @@
+- if email_template.present?
+  %p The following #{link_to(email_template, effective_email_templates.edit_admin_email_template_path(email_template), target: '_blank')} email will be sent:
+
+= form.hidden_field :content_type, value: email_content_type
+
+- uid = effective_bootstrap_unique_id
+- expanded = form.object.cc.present? || form.object.bcc.present?
+- mailer_subject_prefix_hint = EffectiveResources.mailer_subject_prefix_hint.to_s.strip.presence
+
+- if form.object.new_record? && form.object.errors.blank?
+  .row
+    .col-md-10
+      = form.select :from, mailer_froms_collection(), label: 'From', value: email_from
+    .col-md-2.my-4
+      %a{href: "#acts-as-email-notification-collapse-#{uid}", 'data-toggle': 'collapse', role: 'button', 'aria-expanded': expanded, 'aria-controls': "acts-as-email-notification-collapse-#{uid}"} more...
+
+  .collapse{id: "acts-as-email-notification-collapse-#{uid}", class: ('show' if expanded)}
+    = form.text_field :cc, label: 'CC', value: email_cc
+    = form.text_field :bcc, label: 'BCC', value: email_bcc
+
+  = form.text_field :subject, value: email_subject, hint: (mailer_subject_prefix_hint ? "The subject of your email. It will be automatically prefixed with: #{mailer_subject_prefix_hint}" : 'The subject of your email')
+
+  - if email_content_type == 'text/html'
+    = form.article_editor :body, label: 'Body', mode: :email, value: email_body
+  - else
+    = form.text_area :body, label: 'Body', rows: 10, value: email_body
+
+- else
+  .row
+    .col-md-10
+      = form.select :from, mailer_froms_collection(), label: 'From'
+    .col-md-2.my-4
+      %a{href: "#acts-as-email-notification-collapse-#{uid}", 'data-toggle': 'collapse', role: 'button', 'aria-expanded': expanded, 'aria-controls': "acts-as-email-notification-collapse-#{uid}"} more...
+
+  .collapse{id: "acts-as-email-notification-collapse-#{uid}", class: ('show' if expanded)}
+    = form.text_field :cc, label: 'CC'
+    = form.text_field :bcc, label: 'BCC'
+
+  = form.text_field :subject, hint: (mailer_subject_prefix_hint ? "The subject of your email. It will be automatically prefixed with: #{mailer_subject_prefix_hint}" : 'The subject of your email')
+
+  - if email_content_type == 'text/html'
+    = form.article_editor :body, label: 'Body', mode: :email
+  - else
+    = form.text_area :body, label: 'Body', rows: 10
+
+- if email_variables.present?
+  = card do
+    %p You can use the following variables in the subject and body:
+
+    %ul
+      - email_variables.each do |variable|
+        %li {{ #{variable} }}
+

data/lib/effective_resources/engine.rb

@@ -24,6 +24,7 @@ module EffectiveResources
       app.config.to_prepare do
         ActiveRecord::Base.extend(ActsAsArchived::Base)
         ActiveRecord::Base.extend(ActsAsEmailForm::Base)
+        ActiveRecord::Base.extend(ActsAsEmailNotification::Base)
         ActiveRecord::Base.extend(ActsAsTokened::Base)
         ActiveRecord::Base.extend(ActsAsSlugged::Base)
         ActiveRecord::Base.extend(ActsAsStatused::Base)

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '2.23.0'.freeze
+  VERSION = '2.25.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 2.23.0
+  version: 2.25.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -194,13 +194,14 @@ files:
 - app/controllers/concerns/effective/wizard_controller/permitted_params.rb
 - app/controllers/concerns/effective/wizard_controller/save.rb
 - app/controllers/concerns/effective/wizard_controller/wicked_overrides.rb
-- app/helpers/effective_acts_as_email_form_helper.rb
+- app/helpers/effective_resources_email_helper.rb
 - 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_email_notification.rb
 - app/models/concerns/acts_as_paginable.rb
 - app/models/concerns/acts_as_purchasable_wizard.rb
 - app/models/concerns/acts_as_slugged.rb
@@ -256,6 +257,7 @@ files:
 - app/views/application/show.js.erb
 - app/views/application/update.js.erb
 - app/views/effective/acts_as_email_form/_fields.html.haml
+- app/views/effective/acts_as_email_notification/_fields.html.haml
 - app/views/effective/acts_as_wizard/_wizard_step.html.haml
 - app/views/effective/resource/_actions.html.haml
 - app/views/effective/resource/_actions_dropleft.html.haml

data/app/helpers/effective_acts_as_email_form_helper.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module EffectiveActsAsEmailFormHelper
-
-  def email_form_fields(form, action = nil, skip: true, to: nil, variables: nil, partial: nil)
-    raise('expected a form') unless form.respond_to?(:object)
-
-    resource = form.object
-
-    # Intended for acts_as_email_form but sometimes we use a duck typed object to save these fields as well
-    unless resource.class.respond_to?(:acts_as_email_form?) || resource.respond_to?("email_form_action=")
-      raise('expected an acts_as_email_form resource or one that responds to email_form_action') 
-    end
-
-    # Load the template.
-    email_template = if action.present? && defined?(EffectiveEmailTemplates)
-      action.kind_of?(Effective::EmailTemplate) ? action : Effective::EmailTemplate.where(template_name: action).first!
-    end
-
-    # These defaults are only used when there is no email_template
-    email_defaults = form.object.email_form_defaults(action) unless email_template.present?
-
-    from = email_template&.from || email_defaults[:from] || EffectiveResources.mailer_froms.first
-    subject = email_template&.subject || email_defaults[:subject] || ''
-    body = email_template&.body || email_defaults[:body] || ''
-    content_type = email_template&.content_type || email_defaults[:content_type] || ''
-
-    locals = {
-      form: form,
-      email_to: to,
-      email_from: from,
-      email_subject: subject,
-      email_body: body,
-      email_content_type: content_type,
-      email_skip: skip,
-      email_action: (action || true),
-      email_template: email_template,
-      email_variables: variables
-    }
-
-    render(partial: (partial || 'effective/acts_as_email_form/fields'), locals: locals)
-  end
-
-  def mailer_froms_collection(froms: nil)
-    froms ||= EffectiveResources.mailer_froms
-
-    froms.map do |from|
-      html = content_tag(:span, escape_once(from))
-      [from, from, 'data-html': html]
-    end
-  end
-
-end