spree_core 5.1.8 → 5.2.0.rc1

data/app/models/spree/shipment.rb

@@ -5,6 +5,7 @@ module Spree
     include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
     include Spree::NumberIdentifier
     include Spree::NumberAsParam
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Security::Shipments)
       include Spree::Security::Shipments

data/app/models/spree/shipping_method.rb

@@ -2,6 +2,7 @@ module Spree
   class ShippingMethod < Spree.base_class
     acts_as_paranoid
     include Spree::CalculatedAdjustments
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::DisplayOn
     if defined?(Spree::Webhooks::HasWebhooks)

data/app/models/spree/stock_item.rb

@@ -2,6 +2,7 @@ module Spree
   class StockItem < Spree.base_class
     acts_as_paranoid
 
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::StockItem::Webhooks
 

data/app/models/spree/stock_transfer.rb

@@ -3,6 +3,7 @@ module Spree
     include Spree::Core::NumberGenerator.new(prefix: 'T')
     include Spree::NumberIdentifier
     include Spree::NumberAsParam
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/store.rb

@@ -8,12 +8,14 @@ module Spree
 
     include FriendlyId
     include Spree::TranslatableResource
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::Stores::Setup
     include Spree::Stores::Socials
     include Spree::Webhooks::HasWebhooks if defined?(Spree::Webhooks::HasWebhooks)
     include Spree::Security::Stores if defined?(Spree::Security::Stores)
     include Spree::UserManagement
+    include Spree::HasPageLinks
 
     #
     # Magic methods
@@ -111,6 +113,8 @@ module Spree
 
     has_many :gift_cards, class_name: 'Spree::GiftCard', dependent: :destroy
 
+    has_many :policies, class_name: 'Spree::Policy', dependent: :destroy, as: :owner
+
     #
     # Page Builder associations
     #
@@ -123,6 +127,7 @@ module Spree
              inverse_of: :store,
              dependent: :destroy
     has_one :default_theme, -> { without_previews.where(default: true) }, class_name: 'Spree::Theme', inverse_of: :store
+    alias theme default_theme
     has_many :theme_pages, class_name: 'Spree::Page', through: :themes, source: :pages
     has_many :theme_page_previews, class_name: 'Spree::Page', through: :theme_pages, source: :previews
     has_many :pages, -> { without_previews.custom }, class_name: 'Spree::Pages::Custom', dependent: :destroy, as: :pageable
@@ -185,6 +190,7 @@ module Spree
     after_create :import_products_from_store, if: -> { import_products_from_store_id.present? }
     after_create :import_payment_methods_from_store, if: -> { import_payment_methods_from_store_id.present? }
     after_create :create_default_theme
+    after_create :create_default_policies
     before_destroy :validate_not_last, unless: :skip_validate_not_last
     before_destroy :pass_default_flag_to_other_store
     after_commit :clear_cache
@@ -203,7 +209,11 @@ module Spree
     delegate :iso, to: :default_country, prefix: true, allow_nil: true
 
     def self.current(url = nil)
-      Spree::Dependencies.current_store_finder.constantize.new(url: url).execute || Spree::Current.store
+      if url.present?
+        Spree::Dependencies.current_store_finder.constantize.new(url: url).execute
+      else
+        Spree::Current.store
+      end
     end
 
     # FIXME: we need to drop `or_initialize` in v5
@@ -320,15 +330,20 @@ module Spree
       formatted_custom_domain || formatted_url
     end
 
+    # Returns the countries available for checkout for the store or creates a new one if it doesn't exist
+    # @return [Array<Spree::Country>]
     def countries_available_for_checkout
       @countries_available_for_checkout ||= Rails.cache.fetch(countries_available_for_checkout_cache_key) do
-        checkout_zone.try(:country_list) || Spree::Country.all
+        (checkout_zone.try(:country_list) || Spree::Country.all).to_a
       end
     end
 
+    # Returns the states available for checkout for the store or creates a new one if it doesn't exist
+    # @param country [Spree::Country] the country to get the states for
+    # @return [Array<Spree::State>]
     def states_available_for_checkout(country)
       Rails.cache.fetch(states_available_for_checkout_cache_key(country)) do
-        checkout_zone.try(:state_list_for, country) || country.states
+        (checkout_zone.try(:state_list_for, country) || country.states).to_a
       end
     end
 
@@ -403,6 +418,21 @@ module Spree
       StorePaymentMethod.insert_all(payment_method_ids.map { |payment_method_id| { store_id: id, payment_method_id: payment_method_id } })
     end
 
