effective_resources 1.8.15 → 1.8.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4b28e1caca0bb8019717713f5c76ae4c1b9e8008936450697ff53f9bca96546
-  data.tar.gz: '09187e5fcec31ad99827706d91a900038097c84579ee701fbafe6efde2dbed7d'
+  metadata.gz: 2c710016d91d82e5d8705081872474e2ea12382b938b0d0c7b5836da9f1240a2
+  data.tar.gz: c0fde3c5d9f60dd28a01690c60d4e352f94eb4f3d4e537c877290f06500debdb
 SHA512:
-  metadata.gz: af2652031c87d654fd8ba0210a41893a5eae2fa1a85ff05667b78b36cf0cf51fe01185f6c5d4d6d4ebb36eb8217ec73170a3f24680f19fba6b330b04ee1cf439
-  data.tar.gz: 651d54db0baf6fd4c6817b1669e9facaecd43b1792fe6a48b96ce9a72ce65f6c430b77665152574e95ebaf786886b78d63374e9cade0113794d0c78b9d824127
+  metadata.gz: 4b7c8f4a286e5a541b3a9ff3071e55b08c12b2499ae102723428c47bb563ab68716a63e05cd8c60f711f629e3b51396efd145a95f3e3f77b6b6bc3c13b0b06e7
+  data.tar.gz: 00f0c760c16282fe326b09061376658f54efba2634cf270a50af3df559895ffaea3d83f38edb7e796b22803d9edc47503421403cfee6494c3bc47a7a0967d87e

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/crud_controller/respond.rb

@@ -15,7 +15,16 @@ module Effective
 
             format.js do
               flash[:success] ||= resource_flash(:success, resource, action)
-              render(action, locals: { remote_form_redirect: resource_redirect_path(resource, action)}) # action.js.erb
+
+              if params[:_datatable_action]
+                redirect_to(resource_redirect_path(resource, action))
+              else
+                render(
+                  (template_present?(action) ? action : :member_action),
+                  locals: { action: action, remote_form_redirect: resource_redirect_path(resource, action)}
+                )
+              end
+
             end
           end
         elsif template_present?(action)

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

@@ -46,9 +46,9 @@ module Effective
       end
     end
 
-    def resource_wizard_step_title(step)
+    def resource_wizard_step_title(resource, step)
       return if step == 'wicked_finish'
-      effective_resource.klass.const_get(:WIZARD_STEPS).fetch(step)
+      resource.wizard_step_title(step)
     end
 
     def resource_wizard_steps

data/app/controllers/concerns/effective/wizard_controller/actions.rb

@@ -8,7 +8,7 @@ module Effective
         self.resource ||= resource_scope.new
         EffectiveResources.authorize!(self, :new, resource)
 
-        redirect_to resource_wizard_path(:new, resource_wizard_steps.first)
+        redirect_to resource_wizard_path(:new, resource.first_uncompleted_step || resource_wizard_steps.first)
       end
 
       def show

data/app/controllers/concerns/effective/wizard_controller/before_actions.rb

@@ -49,7 +49,7 @@ module Effective
           Rails.logger.info "  Unable to visit step :#{step}. Last can_visit_step? is :#{next_step}. Change the acts_as_wizard model's can_visit_step?(step) function to change this."
         end
 
-        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(next_step)} step."
+        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(resource, next_step)} step."
         redirect_to wizard_path(next_step)
       end
 
@@ -66,7 +66,7 @@ module Effective
       # before_action :assign_page_title, only: [:show, :update]
       # Assign page title
       def assign_page_title
-        @page_title ||= resource_wizard_step_title(step)
+        @page_title ||= resource_wizard_step_title(resource, step)
       end
 
     end

data/app/controllers/concerns/effective/wizard_controller/save.rb

@@ -9,7 +9,7 @@ module Effective
         if save_resource(resource, action)
           flash[:success] ||= options.delete(:success) || resource_flash(:success, resource, action)
 
-          @skip_to ||= next_step
+          @skip_to ||= resource.required_steps.find { |s| s == next_step } || resource.first_uncompleted_step
           @redirect_to ||= resource_wizard_path(resource, @skip_to) if was_new_record
 
           redirect_to(@redirect_to || wizard_path(@skip_to))

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/helpers/effective_resources_wizard_helper.rb

@@ -20,7 +20,7 @@ module EffectiveResourcesWizardHelper
   def render_wizard_sidebar_item(resource, nav_step, index = nil)
     # From Controller
     current = (nav_step == step)
-    title = resource_wizard_step_title(nav_step)
+    title = resource_wizard_step_title(resource, nav_step)
 
     # From Model
     disabled = !resource.can_visit_step?(nav_step)

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/acts_as_wizard.rb

@@ -43,6 +43,7 @@ module ActsAsWizard
       wizard_steps[current_step.to_sym] ||= Time.zone.now
     end
 
+    # Use can_visit_step? required_steps and wizard_step_title(step) to control the wizard behaviour
     def can_visit_step?(step)
       can_revisit_completed_steps(step)
     end
@@ -52,6 +53,10 @@ module ActsAsWizard
       self.class.const_get(:WIZARD_STEPS).keys
     end
 
+    def wizard_step_title(step)
+      self.class.const_get(:WIZARD_STEPS).fetch(step)
+    end
+
     def first_completed_step
       required_steps.find { |step| has_completed_step?(step) }
     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/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.15'.freeze
+  VERSION = '1.8.20'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.8.15
+  version: 1.8.20
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-05-14 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