spree_core 6.0.0.beta4 → 6.0.0.rc2

data/app/models/spree/return_line_item.rb

@@ -3,7 +3,11 @@ module Spree
   #
   # Named for {Spree::LineItem}, which it mirrors: `quantity` is what the
   # customer said was coming, `received_quantity` what the warehouse counted.
+  # Like a line item it carries its worth before tax in `pre_tax_amount` and
+  # the tax on it beside that, both for the announced quantity.
   class ReturnLineItem < Spree.base_class
+    include Spree::PostSale::TaxedLine
+
     has_prefix_id :rli
 
     belongs_to :return, class_name: 'Spree::Return', inverse_of: :return_line_items
@@ -19,31 +23,80 @@ module Spree
 
     delegate :order, :currency, to: :return
 
-    # What this line refunds. Once the warehouse has counted, only the units
-    # that arrived are paid for — a customer who announced three and sent two
-    # is owed two — and before the count there is nothing to go on but the
-    # announced quantity.
+    extend Spree::DisplayMoney
+    money_methods :pre_tax_amount, :included_tax_total, :additional_tax_total, :tax_total,
+                  :refund_amount, :refund_tax_amount
+
+    # What this line refunds, tax included. Once the warehouse has counted,
+    # only the units that arrived are paid for — a customer who announced
+    # three and sent two is owed two — and before the count there is nothing
+    # to go on but the announced quantity.
     #
     # Rounded to the currency, because this is the ceiling a refund is checked
     # against as well as the figure the dialog offers: a third of $29.99 taken
     # three times is not $29.99 until it is.
     #
+    # A line opened before returns carried tax holds the price it was opened
+    # with in `pre_tax_amount` and no tax, so it refunds exactly what it did.
+    #
     # @return [BigDecimal]
     def refund_amount
-      return pre_tax_amount unless self.return.counted?
-      return 0.to_d if quantity.to_i.zero?
+      counted_share(total)
+    end
 
-      Spree::Money::Rounding.to_currency(
-        (pre_tax_amount / quantity) * received_quantity.to_i, currency
-      )
+    # @return [BigDecimal] the tax inside {#refund_amount}
+    def refund_tax_amount
+      counted_share(tax_total)
+    end
+
+    # @return [BigDecimal] the announced units, tax included
+    def total
+      pre_tax_amount + tax_total
+    end
+
+    def tax_total
+      included_tax_total + additional_tax_total
+    end
+
+    # The units this line gives back: none once the return is canceled, what
+    # arrived once the warehouse has counted, what was announced before.
+    #
+    # @return [Integer]
+    def credited_quantity
+      return 0 if self.return.canceled?
+
+      self.return.counted? ? received_quantity.to_i : quantity.to_i
+    end
+
+    # @return [BigDecimal] what the credited units are worth, tax included
+    def credited_worth
+      refund_amount
     end
 
-    def display_pre_tax_amount
-      Spree::Money.new(pre_tax_amount, currency: currency)
+    # Copies the credit rows written at opening onto the line. The before-tax
+    # figure is what was paid after discounts less the tax inside it, so the
+    # three columns add up to the cent.
+    #
+    # @return [void]
+    def fold_tax_lines!
+      included, additional = tax_totals_from(tax_lines.credits.reload)
+
+      update_columns(
+        pre_tax_amount: default_pre_tax_amount - included,
+        included_tax_total: included,
+        additional_tax_total: additional
+      )
     end
 
     private
 
+    def counted_share(value)
+      return value unless self.return.counted?
+      return 0.to_d if quantity.to_i.zero?
+
+      Spree::Money::Rounding.to_currency((value / quantity) * received_quantity.to_i, currency)
+    end
+
     # The refundable amount defaults to this item's share of what the
     # customer actually paid for the line, after discounts — refunding the
     # list price would give back more than was taken.
@@ -53,9 +106,7 @@ module Spree
     end
 
     def default_pre_tax_amount
-      return 0 if line_item.nil? || line_item.quantity.to_i.zero?
-
-      (line_item.amount / line_item.quantity) * quantity.to_i
+      line_item&.discounted_amount_for(quantity) || 0
     end
   end
 end

