spree_core 5.1.8 → 5.2.0.rc1

data/app/models/concerns/spree/metafields.rb

@@ -0,0 +1,94 @@
+module Spree
+  module Metafields
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def ensure_metafield_definition_exists!(key_with_namespace)
+        namespace, key = extract_namespace_and_key(key_with_namespace)
+        Spree::MetafieldDefinition.find_or_create_by!(namespace: namespace, key: key, resource_type: self.name)
+      end
+
+      def extract_namespace_and_key(key_with_namespace)
+        namespace = key_with_namespace.to_s.split('.').first
+        key = key_with_namespace.to_s.split('.').last
+        [namespace, key]
+      end
+    end
+
+    included do
+      has_many :metafields, -> { includes(:metafield_definition) }, as: :resource, class_name: 'Spree::Metafield', dependent: :destroy
+      has_many :public_metafields, -> { includes(:metafield_definition).available_on_front_end }, as: :resource, class_name: 'Spree::Metafield'
+      has_many :private_metafields, -> { includes(:metafield_definition).available_on_back_end }, as: :resource, class_name: 'Spree::Metafield'
+
+      accepts_nested_attributes_for :metafields, allow_destroy: true, reject_if: lambda { |mf|
+                                                                                     mf[:metafield_definition_id].blank? || (mf[:id].blank? && mf[:value].blank?)
+                                                                                   }
+
+      # Override metafields_attributes= to automatically mark existing metafields
+      # with empty values for destruction
+      def metafields_attributes=(attributes)
+        attributes = attributes.values if attributes.is_a?(Hash)
+
+        attributes.each do |attrs|
+          # If this is an existing metafield (has an id) and value is blank,
+          # mark it for destruction
+          if attrs[:id].present? && value_blank?(attrs[:value])
+            attrs[:_destroy] = true
+          end
+        end
+
+        super(attributes)
+      end
+
+      scope :with_metafield_key, ->(key_with_namespace) {
+        namespace, key = extract_namespace_and_key(key_with_namespace)
+        joins(metafields: :metafield_definition).where(spree_metafield_definitions: { namespace: namespace, key: key })
+      }
+      scope :with_metafield_key_value, ->(key_with_namespace, value) {
+        namespace, key = extract_namespace_and_key(key_with_namespace)
+
+        joins(metafields: :metafield_definition)
+          .where(spree_metafield_definitions: { namespace: namespace, key: key })
+          .where(spree_metafields: { value: value })
+      }
+
+      def extract_namespace_and_key(key_with_namespace)
+        self.class.extract_namespace_and_key(key_with_namespace)
+      end
+
+      def set_metafield(key_with_namespace, value)
+        namespace, key = extract_namespace_and_key(key_with_namespace)
+        metafield_definition = Spree::MetafieldDefinition.find_or_create_by!(namespace: namespace, key: key, resource_type: self.class.name)
+
+        metafield = metafields.find_or_initialize_by(metafield_definition: metafield_definition)
+        metafield.value = value
+        metafield.save!
+        metafield
+      end
+
+      def get_metafield(key_with_namespace)
+        namespace, key = extract_namespace_and_key(key_with_namespace)
+        metafields.with_key(namespace, key).first
+      end
+
+      def has_metafield?(key_with_namespace)
+        if key_with_namespace.is_a?(Spree::MetafieldDefinition)
+          namespace = key_with_namespace.namespace
+          key = key_with_namespace.key
+        elsif key_with_namespace.is_a?(String)
+          namespace, key = extract_namespace_and_key(key_with_namespace)
+        else
+          raise ArgumentError, "Invalid key_with_namespace: #{key_with_namespace.inspect}"
+        end
+
+        metafields.with_key(namespace, key).exists?
+      end
+
+      private
+
+      def value_blank?(value)
+        value.blank?
+      end
+    end
+  end
+end

data/app/models/concerns/spree/named_type.rb

@@ -4,7 +4,7 @@ module Spree
 
     included do
       scope :active, -> { where(active: true) }
-      default_scope { order(Arel.sql("LOWER(#{table_name}.name)")) }
+      default_scope { order(name: :asc) }
 
       include Spree::UniqueName
     end

data/app/models/concerns/spree/user_methods.rb

