effective_email_templates 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d32e71af524fb3658debbf8210a4239b4bbd98f7a806f0a743735e62bc135dc
-  data.tar.gz: f6064f01a1a679b3c4bf1abca99222ab4ba191d4bb0ee16a1ac23ddad644c368
+  metadata.gz: 3f5c8f6d7991aa4a349fecda1ea4fc687df0facb55214d176a0030720ede39db
+  data.tar.gz: 7882e4790ff27ff4c60d5985bc501df2fac90bba84e96dcb7b44f7d63dfe3657
 SHA512:
-  metadata.gz: 360328a697866d2d802d7c882bcfbd9c0be6e148c0b6d98114417088af72b9ea74cc935d275b6396a8be64becd88749536f491b1cfcb0f953e8ab1c739ba276e
-  data.tar.gz: 5cad8e018ad138e6050278c36e39a69a631a06773bc8d87aeee9986a96b56de9ab3f491198634eea514126f30241a0536b2b8ccceb9721f5e6a7da928e7f0b63
+  metadata.gz: f36ac864bc2efe007f7f06555aefe5a5a9abdae549dc2b4ed44db66033858efb1c26cac1ab7679ce6bb4321c2a3468fc8b80399347682c76b412e05ba74acdbf
+  data.tar.gz: 4ef1228155f5f2940e36af9a9b1c7373147954eb241fe5573c15f880b00231e8f86b6dec1eba53b24bea6b29c688c861b983ffc94a716f55a13c349b39a7f329

data/app/datatables/effective_email_templates_datatable.rb

@@ -9,7 +9,10 @@ class EffectiveEmailTemplatesDatatable < Effective::Datatable
 
     col :template_name, label: 'Name'
 
-    col :from, search: EffectiveEmailTemplates.mailer_froms
+    col :from, search: EffectiveEmailTemplates.mailer_froms do |email_template|
+      ERB::Util.html_escape_once(email_template.from)
+    end
+
     col :cc
     col :bcc
     col :subject

data/app/mailers/concerns/effective_email_templates_mailer.rb

@@ -42,11 +42,40 @@ module EffectiveEmailTemplatesMailer
       end
     end
 
-    super(merged)
+    # Process body as plain text or html
+    body = merged.fetch(:body) || ''
+
+    # For text/plain emails
+    if email_template.plain?
+      stripped = body.strip
+
+      if stripped.starts_with?('<p>') || stripped.ends_with?('</p>')
+        raise("unexpected html content found when when rendering text/plain email_template #{action_name}")
+      end
+
+      return super(merged) 
+    end
+
+    # For text/html emails
+    layout = mailer_layout().presence || raise("expected a mailer layout when rendering text/html email_template #{action_name}")
+
+    super(merged.except(:body, :content_type)) do |format|
+      format.text { strip_tags(body) }
+      format.html { render(layout: layout, inline: body) }
+    end
+  end
+
+  def mailer_layout
+    try(:mailer_settings).try(:mailer_layout) || EffectiveEmailTemplates.mailer_layout
   end
 
   private
 
+  def strip_tags(html)
+    return html if html.blank?
+    view_context.strip_tags(html.gsub(/<\/(div|p|br|h[1-6])>/, "\n"))
+  end
+
   def route_url_assigns(email_template, existing)
     route_variables = email_template.template_variables
       .select { |name| name.ends_with?('_url') }

data/app/models/effective/email_template.rb

@@ -1,29 +1,35 @@
 module Effective
   class EmailTemplate < ActiveRecord::Base
+    include ActionView::Helpers::TextHelper
+
     self.table_name = (EffectiveEmailTemplates.email_templates_table_name || :email_templates).to_s
 
     attr_accessor :current_user
 
     log_changes if respond_to?(:log_changes)
 
-    CONTENT_TYPES = ['text/plain', 'text/html']
+    CONTENT_TYPE_PLAIN = 'text/plain'
+    CONTENT_TYPE_HTML = 'text/html'
+    CONTENT_TYPES = [CONTENT_TYPE_PLAIN, CONTENT_TYPE_HTML]
 
     effective_resource do
       template_name     :string
-      content_type      :string
 
