spree_cm_commissioner 2.0.0 → 2.0.1.pre.pre

data/app/jobs/spree_cm_commissioner/inventory_item_syncer_job.rb

@@ -0,0 +1,7 @@
+module SpreeCmCommissioner
+  class InventoryItemSyncerJob < ApplicationUniqueJob
+    def perform(inventory_id_and_quantities:)
+      InventoryItemSyncer.call(inventory_id_and_quantities:)
+    end
+  end
+end

data/app/jobs/spree_cm_commissioner/sms_pin_code_job.rb

@@ -1,6 +1,6 @@
 module SpreeCmCommissioner
   class SmsPinCodeJob < SpreeCmCommissioner::SmsJob
-    # options = { to: xxxx, body: xxxx }
+    # options = { from: xxx, to: xxxx, body: xxxx }
     def perform(options)
       SpreeCmCommissioner::Sms.call(options)
     end

data/app/jobs/spree_cm_commissioner/stock/inventory_items_adjuster_job.rb

@@ -0,0 +1,11 @@
+module SpreeCmCommissioner
+  module Stock
+    class InventoryItemsAdjusterJob < ApplicationUniqueJob
+      def perform(variant_id:, quantity:)
+        variant = Spree::Variant.find(variant_id)
+
+        SpreeCmCommissioner::Stock::InventoryItemsAdjuster.call(variant: variant, quantity: quantity)
+      end
+    end
+  end
+end

data/app/jobs/spree_cm_commissioner/stock/inventory_items_generator_job.rb

@@ -0,0 +1,11 @@
+module SpreeCmCommissioner
+  module Stock
+    class InventoryItemsGeneratorJob < ApplicationUniqueJob
+      def perform(variant_id:)
+        variant = Spree::Variant.find(variant_id)
+
+        SpreeCmCommissioner::Stock::InventoryItemsGenerator.call(variant: variant)
+      end
+    end
+  end
+end

data/app/jobs/spree_cm_commissioner/stock/permanent_inventory_items_generator_job.rb

@@ -0,0 +1,9 @@
+module SpreeCmCommissioner
+  module Stock
+    class PermanentInventoryItemsGeneratorJob < ApplicationUniqueJob
+      def perform
+        SpreeCmCommissioner::Stock::PermanentInventoryItemsGenerator.call
+      end
+    end
+  end
+end

data/app/mailers/spree/order_mailer_decorator.rb

@@ -1,5 +1,6 @@
 module Spree
   module OrderMailerDecorator
+    # overrided
     def cancel_email(order, resend: false)
       @order = order.respond_to?(:id) ? order : Spree::Order.find(order)
       return false if @order.email.blank?
@@ -11,34 +12,18 @@ module Spree
       @order = order.respond_to?(:id) ? order : Spree::Order.find(order)
       return false if @order.email.blank?
 
-      @tenant = @order.tenant
-      if @tenant.present?
-        @brand_color = @tenant.preferences[:brand_primary_color]
-        @vendor_logo_url = @tenant.active_vendor&.logo&.original_url
-      end
-
       @current_store = @order.store
       @product_type = @order.products.first&.product_type || 'accommodation'
 
-      subject = resend ? "[#{Spree.t(:resend).upcase}] " : ''
+      subject = (resend ? "[#{Spree.t(:resend).upcase}] " : '')
       subject += "#{@current_store&.name} Booking Confirmation ##{@order.number}"
 
-      mail(to: @order.email, from: from_email_address, subject: subject, store_url: @current_store.url) do |format|
+      mail(to: @order.email, from: from_address, subject: subject, store_url: @current_store.url) do |format|
         format.html { render layout: 'spree_cm_commissioner/layouts/order_mailer' }
         format.text
       end
     end
 
-    private
-
-    def from_email_address
-      if @order.tenant.nil?
-        from_address
-      else
-        @order.tenant.active_vendor&.from_email
-      end
-    end
-
     def ticket_email(guest, email)
       @guest = guest
       @event = @guest.event

data/app/models/concerns/spree_cm_commissioner/line_item_durationable.rb

@@ -18,29 +18,23 @@ module SpreeCmCommissioner
     def date_unit
       return nil unless permanent_stock?
 
-      date_range_excluding_checkout.size if accommodation?
+      date_range.size
     end
 
-    def date_range_excluding_checkout
+    def date_range
       return [] unless date_present?
 
-      date_range = (from_date.to_date..to_date.to_date).to_a
-      date_range.pop if date_range.size > 1
-      date_range
+      (from_date.to_date..to_date.to_date).to_a
     end
 
-    def date_range_including_checkout
-      return [] unless date_present?
-
-      (from_date.to_date..to_date.to_date).to_a
+    def checkin_date
+      from_date&.to_date
     end
 
-    def date_range
-      if accommodation?
-        date_range_excluding_checkout
-      else
-        date_range_including_checkout
-      end
+    def checkout_date
+      return to_date ? to_date.to_date - 1.day : nil if accommodation?
+
+      to_date&.to_date
     end
 
     private

data/app/models/concerns/spree_cm_commissioner/option_type_attr_type.rb

@@ -14,13 +14,6 @@ module SpreeCmCommissioner
       state_selection
       payment_option
       delivery_option
-      amenity
-      departure_time
-      duration
-      vehicle_id
-      origin
-      destination
-      place_id
     ].freeze
 
     RESERVED_OPTIONS = {
@@ -48,11 +41,7 @@ module SpreeCmCommissioner
       'bib-display-prefix' => 'boolean',
       'bib-pre-generation-on-create' => 'boolean',
       'seat-number-positions' => 'array',
-      'origin' => 'place_id',
-      'destination' => 'place_id',
-      'departure-time' => 'time',
-      'vehicle' => 'vehicle_id',
-      'allow-seat-selection' => 'boolean'
+      'seat-type' => 'string'
     }.freeze
 
     included do

data/app/models/concerns/spree_cm_commissioner/order_seatable.rb

@@ -0,0 +1,44 @@
+module SpreeCmCommissioner
+  module OrderSeatable
+    def should_manage_blocks?
+      preload_block_ids.any?
+    end
+
+    def hold_blocks!
+      return unless should_manage_blocks?
+
+      CmAppLogger.log(label: "#{self.class.name}#hold_blocks!", data: { order_id: id }) do
+        SpreeCmCommissioner::Seats::BlocksHolder.new(line_item_ids: line_item_ids, hold_by: user).hold_blocks!
+      end
+    end
+
+    def cancel_blocks!
+      return unless should_manage_blocks?
+
+      CmAppLogger.log(label: "#{self.class.name}#cancel_blocks!", data: { order_id: id }) do
+        SpreeCmCommissioner::Seats::BlocksCanceler.new(order_id: id, cancel_by: user).cancel_blocks!
+      end
+    end
+
+    def reserve_blocks!
+      return unless should_manage_blocks?
+
+      CmAppLogger.log(label: "#{self.class.name}#reserve_blocks!", data: { order_id: id }) do
+        SpreeCmCommissioner::Seats::BlocksReserver.new(line_item_ids: line_item_ids, reserve_by: user).reserve_blocks!
+      end
+    end
+
+    # Calling `.block_ids` directly can cause many slow database queries (N+1 problem)
+    # every time `.should_manage_blocks?` or `.preload_block_ids` runs.
+    # To avoid this, we store a precomputed list of block IDs in `private_metadata`.
+    # This list is updated whenever a guest’s block is saved or destroy.
+    def preload_block_ids=(preload_block_ids = [])
+      self.private_metadata ||= {}
+      self.private_metadata['preload_block_ids'] = preload_block_ids
+    end
+
+    def preload_block_ids
+      self.private_metadata&.fetch('preload_block_ids', []) || []
+    end
+  end
+end

data/app/models/concerns/spree_cm_commissioner/order_state_machine.rb

@@ -5,6 +5,8 @@ module SpreeCmCommissioner
     extend ActiveSupport::Concern
 
     included do
+      state_machine.before_transition to: :payment, do: :hold_blocks!
+
       state_machine.before_transition to: :complete, do: :request, if: :need_confirmation?
       state_machine.before_transition to: :complete, do: :generate_bib_number
 
@@ -14,10 +16,14 @@ module SpreeCmCommissioner
       state_machine.after_transition to: :complete, do: :send_order_complete_telegram_alert_to_vendors, unless: :need_confirmation?
       state_machine.after_transition to: :complete, do: :send_order_complete_telegram_alert_to_store, unless: :need_confirmation?
 
+      state_machine.around_transition to: :complete, do: :unstock_inventory!
+
       state_machine.after_transition to: :complete, do: :send_transaction_email_to_user, if: :user_has_email?
       state_machine.after_transition to: :resumed, do: :precalculate_conversion
+      state_machine.around_transition to: :resumed, do: :unstock_inventory!
 
       state_machine.after_transition to: :canceled, do: :precalculate_conversion
+      state_machine.after_transition to: :canceled, do: :restock_inventory!
 
       scope :accepted, -> { where(request_state: 'accepted') }
 
@@ -67,6 +73,39 @@ module SpreeCmCommissioner
       end
     end
 
+    def unstock_inventory!
+      ActiveRecord::Base.transaction do
+        yield # Equal to block.call
+
+        # After the transition is complete, the following code will execute first before proceeding to other `after_transition` callbacks.
+        # This ensures that if `reserve_blocks!` or `unstock_inventory_in_redis!` fails, the state will be rolled back,
+        # and neither the `finalize!` method nor any notifications will be triggered.
+        # The payment will be reversed in vPago gem, and `Spree::Checkout::Complete` will be called, which checks `order.reload.complete?`.
+        # This is critical because if the order state is complete, the payment will be marked as paid.
+
+        reserve_blocks!
+        unstock_inventory_in_redis!
+
+        # We rollback only order state, and we keep payment state as it is.
+        # We implement payment in vPago gem, and it will be reversed in the gem.
+        # Some bank has api for refund, but some don't have the api to refund yet. So we keep the payment state as it is and refund manually.
+      end
+    rescue StandardError => e
+      CmAppLogger.log(
+        label: 'SpreeCmCommissioner::OrderStateMachine#reserve_inventory failed',
+        data: { order_id: id, error: e.message, type: e.class.name, backtrace: e.backtrace&.first(5)&.join("\n") }
+      )
+
+      raise e
+    end
+
+    def restock_inventory!
+      ActiveRecord::Base.transaction do
+        cancel_blocks!
+        restock_inventory_in_redis!
+      end
+    end
+
     def generate_bib_number
       line_items.find_each(&:generate_remaining_guests)
 

data/app/models/concerns/spree_cm_commissioner/product_delegation.rb

@@ -3,12 +3,10 @@ module SpreeCmCommissioner
     extend ActiveSupport::Concern
 
     included do
-      delegate :product_type,
-               :subscribable?,
+      delegate :subscribable?,
                :allowed_upload_later?,
                :need_confirmation?, :need_confirmation,
                :allow_anonymous_booking,
-               :accommodation?, :service?, :ecommerce?,
                :allow_self_check_in,
                :allow_self_check_in?,
                :required_self_check_in_location,

data/app/models/concerns/spree_cm_commissioner/product_type.rb

@@ -6,10 +6,20 @@ module SpreeCmCommissioner
     extend ActiveSupport::Concern
 
     PRODUCT_TYPES = %i[accommodation service ecommerce transit].freeze
+    PERMANENT_STOCK_PRODUCT_TYPES = %w[accommodation service transit].freeze
+    PRE_INVENTORY_DAYS = { 'transit' => 90, 'accommodation' => 365, 'service' => 30 }.freeze
 
     included do
       enum product_type: PRODUCT_TYPES if table_exists? && column_names.include?('product_type')
       enum primary_product_type: PRODUCT_TYPES if table_exists? && column_names.include?('primary_product_type')
     end
+
+    def permanent_stock?
+      PERMANENT_STOCK_PRODUCT_TYPES.include?(product_type)
+    end
+
+    def pre_inventory_days
+      PRE_INVENTORY_DAYS[product_type]
+    end
   end
 end

data/app/models/concerns/spree_cm_commissioner/taxon_kind.rb

@@ -3,7 +3,7 @@ module SpreeCmCommissioner
     extend ActiveSupport::Concern
 
     included do
-      enum kind: { category: 0, cms: 1, event: 2, occupation: 3, nationality: 4, organization: 5, transit: 6 }
+      enum kind: { category: 0, cms: 1, event: 2, occupation: 3, nationality: 4, organization: 5 }
     end
   end
 end

data/app/models/concerns/spree_cm_commissioner/tenant_preference.rb

@@ -9,7 +9,6 @@ module SpreeCmCommissioner
       preference :payment_failed_image, :string, default: ''
       preference :payment_success_image, :string, default: ''
       preference :payment_loader, :string, default: ''
-      preference :brand_primary_color, :string, default: ''
     end
   end
 end

data/app/models/spree_cm_commissioner/block.rb

@@ -0,0 +1,23 @@
+module SpreeCmCommissioner
+  class Block < Base
+    belongs_to :seat_section, class_name: 'SpreeCmCommissioner::SeatSection', optional: true
+    belongs_to :seat_layout, class_name: 'SpreeCmCommissioner::SeatLayout', optional: false
+
+    validates :label, presence: true
+
+    has_many :variant_blocks, class_name: 'SpreeCmCommissioner::VariantBlock', dependent: :destroy
+    has_many :variants, class_name: 'Spree::Variant', through: :variant_blocks
+
+    validates :width, presence: true, numericality: { greater_than: 0 }
+    validates :height, presence: true, numericality: { greater_than: 0 }
+    validates :x, presence: true, numericality: true
+    validates :y, presence: true, numericality: true
+    validates :rotation, presence: true, numericality: { greater_than_or_equal_to: -360, less_than_or_equal_to: 360 }
+
+    before_validation :assign_layout_from_section, if: -> { seat_layout.nil? && seat_section.present? }
+
+    def assign_layout_from_section
+      self.seat_layout = seat_section.seat_layout
+    end
+  end
+end

data/app/models/spree_cm_commissioner/dynamic_field.rb

@@ -9,14 +9,12 @@ module SpreeCmCommissioner
     has_many :product_dynamic_fields, class_name: 'SpreeCmCommissioner::ProductDynamicField', dependent: :destroy
 
     enum data_type: { text: 0, number: 1, boolean: 2, checkbox: 3, radio: 4, selection: 5, textarea: 6 }
-    enum data_fill_stage: { pre_registration: 0, post_registration: 1, during_check_in: 2 }
 
     accepts_nested_attributes_for :dynamic_field_options, allow_destroy: true, reject_if: :all_blank
 
     validates :label, presence: true
     validates :data_type, presence: true
     validates :configurations, presence: true, allow_blank: false
-    validate :validate_data_fill_stage_phase
 
     def requires_dynamic_field_options?
       checkbox? || radio? || selection?
@@ -32,23 +30,5 @@ module SpreeCmCommissioner
       self.configurations ||= {}
       self.configurations['multiple_select'] = ActiveModel::Type::Boolean.new.cast(value)
     end
-
-    def required_at_stage?(stage)
-      data_fill_stage == stage.to_s
-    end
-
-    def display_label
-      label + " (#{data_fill_stage.humanize})"
-    end
-
-    private
-
-    def validate_data_fill_stage_phase
-      return if data_fill_stage.blank?
-
-      return if data_fill_stage.in?(self.class.data_fill_stages.keys)
-
-      errors.add(:data_fill_stage, "must be one of: #{self.class.data_fill_stages.keys.join(', ')}")
-    end
   end
 end

data/app/models/spree_cm_commissioner/guest.rb

@@ -24,10 +24,16 @@ module SpreeCmCommissioner
     scope :none_bib, -> { where(bib_prefix: [nil, '']) }
 
     belongs_to :line_item, class_name: 'Spree::LineItem'
+
     has_one :variant, class_name: 'Spree::Variant', through: :line_item
+
     belongs_to :user, class_name: 'Spree::User'
     belongs_to :occupation, class_name: 'Spree::Taxon'
     belongs_to :nationality, class_name: 'Spree::Taxon'
+    belongs_to :block, class_name: 'SpreeCmCommissioner::Block', optional: true
+
+    has_one :reserved_block, class_name: 'SpreeCmCommissioner::ReservedBlock'
+
     scope :checked_ins, -> { joins(:check_in) }
     scope :no_show, -> { left_outer_joins(:check_in).where(cm_check_ins: { id: nil }) }
 
@@ -48,6 +54,10 @@ module SpreeCmCommissioner
 
     before_create :generate_bib, if: -> { line_item.reload && variant.bib_pre_generation_on_create? }
 
