effective_resources 1.9.19 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db61d9867c96af5ca8c727700ab2c453bfc05a61394640a0c625ea656fd8b2a2
-  data.tar.gz: da861639cb20385b43db877442e77a17766b24ef416b127d211089cbe47e6879
+  metadata.gz: 53d143a8c98a09dcf7d4d9806ef793e973d8222de8c26f5078c9921e2ce8fdb9
+  data.tar.gz: bb10ee364077d022fe04717f37e5eac64576077b6f9710313d1251ed252b39a3
 SHA512:
-  metadata.gz: 9b8d7940d66b6982338170336ae87595e7943f43ea6df15b32b12acbbe6e02904e921cfbb1ac5bcca09587955a1cdf2c3d12667121ed105aba30e3f95245ca13
-  data.tar.gz: 13446ebdf1422b9762442ea98a0f0902a4c8ed5fb82d784ee90a5e7b46f779782ef016bdbf5902cce13bc48f2358cc38651dc594ab9b044ff06226f426ddd0e0
+  metadata.gz: c89341875aec7a5520151b0ec922a54f8e309219a5f53b6ddd0a4092b1fb758dfd5f1ddee7222862e9e6406102f004ed30d4e03f72c4dc6d36821c9dc0c1cd58
+  data.tar.gz: 6782dbdbc803c7014e90a9b674cdd0c7be8920c1802203347e3046eaa5e07e05ac988e8a8c2dbbb78478c3caedfc5cb87ab9463cbf568d34ef654d714d8468c8

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

@@ -35,6 +35,19 @@ module Effective
 
       # setup_wizard from Wicked called now
 
+      # Allow only 1 in-progress wizard at a time
+      def redirect_if_existing
+        return if step == 'wicked_finish'
+        return if resource.blank?
+        return if resource.done?
+
+        existing = resource_scope.in_progress.where.not(id: resource).first
+        return unless existing.present?
+
+        flash[:success] = "You have been redirected to your in-progress wizard"
+        redirect_to resource_wizard_path(existing, existing.next_step)
+      end
+
       # before_action :enforce_can_visit_step, only: [:show, :update]
       # Make sure I have permission for this step
       def enforce_can_visit_step
@@ -76,6 +89,10 @@ module Effective
         resource.ready!
       end
 
+      def clear_flash_success
+        @_delete_flash_success = true
+      end
+
     end
   end
 end

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

@@ -0,0 +1,19 @@
+module Effective
+  module WizardController
+    module PermittedParams
+      BLACKLIST = [
+        :created_at, :updated_at,
+        :token, :slug, :price,
+        :logged_change_ids, :orders, :purchased_order_id,
+        :status, :status_steps, :wizard_steps,
+        :submitted_at, :completed_at, :reviewed_at, :approved_at, :declined_at, :purchased_at,
+        :declined_reason
+      ]
+
+      def resource_permitted_params
+        permitted_name = params.key?(effective_resource.name) ? effective_resource.name : effective_resource.resource_name
+        params.require(permitted_name).except(BLACKLIST).permit!
+      end
+    end
+  end
+end

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

@@ -7,9 +7,14 @@ module Effective
 
     include Effective::WizardController::Actions
     include Effective::WizardController::BeforeActions
+    include Effective::WizardController::PermittedParams
     include Effective::WizardController::Save
     include Effective::WizardController::WickedOverrides
 
+    module ClassMethods
+      def effective_wizard_controller?; true; end
+    end
+
     included do
       raise("please install gem 'wicked' to use Effective::WizardController") unless defined?(Wicked)
 
@@ -19,10 +24,14 @@ module Effective
         before_action :assign_resource
         before_action :authorize_resource
         before_action :assign_required_steps
+
         before_action :setup_wizard # Wicked
 
         before_action :enforce_can_visit_step
 
+        before_action :redirect_if_existing, only: [:show, :new]
+        before_action :clear_flash_success, only: [:update]
+
         before_action :assign_current_step
         before_action :assign_page_title
 
@@ -38,6 +47,12 @@ module Effective
         flash[:danger] = "Unknown step. You have been moved to the #{resource_wizard_steps.first} step."
         redirect_to wizard_path(resource_wizard_steps.first)
       end
+
+      # effective_resources on save callback
+      after_action do
+        flash.clear if @_delete_flash_success
+      end
+
     end
 
     def find_wizard_resource

data/app/helpers/effective_resources_helper.rb

@@ -244,4 +244,8 @@ module EffectiveResourcesHelper
     simple_format(sanitize(value.to_s, tags: @format_resource_tags, attributes: @format_resource_atts), {}, sanitize: false)
   end
 
+  def edit_effective_wizard?
+    controller.class.try(:effective_wizard_controller?) && defined?(resource) && resource.draft?
+  end
+
 end

data/app/models/concerns/acts_as_wizard.rb

@@ -59,6 +59,12 @@ module ActsAsWizard
       wizard_step_keys()
     end
 