-      subject           :string
       from              :string
       cc                :string
       bcc               :string
+
+      subject           :string
       body              :text
 
+      content_type      :string
+
       timestamps
     end
 
     before_validation do
-      self.content_type ||= CONTENT_TYPES.first
       self.from ||= EffectiveEmailTemplates.mailer_froms.first
+      self.content_type ||= CONTENT_TYPES.first
     end
 
     validates :body, liquid: true
@@ -35,28 +41,38 @@ module Effective
     validates :content_type, presence: true, inclusion: { in: CONTENT_TYPES }
     validates :template_name, presence: true
 
-    # validate(if: -> { content_type == 'text/html' && body.present? }) do
-    #   unless body.include?('<') && body.include?('>')
-    #     self.errors.add(:content_type, 'expected html tags in body')
-    #     self.errors.add(:body, 'expected html tags in body')
-    #   end
-    # end
+    validate(if: -> { html? && body.present? }) do
+      errors.add(:body, 'expected html tags in body') if body_plain?
+    end
 
-    # validate(if: -> { content_type == 'text/plain' && body.present? }) do
-    #   if body.include?('</a>') || body.include?('</p>')
-    #     self.errors.add(:content_type, 'expected no html tags in body')
-    #     self.errors.add(:body, 'expected no html tags in body')
-    #   end
-    # end
+    validate(if: -> { plain? && body.present? }) do
+      errors.add(:body, 'unexpected html tags found in body') if body_html?
+    end
 
     def to_s
       template_name.presence || 'New Email Template'
     end
 
+    def html?
+      content_type == CONTENT_TYPE_HTML
+    end
+
+    def plain?
+      content_type == CONTENT_TYPE_PLAIN
+    end
+
+    def body_html?
+      body.present? && (body.include?('</p>') || body.include?('</div>'))
+    end
+
+    def body_plain?
+      body.present? && !(body.include?('</p>') || body.include?('</div>'))
+    end
+
     def render(assigns = {})
       assigns = deep_stringify_assigns(assigns)
 
-      result = {
+      {
         from: from,
         cc: cc.presence,
         bcc: bcc.presence,
@@ -74,6 +90,18 @@ module Effective
       end.flatten.uniq.compact
     end
 
+    def save_as_html!
+      assign_attributes(content_type: 'text/html')
+      assign_attributes(body: simple_format(body)) if body_plain?
+      save!
+    end
+
+    def save_as_plain!
+      assign_attributes(content_type: 'text/plain')
+      assign_attributes(body: strip_tags(body)) if body_html?
+      save!
+    end
+
     private
 
     def template_body

data/app/views/admin/email_templates/_form.html.haml

@@ -9,21 +9,22 @@
   = f.text_field :bcc
 
   - prefix_hint = EffectiveResources.mailer_subject_prefix_hint.to_s.strip.presence
+  = f.text_field :subject, hint: (prefix_hint ? "The subject of your email. It will be automatically prefixed with: #{prefix_hint}" : 'The subject of your email')
 
-  = f.text_field :subject,
-    hint: (prefix_hint ? "The subject of your email. It will be automatically prefixed with #{prefix_hint}." : 'The subject of your email')
+  = f.show_if(:content_type, Effective::EmailTemplate::CONTENT_TYPE_PLAIN) do
+    = f.text_area :body, hint: 'The text/plain content of your email template', rows: 10
+  
+  = f.show_if(:content_type, Effective::EmailTemplate::CONTENT_TYPE_HTML) do
+    = f.article_editor :body, hint: 'The text/html content of your email template', mode: :email
 
-  = f.text_area :body, hint: 'The content of your email template', rows: 10
+  = card do
+    %p The available variables for this email template are:
 
-  .card
-    .card-body
-      %p The available variables for this email template are:
+    %ul
+      - Array(f.object.template_variables).each do |variable|
+        %li {{ #{variable} }}
 
-      %ul
-        - Array(f.object.template_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
 
   = f.submit do
     = f.save 'Save'

data/lib/effective_email_templates/version.rb

@@ -1,3 +1,3 @@
 module EffectiveEmailTemplates
-  VERSION = '1.7.0'.freeze
+  VERSION = '1.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_email_templates
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement