spree_cm_commissioner 2.0.3 → 2.1.0.pre.pre1

data/app/models/spree_cm_commissioner/guest_dynamic_field.rb

@@ -4,10 +4,17 @@ module SpreeCmCommissioner
     belongs_to :dynamic_field, class_name: 'SpreeCmCommissioner::DynamicField', optional: false
     belongs_to :dynamic_field_option, class_name: 'SpreeCmCommissioner::DynamicFieldOption', optional: true
 
-    validates :value, presence: true
     validate :validate_value_format, if: -> { value.present? && dynamic_field.present? }
     validate :validate_option_reference, if: -> { dynamic_field_option.present? }
+    validate :validate_phase_sequence
     validate :check_required_fields_based_on_phase
+    validate :reject_empty_string_for_text_fields
+
+    after_commit :sync_guest_data_fill_stage_phase
+
+    scope :with_dynamic_field_and_options, lambda {
+      includes(:dynamic_field, :dynamic_field_option)
+    }
 
     private
 
@@ -15,6 +22,8 @@ module SpreeCmCommissioner
       return if dynamic_field.blank?
 
       case dynamic_field.data_type.to_s
+      when 'text', 'textarea'
+        errors.add(:value, "can't be blank") if value.is_a?(String) && value.strip == ''
       when 'number'
         errors.add(:value, 'must be a number') unless value.to_s.match?(/\A\d+\z/)
       when 'boolean'
@@ -40,44 +49,49 @@ module SpreeCmCommissioner
       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 validate_phase_sequence
+      return if dynamic_field.blank? || guest.blank?
 
-    def after_purchase_phase?
-      guest.present? && guest.line_item.present? && guest.line_item.completed? && guest.check_in.nil?
+      case dynamic_field.data_fill_stage.to_sym
+      when :post_registration
+        errors.add(:base, 'Must complete pre_registration fields first') unless guest.pre_registration_completed?
+      when :during_check_in
+        unless guest.post_registration_completed? || !guest.post_registration_fields?
+          errors.add(:base, 'Must complete post_registration fields first')
+        end
+      end
     end
 
-    def during_checkin_phase?
-      guest.present? && guest.check_in.present?
-    end
+    def field_required_in_current_phase?
+      return false if dynamic_field.blank? || guest.blank?
 
-    def pre_registration_required?
-      dynamic_field.data_fill_stage.to_sym == :pre_registration &&
+      case dynamic_field.data_fill_stage.to_sym
+      when :pre_registration, :post_registration
         guest.line_item.order.completed? && guest.check_in.blank?
+      when :during_check_in
+        guest.check_in.present?
+      else
+        false
+      end
     end
 
-    def post_registration_required?
-      dynamic_field.data_fill_stage.to_sym == :post_registration &&
-        guest.line_item.order.completed? && guest.check_in.blank?
+    def check_required_fields_based_on_phase
+      return if dynamic_field.blank? || value.present?
+      return unless field_required_in_current_phase?
+
+      errors.add(:value, I18n.t("guest_dynamic_field.errors.#{dynamic_field.data_fill_stage}_required"))
     end
 
-    def during_check_in_required?
-      dynamic_field.data_fill_stage.to_sym == :during_check_in &&
-        guest.check_in.present?
+    def sync_guest_data_fill_stage_phase
+      guest&.save_and_move_to_next_stage
     end
 
-    def check_required_fields_based_on_phase
-      return if dynamic_field.blank? || value.present?
+    def reject_empty_string_for_text_fields
+      return if dynamic_field.blank?
+      return unless %w[text textarea].include?(dynamic_field.data_type.to_s)
+      return unless value.is_a?(String)
 
-      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
+      errors.add(:value, "can't be blank") if value.strip == ''
     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,82 @@
+module SpreeCmCommissioner
+  class InventoryItem < Base
+    include SpreeCmCommissioner::ProductType
+
+    MAX_DISPLAY_STOCK = 20
+
+    # Association
+    belongs_to :variant, class_name: 'Spree::Variant', optional: false
+
+    has_many :prices, class_name: 'Spree::Price', inverse_of: :inventory_item, dependent: :destroy
+
+    has_many :reserved_blocks, -> { reserved_or_on_hold }, class_name: 'SpreeCmCommissioner::ReservedBlock', 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? }
+
+    def public_quantity_available
+      [quantity_available, MAX_DISPLAY_STOCK].min
+    end
+
+    def price_in(currency)
+      prices.detect { |price| price.currency == currency } || prices.build(currency: currency)
+    end
+
+    # 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

data/app/models/spree_cm_commissioner/line_item_decorator.rb

@@ -1,6 +1,6 @@
 module SpreeCmCommissioner
   module LineItemDecorator
-    def self.prepended(base) # rubocop:disable Metrics/MethodLength
+    def self.prepended(base) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
       include_modules(base)
 
       base.belongs_to :accepter, class_name: 'Spree::User', optional: true
@@ -10,31 +10,32 @@ module SpreeCmCommissioner
       base.has_one :google_wallet, class_name: 'SpreeCmCommissioner::GoogleWallet', through: :product
 
       base.has_many :option_types, through: :product
+
+      base.has_many :inventory_items, lambda { |line_item|
+        where(inventory_date: nil).or(where(inventory_date: line_item.date_range))
+      }, through: :variant
+
       base.has_many :taxons, class_name: 'Spree::Taxon', through: :product
       base.has_many :guests, class_name: 'SpreeCmCommissioner::Guest', dependent: :destroy
+      base.has_many :guests_with_blocks, -> { where.not(block_id: nil) }, class_name: 'SpreeCmCommissioner::Guest'
+      base.has_many :reserved_blocks, through: :guests, class_name: 'SpreeCmCommissioner::ReservedBlock'
       base.has_many :pending_guests, pending_guests_query, class_name: 'SpreeCmCommissioner::Guest', dependent: :destroy
       base.has_many :product_completion_steps, class_name: 'SpreeCmCommissioner::ProductCompletionStep', through: :product
-      base.has_many :line_item_seats, class_name: 'SpreeCmCommissioner::LineItemSeat', dependent: :destroy
 
       base.before_save :update_vendor_id
-      base.before_save :update_quantity, if: :transit?
-
-      base.validate :validate_seats_reservation, if: :transit?
 
       base.before_create :add_due_date, if: :subscription?
+      base.before_save -> { self.product_type = variant.product_type }, if: -> { product_type.nil? }
 
       base.validate :ensure_not_exceed_max_quantity_per_order, if: -> { variant&.max_quantity_per_order.present? }
 
       base.whitelisted_ransackable_associations |= %w[guests order]
       base.whitelisted_ransackable_attributes |= %w[number to_date from_date vendor_id]
 
-      base.delegate :delivery_required?, :permanent_stock?, :high_demand, :transit?,
+      base.delegate :delivery_required?, :high_demand,
                     to: :variant
-      base.delegate :discontinue_on, :product_type, :accommodation?, :service?, :ecommerce?, :need_confirmation,
-                    to: :product
 
       base.accepts_nested_attributes_for :guests, allow_destroy: true
-      base.accepts_nested_attributes_for :line_item_seats, allow_destroy: true
 
       def base.json_api_columns
         json_api_columns = column_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }
@@ -42,6 +43,10 @@ module SpreeCmCommissioner
         json_api_columns << :vendor_id
       end
 
+      def discontinue_on
+        variant.discontinue_on || product.discontinue_on
+      end
+
       def base.search_by_qr_data!(data)
         matches = data.match(/(R\d+)-([A-Za-z0-9_\-]+)-(L\d+)/)&.captures
 
@@ -60,6 +65,8 @@ module SpreeCmCommissioner
       base.include SpreeCmCommissioner::LineItemDurationable
       base.include SpreeCmCommissioner::LineItemsFilterScope
       base.include SpreeCmCommissioner::LineItemGuestsConcern
+      base.include SpreeCmCommissioner::LineItemTransitable
+      base.include SpreeCmCommissioner::ProductType
       base.include SpreeCmCommissioner::ProductDelegation
       base.include SpreeCmCommissioner::KycBitwise
     end
@@ -75,24 +82,39 @@ module SpreeCmCommissioner
       }
     end
 
-    def reservation?
-      date_present? && !subscription?
-    end
+    # override to calculate price per date for permanent stock
+    def update_price_from_modifier(currency, opts)
+      self.currency = currency
 
