effective_resources 1.9.14 → 1.9.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fa555e65ca74d65ab0bfbeef9b7dc8817e12951daf8ae8de6328512391a61aa
-  data.tar.gz: 5a19481dee889d9b75d93523c2a8c8b3899c60eecb1496637cb7bf3c592f4421
+  metadata.gz: f5c9b933021449f0eb3d4ae100ff09fa9aa4af1efbff1e3ee29bdbbf7204a264
+  data.tar.gz: db60abded322951ceb47c9f75c8a19743ff6989a29b0441bc9c55915481a92ed
 SHA512:
-  metadata.gz: 9c7d741ba719f1255fe53a1aecd195fcc78d70d29387c4a6f2cf8b989999b69effed19e5d18336521476dfc036362ca6c9ca9a829d3832c975f976ac89362208
-  data.tar.gz: 2f363dd0624e8d7ab007e7e9e7446b557f1f8f311d348d4dcafeb8b99bd8cb14de50f24b0a508eae8a1c7f3b22d1c0d2aad25755caf85e649964a89a2f23fbe6
+  metadata.gz: 1d09592ecbb18c8b4310d374f19e2a30d63522c4d34ff27ef795eb3e0aef4e441305872012fa1cf6fa6519998e33a9dd86237abd5fe50ab878543292def7a390
+  data.tar.gz: 6f4e36f8181d3673739d72dc19750b68e3f239d5d911dcf9399c24be92a9f1716fb709c41345252506689eb1b220dfd91212b2213aa76cf8b05b976600c9a980

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

@@ -40,6 +40,7 @@ module ActsAsTokened
   end
 
   def to_global_id(**params)
+    params[:tenant] = Tenant.current if defined?(Tenant)
     GlobalID.new(URI::GID.build(app: Rails.application.config.global_id.app, model_name: model_name, model_id: to_param, params: params))
   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.14'.freeze
+  VERSION = '1.9.18'.freeze
 end

metadata

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