Merge pull request #443 from RailsEventStore/processes-improved-readability

Processes improved readability

Author: dysk

ecommerce/processes/lib/processes/determine_vat_rates_on_order_placed.rb

@@ -3,7 +3,7 @@ class DetermineVatRatesOnOrderPlaced
 
     ProcessState = Data.define(:offer_accepted, :order_placed, :order_id, :order_lines) do
       def initialize(offer_accepted: false, order_placed: false, order_id: nil, order_lines: [])
-        super(offer_accepted:, order_placed:, order_id:, order_lines: order_lines)
+        super
       end
 
       def placed? = offer_accepted && order_placed
@@ -15,18 +15,7 @@ def placed? = offer_accepted && order_placed
       Fulfillment::OrderRegistered
     )
 
-    def apply(event)
-      case event
-      when Pricing::OfferAccepted
-        state.with(
-          offer_accepted: true,
-          order_lines: event.data.fetch(:order_lines),
-          order_id: event.data.fetch(:order_id)
-        )
-      when Fulfillment::OrderRegistered
-        state.with(order_placed: true)
-      end
-    end
+    private
 
     def act
       determine_vat_rates if state.placed?
@@ -40,11 +29,22 @@ def determine_vat_rates
       end
     end
 
-    private
+    def apply(event)
+      case event
+      when Pricing::OfferAccepted
+        state.with(
+          offer_accepted: true,
+          order_lines: event.data.fetch(:order_lines),
+          order_id: event.data.fetch(:order_id)
+        )
+      when Fulfillment::OrderRegistered
+        state.with(order_placed: true)
+      end
+    end
 
     def fetch_id(event)
       event.data.fetch(:order_id)
     end
 
   end
-end
+end

ecommerce/processes/lib/processes/order_item_invoicing_process.rb

@@ -3,7 +3,7 @@ class OrderItemInvoicingProcess
 
     ProcessState = Data.define(:order_id, :product_id, :quantity, :vat_rate, :discounted_amount) do
       def initialize(order_id: nil, product_id: nil, quantity: nil, vat_rate: nil, discounted_amount: nil)
-        super(order_id:, product_id:, quantity:, vat_rate:, discounted_amount:)
+        super
       end
 
       def can_create_invoice_item?
@@ -18,6 +18,25 @@ def can_create_invoice_item?
       Taxes::VatRateDetermined
     )
 
+    private
+
+    def act
+      return unless state.can_create_invoice_item?
+
+      unit_prices = MoneySplitter.new(state.discounted_amount, state.quantity).call
+      unit_prices.tally.each do |unit_price, quantity|
+        command_bus.call(
+          Invoicing::AddInvoiceItem.new(
+            invoice_id: state.order_id,
+            product_id: state.product_id,
+            vat_rate: state.vat_rate,
+            quantity: quantity,
+            unit_price: unit_price
+          )
+        )
+      end
+    end
+
     def apply(event)
       case event
       when Pricing::PriceItemValueCalculated
@@ -34,23 +53,6 @@ def apply(event)
       end
     end
 
-    def act
-      return unless state.can_create_invoice_item?
-
-      unit_prices = MoneySplitter.new(state.discounted_amount, state.quantity).call
-      unit_prices.tally.each do |unit_price, quantity|
-        command_bus.call(Invoicing::AddInvoiceItem.new(
-          invoice_id: state.order_id,
-          product_id: state.product_id,
-          vat_rate: state.vat_rate,
-          quantity: quantity,
-          unit_price: unit_price
-        ))
-      end
-    end
-
-    private
-
     def fetch_id(event)
       "#{event.data.fetch(:order_id)}$#{event.data.fetch(:product_id)}"
     end
@@ -70,12 +72,14 @@ def call
           distributed_amounts << 0
           next
         end
+
         p = weight / total_weight
         distributed_amount = (p * @amount).round(2)
         distributed_amounts << distributed_amount
         total_weight -= weight
         @amount -= distributed_amount
       end
+
       distributed_amounts
     end
   end

ecommerce/processes/lib/processes/release_payment_process.rb

@@ -3,7 +3,7 @@ class ReleasePaymentProcess
 
     ProcessState = Data.define(:order, :payment, :order_id) do
       def initialize(order: :draft, payment: :none, order_id: nil)
-        super(order:, payment:, order_id:)
+        super
       end
 
       def release?
@@ -21,6 +21,12 @@ def release?
       Fulfillment::OrderConfirmed
     )
 
+    private
+
+    def act
+      release_payment if state.release?
+    end
+
     def apply(event)
       case event
       when Payments::PaymentAuthorized
