effective_resources 1.9.15 → 1.9.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dd0112208ea9815fab0543b91b2ab24fd607d561a49b05d1f19ddffa4e6894b
-  data.tar.gz: b9fc2f5ac59dc2cb164b4397995b81c8b1c855e045c6934fb2081f4ac9381db0
+  metadata.gz: db61d9867c96af5ca8c727700ab2c453bfc05a61394640a0c625ea656fd8b2a2
+  data.tar.gz: da861639cb20385b43db877442e77a17766b24ef416b127d211089cbe47e6879
 SHA512:
-  metadata.gz: 41562bcb2c1f07e868fcea21088c9b676da9d43b193ad594affde4bc247d47713873f9fb56c63a58ca50b147d0a60905ae476544888e64ce709f22e5cd4dd859
-  data.tar.gz: c0e9b28781244c3638f63ca6a6ce89ea811afe31774acb3911f6cc774ad57d61e4b803dde8423c81c39cb620a64be22a75b9a47e613c6da124a0699222763596
+  metadata.gz: 9b8d7940d66b6982338170336ae87595e7943f43ea6df15b32b12acbbe6e02904e921cfbb1ac5bcca09587955a1cdf2c3d12667121ed105aba30e3f95245ca13
+  data.tar.gz: 13446ebdf1422b9762442ea98a0f0902a4c8ed5fb82d784ee90a5e7b46f779782ef016bdbf5902cce13bc48f2358cc38651dc594ab9b044ff06226f426ddd0e0

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

@@ -17,6 +17,7 @@ module Effective
       def show
         Rails.logger.info 'Processed by Effective::WizardController#show'
 
+        run_callbacks(:resource_render)
         render_wizard
       end
 

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

@@ -69,6 +69,13 @@ module Effective
         @page_title ||= resource_wizard_step_title(resource, step)
       end
 
+      def ready_checkout
+        return unless step == :checkout
+        return unless resource.class.try(:acts_as_purchasable_wizard?)
+
+        resource.ready!
+      end
+
     end
   end
 end

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

@@ -25,6 +25,8 @@ module Effective
 
         before_action :assign_current_step
         before_action :assign_page_title
+
+        before_action :ready_checkout
       end
 
       helper_method :resource

data/app/helpers/effective_resources_wizard_helper.rb

@@ -14,8 +14,8 @@ module EffectiveResourcesWizardHelper
     return sidebar unless block_given?
 
     content_tag(:div, class: 'row') do
-      content_tag(:div, class: 'col-3') { sidebar } +
-      content_tag(:div, class: 'col-9') { yield }
+      content_tag(:div, class: 'col-lg-3') { sidebar } +
+      content_tag(:div, class: 'col-lg-9') { yield }
     end
   end
 
@@ -28,10 +28,10 @@ module EffectiveResourcesWizardHelper
     disabled = !resource.can_visit_step?(nav_step)
 
     label = [index, title].compact.join('. ')
-    klass = ['list-group-item', ('active' if current), ('disabled' if disabled && !current)].compact.join(' ')
+    klass = ['list-group-item', 'list-group-item-action', ('active' if current), ('disabled' if disabled && !current)].compact.join(' ')
 
     if (current || disabled)
-      content_tag(:li, label, class: klass)
+      content_tag(:a, label, class: klass)
     else
       link_to(label, wizard_path(nav_step), class: klass)
     end

data/app/models/concerns/acts_as_purchasable_wizard.rb