data/app/models/spree/role.rb

@@ -150,7 +150,7 @@ module Spree
 
     def permissions_must_be_known
       unknown = permissions - Spree.permissions.catalog_keys
-      errors.add(:permissions, :role_permissions_unknown, message: Spree.t(:role_permissions_unknown, keys: unknown.join(', '))) if unknown.any?
+      errors.add(:permissions, :role_permissions_unknown, message: I18n.t('spree.role_permissions_unknown', keys: unknown.join(', '))) if unknown.any?
     end
 
     # Every role is bounded by the catalog: only resources registered as
@@ -164,26 +164,26 @@ module Spree
       return if ungrantable.none?
 
       errors.add(
-        :permissions, :role_permissions_not_grantable_for_audience, message: Spree.t(:role_permissions_not_grantable_for_audience, audience: audience, keys: ungrantable.join(', '))
+        :permissions, :role_permissions_not_grantable_for_audience, message: I18n.t('spree.role_permissions_not_grantable_for_audience', audience: audience, keys: ungrantable.join(', '))
       )
     end
 
     # Re-pointing the resource would move every existing assignment to another
     # panel — and, for a store, to another tenant.
     def resource_immutable
-      errors.add(:resource, :role_resource_immutable, message: Spree.t(:role_resource_immutable))
+      errors.add(:resource, :role_resource_immutable, message: I18n.t('spree.role_resource_immutable'))
     end
 
     def name_immutable
-      errors.add(:name, :role_immutable, message: Spree.t(:role_immutable)) unless mutable_was_and_not_admin?
+      errors.add(:name, :role_immutable, message: I18n.t('spree.role_immutable')) unless mutable_was_and_not_admin?
     end
 
     def permissions_immutable
-      errors.add(:permissions, :role_immutable, message: Spree.t(:role_immutable)) unless mutable_was_and_not_admin?
+      errors.add(:permissions, :role_immutable, message: I18n.t('spree.role_immutable')) unless mutable_was_and_not_admin?
     end
 
     def description_immutable
-      errors.add(:description, :role_immutable, message: Spree.t(:role_immutable)) unless mutable_was_and_not_admin?
+      errors.add(:description, :role_immutable, message: I18n.t('spree.role_immutable')) unless mutable_was_and_not_admin?
     end
 
     # Guards compare against the persisted `mutable` so flipping it in the same
@@ -197,7 +197,7 @@ module Spree
     def ensure_can_be_deleted
       return true if can_be_deleted?
 
-      errors.add(:base, :role_cannot_be_deleted, message: Spree.t(:role_cannot_be_deleted))
+      errors.add(:base, :role_cannot_be_deleted, message: I18n.t('spree.role_cannot_be_deleted'))
       throw :abort
     end
   end

data/app/models/spree/saved_report.rb

@@ -23,9 +23,10 @@ module Spree
     scope :seeded, -> { where(seeded: true) }
 
     self.whitelisted_ransackable_attributes = %w[name seeded created_at updated_at]
+    search_by :name
 
     def event_serializer_class
-      'Spree::Api::V3::Admin::SavedReportSerializer'.safe_constantize
+      'Spree::Api::V3::SavedReportEventSerializer'.safe_constantize
     end
 
     # The stored query, normalized against the registry.

data/app/models/spree/search_provider/base.rb

@@ -1,6 +1,10 @@
 module Spree
   module SearchProvider
     class Base
+      # Sort keys a provider accepts beyond the product's sortable
+      # attributes. `price` also sorts descending as `-price`.
+      SORT_FIELDS = %w[price best_selling manual].freeze
+
       attr_reader :store
 
       # Whether this provider requires background indexing jobs.

data/app/models/spree/seller.rb

@@ -25,6 +25,8 @@ module Spree
     MEMOIZED_METHODS = %w[onboarding_requirements onboarding_progress products_count returns_location].freeze
 
     publishes_lifecycle_events
+    publishes_events :approved, :invited, :onboarding_reopened, :onboarding_started, :rejected,
+                     :submitted_for_review, :suspended
 
     # Where a seller is in its life on the marketplace. Transitions belong to
     # workflows (Spree::Sellers::Approve and friends) rather than a state
@@ -39,6 +41,12 @@ module Spree
     has_status :pending, :invited, :canceled, :onboarding, :ready_for_review,
                :approved, :rejected, :suspended, default: :pending
 
+    # The storefront lists approved sellers only, and a seller's contact
+    # address is back-office data.
+    self.whitelisted_ransackable_attributes = %w[status contact_email]
+    search_by :name
+    self.private_ransackable_attributes = { store: %w[status contact_email], seller: %w[status contact_email] }
+
     # Who remits consumer tax on this seller's sales. `seller` means they are
     # merchant of record; `platform` is the marketplace-facilitator case, and
     # only Enterprise decides a seller belongs there — core just reads it.
@@ -62,7 +70,6 @@ module Spree
     #
     # Associations
     #
-    belongs_to :store, class_name: 'Spree::Store'
     # The address knows it is a seller's from its owner, so it is read back
     # with the business rules — no personal name insisted on, the company line
     # required. Not `dependent: :destroy`: a seller is paranoid, so destroy is
@@ -195,6 +202,7 @@ module Spree
     has_one_attached :logo, service: Spree.public_storage_service_name
     has_one_attached :square_logo, service: Spree.public_storage_service_name
     has_one_attached :cover_photo, service: Spree.public_storage_service_name
+    signed_id_attachments :logo, :square_logo, :cover_photo
 
     #
     # Validations
@@ -339,7 +347,7 @@ module Spree
     # A seller keeps no clock of their own: a date means whatever the
     # marketplace says it means, so their panel reads timestamps in the
     # store's zone rather than in whichever one their browser sits in.
-    delegate :preferred_timezone, to: :store, allow_nil: true
+    delegate :preferred_timezone, :timezone, to: :store, allow_nil: true
 
     # Sellers holding an account with one provider, for the reverse lookup a
     # provider webhook does — it knows the account, not the seller.

data/app/models/spree/seller_payout.rb

@@ -16,6 +16,8 @@ module Spree
   # and leaves the operator to pay by bank, while a provider like Stripe
   # Connect performs the transfer itself.
   class SellerPayout < Spree.base_class
+    publishes_event :completed
+
     has_prefix_id :vpo
 
     include Spree::Metadata
@@ -58,6 +60,12 @@ module Spree
     scope :owed, -> { where(status: %w[pending processing]) }
 
     self.whitelisted_ransackable_attributes = %w[amount currency status provider reference period_start period_end created_at seller_id]
+    search_by :reference
+    # Filtered by the provider's API shorthand (`system`); the column holds
+    # its class name.
+    ransacker :provider, formatter: ->(value) { Spree::ApiTyped.class_name_for(Spree.payout_providers, value) } do |parent|
+      parent.table[:provider]
+    end
     # No `transfers`: they lead on to the order and its buyer, which a
     # payouts-only caller may not read.
     self.whitelisted_ransackable_associations = %w[seller]

data/app/models/spree/seller_requirement.rb

@@ -16,8 +16,12 @@ module Spree
     include Spree::HasListPosition
     include Spree::PreferenceSchema
     include Spree::Metadata
+    include Spree::TypeLabels
+
+    self.type_labels_scope = 'spree.seller_requirement_types'
 
     has_prefix_id :selreq
+    search_by :name
 
     acts_as_list scope: :store
 
@@ -87,16 +91,6 @@ module Spree
       end
     end
 
-    # @return [String] the localized name of the kind, used by operator pickers
-    def self.human_name
-      Spree.t("seller_requirement_types.#{api_type}.name", default: api_type.titleize)
-    end
-
-    # @return [String] the localized description of the kind
-    def self.human_description
-      Spree.t("seller_requirement_types.#{api_type}.description", default: '')
-    end
-
     # Whether the operator may configure this kind more than once per store.
     # True for the kinds whose meaning comes from the operator's own copy.
     #
@@ -266,8 +260,7 @@ module Spree
       return if Spree.seller_requirements.any? { |kind| kind.to_s == type }
 
       errors.add(
-        :type, :invalid_seller_requirement, message: Spree.t(:invalid_seller_requirement, scope: [:errors, :messages],
-                                             default: 'is not a registered seller requirement')
+        :type, :invalid_seller_requirement, message: I18n.t('spree.errors.messages.invalid_seller_requirement')
       )
     end
   end

