effective_resources 1.8.17 → 1.8.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0162db8b9e57f6f0289551a07214bbba02f4154d8786fa38a92e51c023317f17
-  data.tar.gz: b993410fb958c5efa5a8d281a8def12f8b1e02c209e56ba9835d283a0e33ef44
+  metadata.gz: '0995557680ae1cce106214f47b32fcbb0e3250d3f9d07c2c80dfddbae0a2c133'
+  data.tar.gz: 4d707fb4403abdb45f86930f8375d91bdfcc74aaa6a3fd96df8e625cdef12ae2
 SHA512:
-  metadata.gz: a8d89ebcead9ac5fee2263e5dc6fe83703a103f7daa6e3501a53fdc169b14a0adc65176a46b8fa7ac3310e348afce0b805fe007d14c48a07d38811bdad2f7f6c
-  data.tar.gz: 8f59af5c2225dce3a7378317688f53a4ce79b6db2502f10cd0632b605e9ad5c02c21eba28ec45d8b428c1e1e9ba229d976c4bc1b9a944cfdbf27771f988cde95
+  metadata.gz: d336a5ee4cb5bff6e76addb1693e6abc57539dec033ad0803f20b03a73761b0a44a3838aef4e2c19258adf4906767cef45ff328f5906e22d3ee3726a265cb571
+  data.tar.gz: 30741bdd66aad37d4773f4d66a999c180658d58cce8f6b70dfcfe0951967f5a76d996a2f3cb76d9bf721f594698cdf0b613fddb913e5be3dbdfe8e183bc9df24

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

@@ -125,8 +125,10 @@ module Effective
     end
 
     def resource_layout
-      namespace = controller_path.include?('admin/') ? 'admin' : 'application'
-      defined?(Tenant) ? "#{Tenant.current}/#{namespace}" : namespace
+      if defined?(Tenant)
+        namespace = controller_path.include?('admin/') ? 'admin' : 'application'
+        "#{Tenant.current}/#{namespace}"
+      end
     end
 
     def resource_params_method_name

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

@@ -41,7 +41,7 @@ module Effective
 
       messages = resource.errors.map do |error|
         attribute = error.respond_to?(:attribute) ? error.attribute : error
-        message = error.respond_to?(:message) ? error.message : resource.errors[attribute].to_sentence
+        message = error.respond_to?(:attribute) ? error.message : resource.errors[attribute].to_sentence
 
         if message[0] == message[0].upcase # If the error begins with a capital letter
           message

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/models/concerns/effective_devise_user.rb

@@ -65,6 +65,8 @@ module EffectiveDeviseUser
   end
 
   module ClassMethods
+    def effective_devise_user?; true; end
+
     def permitted_sign_up_params # Should contain all fields as per views/users/_sign_up_fields
       raise('please define a self.permitted_sign_up_params')
       [:email, :password, :password_confirmation, :first_name, :last_name, :name, :login]

data/app/models/effective/model_reader.rb

@@ -11,6 +11,11 @@ module Effective
       @attributes = {}
     end
 
+    # For EffectiveLogging. This is a protected keyword I think.
+    def message(*args)
+      method_missing(:message, args)
+    end
+
     def read(&block)
       instance_exec(&block)
     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.rb

@@ -46,4 +46,22 @@ module EffectiveResources
     (config.respond_to?(:active_job) && config.active_job.queue_adapter) ? :deliver_later : :deliver_now
   end
 
+  def self.advance_date(date, business_days: 1, holidays: [:ca, :observed])
+    raise('business_days must be an integer <= 365') unless business_days.kind_of?(Integer) && business_days <= 365
+
+    business_days.times do
+      loop do
+        date = date + 1.day
+        break if business_day?(date, holidays: holidays)
+      end
+    end
+
+    date
+  end
+
+  def self.business_day?(date, holidays: [:ca, :observed])
+    require 'holidays' unless defined?(Holidays)
+    date.wday != 0 && date.wday != 6 && Holidays.on(date, *holidays).blank?
+  end
+
 end

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.22'.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.22
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-05-19 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: holidays
+  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'
 description: Make any controller an effective resource controller.
 email:
 - info@codeandeffect.com
@@ -133,10 +147,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 +193,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