-    # date_unit could be number of nights, or days or hours depending on usecases
-    # For example:
-    # - accomodation uses number of nights.
-    # - appointment uses number of hours, etc.
-    #
-    # override
-    def amount
-      base_price = price * quantity
+      # these fields can be null during this process below.
+      # it is needed for permanent_stock?, date_range to work.
+      self.product_type = variant.product_type
+      self.from_date = opts.delete(:from_date)&.to_datetime
+      self.to_date = opts.delete(:to_date)&.to_datetime
 
-      if permanent_stock? && date_unit.present?
-        base_price * date_unit
-      else
-        base_price
-      end
+      base_price = variant.price_in(currency)
+
+      self.price = if permanent_stock?
+                     date_range.map do |date|
+                       selected_price = variant.price_for_date(date: date, currency: currency) || base_price
+                       (selected_price.amount || 0) + variant.price_modifier_amount_in(currency, opts.merge(date: date))
+                     end.sum
+                   else
+                     (base_price.amount || 0) + variant.price_modifier_amount_in(currency, opts)
+                   end
+    end
+
+    # override to calculate price per date for permanent stock
+    def update_price
+      base_price = variant.price_in(order.currency)
+      self.price = if permanent_stock?
+                     date_range.map do |date|
+                       selected_price = variant.price_for_date(date: date, currency: order.currency) || base_price
+                       selected_price.amount || 0
+                     end.sum
+                   else
+                     base_price.amount || 0
+                   end
     end
 
     def allowed_self_check_in?
@@ -179,8 +201,6 @@ module SpreeCmCommissioner
 
     # override
     def sufficient_stock?
-      return transit_sufficient_stock? if variant.product.product_type == 'transit'
-
       SpreeCmCommissioner::Stock::LineItemAvailabilityChecker.new(self).can_supply?(quantity)
     end
 
@@ -199,18 +219,6 @@ module SpreeCmCommissioner
       errors.add(:quantity, 'exceeded_max_quantity_per_order') if quantity > variant.max_quantity_per_order
     end
 
-    def transit_sufficient_stock?
-      return selected_seats_available? if reservation_trip.allow_seat_selection
-
-      seat_quantity_available?(reservation_trip)
-    end
-
-    def update_quantity
-      return if line_item_seats.blank?
-
-      self.quantity = line_item_seats.size
-    end
-
     def update_vendor_id
       self.vendor_id = variant.vendor_id
     end
@@ -233,45 +241,6 @@ module SpreeCmCommissioner
 
       from_date + variant.month.month + day.days
     end
-
-    def validate_seats_reservation
-      if reservation_trip.allow_seat_selection && !selected_seats_available?
-        errors.add(:base, :some_seats_are_booked, message: 'Some seats are already booked')
-      elsif !reservation_trip.allow_seat_selection && !seat_quantity_available?(reservation_trip)
-        errors.add(:quantity, :exceeded_available_quantity, message: 'exceeded available quantity')
-      end
-    end
-
-    def selected_seats_available?
-      selected_seat_ids = line_item_seats.map(&:seat_id)
-      !selected_seat_ids_occupied?(selected_seat_ids)
-    end
-
-    def seat_quantity_available?(trip)
-      booked_quantity = Spree::LineItem.joins(:order)
-                                       .where(variant_id: variant_id, date: date, spree_orders: { state: 'complete' })
-                                       .where.not(spree_line_items: { id: id })
-                                       .sum(:quantity)
-      remaining_quantity = trip.vehicle.number_of_seats - booked_quantity
-      remaining_quantity >= quantity
-    end
-
-    def reservation_trip
-      return @trip if defined? @trip
-
-      route = Spree::Variant.find_by(id: variant_id).product
-      @trip = route.trip
-    end
-
-    def selected_seat_ids_occupied?(selected_seat_ids)
-      # check to see if there are any selected_ids exist in the line_item_seats and belongs to completed order
-      SpreeCmCommissioner::LineItemSeat.joins(line_item: :order)
-                                       .where(seat_id: selected_seat_ids, date: date, variant_id: variant_id, spree_orders: { state: 'complete',
-                                                                                                                              canceled_at: nil
-}
-                                       )
-                                       .present?
-    end
   end
 end
 

data/app/models/spree_cm_commissioner/notification_taxon.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  class NotificationTaxon < SpreeCmCommissioner::Base
+  class NotificationTaxon < Base
     belongs_to :customer_notification, class_name: 'SpreeCmCommissioner::CustomerNotification'
     belongs_to :taxon, class_name: 'Spree::Taxon'
   end

