spree_core 5.1.0.beta4 → 5.1.0.rc1

data/app/models/spree/order/checkout.rb

@@ -92,6 +92,7 @@ module Spree
                 after_transition to: :complete, do: :persist_user_credit_card
                 before_transition to: :payment, do: :set_shipments_cost
                 before_transition to: :payment, do: :create_tax_charge!
+                before_transition to: :payment, do: :recalculate_store_credit_payment
               end
 
               before_transition from: :cart, do: :ensure_line_items_present
@@ -118,6 +119,7 @@ module Spree
 
               after_transition to: :complete, do: :finalize!
               after_transition to: :complete, do: :use_all_coupon_codes
+              after_transition to: :complete, do: :redeem_gift_card
               after_transition to: :resumed, do: :after_resume
               after_transition to: :canceled, do: :after_cancel
 

data/app/models/spree/order/gift_card.rb

@@ -0,0 +1,51 @@
+module Spree
+  class Order < Spree.base_class
+    module GiftCard
+      extend ActiveSupport::Concern
+
+      included do
+        # one GiftCard can be used on many orders, until it runs out
+        belongs_to :gift_card, class_name: 'Spree::GiftCard', optional: true
+
+        money_methods :gift_card_total
+      end
+
+      # Returns the total amount of the gift card applied to the order
+      # @return [Decimal]
+      def gift_card_total
+        return 0.to_d unless gift_card.present?
+
+        store_credit_ids = payments.store_credits.valid.pluck(:source_id)
+        store_credits = Spree::StoreCredit.where(id: store_credit_ids, originator: gift_card)
+
+        store_credits.sum(:amount)
+      end
+
+      # Applies a gift card to the order
+      # @param gift_card [Spree::GiftCard] the gift card to apply
+      # @return [Spree::Order] the order with the gift card applied
+      def apply_gift_card(gift_card)
+        Spree::Dependencies.gift_card_apply_service.constantize.call(gift_card: gift_card, order: self)
+      end
+
+      # Removes a gift card from the order
+      # @return [Spree::Order] the order with the gift card removed
+      def remove_gift_card
+        Spree::Dependencies.gift_card_remove_service.constantize.call(order: self)
+      end
+
+      def recalculate_gift_card
+        applied_gift_card = gift_card
+
+        remove_gift_card
+        apply_gift_card(applied_gift_card)
+      end
+
+      def redeem_gift_card
+        return unless gift_card.present?
+
+        Spree::Dependencies.gift_card_redeem_service.constantize.call(gift_card: gift_card)
+      end
+    end
+  end
+end

data/app/models/spree/order/store_credit.rb

@@ -14,12 +14,19 @@ module Spree
       end
       alias covered_by_store_credit covered_by_store_credit?
 
+      # Returns the total amount of store credits available to the user associated with the order.
+      # Returns only store credit for this store and same currency as order
+      #
+      # @return [BigDecimal] The total amount of store credits available to the user associated with the order.
       def total_available_store_credit
         return 0.0 unless user
 
         user.total_available_store_credit(currency, store)
       end
 
+      # Returns the available store credits for the user associated with the order.
+      #
+      # @return [Array<Spree::StoreCredit>] The available store credits for the user associated with the order.
       def available_store_credits
         return Spree::StoreCredit.none if user.nil?
 
@@ -27,15 +34,21 @@ module Spree
       end
 
       def could_use_store_credit?
-        return false if Spree::PaymentMethod::StoreCredit.available.empty?
+        return false if store.payment_methods.store_credit.available.empty?
 
         total_available_store_credit > 0
       end
 
+      # Returns the total amount of the order minus the total amount of store credits applied to the order.
+      #
+      # @return [BigDecimal] The total amount of the order minus the total amount of store credits applied to the order.
       def order_total_after_store_credit
         total - total_applicable_store_credit
       end
 
+      # Returns the total amount of the order minus the total amount of store credits applied to the order.
+      #
+      # @return [BigDecimal] The total amount of the order minus the total amount of store credits applied to the order.
       def total_minus_store_credits
         total - total_applied_store_credit
       end
@@ -48,10 +61,16 @@ module Spree
         end
       end
 
+      # Returns the total amount of store credits applied to the order.
+      #
+      # @return [BigDecimal] The total amount of store credits applied to the order.
       def total_applied_store_credit
         payments.store_credits.valid.sum(:amount)
       end
 
+      # Returns true if the order is using store credit.
+      #
+      # @return [Boolean] True if the order is using store credit, false otherwise.
       def using_store_credit?
         total_applied_store_credit > 0
       end

data/app/models/spree/order.rb