+    %w[customer_terms_of_service customer_privacy_policy customer_returns_policy customer_shipping_policy].each do |policy_method|
+      define_method policy_method do
+        Spree::Deprecation.warn("Store##{policy_method} is deprecated and will be removed in Spree 6.0. Please use Store#policies instead.")
+
+        ActionText::RichText.find_by(name: policy_method, record: self)
+      end
+    end
+
+    # Returns all active webhooks subscribers for the store
+    #
+    # @return [Array<Spree::Webhooks::Subscriber>]
+    def active_webhooks_subscribers
+      @active_webhooks_subscribers ||= Spree::Webhooks::Subscriber.active
+    end
+
     private
 
     def countries_available_for_checkout_cache_key
@@ -496,6 +526,18 @@ module Spree
       post_categories.find_or_create_by(title: Spree.t('default_post_categories.news'))
     end
 
+    def create_default_policies
+      policies.find_or_create_by(name: Spree.t('terms_of_service'))
+      policies.find_or_create_by(name: Spree.t('privacy_policy'))
+      policies.find_or_create_by(name: Spree.t('returns_policy'))
+      policies.find_or_create_by(name: Spree.t('shipping_policy'))
+
+      # Create checkout links to the policies
+      policies.each do |policy|
+        links.find_or_create_by(linkable: policy)
+      end
+    end
+
     # code is slug, so we don't want to generate new slug when code changes
     # we use friendlyId only for history feature
     def should_generate_new_friendly_id?

data/app/models/spree/store_credit.rb

@@ -1,6 +1,7 @@
 module Spree
   class StoreCredit < Spree.base_class
     include Spree::SingleStoreResource
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
@@ -19,7 +20,7 @@ module Spree
     belongs_to :store, class_name: 'Spree::Store'
     belongs_to :user, class_name: "::#{Spree.user_class}", foreign_key: 'user_id'
     belongs_to :category, class_name: 'Spree::StoreCreditCategory', optional: true
-    belongs_to :created_by, class_name: "::#{Spree.admin_user_class}", foreign_key: 'created_by_id', optional: true
+    belongs_to :created_by, class_name: Spree.admin_user_class.to_s, foreign_key: 'created_by_id', optional: true
     belongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id', optional: true
     belongs_to :originator, polymorphic: true, optional: true
 

data/app/models/spree/tax_category.rb

@@ -5,7 +5,7 @@ module Spree
     end
 
     acts_as_paranoid
-    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope.push(:deleted_at) }
+    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope + [:deleted_at] }
 
     has_many :tax_rates, dependent: :destroy, inverse_of: :tax_category
     has_many :products, dependent: :nullify

data/app/models/spree/tax_rate.rb

@@ -4,6 +4,7 @@ module Spree
 
     include Spree::CalculatedAdjustments
     include Spree::AdjustmentSource
+    include Spree::Metafields
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
@@ -71,15 +72,21 @@ module Spree
     # Deletes all tax adjustments, then applies all applicable rates
     # to relevant items.
     def self.adjust(order, items)
+      return if items.none?
+
       rates = match(order.tax_zone)
       tax_category_ids = rates.map(&:tax_category_id)
 
       # using destroy_all to ensure adjustment destroy callback fires.
       Spree::Adjustment.where(adjustable: items).tax.destroy_all
 
-      relevant_items = items.select do |item|
-        tax_category_ids.include?(item.tax_category_id)
-      end
+      relevant_items = if tax_category_ids.any?
+                          items.select do |item|
+                            tax_category_ids.include?(item.tax_category_id)
+                          end
+                        else
+                          []
+                        end
 
       relevant_items.each do |item|
         relevant_rates = rates.select do |rate|
@@ -115,6 +122,14 @@ module Spree
       compute(item)
     end
 
+    def included?
+      included_in_price
+    end
+
+    def additional?
+      !included_in_price
+    end
+
     private
 
     def label

data/app/models/spree/taxon.rb

@@ -16,8 +16,10 @@ module Spree
 
     include Spree::TranslatableResource
     include Spree::TranslatableResourceSlug
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::MemoizedData
+    include Spree::Linkable
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -46,8 +48,6 @@ module Spree
     has_many :promotion_rule_taxons, class_name: 'Spree::PromotionRuleTaxon', dependent: :destroy
     has_many :promotion_rules, through: :promotion_rule_taxons, class_name: 'Spree::PromotionRule'
 
-    has_many :page_links, as: :linkable, class_name: 'Spree::PageLink', dependent: :destroy
-
     #
     # Attachments
     #