+    after_create :preload_order_block_ids, if: -> { block_id.present? }
+    after_update :preload_order_block_ids, if: :saved_change_to_block_id?
+    after_destroy :preload_order_block_ids
+
     validates :seat_number, uniqueness: { scope: :event_id }, allow_nil: true, if: -> { event_id.present? }
     validates :bib_index, uniqueness: true, allow_nil: true
 
@@ -213,62 +223,6 @@ module SpreeCmCommissioner
       save!
     end
 
-    def missing_dynamic_fields_for_stage(stage)
-      required_fields = line_item.product.dynamic_fields.where(data_fill_stage: stage)
-      filled_ids = guest_dynamic_fields.map(&:dynamic_field_id)
-
-      required_fields.reject { |field| filled_ids.include?(field.id) }
-    end
-
-    def all_required_dynamic_fields_completed?(stage)
-      missing_dynamic_fields_for_stage(stage).blank?
-    end
-
-    def validate_dynamic_fields_for_phase(phase)
-      required_fields = line_item.product.dynamic_fields.where(data_fill_stage: phase)
-      filled_ids = guest_dynamic_fields.map(&:dynamic_field_id)
-
-      required_fields.each do |field|
-        errors.add(:base, "#{field.label} is required for #{phase} phase") unless filled_ids.include?(field.id)
-      end
-    end
-
-    def pre_registration_completed?
-      return true unless line_item.product.dynamic_fields.pre_registration.any?
-
-      pre_registration_fields_completed?
-    end
-
-    def post_registration_completed?
-      return true unless line_item.product.dynamic_fields.post_registration.any?
-
-      post_registration_fields_completed?
-    end
-
-    def check_in_completed?
-      return true unless line_item.product.dynamic_fields.during_check_in.any?
-
-      check_in_fields_completed?
-    end
-
-    def current_collection_phase
-      if check_in.present?
-        :during_check_in
-      elsif line_item.order.completed?
-        :post_registration
-      else
-        :pre_registration
-      end
-    end
-
-    def phase_completion_status
-      {
-        pre_registration: pre_registration_completed?,
-        post_registration: post_registration_completed?,
-        during_check_in: check_in_completed?
-      }
-    end
-
     # bib_number: 345, bib_prefix: 5KM, bib_zerofill: 5 => return 5KM00345
     # bib_number: 345, bib_prefix: 5KM, bib_zerofill: 2 => return 5KM345
     def formatted_bib_number
@@ -283,6 +237,14 @@ module SpreeCmCommissioner
         filled_bib_number
       end
     end
+
+    def preload_order_block_ids
+      return if line_item.blank?
+      return if line_item.order.blank?
+
+      block_ids = line_item.order.blocks.pluck(:id)
+      line_item.order.update(preload_block_ids: block_ids)
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/app/models/spree_cm_commissioner/guest_dynamic_field.rb

@@ -7,7 +7,6 @@ module SpreeCmCommissioner
     validates :value, presence: true
     validate :validate_value_format, if: -> { value.present? && dynamic_field.present? }
     validate :validate_option_reference, if: -> { dynamic_field_option.present? }
-    validate :check_required_fields_based_on_phase
 
     private
 
@@ -35,49 +34,10 @@ module SpreeCmCommissioner
 
     def validate_option_reference
       return if dynamic_field.blank? || dynamic_field_option.blank?
+
       return if dynamic_field_option.dynamic_field_id == dynamic_field_id
 
       errors.add(:dynamic_field_option, 'must belong to the same dynamic field')
     end