@@ -4,6 +4,7 @@ require_dependency 'spree/order/digital'
 require_dependency 'spree/order/payments'
 require_dependency 'spree/order/store_credit'
 require_dependency 'spree/order/emails'
+require_dependency 'spree/order/gift_card'
 
 module Spree
   class Order < Spree.base_class
@@ -11,6 +12,8 @@ module Spree
     SHIPMENT_STATES = %w(backorder canceled partial pending ready shipped)
     LINE_ITEM_REMOVABLE_STATES = %w(cart address delivery payment confirm resumed)
 
+    extend Spree::DisplayMoney
+
     include Spree::Order::Checkout
     include Spree::Order::CurrencyUpdater
     include Spree::Order::Digital
@@ -20,6 +23,7 @@ module Spree
     include Spree::Order::Emails
     include Spree::Order::Webhooks
     include Spree::Core::NumberGenerator.new(prefix: 'R')
+    include Spree::Order::GiftCard
 
     include Spree::NumberIdentifier
     include Spree::NumberAsParam
@@ -38,7 +42,6 @@ module Spree
 
     MEMOIZED_METHODS = %w(tax_zone)
 
-    extend Spree::DisplayMoney
     money_methods :outstanding_balance, :item_total,           :adjustment_total,
                   :included_tax_total,  :additional_tax_total, :tax_total,
                   :shipment_total,      :promo_total,          :total,
@@ -313,10 +316,28 @@ module Spree
       shipments.any?(&:backordered?)
     end
 
+    # Check if the shipping address is a quick checkout address
+    # quick checkout addresses are incomplete as wallet providers like Apple Pay and Google Pay
+    # do not provide all the address fields until the checkout is completed (confirmed) on their side
+    # @return [Boolean]
     def quick_checkout?
       shipping_address.present? && shipping_address.quick_checkout?
     end
 
+    # Check if quick checkout is available for this order
+    # Either fully digital or not digital at all
+    # @return [Boolean]
+    def quick_checkout_available?
+      payment_required? && shipments.count <= 1 && (digital? || !some_digital? || !delivery_required?)
+    end
+
+    # Check if quick checkout requires an address collection
+    # If the order is digital or not delivery required, then we don't need to collect an address
+    # @return [Boolean]
+    def quick_checkout_require_address?
+      !digital? && delivery_required?
+    end
+
     # Returns the relevant zone (if any) to be used for taxation purposes.
     # Uses default tax zone unless there is a specific match
     def tax_zone
@@ -631,7 +652,7 @@ module Spree
     #
     # @return [BigDecimal] the total weight of the inventory units in the order
     def total_weight
-      @total_weight ||= line_items.joins(:variant).includes(:variant).map { |li| li.variant.weight * li.quantity }.sum
+      @total_weight ||= line_items.joins(:variant).includes(:variant).map(&:item_weight).sum
     end
 
     # Returns line items that have no shipping rates
@@ -742,6 +763,11 @@ module Spree
     end
 
     def can_be_destroyed?
+      Spree::Deprecation.warn('Spree::Order#can_be_destroyed? is deprecated and will be removed in the next major version. Use Spree::Order#can_be_deleted? instead.')
+      can_be_deleted?
+    end
+
+    def can_be_deleted?
       !completed? && payments.completed.empty?
     end
 
@@ -834,6 +860,10 @@ module Spree
       line_items
     end
 
+    def requires_ship_address?
+      !digital?
+    end
+
     private
 
     def link_by_email
@@ -870,10 +900,15 @@ module Spree
 
     def after_cancel
       shipments.each(&:cancel!)
-      payments.completed.each(&:cancel!)
 
-      # Free up authorized store credits
-      payments.store_credits.pending.each(&:void!)
+      # payments fully covered by gift card won't be refunded
+      # we want to only void the payment
+      if gift_card.present? && covered_by_store_credit?
+        payments.completed.store_credits.each(&:void!)
+      else
+        payments.completed.each(&:cancel!)
+        payments.store_credits.pending.each(&:void!)
+      end
 
       send_cancel_email
       update_with_updater!
@@ -895,7 +930,7 @@ module Spree
     end
 
     def ensure_currency_presence
-      self.currency ||= store.default_currency
+      self.currency ||= store&.default_currency
     end
 
     def collect_payment_methods(store = nil)
@@ -911,5 +946,15 @@ module Spree
     def credit_card_nil_payment?(attributes)
       payments.store_credits.present? && attributes[:amount].to_f.zero?
     end
+
+    def recalculate_store_credit_payment
+      updater.update_adjustment_total if using_store_credit?
+
+      if gift_card.present?
+        recalculate_gift_card
+      elsif using_store_credit?
+        Spree::Dependencies.checkout_add_store_credit_service.constantize.call(order: self)
+      end
+    end
   end
 end