@@ -118,6 +118,16 @@ module Spree
       end
     end
 
+    scope :with_matching_name, ->(name_to_match) do
+      value = name_to_match.to_s.strip.downcase
+
+      if Spree.use_translations?
+        i18n { name.lower.eq(value) }
+      else
+        where(arel_table[:name].lower.eq(value))
+      end
+    end
+
     #
     #  Ransack
     #

data/app/models/spree/taxonomy.rb

@@ -1,6 +1,7 @@
 module Spree
   class Taxonomy < Spree.base_class
     include Spree::TranslatableResource
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::SingleStoreResource
     if defined?(Spree::Webhooks::HasWebhooks)
@@ -24,6 +25,16 @@ module Spree
 
     default_scope { order("#{table_name}.position, #{table_name}.created_at") }
 
+    scope :with_matching_name, ->(name_to_match) do
+      value = name_to_match.to_s.strip.downcase
+
+      if Spree.use_translations?
+        i18n { name.lower.eq(value) }
+      else
+        where(arel_table[:name].lower.eq(value))
+      end
+    end
+
     self.whitelisted_ransackable_attributes = %w[name]
     self.whitelisted_ransackable_associations = %w[root]
 

data/app/models/spree/theme.rb

@@ -21,7 +21,7 @@ module Spree
     has_many :previews, class_name: 'Spree::Theme', foreign_key: :parent_id, dependent: :destroy_async
     has_many :pages, -> { without_previews }, class_name: 'Spree::Page', dependent: :destroy, as: :pageable
     has_many :page_previews, -> { only_previews }, class_name: 'Spree::Page', dependent: :destroy_async, as: :pageable
-    has_many :layout_sections, class_name: 'Spree::PageSection', dependent: :destroy, as: :pageable
+    has_many :layout_sections, -> { order(position: :asc) }, class_name: 'Spree::PageSection', dependent: :destroy, as: :pageable
     alias sections layout_sections
 
     #

data/app/models/spree/variant.rb

@@ -4,6 +4,7 @@ module Spree
     acts_as_list scope: :product
 
     include Spree::MemoizedData
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::Variant::Webhooks
 
@@ -393,6 +394,22 @@ module Spree
       price_in(currency).try(:compare_at_amount)
     end
 
+    def set_price(currency, amount, compare_at_amount = nil)
+      price = prices.find_or_initialize_by(currency: currency)
+      price.amount = amount
+      price.compare_at_amount = compare_at_amount if compare_at_amount.present?
+      price.save!
+    end
+
+    def set_stock(count_on_hand, backorderable = nil, stock_location = nil)
+      stock_location ||= Spree::Store.current.default_stock_location
+      stock_items.find_or_initialize_by(stock_location: stock_location) do |stock_item|
+        stock_item.count_on_hand = count_on_hand
+        stock_item.backorderable = backorderable if backorderable.present?
+        stock_item.save!
+      end
+    end
+
     def price_modifier_amount_in(currency, options = {})
       return 0 unless options.present?
 

data/app/presenters/spree/csv/customer_presenter.rb

@@ -0,0 +1,59 @@
+module Spree
+  module CSV
+    class CustomerPresenter
+      include Spree::CSV::MetafieldsHelper
+
+      HEADERS = [
+        'First Name',
+        'Last Name',
+        'Email',
+        'Accepts Email Marketing',
+        'Company',
+        'Address 1',
+        'Address 2',
+        'City',
+        'Province',
+        'Province Code',
+        'Country',
+        'Country Code',
+        'Zip',
+        'Phone',
+        'Total Spent',
+        'Total Orders',
+        'Tags'
+      ].freeze
+
+      def initialize(customer)
+        @customer = customer
+      end
+
+      attr_accessor :customer
+
+      def call
+        csv = [
+          customer.first_name,
+          customer.last_name,
+          customer.email,
+          customer.accepts_email_marketing ? Spree.t(:say_yes) : Spree.t(:say_no),
+          customer.address&.company,
+          customer.address&.address1,
+          customer.address&.address2,
+          customer.address&.city,
+          customer.address&.state_text,
+          customer.address&.state_abbr,
+          customer.address&.country&.name,
+          customer.address&.country&.iso,
+          customer.address&.zipcode,
+          customer.phone,
+          customer.amount_spent_in(Spree::Store.current.default_currency),
+          customer.completed_orders.count,
+          customer.tag_list
+        ]
+
+        csv += metafields_for_csv(customer)
+
+        csv
+      end
+    end
+  end
+end

