effective_resources 2.23.0 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5203021d6f8cd741603bcf0459f4277f6227c56fde16fd21fb99cae45564667
-  data.tar.gz: 505149510d60183e7b0935a043f6be30d96dbb79099225a89c6fdc136ad1100d
+  metadata.gz: d92db06b508d630c29e392525580e558bc4fa5505358a04dcc371397ef0c6bc3
+  data.tar.gz: e808c12ee8b6e047409ec0c5fb4855db64abfe79f15b35769f324b0202ad97e8
 SHA512:
-  metadata.gz: 5efcc14c75d711551ae84574fd1bb64970273a170c7135a645af656b55be45ea8b71520827950933b13d636a32c51c5b0a4a58326666bbcf8722394ae086b6ad
-  data.tar.gz: ca89163745a47fe5be4342149df505800565cf6afc6991a9d765de4099d8b2efe17f570f27026eadaa5f7c6629edcd6d7f25c4f0ba5e6a13ea6b840f52c49f15
+  metadata.gz: 17830298a77d5f208d346b7a154da717c3670803d9868c803fa08f57f1fb37a0ebcab523a476970be3e90fbdc35fb3df2d4cf2508ddb5f48f7956d8767991b0a
+  data.tar.gz: c03f3f837d93e5c4ed6506f6110cdc737aa3643c1ec0fd88f93168d4dc7f06650253eb9daf09b55e3a949f1f8835926575e6fae98d8a36b55a0834c2569316c5

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_acts_as_email_form_helper.rb → effective_resources_email_helper.rb}

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
-module EffectiveActsAsEmailFormHelper
+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)
 
@@ -41,13 +50,38 @@ module EffectiveActsAsEmailFormHelper
     render(partial: (partial || 'effective/acts_as_email_form/fields'), locals: locals)
   end
 
-  def mailer_froms_collection(froms: nil)
-    froms ||= EffectiveResources.mailer_froms
+  # acts_as_email_notification
+  def email_notification_fields(form, action, partial: nil, variables: nil)
+    raise('expected a form') unless form.respond_to?(:object)
 
-    froms.map do |from|
-      html = content_tag(:span, escape_once(from))
-      [from, from, 'data-html': html]
+    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
 
+
 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,82 @@
+# 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
+  end
+
+  module ClassMethods
+    def acts_as_email_notification?; true; end
+  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
+
+  # To be overrided
+  def email_template
+    nil
+  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?
+
+- 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, label: 'Subject', value: email_subject
+
+  - 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, label: 'Subject'
+
+  - 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 The available variables are:
+
+    %ul
+      - email_variables.each do |variable|
+        %li {{ #{variable} }}
+
+    %small.text-muted Please contact us to add additional variables

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.24.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.24.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-24 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