effective_email_templates 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac065491013a9a2c051a9c35e24bdf06dab0df7a5e99b4c5e94c90611207d4b
-  data.tar.gz: 4a461d58c903499e753d86563b315c43e4067a53bff47d39a134b575b8bf6f76
+  metadata.gz: d25efc5fcbfdd39c8db6714777574361d0658757e68cfee0e88c075c0b84faa4
+  data.tar.gz: fc54755485ddc9a80b081ea1448ce4b2ecbccdb546c1b08146dbc36982499100
 SHA512:
-  metadata.gz: 86639e64193989056fe756a73602823431d7d6d4efd86f7fa02e52c4f09f707ee94b94640be9fbd79fe5092b3fe603357dae11bc01b816ebc8019fa3ec39d18b
-  data.tar.gz: '06669f2e153895afc3db34e147b63d017e7930c68c09cd464dc2e2ff0ff185462b7e9562244f3834fa6f47b19301368c8328f9c3752cd0d6ae5f3f4d22cf04b7'
+  metadata.gz: 6727c12728c12a03a74c9b126b0a16a3c2bf12b16e2dcb8efc53c66b3f9efef9a0f71df34c4a97bf3336b6e1586e606b1ae91e3cbaccfbc833c4c0653c273f51
+  data.tar.gz: cc09e802861ebbfb5564a6670fb8422c9acf9f522a5230ffdeeb56a0c5e5af7f42d80826335c4ada8cb36649b45a3589e7395228ce45b9541e0d9441d4c70a0a

data/app/helpers/effective_email_templates_helper.rb

@@ -0,0 +1,14 @@
+module EffectiveEmailTemplatesHelper
+
+  def effective_email_review_fields(form, template_name)
+    email_review = form.object.email_review
+
+    email_review ||= begin
+      email_template = Effective::EmailTemplate.where(template_name: template_name).first!
+      form.object.build_email_review(email_template: email_template)
+    end
+
+    render(partial: 'effective/email_reviews/fields', locals: { email_review: email_review, form: form })
+  end
+
+end

data/app/mailers/effective/email_templates_mailer.rb

@@ -4,7 +4,16 @@ module Effective
     def mail(headers = {}, &block)
       email_template = Effective::EmailTemplate.where(template_name: action_name).first!
 
-      assigns = route_url_assigns(email_template).merge(@assigns || {})
+      # Parse Assigns. :body is a special key
+      assigns = (@assigns || {})
+
+      if (body = assigns.delete(:body))
+        email_template.body = body
+      end
+
+      assigns = route_url_assigns(email_template).merge(assigns)
+
+      # Render from the template, possibly with updated body
       rendered = email_template.render(assigns)
 
       super(rendered.merge(headers))

data/app/models/concerns/has_one_email_review.rb

@@ -0,0 +1,30 @@
+# HasOneEmailReview
+# Allows any model to easily review an email template and make changes to the body
+
+module HasOneEmailReview
+  extend ActiveSupport::Concern
+
+  module ActiveRecord
+    def has_one_email_review
+      include ::HasOneEmailReview
+    end
+  end
+
+  included do
+    attr_accessor :email_review
+
+    validate(if: -> { email_review.present? }) do
+      self.errors.add(:base, 'reviewed email is invalid') unless email_review.valid?
+    end
+  end
+
+  def build_email_review(atts = {})
+    self.email_review ||= Effective::EmailReview.build(atts)
+  end
+
+  def email_review_attributes=(atts)
+    self.email_review = Effective::EmailReview.new(atts)
+  end
+
+end
+

data/app/models/effective/email_review.rb

@@ -0,0 +1,25 @@
+module Effective
+  class EmailReview
+    include ActiveModel::Model
+
+    attr_accessor :email_template
+    attr_accessor :body
+
+    def self.build(attributes = {})
+      new(attributes).tap do |email_review|
+        email_review.body ||= email_review.email_template&.body
+      end
+    end
+
+    validates :body, presence: true
+
+    validate(if: -> { body.present? }) do
+      begin
+        Liquid::Template.parse(body)
+      rescue Liquid::SyntaxError => e
+        errors.add(:body, e.message)
+      end
+    end
+
+  end
+end

data/app/models/effective/email_template.rb

@@ -4,10 +4,6 @@ module Effective
 
     CONTENT_TYPES = ['text/plain', 'text/html']
 
-    serialize :template_body, Liquid::Template
-    serialize :template_subject, Liquid::Template
-    serialize :template_variables, Array
-
     # Attributes
     # subject           :string
     # from              :string
@@ -16,21 +12,17 @@ module Effective
     # body              :text
     # content_type      :string
     #
-    # template_name       :string
-    # template_body       :text
-    # template_subject    :text
-    # template_variables  :text
+    # template_name     :string
     #
     # timestamps
 
     before_validation do