@@ -2,9 +2,11 @@ module Spree
   module UserMethods
     extend ActiveSupport::Concern
 
+    include Spree::Metafields
     include Spree::UserPaymentSource
     include Spree::UserReporting
     include Spree::UserRoles
+    include Spree::AdminUserMethods
     include Spree::RansackableAttributes
     include Spree::MultiSearchable
     included do
@@ -12,7 +14,6 @@ module Spree
       # https://github.com/rails/rails/issues/3458
       before_validation :clone_billing_address, if: :use_billing?
       before_destroy :check_completed_orders
-      after_destroy :nullify_approver_id_in_approved_orders
 
       attr_accessor :use_billing
 
@@ -83,6 +84,11 @@ module Spree
           where("#{Spree::Address.table_name}.firstname LIKE ? or #{Spree::Address.table_name}.lastname LIKE ? or #{table_name}.email LIKE ?",
                 "%#{address}%", "%#{address}%", "%#{email}%")
       end
+
+      # We override this method because we cannot use for_store on users because it will return admin users
+      def self.for_store(store)
+        self
+      end
     end
 
     # Returns the last incomplete spree order for the current store
@@ -138,16 +144,23 @@ module Spree
       end
     end
 
-    private
+    # Returns the CSV row representation of the user
+    # @param [Spree::Store] store
+    # @return [Array<String>]
+    def to_csv(_store = nil)
+      Spree::CSV::CustomerPresenter.new(self).call
+    end
 
-    def check_completed_orders
-      raise Spree::Core::DestroyWithOrdersError if orders.complete.present?
+    # Returns the full name of the user
+    # @return [String]
+    def full_name
+      name&.full
     end
 
-    def nullify_approver_id_in_approved_orders
-      return unless Spree.admin_user_class != Spree.user_class
+    private
 
-      Spree::Order.where(approver_id: id).update_all(approver_id: nil)
+    def check_completed_orders
+      raise Spree::Core::DestroyWithOrdersError if !has_spree_role?(Spree::Role::ADMIN_ROLE) && orders.complete.present?
     end
 
     def clone_billing_address

data/app/models/concerns/spree/user_payment_source.rb

@@ -3,7 +3,7 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
-      has_many :credit_cards, class_name: 'Spree::CreditCard', foreign_key: :user_id
+      has_many :credit_cards, class_name: 'Spree::CreditCard', foreign_key: :user_id, dependent: :destroy
       def default_credit_card
         credit_cards.default.first
       end

data/app/models/concerns/spree/user_roles.rb

@@ -3,10 +3,11 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
-      has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, as: :user, dependent: :destroy
+      has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, as: :user, dependent: :destroy_async # async as we need to check if the user has admin role before destroying
       has_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :role
       has_many :stores, through: :role_users, source: :resource, source_type: 'Spree::Store'
-      has_many :invitations, class_name: 'Spree::Invitation', foreign_key: :invitee_id, dependent: :destroy
+      has_many :invitations, class_name: 'Spree::Invitation', as: :invitee, dependent: :destroy
+      has_many :sent_invitations, class_name: 'Spree::Invitation', as: :inviter, dependent: :destroy
 
       scope :spree_admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: Spree::Role::ADMIN_ROLE }) }
 

data/app/models/spree/ability.rb

@@ -99,6 +99,10 @@ module Spree
         wished_item.wishlist.user == user
       end
       can :accept, Spree::Invitation, invitee_id: [user.id, nil], invitee_type: user.class.name, status: 'pending'
+      can :read, ::Spree::Policy
+      can :read, ::Spree::Page
+      can :read, ::Spree::Post
+      can :read, ::Spree::PostCategory
     end
 
     def protect_admin_role

data/app/models/spree/address.rb

@@ -2,6 +2,7 @@ module Spree
   class Address < Spree.base_class
     require 'validates_zipcode'
 
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
@@ -43,7 +44,8 @@ module Spree
 
     belongs_to :country, class_name: 'Spree::Country'
     belongs_to :state, class_name: 'Spree::State', optional: true
-    belongs_to :user, class_name: Spree.user_class.name, optional: true, touch: true
+    # we need a safe operator here as Address is added to metafield_enabled_resources in Engine
+    belongs_to :user, class_name: Spree.user_class&.name, optional: true, touch: true
 
     has_many :shipments, inverse_of: :address
 