data/app/presenters/spree/csv/gift_card_presenter.rb

@@ -0,0 +1,49 @@
+module Spree
+  module CSV
+    class GiftCardPresenter
+      include Spree::CSV::MetafieldsHelper
+
+      HEADERS = [
+        'Code',
+        'Amount',
+        'Amount Used',
+        'Amount Remaining',
+        'Currency',
+        'Status',
+        'Expires At',
+        'Customer Email',
+        'Customer First Name',
+        'Customer Last Name',
+        'Created At',
+        'Updated At'
+      ].freeze
+
+      def initialize(gift_card)
+        @gift_card = gift_card
+      end
+
+      attr_accessor :gift_card
+
+      def call
+        csv = [
+          gift_card.display_code,
+          gift_card.display_amount,
+          gift_card.display_amount_used,
+          gift_card.display_amount_remaining,
+          gift_card.currency,
+          gift_card.display_state,
+          gift_card.expires_at&.strftime('%Y-%m-%d'),
+          gift_card.user&.email,
+          gift_card.user&.first_name,
+          gift_card.user&.last_name,
+          gift_card.created_at&.strftime('%Y-%m-%d %H:%M:%S'),
+          gift_card.updated_at&.strftime('%Y-%m-%d %H:%M:%S')
+        ]
+
+        csv += metafields_for_csv(gift_card)
+
+        csv
+      end
+    end
+  end
+end

data/app/presenters/spree/csv/metafields_helper.rb

@@ -0,0 +1,17 @@
+module Spree
+  module CSV
+    module MetafieldsHelper
+      private
+
+      def metafield_definitions_for_csv(resource)
+        Spree::MetafieldDefinition.for_resource_type(resource.class.to_s).order(:namespace, :key)
+      end
+
+      def metafields_for_csv(resource)
+        Spree::MetafieldDefinition.for_resource_type(resource.class.to_s).order(:namespace, :key).map do |mf_def|
+          resource.metafields.find { |mf| mf.metafield_definition_id == mf_def.id }&.csv_value
+        end
+      end
+    end
+  end
+end

data/app/presenters/spree/csv/newsletter_subscriber_presenter.rb

@@ -0,0 +1,39 @@
+module Spree
+  module CSV
+    class NewsletterSubscriberPresenter
+      include Spree::CSV::MetafieldsHelper
+
+      HEADERS = [
+        'Email',
+        'Customer Name',
+        'Customer ID',
+        'Verified',
+        'Verified At',
+        'Created At',
+        'Updated At'
+      ].freeze
+
+      def initialize(newsletter_subscriber)
+        @newsletter_subscriber = newsletter_subscriber
+      end
+
+      attr_accessor :newsletter_subscriber
+
+      def call
+        csv = [
+          newsletter_subscriber.email,
+          newsletter_subscriber.user&.full_name,
+          newsletter_subscriber.user_id,
+          newsletter_subscriber.verified? ? Spree.t(:say_yes) : Spree.t(:say_no),
+          newsletter_subscriber.verified_at,
+          newsletter_subscriber.created_at,
+          newsletter_subscriber.updated_at
+        ]
+
+        csv += metafields_for_csv(newsletter_subscriber)
+
+        csv
+      end
+    end
+  end
+end

data/app/presenters/spree/csv/order_line_item_presenter.rb

@@ -59,16 +59,17 @@ module Spree
         'Notes'
       ].freeze
 
-      def initialize(order, line_item, index)
+      def initialize(order, line_item, index, metafields = [])
         @order = order
         @line_item = line_item
         @index = index
+        @metafields = metafields
       end
 
-      attr_accessor :order, :line_item, :index
+      attr_accessor :order, :line_item, :index, :metafields
 
       def call
-        [
+        csv = [
           order.number,
           index.zero? ? order.email : nil,
           index.zero? ? order.state : nil,
@@ -85,7 +86,7 @@ module Spree
           index.zero? ? order.total.to_f : nil,
           index.zero? ? order.shipping_method&.name : nil,
           index.zero? ? order.total_weight.to_f : nil,
-          index.zero? && order.payments.valid.any? ? order.payments.valid.first.display_source_name : nil,
+          index.zero? ? order.payments.valid&.first&.display_source_name : nil,
           line_item.product_id,
           line_item.quantity,
           line_item.sku,
@@ -94,7 +95,7 @@ module Spree
           line_item.promo_total.abs,
           line_item.total,
           !line_item.product.digital?,
-          line_item.product.tax_category.present?,
+          line_item.product.tax_category_id.present?,
           line_item.product.try(:vendor_name),
           taxon_dict(line_item.product.main_taxon)[0],
           taxon_dict(line_item.product.main_taxon)[1],
@@ -125,6 +126,12 @@ module Spree
           index.zero? ? order.canceler&.email : nil,
           index.zero? ? order.special_instructions : nil
         ]
+
+        if index.zero?
+          csv += metafields
+        end
+
+        csv
       end
 
       private

data/app/presenters/spree/csv/product_variant_presenter.rb

@@ -47,7 +47,7 @@ module Spree
         'category3',
       ].freeze
 