-      self.template_name ||= subject.to_s.parameterize
       self.content_type ||= CONTENT_TYPES.first
     end
 
     before_validation(if: -> { body.present? }) do
       begin
-        self.template_body = Liquid::Template.parse(body)
+        Liquid::Template.parse(body)
       rescue Liquid::SyntaxError => e
         errors.add(:body, e.message)
       end
@@ -38,7 +30,7 @@ module Effective
 
     before_validation(if: -> { subject.present? }) do
       begin
-        self.template_subject = Liquid::Template.parse(subject)
+        Liquid::Template.parse(subject)
       rescue Liquid::SyntaxError => e
         errors.add(:subject, e.message)
       end
@@ -48,21 +40,14 @@ module Effective
     validates :from, presence: true
     validates :body, presence: true
     validates :content_type, presence: true, inclusion: { in: CONTENT_TYPES }
-
     validates :template_name, presence: true
-    validates :template_body, presence: true
-    validates :template_subject, presence: true
-
-    before_save do
-      self.template_variables = find_template_variables
-    end
 
     def to_s
       template_name.presence || 'New Email Template'
     end
 
     def render(assigns = {})
-      assigns = assigns.deep_stringify_keys() if assigns.respond_to?(:deep_stringify_keys)
+      assigns = deep_stringify_assigns(assigns)
 
       {
         from: from,
@@ -74,9 +59,7 @@ module Effective
       }
     end
 
-    private
-
-    def find_template_variables
+    def template_variables
       [template_body.presence, template_subject.presence].compact.map do |template|
         Liquid::ParseTreeVisitor.for(template.root).add_callback_for(Liquid::VariableLookup) do |node|
           [node.name, *node.lookups].join('.')
@@ -84,6 +67,30 @@ module Effective
       end.flatten.uniq.compact
     end
 
+    private
+
+    def template_body
+      Liquid::Template.parse(body)
+    end
+
+    def template_subject
+      Liquid::Template.parse(subject)
+    end
+
+    def deep_stringify_assigns(assigns)
+      if assigns.respond_to?(:deep_stringify_keys!)
+        assigns.deep_stringify_keys!
+      end
+
+      if assigns.respond_to?(:deep_transform_values!)
+        assigns.deep_transform_values! do |value|
+          value.kind_of?(ActiveRecord::Base) ? value.to_s : value
+        end
+      end
+
+      assigns
+    end
+
   end
 
 end

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

@@ -0,0 +1,2 @@
+= form.fields_for(:email_review, email_review) do |f|
+  = f.text_area :body, rows: 10

data/db/migrate/01_create_effective_email_templates.rb.erb

@@ -1,6 +1,8 @@
 class CreateEffectiveEmailTemplates < ActiveRecord::Migration[4.2]
   def self.up
     create_table <%= @email_templates_table_name %> do |t|
+      t.string    :template_name
+
       t.string    :subject
       t.string    :from
       t.string    :bcc
@@ -9,11 +11,6 @@ class CreateEffectiveEmailTemplates < ActiveRecord::Migration[4.2]
       t.string    :content_type
       t.text      :body
 
-      t.string    :template_name
-      t.text      :template_body
-      t.text      :template_subject
-      t.text      :template_variables
-
       t.timestamps
     end
 

data/lib/effective_email_templates/engine.rb

@@ -7,6 +7,13 @@ module EffectiveEmailTemplates
       eval File.read("#{config.root}/config/effective_email_templates.rb")
     end
 
+    # Include has_one_email_review concern and allow any ActiveRecord object to call it
+    initializer 'effective_email_templates.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(HasOneEmailReview::ActiveRecord)
+      end
+    end
+
   end
 end
 

data/lib/effective_email_templates/version.rb

@@ -1,3 +1,3 @@
 module EffectiveEmailTemplates
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_email_templates
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,13 +91,17 @@ files:
 - README.md
 - app/controllers/admin/email_templates_controller.rb
 - app/datatables/effective_email_templates_datatable.rb
+- app/helpers/effective_email_templates_helper.rb
 - app/mailers/effective/email_templates_mailer.rb
+- app/models/concerns/has_one_email_review.rb
 - app/models/effective/access_denied.rb
+- app/models/effective/email_review.rb
 - app/models/effective/email_template.rb
 - app/views/admin/email_templates/_actions.html.haml
 - app/views/admin/email_templates/_form.html.haml
 - app/views/admin/email_templates/edit.html.haml
 - app/views/admin/email_templates/index.html.haml
+- app/views/effective/email_reviews/_fields.html.haml
 - app/views/layouts/effective_email_templates_mailer_layout.html.haml
 - config/effective_email_templates.rb
 - config/email_templates_mailer.rb