data/app/models/spree/seller_requirement_custom_field.rb

@@ -22,8 +22,7 @@ module Spree
       return if custom_field_definition.resource_type == Spree::Seller.to_s
 
       errors.add(:custom_field_definition, :invalid,
-                 message: Spree.t('seller_requirements.custom_field_not_for_sellers',
-                                  default: 'must be a custom field defined for sellers'))
+                 message: I18n.t('spree.seller_requirements.custom_field_not_for_sellers'))
     end
 
     # Both sides are store-owned, so a marketplace can only ask its sellers

data/app/models/spree/seller_requirement_submission.rb

@@ -16,6 +16,7 @@ module Spree
     has_prefix_id :selsub
 
     publishes_lifecycle_events
+    publishes_events :accepted, :created, :rejected, :waived
 
     # `waived` is the operator excusing one seller from something the store
     # asks of everyone — a requirement they have already satisfied off the
@@ -37,6 +38,7 @@ module Spree
     # Private, and served only through the admin and seller branches: these
     # are business registrations and identity documents.
     has_one_attached :file, service: Spree.private_storage_service_name
+    signed_id_attachments :file
 
     #
     # Validations
@@ -84,8 +86,7 @@ module Spree
       return if seller.nil? || requirement.nil?
       return if seller.store_id == requirement.store_id
 
-      errors.add(:requirement, :seller_requirement_store_mismatch, message: Spree.t('errors.messages.seller_requirement_store_mismatch',
-                                       default: 'must belong to the same store as the seller'))
+      errors.add(:requirement, :seller_requirement_store_mismatch, message: I18n.t('spree.errors.messages.seller_requirement_store_mismatch'))
     end
   end
 end

data/app/models/spree/seller_requirements/accept_terms.rb

@@ -90,14 +90,13 @@ module Spree
         # On the preference rather than :base, so the operator's form marks the
         # field they got wrong instead of only showing a summary line.
         errors.add(:preferred_terms_effective_from, :invalid_terms_effective_from,
-                   message: Spree.t('seller_requirements.invalid_terms_effective_from',
-                                    default: 'Terms effective from is not a date'))
+                   message: I18n.t('spree.seller_requirements.invalid_terms_effective_from'))
       end
 
       def store_terms_body
         return if store.nil?
 
-        store.policies.with_matching_name(Spree.t(:terms_of_service)).detect(&:with_body?)&.body
+        store.policies.with_matching_name(I18n.t('spree.terms_of_service')).detect(&:with_body?)&.body
       end
     end
   end

data/app/models/spree/seller_transfer.rb

@@ -112,6 +112,12 @@ module Spree
     end
 
     self.whitelisted_ransackable_attributes = %w[amount currency kind status provider reference created_at seller_id order_id payout_id]
+    search_by :reference
+    # Filtered by the provider's API shorthand (`system`); the column holds
+    # its class name.
+    ransacker :provider, formatter: ->(value) { Spree::ApiTyped.class_name_for(Spree.payout_providers, value) } do |parent|
+      parent.table[:provider]
+    end
     # No `order`: filtering through it reaches the buyer's email and address,
     # which a payouts-only caller may not read. `order_id` covers the lookup.
     self.whitelisted_ransackable_associations = %w[seller payout refund]

data/app/models/spree/shipping_label.rb

@@ -20,6 +20,7 @@ module Spree
     include Spree::Metadata
 
     publishes_lifecycle_events
+    publishes_events :purchased, :refunded
 
     has_status :purchased, :refund_requested, :refunded, default: :purchased
 
@@ -38,6 +39,7 @@ module Spree
     # merchant's account details, and is served only through an
     # authenticated, streamed download.
     has_one_attached :file, service: Spree.private_storage_service_name
+    signed_id_attachments :file
 
     validates :source, inclusion: { in: SOURCES }
     validates :owner_type, inclusion: { in: OWNER_TYPES }

data/app/models/spree/stock/availability_validator.rb