@@ -0,0 +1,129 @@
+# ActsAsPurchasableWizard
+#
+
+module ActsAsPurchasableWizard
+  extend ActiveSupport::Concern
+
+  module Base
+    def acts_as_purchasable_wizard
+      raise('please declare acts_as_wizard first') unless respond_to?(:acts_as_wizard?)
+      raise('please declare acts_as_purchasable_parent first') unless respond_to?(:acts_as_purchasable_parent?)
+
+      unless (const_get(:WIZARD_STEPS).keys & [:billing, :checkout, :submitted]).length == 3
+        raise('please include a :billing, :checkout and :submitted step')
+      end
+
+      include ::ActsAsPurchasableWizard
+    end
+  end
+
+  included do
+    validates :owner, presence: true
+
+    # Billing Step
+    validate(if: -> { current_step == :billing && owner.present? }) do
+      self.errors.add(:base, "must have a billing address") unless owner.billing_address.present?
+      self.errors.add(:base, "must have an email") unless owner.email.present?
+    end
+
+    after_purchase do |_|
+      raise('expected submit_order to be purchased') unless submit_order&.purchased?
+      before_submit_purchased!
+      submit_purchased!
+      after_submit_purchased!
+    end
+  end
+
+  # All Fees and Orders
+  def submit_fees
+    raise('to be implemented by caller')
+  end
+
+  def submit_order
+    orders.first
+  end
+
+  def find_or_build_submit_fees
+    submit_fees
+  end
+
+  def find_or_build_submit_order
+    order = submit_order || orders.build(user: owner)
+    fees = submit_fees().reject { |fee| fee.marked_for_destruction? }
+
+    # Adds fees, but does not overwrite any existing price.
+    fees.each do |fee|
+      order.add(fee) unless order.purchasables.include?(fee)
+    end
+
+    order.order_items.each do |order_item|
+      fee = fees.find { |fee| fee == order_item.purchasable }
+      order.remove(order_item) unless fee.present?
+    end
+
+    # From Billing Step
+    order.billing_address = owner.billing_address if owner.billing_address.present?
+
+    # Important to add/remove anything
+    order.save!
+
+    order
+  end
+
+  # Should be indempotent.
+  def build_submit_fees_and_order
+    return false if was_submitted?
+
+    fees = find_or_build_submit_fees()
+    raise('already has purchased submit fees') if fees.any?(&:purchased?)
+
+    order = find_or_build_submit_order()
+    raise('already has purchased submit order') if order.purchased?
+
+    true
+  end
+
+  # Owner clicks on the Billing step. Next step is Checkout
+  def billing!
+    ready! && save!
+  end
+
+  # Ready to check out
+  # This is called by the "ready_checkout" before_action in wizard_controller/before_actions.rb
+  def ready!
+    without_current_step do
+      build_submit_fees_and_order
+      save!
+    end
+  end
+
+  # Called automatically via after_purchase hook above
+  def submit_purchased!
+    return false if was_submitted?
+
+    wizard_steps[:checkout] = Time.zone.now
+    submit!
+  end
+
+  # A hook to extend
+  def before_submit_purchased!
+  end
+
+  def after_submit_purchased!
+  end
+
+  # Draft -> Submitted requirements
+  def submit!
+    raise('already submitted') if was_submitted?
+    raise('expected a purchased order') unless submit_order&.purchased?
+
+    wizard_steps[:checkout] ||= Time.zone.now
+    wizard_steps[:submitted] = Time.zone.now
+    submitted!
+  end
+
+  module ClassMethods
+    def acts_as_purchasable_wizard?; true; end
+  end
+
+end

data/app/models/concerns/acts_as_wizard.rb

@@ -50,9 +50,13 @@ module ActsAsWizard
       can_revisit_completed_steps(step)
     end
 
+    def wizard_step_keys
+      self.class.const_get(:WIZARD_STEPS).keys
+    end
+
     def required_steps
       return self.class.test_required_steps if Rails.env.test? && self.class.test_required_steps.present?
-      self.class.const_get(:WIZARD_STEPS).keys
+      wizard_step_keys()
     end
 
     def wizard_step_title(step)
@@ -104,6 +108,16 @@ module ActsAsWizard
       has_completed_step?(required_steps.last)
     end
 
+    def without_current_step(&block)
+      existing = current_step
+
+      begin
+        self.current_step = nil; yield
+      ensure
+        self.current_step = existing
+      end
+    end
+
     private
 
     def can_revisit_completed_steps(step)

data/lib/effective_resources/engine.rb

@@ -28,6 +28,7 @@ module EffectiveResources
         ActiveRecord::Base.extend(ActsAsSlugged::Base)
         ActiveRecord::Base.extend(ActsAsStatused::Base)
         ActiveRecord::Base.extend(ActsAsWizard::Base)
+        ActiveRecord::Base.extend(ActsAsPurchasableWizard::Base)
         ActiveRecord::Base.extend(HasManyRichTexts::Base)
 
         ActiveRecord::Base.extend(EffectiveDeviseUser::Base)

data/lib/effective_resources/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.9.15
+  version: 1.9.19
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -153,6 +153,7 @@ files:
 - 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_purchasable_wizard.rb
 - app/models/concerns/acts_as_slugged.rb
 - app/models/concerns/acts_as_statused.rb
 - app/models/concerns/acts_as_tokened.rb