+    # For use in the summary partials. Does not include summary.
+    def render_steps
+      blacklist = [:start, :billing, :checkout, :submitted, :summary]
+      (required_steps - blacklist).select { |step| has_completed_step?(step) }
+    end
+
     def wizard_step_title(step)
       self.class.const_get(:WIZARD_STEPS).fetch(step)
     end
@@ -134,6 +140,11 @@ module ActsAsWizard
 
   module ClassMethods
     def acts_as_wizard?; true; end
+
+    def all_wizard_steps
+      const_get(:WIZARD_STEPS).keys
+    end
+
   end
 
 end

data/app/views/layouts/effective_mailer_layout.html.haml

@@ -0,0 +1,7 @@
+!!!
+%html{style: 'background: #fff;'}
+  %head
+    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
+
+  %body{style: 'background: #fff;'}
+    = yield

data/config/effective_resources.rb

@@ -21,6 +21,8 @@ EffectiveResources.setup do |config|
   # end
   config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
 
+  # Default Submits
+  #
   # These default submit actions will be added to each controller
   # and rendered when calling effective_submit(f)
   # based on the controller, and its `submits` if any.
@@ -28,4 +30,22 @@ EffectiveResources.setup do |config|
   # Supported values: 'Save', 'Continue', and 'Add New'
   config.default_submits = ['Save', 'Continue', 'Add New']
 
+  # Email Settings
+  #
+  # The default mailer settings for all effective gems
+  #
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = '::ApplicationMailer'
+
+  # Default deliver method
+  # config.deliver_method = :deliver_later
+
+  # Default layout
+  # config.mailer_layout = 'effective_mailer_layout'
+
+  # Default From
+  config.mailer_sender = "no-reply@example.com"
+
+  # Send Admin correspondence To
+  config.mailer_admin = "admin@example.com"
 end

data/lib/effective_resources/effective_gem.rb

@@ -38,6 +38,16 @@ module EffectiveGem
 
       true
     end
+
+    # This is included into every gem
+    # The gem may not have a mailer or use effective email templates
+    def send_email(email, *args)
+      raise('gem does not respond to mailer_class') unless respond_to?(:mailer_class)
+      raise('expected args to be an Array') unless args.kind_of?(Array)
+
+      mailer_class.send(email, *args).send(EffectiveResources.deliver_method)
+    end
+
   end
 
 end

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.9.19'.freeze
+  VERSION = '1.12.0'.freeze
 end

data/lib/effective_resources.rb

@@ -5,7 +5,10 @@ require 'effective_resources/effective_gem'
 module EffectiveResources
 
   def self.config_keys
-    [:authorization_method, :default_submits]
+    [
+      :authorization_method, :default_submits,
+      :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :parent_mailer
+    ]
   end
 
   include EffectiveGem
@@ -31,6 +34,31 @@ module EffectiveResources
     (['Save', 'Continue', 'Add New'] & Array(config.default_submits)).inject({}) { |h, v| h[v] = true; h }
   end
 
+  # Email
+  def self.deliver_method
+    return config[:deliver_method] if config[:deliver_method].present?
+
+    rails = Rails.application.config
+    (rails.respond_to?(:active_job) && rails.active_job.queue_adapter) ? :deliver_later : :deliver_now
+  end
+
+  def self.mailer_layout
+    config[:mailer_layout] || 'effective_mailer_layout'
+  end
+
+  def self.mailer_sender
+    config[:mailer_sender] || raise('effective resources mailer_sender missing. Add it to config/initializers/effective_resources.rb')
+  end
+
+  def self.mailer_admin
+    config[:mailer_admin] || raise('effective resources mailer_admin missing. Add it to config/initializers/effective_resources.rb')
+  end
+
+  def self.parent_mailer_class
+    return config[:parent_mailer].constantize if config[:parent_mailer].present?
+    '::ApplicationMailer'.safe_constantize || 'ActionMailer::Base'.constantize
+  end
+
   # Utilities
 
   # This looks up the best class give the name
@@ -81,10 +109,6 @@ module EffectiveResources
     end
   end
 
-  def self.deliver_method
-    config = Rails.application.config
-    (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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.9.19
+  version: 1.12.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -145,6 +145,7 @@ files:
 - app/controllers/concerns/effective/wizard_controller.rb
 - app/controllers/concerns/effective/wizard_controller/actions.rb
 - app/controllers/concerns/effective/wizard_controller/before_actions.rb
+- app/controllers/concerns/effective/wizard_controller/permitted_params.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
@@ -202,6 +203,7 @@ files:
 - app/views/effective/resource/_actions.html.haml
 - app/views/effective/resource/_actions_dropleft.html.haml
 - app/views/effective/resource/_actions_glyphicons.html.haml
+- app/views/layouts/effective_mailer_layout.html.haml
 - config/effective_resources.rb
 - lib/effective_resources.rb
 - lib/effective_resources/effective_gem.rb