data/app/models/spree_cm_commissioner/option_type_decorator.rb

@@ -6,7 +6,7 @@ module SpreeCmCommissioner
       base.include SpreeCmCommissioner::ParameterizeName
       base.include SpreeCmCommissioner::OptionTypeAttrType
 
-      base.enum kind: %i[variant product vendor vehicle_type transit]
+      base.enum kind: %i[variant product vendor vehicle]
 
       base.validates :name, presence: true
 
@@ -19,16 +19,6 @@ module SpreeCmCommissioner
       base.scope :promoted, -> { where(promoted: true) }
       base.whitelisted_ransackable_attributes = %w[kind]
 
-      def base.amenities
-        Spree::OptionType.where(kind: 'vehicle_type', name: 'amenities', presentation: 'Amenities', attr_type: 'amenity').first_or_create
-      end
-
-      def base.vehicle
-        Spree::OptionType.where(presentation: 'vehicle', attr_type: 'vehicle_id', kind: 'variant',
-                                name: 'vehicle'
-        ).first_or_create
-      end
-
       def base.rules_option_type
         Spree::OptionType.find_by(name: RULES_OPTION_TYPE_NAME)
       end

data/app/models/spree_cm_commissioner/order/address_book_decorator.rb

@@ -5,30 +5,48 @@
 module SpreeCmCommissioner
   module Order
     module AddressBookDecorator
-      def guest_order? = user.blank?
-
       # override
       def bill_address_attributes=(attributes)
-        attributes[:id] = bill_address&.id if attributes[:id].blank?
-        return if guest_order? && !basic_info_included?(attributes)
+        attributes[:id] = bill_address_id if attributes[:id].blank?
+        attributes[:phone] = intel_phone_number if intel_phone_number.present?
 
-        super
+        self.bill_address = assign_address_attributes(attributes)
+        user.bill_address = bill_address if user && user.bill_address.nil?
       end
 
       # override
       def ship_address_attributes=(attributes)
-        attributes[:id] = bill_address&.id if attributes[:id].blank?
-        return if guest_order? && !basic_info_included?(attributes)
+        attributes[:id] = ship_address_id if attributes[:id].blank?
+        attributes[:phone] = intel_phone_number if intel_phone_number.present?
 
-        super
+        self.ship_address = assign_address_attributes(attributes)
+        user.ship_address = ship_address if user && user.ship_address.nil?
       end
 
-      private
+      def assign_address_attributes(attributes = {})
+        return if attributes.blank?
+
+        attributes.transform_values! { |v| v == '' ? nil : v }
+        attributes = attributes.to_h.symbolize_keys
 
-      def basic_info_included?(attributes)
-        return true if attributes[:id].present?
+        existing_address = attributes[:id].present? ? find_existing_address(attributes[:id]) : nil
+
+        if existing_address&.editable?
+          existing_address.assign_attributes(attributes)
+          existing_address
+        else
+          ::Spree::Address.new(attributes.except(:id, :updated_at, :created_at))
+        end
+      end
 
-        %i[firstname lastname phone].all? { |key| attributes[key].present? }
+      def find_existing_address(id)
+        if user.present?
+          ::Spree::Address.where('(user_id = ? OR user_id IS NULL) AND deleted_at IS NULL', user.id)
+                          .find_by(id: id)
+        else
+          ::Spree::Address.where(user_id: nil, deleted_at: nil)
+                          .find_by(id: id)
+        end
       end
     end
   end

data/app/models/spree_cm_commissioner/order_decorator.rb

@@ -2,6 +2,7 @@ module SpreeCmCommissioner
   module OrderDecorator
     def self.prepended(base) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
       base.include SpreeCmCommissioner::PhoneNumberSanitizer
+      base.include SpreeCmCommissioner::OrderSeatable
       base.include SpreeCmCommissioner::OrderStateMachine
 
       base.scope :subscription, -> { where.not(subscription_id: nil) }
@@ -42,6 +43,14 @@ module SpreeCmCommissioner
       base.has_many :vendors, through: :products, class_name: 'Spree::Vendor'
       base.has_many :taxons, through: :products, class_name: 'Spree::Taxon'
       base.has_many :guests, through: :line_items, class_name: 'SpreeCmCommissioner::Guest'