data/app/models/spree/order_merger.rb

@@ -8,6 +8,7 @@ module Spree
     end
 
     def merge!(other_order, user = nil, discard_merged: true)
+      handle_gift_card(other_order)
       other_order.line_items.each do |other_order_line_item|
         next unless other_order_line_item.currency == order.currency
 
@@ -26,6 +27,8 @@ module Spree
       end
     end
 
+    private
+
     # Compare the line item of the other order with mine.
     # Make sure you allow any extensions to chime in on whether or
     # not the extension-specific parts of the line item match
@@ -70,5 +73,14 @@ module Spree
       updater.update_item_total
       updater.persist_totals
     end
+
+    def handle_gift_card(other_order)
+      return unless other_order.gift_card.present?
+
+      gift_card = other_order.gift_card
+
+      other_order.remove_gift_card
+      order.apply_gift_card(gift_card)
+    end
   end
 end

data/app/models/spree/page_sections/featured_posts.rb

@@ -19,6 +19,10 @@ module Spree
         'news'
       end
 
+      def posts
+        Spree::Post.published.by_newest.limit(preferred_max_posts_to_show)
+      end
+
       private
 
       def make_posts_to_show_valid

data/app/models/spree/payment_method/store_credit.rb

@@ -102,7 +102,7 @@ module Spree
     end
 
     def available_for_order?(order)
-      order.could_use_store_credit?
+      order.gift_card.present? || order.could_use_store_credit?
     end
 
     private

data/app/models/spree/payment_method.rb

@@ -12,6 +12,7 @@ module Spree
 
     scope :active,    -> { where(active: true).order(position: :asc) }
     scope :available, -> { active.where(display_on: [:front_end, :back_end, :both]) }
+    scope :store_credit, -> { where(type: 'Spree::PaymentMethod::StoreCredit') }
 
     after_initialize :set_name, if: :new_record?
 

data/app/models/spree/post.rb

@@ -54,6 +54,7 @@ module Spree
     # Scopes
     #
     scope :published, -> { where(published_at: [..Time.current]) }
+    scope :by_newest, -> { order(created_at: :desc) }
 
     delegate :name, to: :author, prefix: true, allow_nil: true
     delegate :title, to: :post_category, prefix: true, allow_nil: true

data/app/models/spree/price.rb

@@ -36,7 +36,13 @@ module Spree
     scope :with_currency, ->(currency) { where(currency: currency) }
     scope :non_zero, -> { where.not(amount: [nil, 0]) }
     scope :discounted, -> { where('compare_at_amount > amount') }
-    scope :for_products, ->(products) { joins(variant: :product).where("#{Spree::Product.table_name}.id" => products) }
+    scope :for_products, ->(products, currency = nil) do
+      currency ||= Spree::Store.default.default_currency
+
+      with_currency(currency).joins(:variant).where(
+        Spree::Variant.table_name => { product_id: products }
+      )
+    end
 
     extend DisplayMoney
     money_methods :amount, :price, :compare_at_amount

data/app/models/spree/product/slugs.rb

@@ -0,0 +1,103 @@
+module Spree
+  class Product < Spree.base_class
+    module Slugs
+      extend ActiveSupport::Concern
+
+      included do
+        extend FriendlyId
+        include Spree::TranslatableResourceSlug
+
+        translates :slug
+        friendly_id :slug_candidates, use: [:history, :slugged, :scoped, :mobility], scope: spree_base_uniqueness_scope, slug_limit: 255
+
+        Product::Translation.class_eval do
+          before_save :set_slug
+          acts_as_paranoid
+          # deleted translation values also need to be accessible for index views listing deleted resources
+          default_scope { unscope(where: :deleted_at) }
+
+          private
+
+          def set_slug
+            self.slug = generate_slug
+          end
+
+          def generate_slug
+            if name.blank? && slug.blank?
+              translated_model.name.to_url
+            elsif slug.blank?
+              name.to_url
+            else
+              slug.to_url
+            end
+          end
+        end
+
+        before_validation :downcase_slug
+        before_validation :normalize_slug, on: :update
+        after_destroy :punch_slugs
+        after_restore :regenerate_slug
+
+        validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: true, scope: spree_base_uniqueness_scope }
+
+        def self.slug_available?(slug, id)
+          !where(slug: slug).where.not(id: id).exists?
+        end
+      end
+
+      def ensure_slug_is_unique(candidate_slug)
+        return slug if candidate_slug.blank? || slug.blank?
+        return candidate_slug if self.class.slug_available?(candidate_slug, id)
+
+        normalize_friendly_id([candidate_slug, uuid_for_friendly_id])
+      end
+
+      private
+
+      def slug_candidates
+        if defined?(:deleted_at) && deleted_at.present?
+          [
+            ['deleted', :name],
+            ['deleted', :name, :sku],
+            ['deleted', :name, :uuid_for_friendly_id]
+          ]
+        else
+          [
+            [:name],
+            [:name, :sku],
+            [:name, :uuid_for_friendly_id]
+          ]
+        end
+      end
+
+      def downcase_slug
+        slug&.downcase!
+      end
+
+      def normalize_slug
+        self.slug = normalize_friendly_id(slug)
+      end
+
+      def regenerate_slug
+        self.slug = nil
+        save!
+      end
+
+      def punch_slugs
+        return if new_record? || frozen?
+
+        self.slug = nil
+
+        set_slug
+        update_column(:slug, slug)
+
+        new_slug = ->(rec) { "deleted-#{rec.id}_#{rec.slug}"[..254] }
+
+        translations.with_deleted.each { |rec| rec.update_columns(slug: new_slug.call(rec)) }
+        slugs.with_deleted.each { |rec| rec.update_column(:slug, new_slug.call(rec)) }
+
+        translations.find_by!(locale: I18n.locale).update_column(:slug, slug) if Spree.use_translations?
+      end
+    end
+  end
+end

