effective_resources 1.8.17 → 1.8.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0162db8b9e57f6f0289551a07214bbba02f4154d8786fa38a92e51c023317f17
-  data.tar.gz: b993410fb958c5efa5a8d281a8def12f8b1e02c209e56ba9835d283a0e33ef44
+  metadata.gz: 180638d525bdd6d499cddd67f09595509685ebbfdc59e69ea16d89fdef6ff1fa
+  data.tar.gz: e9687c798dceef560a070a4631876ca17b401cf2e7d993c7df98dbe5af5febc4
 SHA512:
-  metadata.gz: a8d89ebcead9ac5fee2263e5dc6fe83703a103f7daa6e3501a53fdc169b14a0adc65176a46b8fa7ac3310e348afce0b805fe007d14c48a07d38811bdad2f7f6c
-  data.tar.gz: 8f59af5c2225dce3a7378317688f53a4ce79b6db2502f10cd0632b605e9ad5c02c21eba28ec45d8b428c1e1e9ba229d976c4bc1b9a944cfdbf27771f988cde95
+  metadata.gz: 41b62506a91d29ebe9049ce5de063e18412ba60cf4d63636e2cbe245d2b972a8a767d4645d2f42f5b4923b73eb867b4ea0ed508bda1ab55747d68f46dc1db4af
+  data.tar.gz: de31440669699862980273c6b1ce68b786057d200b524ec1ad0a54a09d73b8fbae9bfb372918b263fe8bc23254329ca15feb305adab7a683d86833738d0c5f6c

data/app/helpers/effective_acts_as_email_form_helper.rb

@@ -0,0 +1,32 @@
+# 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
+    raise('expected an acts_as_email_form resource') unless resource.class.respond_to?(:acts_as_email_form?)
+
+    # Load the template.
+    email_template = if action.present? && resource.email_form_effective_email_templates?
+      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?
+
+    locals = {
+      form: form,
+      email_to: to,
+      email_skip: skip,
+      email_action: (action || true),
+      email_defaults: email_defaults,
+      email_template: email_template,
+      email_variables: variables
+    }
+
+    render(partial: (partial || 'effective/acts_as_email_form/fields'), locals: locals)
+  end
+
+end

data/app/models/concerns/acts_as_email_form.rb

@@ -0,0 +1,74 @@
+# ActsAsEmailForm
+# Adds an email_form_skip, email_form_from, email_form_subject, email_form_body attr_accessors
+# And some helpful methods to render and validate a Email to Send form
+# That should work with or without effective_email_templates to send an email on a model
+
+module ActsAsEmailForm
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_email_form
+      include ::ActsAsEmailForm
+    end
+  end
+
+  included do
+    # Yes, we are submitting an email form
+    attr_accessor :email_form_action
+
+    # Skip sending the email entirely
+    attr_accessor :email_form_skip
+
+    # The email From / Subject / Body fields
+    attr_accessor :email_form_from
+    attr_accessor :email_form_subject
+    attr_accessor :email_form_body
+
+    effective_resource do
+      email_form_action      :string, permitted: true
+      email_form_skip        :boolean, permitted: true
+
+      email_form_from        :string, permitted: true
+      email_form_subject     :string, permitted: true
+      email_form_body        :text, permitted: true
+    end
+
+    with_options(if: -> { email_form_action.present? && !email_form_skip? }) do
+      validates :email_form_from, presence: true
+      validates :email_form_subject, presence: true
+      validates :email_form_body, presence: true
+
+      validate(unless: -> { email_form_from.blank? }) do
+        self.errors.add(:email_form_from, 'must be a valid email address') unless email_form_from.include?('@')
+      end
+    end
+
+    if defined?(EffectiveEmailTemplates)
+      validates :email_form_subject, liquid: true, if: -> { email_form_effective_email_templates? }
+      validates :email_form_body, liquid: true, if: -> { email_form_effective_email_templates? }
+    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
+
+    def email_form_effective_email_templates?
+      !!defined?(EffectiveEmailTemplates)
+    end
+
+    # Only considered when not using an effective email template
+    def email_form_defaults(action)
+      { from: nil, subject: nil, body: nil }
+    end
+
+  end
+
+  module ClassMethods
+    def acts_as_email_form?; true; end
+  end
+
+end

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

@@ -0,0 +1,33 @@
+= form.hidden_field :email_form_action, value: email_action
+
+- if email_skip
+  = form.check_box :email_form_skip, label: 'Do not send email'
+
+= form.hide_if :email_form_skip, true do
+  - if email_to.present? && form.respond_to?(:static_field)
+    = form.static_field :email_form_to, label: 'To', value: (email_to.respond_to?(:email) ? email_to.email : email_to)
+
+  - if form.object.errors.present?
+    = form.text_field :email_form_from, label: 'From'
+    = form.text_field :email_form_subject, label: 'Subject'
+    = form.text_area :email_form_body, label: 'Body', rows: 10
+
+  - elsif email_template.present?
+    -# email_template is an Effective::EmailTemplate
+    = form.text_field :email_form_from, label: 'From', value: email_template.from
+    = form.text_field :email_form_subject, label: 'Subject', value: email_template.subject
+    = form.text_area :email_form_body, label: 'Body', value: email_template.body, rows: 10
+
+  - else
+    = form.text_field :email_form_from, label: 'From', value: (email_defaults[:from] || '')
+    = form.text_field :email_form_subject, label: 'Subject', value: (email_defaults[:subject] || '')
+    = form.text_area :email_form_body, label: 'Body', rows: 10, value: (email_defaults[:body] || '')
+
+  - if email_variables.present?
+    %p The available variables are:
+
+    %ul
+      - email_variables.each do |variable|
+        %li {{ #{variable} }}
+
+    %small.text-muted Only a developer can add additional variables

data/lib/effective_resources/engine.rb

@@ -23,6 +23,7 @@ module EffectiveResources
     initializer 'effective_resources.active_record' do |app|
       ActiveSupport.on_load :active_record do
         ActiveRecord::Base.extend(ActsAsArchived::Base)
+        ActiveRecord::Base.extend(ActsAsEmailForm::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 = '1.8.17'.freeze
+  VERSION = '1.8.18'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.8.17
+  version: 1.8.18
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -133,10 +133,12 @@ files:
 - app/controllers/concerns/effective/wizard_controller/before_actions.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_helper.rb
 - app/helpers/effective_resources_private_helper.rb
 - app/helpers/effective_resources_wizard_helper.rb
 - app/models/concerns/acts_as_archived.rb
+- app/models/concerns/acts_as_email_form.rb
 - app/models/concerns/acts_as_slugged.rb
 - app/models/concerns/acts_as_statused.rb
 - app/models/concerns/acts_as_tokened.rb
@@ -177,6 +179,7 @@ files:
 - app/views/application/show.html.haml
 - 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/resource/_actions.html.haml
 - app/views/effective/resource/_actions_dropleft.html.haml
 - app/views/effective/resource/_actions_glyphicons.html.haml