-
-    def before_checkin_phase?
-      guest.present? && guest.line_item.present? && guest.check_in.nil?
-    end
-
-    def after_purchase_phase?
-      guest.present? && guest.line_item.present? && guest.line_item.completed? && guest.check_in.nil?
-    end
-
-    def during_checkin_phase?
-      guest.present? && guest.check_in.present?
-    end
-
-    def pre_registration_required?
-      dynamic_field.data_fill_stage.to_sym == :pre_registration &&
-        guest.line_item.order.completed? && guest.check_in.blank?
-    end
-
-    def post_registration_required?
-      dynamic_field.data_fill_stage.to_sym == :post_registration &&
-        guest.line_item.order.completed? && guest.check_in.blank?
-    end
-
-    def during_check_in_required?
-      dynamic_field.data_fill_stage.to_sym == :during_check_in &&
-        guest.check_in.present?
-    end
-
-    def check_required_fields_based_on_phase
-      return if dynamic_field.blank? || value.present?
-
-      case dynamic_field.data_fill_stage.to_sym
-      when :pre_registration
-        errors.add(:value, I18n.t('guest_dynamic_field.errors.pre_registration_required')) if pre_registration_required?
-      when :post_registration
-        errors.add(:value, I18n.t('guest_dynamic_field.errors.post_registration_required')) if post_registration_required?
-      when :during_check_in
-        errors.add(:value, I18n.t('guest_dynamic_field.errors.during_check_in_required')) if during_check_in_required?
-      end
-    end
   end
 end

data/app/models/spree_cm_commissioner/inventory.rb

@@ -0,0 +1,11 @@
+module SpreeCmCommissioner
+  class Inventory
+    include ActiveModel::Model
+
+    attr_accessor :variant_id, :inventory_date, :quantity_available, :max_capacity, :product_type
+
+    validates :variant_id, presence: true
+    validates :quantity_available, numericality: { only_integer: true, greater_than_or_equal_to: 0 }, allow_nil: true
+    validates :max_capacity, numericality: { only_integer: true, greater_than_or_equal_to: 0 }, allow_nil: true
+  end
+end

data/app/models/spree_cm_commissioner/inventory_item.rb

@@ -0,0 +1,69 @@
+module SpreeCmCommissioner
+  class InventoryItem < Base
+    include SpreeCmCommissioner::ProductType
+
+    # Association
+    belongs_to :variant, class_name: 'Spree::Variant', optional: false
+    has_many :prices, class_name: 'Spree::Price', inverse_of: :inventory_item
+
+    # Validation
+    validates :quantity_available, numericality: { greater_than_or_equal_to: 0 }
+    validates :max_capacity, numericality: { greater_than_or_equal_to: 0 } # Originally inventory of each variant.
+    validates :inventory_date, presence: true, if: :permanent_stock?
+    validates :variant_id, uniqueness: { scope: :inventory_date, message: -> (object, _data) { "The variant is taken on #{object.inventory_date}" } }
+
+    # Scope
+    scope :active, -> { where(inventory_date: nil).or(where('inventory_date >= ?', Time.zone.today)) }
+
+    before_save -> { self.product_type = variant.product_type }, if: -> { product_type.nil? }
+
+    # This method is only used when admin update stock
+    def adjust_quantity!(quantity)
+      with_lock do
+        self.max_capacity = [max_capacity + quantity, 0].max
+        self.quantity_available = [quantity_available + quantity, 0].max
+        save!
+
+        # When user has been searched or booked a product, it has cached the quantity in redis,
+        # So we need to update redis cache if inventory key has been created in redis
+        adjust_quantity_in_redis(quantity)
+      end
+    end
+
+    def redis_key
+      "inventory:#{id}"
+    end
+
+    def adjust_quantity_in_redis(quantity)
+      SpreeCmCommissioner.redis_pool.with do |redis|
+        cached_quantity_available = redis.get(redis_key)
+        # ignore if redis doesn't exist
+        return if cached_quantity_available.nil? # rubocop:disable Lint/NonLocalExitFromIterator
+
+        script = <<~LUA
+          local key = KEYS[1]
+          local increment = tonumber(ARGV[1])
+          local current = tonumber(redis.call('GET', key) or 0)
+          local new_value = current + increment
+          if new_value < 0 then
+            new_value = 0
+          end
+          redis.call('SET', key, new_value)
+          return new_value
+        LUA
+
+        redis.eval(script, keys: [redis_key], argv: [quantity])
+      end
+    end
+
+    def active?
+      inventory_date.nil? || inventory_date >= Time.zone.today
+    end
+
+    def redis_expired_in
+      expired_in = 31_536_000 # 1 year for normal stock
+      expired_in = Time.parse(inventory_date.to_s).end_of_day.to_i - Time.zone.now.to_i if inventory_date.present?
+      [expired_in, 0].max
+    end
+  end
+end