data/app/models/spree/product.rb

@@ -20,14 +20,17 @@
 
 module Spree
   class Product < Spree.base_class
-    extend FriendlyId
+    acts_as_paranoid
+    acts_as_taggable_on :tags, :labels
+    auto_strip_attributes :name
+
     include Spree::ProductScopes
     include Spree::MultiStoreResource
     include Spree::TranslatableResource
-    include Spree::TranslatableResourceSlug
     include Spree::MemoizedData
     include Spree::Metadata
     include Spree::Product::Webhooks
+    include Spree::Product::Slugs
     if defined?(Spree::VendorConcern)
       include Spree::VendorConcern
     end
@@ -50,39 +53,10 @@ module Spree
       if defined?(PgSearch)
         include PgSearch::Model
 
-        if connected? && connection.extension_enabled?('pg_trgm')
-          pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { trigram: { threshold: 0.3, word_similarity: true } }
-        else
-          pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { tsearch: { any_word: true, prefix: true } }
-        end
-      end
-
-      before_save :set_slug
-      acts_as_paranoid
-      # deleted translation values also need to be accessible for index views listing deleted resources
-      default_scope { unscope(where: :deleted_at) }
-      def set_slug
-        self.slug = generate_slug
-      end
-
-      private
-
-      def generate_slug
-        if name.blank? && slug.blank?
-          translated_model.name.to_url
-        elsif slug.blank?
-          name.to_url
-        else
-          slug.to_url
-        end
+        pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { trigram: { threshold: 0.3, word_similarity: true } }
       end
     end
 
-    friendly_id :slug_candidates, use: [:history, :scoped, :mobility], scope: spree_base_uniqueness_scope
-    acts_as_paranoid
-    auto_strip_attributes :name
-    acts_as_taggable_on :tags, :labels
-
     # we need to have this callback before any dependent: :destroy associations
     # https://github.com/rails/rails/issues/3458
     before_destroy :ensure_not_in_complete_orders
@@ -148,17 +122,12 @@ module Spree
     after_initialize :ensure_master
     after_initialize :assign_default_tax_category
 
-    before_validation :downcase_slug
-    before_validation :normalize_slug, on: :update
     before_validation :validate_master
     before_validation :ensure_default_shipping_category
 
     after_create :add_associations_from_prototype
     after_create :build_variants_from_option_values_hash, if: :option_values_hash
 
-    after_destroy :punch_slug
-    after_restore :update_slug_history
-
     after_save :save_master
     after_save :run_touch_callbacks, if: :anything_changed?
     after_save :reset_nested_changes
@@ -176,7 +145,6 @@ module Spree
       validates :price, if: :requires_price?
     end
 
-    validates :slug, presence: true, uniqueness: { allow_blank: true, case_sensitive: true, scope: spree_base_uniqueness_scope }
     validate :discontinue_on_must_be_later_than_make_active_at, if: -> { make_active_at && discontinue_on }
 
     scope :for_store, ->(store) { joins(:store_products).where(StoreProduct.table_name => { store_id: store.id }) }