@@ -17,11 +17,11 @@ module Spree
         if variant.available? || variant.preorder?
           line_item.errors.add(:quantity,
                                :selected_quantity_not_available,
-                               message: Spree.t(:selected_quantity_not_available, item: display_name.inspect))
+                               message: I18n.t('spree.selected_quantity_not_available', item: display_name.inspect))
         else
           line_item.errors.add(:base,
                                :only_active_products_can_be_added_to_cart,
-                               message: Spree.t(:only_active_products_can_be_added_to_cart))
+                               message: I18n.t('spree.only_active_products_can_be_added_to_cart'))
         end
       end
 

data/app/models/spree/stock/estimator.rb

@@ -121,7 +121,7 @@ module Spree
 
         percent = service_row&.markup_percent || delivery_method.markup_percent || 0
         flat = service_row&.markup_flat || delivery_method.markup_flat || 0
-        (cost * (1 + (percent / 100)) + flat).round(2)
+        Spree::Money::Rounding.to_currency(cost * (1 + (percent / 100)) + flat, currency)
       end
 
       # Display name for provider-priced rates: the merchant's label override,

data/app/models/spree/stock/inventory_unit_builder.rb

@@ -14,7 +14,7 @@ module Spree
         @order.line_items.map do |line_item|
           # They go through multiple splits, avoid loading the
           # association to order until needed.
-          Spree::InventoryUnit.new(
+          Spree::FulfillmentItem.new(
             pending: true,
             line_item_id: line_item.id,
             variant_id: line_item.variant_id,

data/app/models/spree/stock/packer.rb

@@ -35,8 +35,8 @@ module Spree
             next unless stock_location.stocks? variant
 
             on_hand, backordered = stock_location.fill_status(variant, unit.quantity)
-            package.add(InventoryUnit.split(unit, backordered), :backordered) if backordered.positive?
-            package.add(InventoryUnit.split(unit, on_hand), :on_hand) if on_hand.positive?
+            package.add(FulfillmentItem.split(unit, backordered), :backordered) if backordered.positive?
+            package.add(FulfillmentItem.split(unit, on_hand), :on_hand) if on_hand.positive?
           else
             package.add unit
           end

data/app/models/spree/stock/splitter/weight.rb

@@ -73,7 +73,7 @@ module Spree
           per_content_max_quantity = 1 if per_content_max_quantity.zero?
           content_items = [content_item]
           while content_item.quantity > per_content_max_quantity
-            split_inventory = InventoryUnit.split(content_item.inventory_unit, per_content_max_quantity)
+            split_inventory = FulfillmentItem.split(content_item.inventory_unit, per_content_max_quantity)
             content_items << ContentItem.new(split_inventory, content_item.state)
           end
           content_items

data/app/models/spree/stock_level/custom_events.rb

@@ -17,6 +17,12 @@ module Spree
       LEGACY_EVENT_PREFIX = 'stock_item'
       LEGACY_EVENT_SUFFIXES = %w[created updated deleted].freeze
 
+      def self.included(base)
+        LEGACY_EVENT_SUFFIXES.each do |suffix|
+          base.publishes_event("#{LEGACY_EVENT_PREFIX}.#{suffix}", deprecated_alias_of: "#{base.event_prefix}.#{suffix}")
+        end
+      end
+
       # Wraps publishing rather than the three callbacks that call it, so the
       # decisions Publishable makes — whether events are enabled at all,
       # whether a touch-only update is worth announcing — are made once and the

data/app/models/spree/stock_level.rb

@@ -38,7 +38,9 @@ module Spree
 
     self.whitelisted_ransackable_attributes = %w[count_on_hand allocated_count reserved_count incoming_count
                                                  stock_location_id variant_id]
+    search_by :variant_sku, :variant_product_name
     self.whitelisted_ransackable_scopes = %w[with_stock_status]
+    self.ransackable_scope_types = { 'with_stock_status' => { list: 'text' } }
     self.whitelisted_ransackable_associations = %w[variant stock_location]
 
     scope :with_active_stock_location, -> { joins(:stock_location).merge(Spree::StockLocation.active) }
@@ -100,7 +102,7 @@ module Spree
     }
 
     def backordered_inventory_units
-      Spree::InventoryUnit.backordered_for_stock_level(self)
+      Spree::FulfillmentItem.backordered_for_stock_level(self)
     end
 
     # @api private

data/app/models/spree/stock_location.rb

@@ -50,6 +50,7 @@ module Spree
       country_code state_code created_at updated_at
       seller_id
     ]