@@ -39,12 +45,6 @@ def apply(event)
       end
     end
 
-    def act
-      release_payment if state.release?
-    end
-
-    private
-
     def release_payment
       command_bus.call(Payments::ReleasePayment.new(order_id: state.order_id))
     end

ecommerce/processes/lib/processes/reservation_process.rb

@@ -1,13 +1,5 @@
 module Processes
   class ReservationProcess
-    class SomeInventoryNotAvailable < StandardError
-      attr_reader :unavailable_products
-
-      def initialize(unavailable_products)
-        @unavailable_products = unavailable_products
-      end
-    end
-
     ProcessState = Data.define(:order, :order_lines) do
       def initialize(order: nil, order_lines: [])
         super(order:, order_lines: order_lines.freeze)
@@ -24,19 +16,7 @@ def reserved_product_ids = order_lines.keys
       Fulfillment::OrderConfirmed
     )
 
-    def apply(event)
-      case event
-      when Pricing::OfferAccepted
-        state.with(
-          order: :accepted,
-          order_lines: event.data.fetch(:order_lines).map { |ol| [ol.fetch(:product_id), ol.fetch(:quantity)] }.to_h
-        )
-      when Fulfillment::OrderCancelled
-        state.with(order: :cancelled)
-      when Fulfillment::OrderConfirmed
-        state.with(order: :confirmed)
-      end
-    end
+    private
 
     def act
       case state
@@ -56,7 +36,19 @@ def act
       end
     end
 
-    private
+    def apply(event)
+      case event
+      when Pricing::OfferAccepted
+        state.with(
+          order: :accepted,
+          order_lines: event.data.fetch(:order_lines).map { |ol| [ol.fetch(:product_id), ol.fetch(:quantity)] }.to_h
+        )
+      when Fulfillment::OrderCancelled
+        state.with(order: :cancelled)
+      when Fulfillment::OrderConfirmed
+        state.with(order: :confirmed)
+      end
+    end
 
     def reserve_stock
       unavailable_products = []
@@ -99,5 +91,13 @@ def reject_order(unavailable_product_ids)
     def fetch_id(event)
       event.data.fetch(:order_id)
     end
+
+    class SomeInventoryNotAvailable < StandardError
+      attr_reader :unavailable_products
+
+      def initialize(unavailable_products)
+        @unavailable_products = unavailable_products
+      end
+    end
   end
 end

ecommerce/processes/lib/processes/shipment_process.rb

@@ -14,17 +14,6 @@ def initialize(order: nil, shipment: nil) = super
 
     private
 
-    def apply(event)
-      case event
-      when Shipping::ShippingAddressAddedToShipment
-        state.with(shipment: :address_set)
-      when Fulfillment::OrderRegistered
-        state.with(order: :placed)
-      when Fulfillment::OrderConfirmed
-        state.with(order: :confirmed)
-      end
-    end
-
     def act
       case state
       in { shipment: :address_set, order: :placed }
@@ -36,6 +25,17 @@ def act
       end
     end
 
+    def apply(event)
+      case event
+      when Shipping::ShippingAddressAddedToShipment
+        state.with(shipment: :address_set)
+      when Fulfillment::OrderRegistered
+        state.with(order: :placed)
+      when Fulfillment::OrderConfirmed
+        state.with(order: :confirmed)
+      end
+    end
+
     def submit_shipment
       command_bus.call(Shipping::SubmitShipment.new(order_id: id))
     end

ecommerce/processes/lib/processes/three_plus_one_free.rb

@@ -26,6 +26,17 @@ def eligible_free_product
 
     private
 
+    def act
+      case [state.free_product, state.eligible_free_product]
+      in [the_same_product, ^the_same_product]
+      in [nil, new_free_product]
+        make_new_product_for_free(new_free_product)
+      in [old_free_product, *]
+        remove_old_free_product(old_free_product)
+      else
+      end
+    end
+
     def apply(event)
       product_id = event.data.fetch(:product_id)
       case event
@@ -44,17 +55,6 @@ def apply(event)
       end
     end
 
-    def act
-      case [state.free_product, state.eligible_free_product]
-      in [the_same_product, ^the_same_product]
-      in [nil, new_free_product]
-        make_new_product_for_free(new_free_product)
-      in [old_free_product, *]
-        remove_old_free_product(old_free_product)
-      else
-      end
-    end
-
     def remove_old_free_product(product_id)
       command_bus.call(Pricing::RemoveFreeProductFromOrder.new(order_id: id, product_id:))
     end