@@ -231,7 +199,7 @@ module Spree
         having("SUM(#{Spree::StockItem.table_name}.count_on_hand) <= 0")
     }
     scope :out_of_stock, lambda {
-                           joins(:stock_items).where("#{Spree::StockItem.table_name}.count_on_hand <= ? OR #{Spree::Variant.table_name}.track_inventory = ?", 0, false)
+                           joins(:stock_items).where("#{Spree::Variant.table_name}.track_inventory = ? OR #{Spree::StockItem.table_name}.count_on_hand <= ?", false, 0)
                          }
 
     scope :by_best_selling, lambda { |order_direction = :desc|
@@ -515,17 +483,6 @@ module Spree
       where conditions.inject(:or)
     end
 
-    def self.slug_available?(slug, id)
-      !where(slug: slug).where.not(id: id).exists?
-    end
-
-    def ensure_slug_is_unique(candidate_slug)
-      return slug if candidate_slug.blank? || slug.blank?
-      return candidate_slug if self.class.slug_available?(candidate_slug, id)
-
-      normalize_friendly_id([candidate_slug, uuid_for_friendly_id])
-    end
-
     # Suitable for displaying only variants that has at least one option value.
     # There may be scenarios where an option type is removed and along with it
     # all option values. At that point all variants associated with only those
@@ -741,25 +698,6 @@ module Spree
       self.tax_category = Spree::TaxCategory.default if new_record?
     end
 
-    def normalize_slug
-      self.slug = normalize_friendly_id(slug)
-    end
-
-    def punch_slug
-      # punch slug with date prefix to allow reuse of original
-      return if frozen?
-
-      update_column(:slug, "#{Time.current.to_i}_#{slug}"[0..254])
-
-      translations.with_deleted.each do |t|
-        t.update_column :slug, "#{Time.current.to_i}_#{t.slug}"[0..254]
-      end
-    end
-
-    def update_slug_history
-      save!
-    end
-
     def anything_changed?
       saved_changes? || @nested_changes
     end
@@ -815,14 +753,6 @@ module Spree
       end
     end
 
-    # Try building a slug based on the following fields in increasing order of specificity.
-    def slug_candidates
-      [
-        :name,
-        [:name, :sku]
-      ]
-    end
-
     def run_touch_callbacks
       run_callbacks(:touch)
     end
@@ -870,10 +800,6 @@ module Spree
       previously_new_record? || tag_list_previously_changed? || available_on_previously_changed?
     end
 
-    def downcase_slug
-      slug&.downcase!
-    end
-
     def after_activate
       # Implement your logic here
     end

data/app/models/spree/product_property.rb

@@ -31,9 +31,9 @@ module Spree
     default_scope { order(:position) }
 
     scope :filterable, -> { joins(:property).where(Property.table_name => { filterable: true }) }
-    scope :for_products, ->(products) { joins(:product).merge(products) }
+    scope :for_products, ->(products) { where(product_id: products) }
     scope :sort_by_property_position, -> {
-      unscope(:order).joins(:property).order("spree_properties.position ASC")
+      unscope(:order).joins(:property).order(Spree::Property.table_name => { position: :asc })
     }
 
     self.whitelisted_ransackable_attributes = ['value', 'filter_param']

data/app/models/spree/promotion_handler/coupon.rb

@@ -11,6 +11,27 @@ module Spree
       end
 
       def apply
+        if load_gift_card_code
+
+          if @gift_card.expired?
+            set_error_code :gift_card_expired
+            return self
+          elsif @gift_card.redeemed?
+            set_error_code :gift_card_already_redeemed
+            return self
+          end
+
+          result = order.apply_gift_card(@gift_card)
+
+          if result.success?
+            set_success_code(:gift_card_applied)
+          else
+            set_error_code(result.value, result.error.value || {})
+          end
+
+          return self
+        end
+
         if order.coupon_code.present?
           if promotion.present? && promotion.actions.exists?
             handle_present_promotion
@@ -26,6 +47,18 @@ module Spree
       end
 
       def remove(coupon_code)
+        if order.gift_card
+          result = order.remove_gift_card
+
+          if result.success?
+            set_success_code(:gift_card_removed)
+          else
+            set_error_code(result.value)
+          end
+
+          return self
+        end
+
         promotion = order.promotions.with_coupon_code(coupon_code)
         if promotion.present?
           # Order promotion has to be destroyed before line item removing
@@ -179,6 +212,12 @@ module Spree
       def handle_coupon_code(discount, coupon_code)
         discount.source.promotion.coupon_codes.unused.find_by(code: coupon_code)&.apply_order!(order)
       end
+
+      def load_gift_card_code
+        return unless order.coupon_code.present?
+
+        @gift_card = order.store.gift_cards.find_by(code: order.coupon_code.downcase)
+      end
     end
   end
 end