-      def initialize(product, variant, index = 0, properties = [], taxons = [], store = nil)
+      def initialize(product, variant, index = 0, properties = [], taxons = [], store = nil, metafields = [])
         @product = product
         @variant = variant
         @index = index
@@ -55,9 +55,10 @@ module Spree
         @taxons = taxons
         @store = store || product.stores.first
         @currency = @store.default_currency
+        @metafields = metafields
       end
 
-      attr_accessor :product, :variant, :index, :properties, :taxons, :store, :currency
+      attr_accessor :product, :variant, :index, :properties, :taxons, :store, :currency, :metafields
 
       ##
       # Generates an array representing a CSV row of product variant data.
@@ -71,11 +72,13 @@ module Spree
       #
       # @return [Array] An array containing the combined product and variant CSV data.
       def call
+        total_on_hand = variant.total_on_hand
+
         csv = [
           product.id,
           variant.sku,
           index.zero? ? product.name : nil,
-          index.zero? ? product.slug : nil,
+          product.slug,
           index.zero? ? product.status : nil,
           index.zero? ? product.try(:vendor_name) : nil,
           index.zero? ? product.try(:brand_name) : nil,
@@ -86,7 +89,7 @@ module Spree
           index.zero? ? product.tag_list.to_s : nil,
           index.zero? ? product.label_list.to_s : nil,
           variant.amount_in(currency).to_f,
-          variant.compare_at_price&.to_f,
+          variant.compare_at_amount_in(currency).to_f,
           currency,
           variant.width,
           variant.height,
@@ -97,7 +100,7 @@ module Spree
           variant.available_on&.strftime('%Y-%m-%d %H:%M:%S'),
           (variant.discontinue_on || product.discontinue_on)&.strftime('%Y-%m-%d %H:%M:%S'),
           variant.track_inventory?,
-          variant.total_on_hand == BigDecimal::INFINITY ? '∞' : variant.total_on_hand,
+          total_on_hand == BigDecimal::INFINITY ? '∞' : total_on_hand,
           variant.backorderable?,
           variant.tax_category&.name,
           variant.digital?,
@@ -115,6 +118,7 @@ module Spree
         if index.zero?
           csv += taxons
           csv += properties
+          csv += metafields
         end
 
         csv

data/app/services/spree/cart/recalculate.rb

@@ -4,11 +4,13 @@ module Spree
       prepend Spree::ServiceModule::Base
 
       def call(order:, line_item:, line_item_created: false, options: {})
-        order.remove_gift_card if order.gift_card.present?
-        order_updater = ::Spree::OrderUpdater.new(order)
+        order_updater = order.updater
 
-        order.payments.store_credits.checkout.destroy_all
-        order_updater.update
+        order.remove_gift_card if order.gift_card.present?
+        order.payments.store_credits.checkout.destroy_all if order.payments.store_credits.checkout.any?
+        order_updater.update_item_count
+        order_updater.update_totals
+        order_updater.persist_totals
 
         shipment = options[:shipment]
         if shipment.present?

data/app/services/spree/cart/remove_line_item.rb

@@ -6,12 +6,11 @@ module Spree
       def call(order:, line_item:, options: nil)
         options ||= {}
         ActiveRecord::Base.transaction do
-          line_item.destroy!
+          order.line_items.destroy(line_item)
           Spree::Dependencies.cart_recalculate_service.constantize.new.call(order: order,
                                                                             line_item: line_item,
                                                                             options: options)
         end
-        order.reload
         success(line_item)
       end
     end

data/app/services/spree/imports/row_processors/base.rb

@@ -0,0 +1,19 @@
+module Spree
+  module Imports
+    module RowProcessors
+      class Base
+        def initialize(row)
+          @row = row
+          @import = row.import
+          @attributes = row.to_schema_hash
+        end
+
+        attr_reader :row, :import, :attributes
+
+        def process!
+          raise NotImplementedError, 'Subclasses must implement the process! method'
+        end
+      end
+    end
+  end
+end