data/app/models/spree/adjustable/adjuster/tax.rb

@@ -4,8 +4,8 @@ module Spree
       class Tax < Spree::Adjustable::Adjuster::Base
         def update
           tax = adjustments.tax
-          included_tax_total = tax.is_included.reload.map(&:update!).compact.sum
-          additional_tax_total = tax.additional.reload.map(&:update!).compact.sum
+          included_tax_total = tax.find_all(&:included?).map(&:update!).compact.sum || 0
+          additional_tax_total = tax.find_all(&:additional?).map(&:update!).compact.sum || 0
 
           update_totals(included_tax_total, additional_tax_total)
         end

data/app/models/spree/adjustable/adjustments_updater.rb

@@ -17,10 +17,16 @@ module Spree
           non_taxable_adjustment_total: 0,
           taxable_adjustment_total: 0
         }
-        adjusters.each do |klass|
+        non_tax_adjusters.each do |klass|
           klass.adjust(@adjustable, totals)
         end
 
+        if tax_adjuster.present?
+          # Other adjustments can change the taxable amount so we need to update it first
+          update_adjustable_attributes(totals)
+          tax_adjuster.adjust(@adjustable, totals)
+        end
+
         persist_totals totals
       end
 
@@ -30,9 +36,18 @@ module Spree
         attributes = totals
         attributes[:adjustment_total] = totals[:non_taxable_adjustment_total] +
           totals[:taxable_adjustment_total] +
-          totals[:additional_tax_total]
+          totals.fetch(:additional_tax_total, 0)
+
+        update_adjustable_attributes(attributes)
+      end
+
+      def update_adjustable_attributes(attributes)
+        # Only update if attributes have changed
+        current_attributes = @adjustable.attributes.slice(*attributes.keys.map(&:to_s))
+        return if attributes.all? { |key, value| current_attributes[key.to_s] == value }
+
         attributes[:updated_at] = Time.current
-        @adjustable.update_columns(totals)
+        @adjustable.update_columns(attributes)
       end
 
       def shipment?
@@ -43,6 +58,14 @@ module Spree
         Rails.application.config.spree.adjusters
       end
 
+      def tax_adjuster
+        @tax_adjuster ||= adjusters.find { |adjuster| adjuster.name == 'Spree::Adjustable::Adjuster::Tax' }
+      end
+
+      def non_tax_adjusters
+        adjusters - [tax_adjuster].compact
+      end
+
       def adjustable_still_exists?
         @adjustable&.class&.exists?(@adjustable.id)
       end

data/app/models/spree/adjustment.rb

@@ -92,6 +92,10 @@ module Spree
       source_type == 'Spree::TaxRate'
     end
 
+    def additional?
+      !included?
+    end
+
     # Passing a target here would always be recommended as it would avoid
     # hitting the database again and would ensure you're compute values over
     # the specific object amount passed here.
@@ -103,7 +107,6 @@ module Spree
       attributes[:eligible] = source.promotion.eligible?(target) if promotion?
 
       update_columns(attributes)
-      source.promotion.touch if promotion?
 
       amount
     end

data/app/models/spree/asset.rb

@@ -1,11 +1,14 @@
 module Spree
   class Asset < Spree.base_class
     include Support::ActiveStorage
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
+    EXTERNAL_URL_METAFIELD_KEY = 'external.url'
+
     belongs_to :viewable, polymorphic: true, touch: true
     acts_as_list scope: [:viewable_id, :viewable_type]
 
@@ -19,9 +22,22 @@ module Spree
     scope :with_session_uploaded_assets_uuid, lambda { |uuid|
       where(session_id: uuid)
     }
+    scope :with_external_url, ->(url) { url.present? ? with_metafield_key_value(EXTERNAL_URL_METAFIELD_KEY, url.downcase.strip) : none }
 
     def product
       @product ||= viewable_type == 'Spree::Variant' ? viewable&.product : nil
     end
+
+    def external_url
+      get_metafield(EXTERNAL_URL_METAFIELD_KEY)&.value
+    end
+
+    def external_url=(url)
+      set_metafield(EXTERNAL_URL_METAFIELD_KEY, url.downcase.strip)
+    end
+
+    def skip_import?
+      false
+    end
   end
 end