+
+      base.has_many :saved_guests,
+                    through: :guests,
+                    source: :saved_guest,
+                    class_name: 'SpreeCmCommissioner::SavedGuest'
+
+      base.has_many :blocks, through: :guests, class_name: 'SpreeCmCommissioner::Block', source: :block
+      base.has_many :reserved_blocks, through: :guests, class_name: 'SpreeCmCommissioner::ReservedBlock'
       base.has_many :guest_card_classes, class_name: 'SpreeCmCommissioner::GuestCardClass', through: :variants
 
       base.delegate :customer, to: :user, allow_nil: true
@@ -49,6 +58,8 @@ module SpreeCmCommissioner
       base.whitelisted_ransackable_associations |= %w[customer taxon payments guests invoice]
       base.whitelisted_ransackable_attributes |= %w[intel_phone_number phone_number email number state]
 
+      base.accepts_nested_attributes_for :saved_guests, allow_destroy: true
+
       def base.search_by_qr_data!(data)
         token = data.match(/^R\d{9,}-([A-Za-z0-9_\-]+)$/)&.captures
 
@@ -58,6 +69,13 @@ module SpreeCmCommissioner
       end
     end
 
+    # override
+    # spree use this method to check stock availability & consider whether :order can continue to next state.
+    def insufficient_stock_lines
+      checker = SpreeCmCommissioner::Stock::OrderAvailabilityChecker.new(self)
+      checker.insufficient_stock_lines
+    end
+
     def ticket_seller_user?
       return false if user.nil?
 
@@ -106,7 +124,14 @@ module SpreeCmCommissioner
     end
 
     def mark_as_archive
-      update(archived_at: Time.current)
+      blocks_canceled = begin
+        cancel_blocks!
+        true
+      rescue StandardError
+        false
+      end
+
+      update(archived_at: Time.current) if blocks_canceled
     end
 
     # overrided
@@ -199,6 +224,18 @@ module SpreeCmCommissioner
 
     private
 
+    def unstock_inventory_in_redis!
+      CmAppLogger.log(label: "#{self.class.name}#unstock_inventory_in_redis!", data: { order_id: id }) do
+        SpreeCmCommissioner::RedisStock::InventoryUpdater.new(line_item_ids).unstock!
+      end
+    end
+
+    def restock_inventory_in_redis!
+      CmAppLogger.log(label: "#{self.class.name}#restock_inventory_in_redis!", data: { order_id: id }) do
+        SpreeCmCommissioner::RedisStock::InventoryUpdater.new(line_item_ids).restock!
+      end
+    end
+
     # override :spree_api
     def webhook_payload_body
       resource_serializer.new(

data/app/models/spree_cm_commissioner/place.rb

@@ -1,7 +1,5 @@
-require_dependency 'spree_cm_commissioner'
-
 module SpreeCmCommissioner
-  class Place < ApplicationRecord
+  class Place < Base
     acts_as_nested_set
 
     validates :reference, presence: true, if: :validate_reference?
@@ -16,8 +14,9 @@ module SpreeCmCommissioner
     has_many :product_places, class_name: 'SpreeCmCommissioner::ProductPlace', dependent: :destroy
     has_many :products, through: :product_places
 
+    has_many :location_vendor_places, -> { where(place_type: :location) }, class_name: 'SpreeCmCommissioner::VendorPlace'
+
     has_many :children, -> { order(:lft) }, class_name: 'SpreeCmCommissioner::Place', foreign_key: :parent_id, dependent: :destroy
-    has_many :vendor_stops, class_name: 'SpreeCmCommissioner::VendorStop', dependent: :destroy, foreign_key: :stop_id
 
     has_many :taxon_places, class_name: 'SpreeCmCommissioner::TaxonPlace', dependent: :destroy
     has_many :taxons, through: :taxon_places

data/app/models/spree_cm_commissioner/price_decorator.rb

@@ -0,0 +1,9 @@
+module SpreeCmCommissioner
+  module PriceDecorator
+    def self.prepended(base)
+      base.belongs_to :inventory_item, class_name: 'SpreeCmCommissioner::InventoryItem', inverse_of: :prices, optional: true
+    end
+  end
+end
+
+Spree::Price.prepend(SpreeCmCommissioner::PriceDecorator) unless Spree::Price.included_modules.include?(SpreeCmCommissioner::PriceDecorator)