effective_resources 1.9.16 → 1.9.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2aae5d9ac90fa652dad2f7a60995282a9347dbfbbfdb0b497d1c46db42d7fe4
-  data.tar.gz: 9d19f8cc152193da25ab30c7a4bc43187f9e52fb4eb309c0751df134f2a76dbc
+  metadata.gz: 9b69f74d07daa22a1733f0c9a9834056c614e025f70382f5c5bbae286d3bf066
+  data.tar.gz: 18517fd35b619d93f979a2536e0feed6d007306e47028beb70b21f6afcb3dfaf
 SHA512:
-  metadata.gz: 2f33925a5ae6b5eda2076f6a27607af422e02412db62b55d0b6175a77cff200c18450611c314680b54c7843b59bdc498b508b760c03221e47da2a6e62f59efb1
-  data.tar.gz: 71e9ab7dd0e61db615b043455459dad0de6b4e199f14ed39a0eb88ac16558d8b33d55bb9e0b95a2412dd4fa630ef277b198636078825ddb66d5c6db68c6b9fd3
+  metadata.gz: 8ef58e8d1d3f02d64c1a0e9f5979b22db50dc47314b945906cbc89edae6147d733d77305353ab25798f512d0f182460525fae2cfe6c4c93f919717d743670f32
+  data.tar.gz: 42b9e8c8ac3878d56d1f71f429c40cae535e23bbb43fe76b0b70deb3917779bb60c52a9122bbd5c0d057fc70778f4983c47d7ac5c3cd0024cdb0fbace2fe640f

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,128 @@
+# 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()
+
+    # Adds fees, but does not overwrite any existing price.
+    fees.each do |fee|
+      order.add(fee) unless order.purchasables.include?(fee)
+    end
+
+    order.purchasables.each do |purchasable|
+      order.remove(purchasable) unless fees.include?(purchasable)
+    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.16'.freeze
+  VERSION = '1.9.17'.freeze
 end

metadata

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