+    search_by :name
     self.whitelisted_ransackable_associations = %w[seller]
 
     scope :active, -> { where(active: true) }

data/app/models/spree/stock_movement.rb

@@ -114,7 +114,7 @@ module Spree
       return default_adjustment_reason if reason.blank?
       return reason.to_s unless ADJUSTMENT_REASONS.include?(reason.to_s)
 
-      Spree.t("stock_movement.reasons.#{reason}", locale: :en)
+      I18n.t("spree.stock_movement.reasons.#{reason}", locale: :en)
     end
 
     # A movement is an immutable audit row: once written, nothing may rewrite

data/app/models/spree/stock_receipt_item.rb

@@ -29,7 +29,7 @@ module Spree
     def counts_something
       return if quantity_counted.positive?
 
-      errors.add(:base, :nothing_counted, message: Spree.t('stock_receipt.errors.nothing_counted'))
+      errors.add(:base, :nothing_counted, message: I18n.t('spree.stock_receipt.errors.nothing_counted'))
     end
   end
 end

data/app/models/spree/stock_reservation.rb

@@ -127,7 +127,7 @@ module Spree
     end
 
     def exactly_one_owner
-      errors.add(:base, :exactly_one_of_cart_or_order, message: Spree.t('errors.messages.exactly_one_of_cart_or_order')) unless [order, cart].compact.one?
+      errors.add(:base, :exactly_one_of_cart_or_order, message: I18n.t('spree.errors.messages.exactly_one_of_cart_or_order')) unless [order, cart].compact.one?
     end
 
     # Only a quantity change moves units between counters, so re-pointing a
@@ -135,7 +135,7 @@ module Spree
     # missing from the new. A hold that belongs elsewhere is released and
     # taken again, never moved.
     def stock_level_unchanged
-      errors.add(:stock_level_id, :immutable, message: Spree.t('errors.messages.stock_level_immutable')) if stock_level_id_changed?
+      errors.add(:stock_level_id, :immutable, message: I18n.t('spree.errors.messages.stock_level_immutable')) if stock_level_id_changed?
     end
   end
 end

data/app/models/spree/stock_transfer.rb

@@ -36,6 +36,8 @@ module Spree
     acts_as_paranoid
 
     publishes_lifecycle_events
+    publishes_events :canceled, :draft, :partially_received, :over_received, :ready_to_ship,
+                     :received, :shipped
 
     has_status :draft, :ready_to_ship, :in_transit, :partially_received, :received, :over_received, :canceled,
                default: :draft
@@ -64,7 +66,9 @@ module Spree
     self.whitelisted_ransackable_attributes = %w[number status reference source_location_id
                                                  destination_location_id shipped_at received_at
                                                  closed_short_at created_at]
+    search_by :number, :reference
     self.whitelisted_ransackable_scopes = %w[open closed]
+    self.ransackable_scope_types = %w[open closed].index_with('boolean')
     self.whitelisted_ransackable_associations = %w[source_location destination_location items]
 
     # Whether the merchant may still edit the lines. Once the box is sealed and
@@ -97,7 +101,7 @@ module Spree
       return if source_location_id.blank? || destination_location_id.blank?
       return if source_location_id != destination_location_id
 
-      errors.add(:source_location, :same_location, message: Spree.t('stock_transfer.errors.same_location'))
+      errors.add(:source_location, :same_location, message: I18n.t('spree.stock_transfer.errors.same_location'))
     end
 
     # A transfer moves a merchant's own stock between their own warehouses. Two
@@ -108,7 +112,7 @@ module Spree
       return if source_location.store_id == destination_location.store_id
 
       errors.add(:destination_location, :must_belong_to_same_store,
-                 message: Spree.t('stock_transfer.errors.locations_in_different_stores'))
+                 message: I18n.t('spree.stock_transfer.errors.locations_in_different_stores'))
     end
   end
 end