data/app/models/spree/base.rb

@@ -87,7 +87,7 @@ class Spree::Base < ApplicationRecord
 
   # Try building a slug based on the following fields in increasing order of specificity.
   def slug_candidates
-    if defined?(:deleted_at) && deleted_at.present?
+    if defined?(deleted_at) && deleted_at.present?
       [
         ['deleted', :name],
         ['deleted', :name, :uuid_for_friendly_id]

data/app/models/spree/credit_card.rb

@@ -1,6 +1,7 @@
 module Spree
   class CreditCard < Spree.base_class
     include ActiveMerchant::Billing::CreditCardMethods
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::PaymentSourceConcern
 

data/app/models/spree/current.rb

@@ -1,9 +1,13 @@
 module Spree
   class Current < ::ActiveSupport::CurrentAttributes
-    attribute :store
+    attribute :store, :webhooks_subscribers
 
     def store
       super || Spree::Store.default
     end
+
+    def webhooks_subscribers
+      super || store&.active_webhooks_subscribers || Spree::Webhooks::Subscriber.none
+    end
   end
 end

data/app/models/spree/custom_domain.rb

@@ -1,6 +1,7 @@
 module Spree
   class CustomDomain < Spree::Base
     include Spree::SingleStoreResource
+    include Spree::Metafields
     include Spree::Metadata
 
     auto_strip_attributes :url
@@ -44,6 +45,10 @@ module Spree
       true
     end
 
+    def name
+      url
+    end
+
     private
 
     # remove https:// and http:// from the url

data/app/models/spree/customer_return.rb

@@ -2,6 +2,7 @@ module Spree
   class CustomerReturn < Spree.base_class
     include Spree::Core::NumberGenerator.new(prefix: 'CR', length: 9)
     include Spree::NumberIdentifier
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/export.rb

@@ -42,6 +42,7 @@ module Spree
     # Callbacks
     #
     before_validation :set_default_format, on: :create
+    before_validation :normalize_search_params, on: :create, if: -> { search_params.present? }
     before_create :clear_search_params, if: -> { record_selection == 'all' }
     after_commit :generate_async, on: :create
 
@@ -89,6 +90,13 @@ module Spree
       raise NotImplementedError, 'csv_headers must be implemented'
     end
 
+    # Returns an array of metafield headers for the model
+    #
+    # @return [Array<String>]
+    def metafields_headers
+      @metafields_headers ||= Spree::MetafieldDefinition.for_resource_type(model_class.to_s).order(:namespace, :key).map(&:csv_header_name)
+    end
+
     def build_csv_line(_record)
       raise NotImplementedError, 'build_csv_line must be implemented'
     end
@@ -120,7 +128,32 @@ module Spree
 
     # eg. Spree::Exports::Products => Spree::Product
     def model_class
-      "Spree::#{type.demodulize.singularize}".constantize
+      if type == 'Spree::Exports::Customers'
+        Spree.user_class
+      else
+        "Spree::#{type.demodulize.singularize}".constantize
+      end
+    end
+
+    # Ensures search params maintain consistent format between UI and exports
+    # - Preserves valid JSON unchanged
+    # - Converts Ruby hashes to JSON strings
+    # - Handles malformed input gracefully
+    def normalize_search_params
+      return if search_params.blank?
+
+      if search_params.is_a?(Hash)
+        self.search_params = search_params.to_json
+        return
+      end
+
+      begin
+        # It's a string, so we parse and re-dump to ensure consistency
+        parsed = JSON.parse(search_params.to_s)
+        self.search_params = parsed.to_json
+      rescue JSON::ParserError
+        # Leave as-is if not valid JSON string
+      end
     end
 
     def current_ability
@@ -155,7 +188,11 @@ module Spree
 
       # eg. Spree::Exports::Products => Spree::Product
       def model_class
-        "Spree::#{to_s.demodulize.singularize}".constantize
+        klass = "Spree::#{to_s.demodulize.singularize}".safe_constantize
+
+        raise NameError, "Missing model class for #{to_s}" unless klass
+
+        klass
       end
     end
 

data/app/models/spree/exports/customers.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Exports
+    class Customers < Spree::Export
+      def scope_includes
+        [
+          { bill_address: :state },
+          { ship_address: :state },
+          { metafields: :metafield_definition }
+        ]
+      end
+
+      def csv_headers
+        Spree::CSV::CustomerPresenter::HEADERS + metafields_headers
+      end
+    end
+  end
+end

data/app/models/spree/exports/gift_cards.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Exports
+    class GiftCards < Spree::Export
+      def scope_includes
+        [:user, { metafields: :metafield_definition }]
+      end
+
+      def csv_headers
+        Spree::CSV::GiftCardPresenter::HEADERS + metafields_headers
+      end
+    end
+  end
+end

data/app/models/spree/exports/newsletter_subscribers.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Exports
+    class NewsletterSubscribers < Spree::Export
+      def scope_includes
+        [:user, { metafields: :metafield_definition }]
+      end
+
+      def csv_headers
+        Spree::CSV::NewsletterSubscriberPresenter::HEADERS + metafields_headers
+      end
+    end
+  end
+end

data/app/models/spree/exports/orders.rb

@@ -3,11 +3,13 @@ module Spree
     class Orders < Spree::Export
       def scope_includes
         [
+          :store,
           :payments,
           :shipments,
-          { bill_address: :state },
-          { ship_address: :state },
-          { line_items: { variant: { product: [:taxons] } } }
+          { bill_address: [:state, :country] },
+          { ship_address: [:state, :country] },
+          { line_items: { variant: { product: [:taxons] } } },
+          { metafields: :metafield_definition }
         ]
       end
 
@@ -16,7 +18,7 @@ module Spree
       end
 
       def csv_headers
-        Spree::CSV::OrderLineItemPresenter::HEADERS
+        Spree::CSV::OrderLineItemPresenter::HEADERS + metafields_headers
       end
     end
   end

data/app/models/spree/exports/products.rb

@@ -3,11 +3,14 @@ module Spree
     class Products < Spree::Export
       # to avoid N+1 queries
       def scope_includes
-        [:tax_category, :master, { taxons: :taxonomy }, { product_properties: [:property] }, { variants_including_master: variant_includes }]
+        includes = [:tax_category, :master, :option_types, { taxons: :taxonomy }, { variants_including_master: variant_includes }]
+        includes << { product_properties: [:property] } if Spree::Config[:product_properties_enabled]
+        includes << { metafields: :metafield_definition }
+        includes
       end
 
       def variant_includes
-        [:images, :prices, :stock_items, { option_values: [:option_type] }]
+        [:images, :prices, :stock_items, :stock_locations, { option_values: [:option_type] }]
       end
 
       def multi_line_csv?
@@ -24,7 +27,10 @@ module Spree
       end
 
       def csv_headers
-        @csv_headers ||= Spree::CSV::ProductVariantPresenter::CSV_HEADERS + properties_headers
+        headers = Spree::CSV::ProductVariantPresenter::CSV_HEADERS.dup
+        headers += properties_headers if Spree::Config[:product_properties_enabled]
+        headers += metafields_headers
+        @csv_headers ||= headers
       end
 
       def properties_headers

data/app/models/spree/gift_card.rb

@@ -2,6 +2,7 @@ module Spree
   class GiftCard < Spree.base_class
     extend DisplayMoney
     include Spree::SingleStoreResource
+    include Spree::Metafields
     include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
 
     #
@@ -55,8 +56,9 @@ module Spree
     #
     # Ransack
     #
-    self.whitelisted_ransackable_attributes = %w[code user_id]
+    self.whitelisted_ransackable_attributes = %w[code user_id state]
     self.whitelisted_ransackable_associations = %w[users orders batch]
+    self.whitelisted_ransackable_scopes = %w[active expired redeemed partially_redeemed]
 
     auto_strip_attributes :code
 
@@ -131,6 +133,10 @@ module Spree
       end.to_s
     end
 
+    def to_csv(_store = nil)
+      Spree::CSV::GiftCardPresenter.new(self).call
+    end
+
     private
 
     def generate_code

data/app/models/spree/gift_card_batch.rb

@@ -10,7 +10,6 @@ module Spree
     belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
     has_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch, dependent: :destroy
 
-
     #
     # Validations
     #