spree_core 6.0.0.beta4 → 6.0.0.rc2

data/app/workflows/spree/shipping_labels/record.rb

@@ -13,7 +13,7 @@ module Spree
       attr_reader :shipping_label
 
       # @param owner [Spree::Fulfillment, Spree::Return]
-      # @param file [ActionDispatch::Http::UploadedFile, String] the file, or a signed blob id from a direct upload
+      # @param file [ActionDispatch::Http::UploadedFile, String] the file, or a signed id from POST /files
       # @param tracking_number [String] the number printed on the label
       # @param carrier [String, nil] free text; detected from the number when omitted
       # @param service [String, nil]
@@ -41,15 +41,15 @@ module Spree
       private
 
       def ensure_recordable
-        failure(owner, Spree.t('shipping_labels.errors.already_purchased')) if owner.shipping_labels.active.exists?
-        failure(owner, Spree.t('shipping_labels.errors.tracking_number_required')) if tracking_number.blank?
-        failure(owner, Spree.t('shipping_labels.errors.file_required')) if file.blank?
+        failure(owner, I18n.t('spree.shipping_labels.errors.already_purchased')) if owner.shipping_labels.active.exists?
+        failure(owner, I18n.t('spree.shipping_labels.errors.tracking_number_required')) if tracking_number.blank?
+        failure(owner, I18n.t('spree.shipping_labels.errors.file_required')) if file.blank?
 
         case owner
         when Spree::Fulfillment
-          failure(owner, Spree.t('fulfillments.errors.cannot_purchase_label')) if owner.canceled? || owner.delivered?
+          failure(owner, I18n.t('spree.fulfillments.errors.cannot_purchase_label')) if owner.canceled? || owner.delivered?
         when Spree::Return
-          failure(owner, Spree.t('shipping_labels.errors.return_closed')) if owner.received? || owner.refunded? || owner.canceled?
+          failure(owner, I18n.t('spree.shipping_labels.errors.return_closed')) if owner.received? || owner.refunded? || owner.canceled?
         end
       end
 
@@ -69,7 +69,7 @@ module Spree
         failure(@shipping_label) unless @shipping_label.save
       end
 
-      # A direct-upload blob carries the type the client declared, which the
+      # An uploaded blob carries the type the client declared, which the
       # attachment validator re-decides from the bytes; either way the
       # extension is the merchant-visible answer, so it wins when it names a
       # format Spree knows.

data/app/workflows/spree/shipping_labels/refund.rb

@@ -42,7 +42,7 @@ module Spree
         return if shipping_label.refundable?
 
         reason = shipping_label.uploaded? ? 'uploaded_not_refundable' : 'not_refundable'
-        failure(shipping_label, Spree.t("shipping_labels.errors.#{reason}"))
+        failure(shipping_label, I18n.t("spree.shipping_labels.errors.#{reason}"))
       end
 
       # A provider that knows why the carrier said no raises with its words;
@@ -52,7 +52,7 @@ module Spree
 
         return if %w[refunded refund_requested].include?(@outcome)
 
-        failure(shipping_label, Spree.t('shipping_labels.errors.refund_failed'))
+        failure(shipping_label, I18n.t('spree.shipping_labels.errors.refund_failed'))
       rescue Spree::Core::LabelRefundRefused => e
         failure(shipping_label, e.message)
       end

data/app/workflows/spree/stock_receipts/recording.rb

@@ -61,19 +61,19 @@ module Spree
 
         return if @normalized_items.any?
 
-        failure(receivable, Spree.t("#{error_scope}.errors.no_items_received"))
+        failure(receivable, I18n.t("spree.#{error_scope}.errors.no_items_received"))
       end
 
       # A line the payload names but counts nothing on is left out rather than
       # refused: a receive screen submits every row, most of them untouched.
       def normalize_item(item)
         line = item[:item]
-        failure(receivable, Spree.t("#{error_scope}.errors.item_not_on_document")) unless line_belongs?(line)
+        failure(receivable, I18n.t("spree.#{error_scope}.errors.item_not_on_document")) unless line_belongs?(line)
 
         accepted = item[:quantity_accepted].to_i
         rejected = item[:quantity_rejected].to_i
         if accepted.negative? || rejected.negative?
-          failure(receivable, Spree.t("#{error_scope}.errors.invalid_receipt_quantity", variant: line.variant_name))
+          failure(receivable, I18n.t("spree.#{error_scope}.errors.invalid_receipt_quantity", variant: line.variant_name))
         end
         return nil if accepted.zero? && rejected.zero?
 
@@ -93,7 +93,7 @@ module Spree
         repeated = lines.group_by(&:id).values.find { |group| group.length > 1 }
         return if repeated.nil?
 
-        failure(receivable, Spree.t("#{error_scope}.errors.repeated_item", variant: repeated.first.variant_name))
+        failure(receivable, I18n.t("spree.#{error_scope}.errors.repeated_item", variant: repeated.first.variant_name))
       end
 
       def build_receipt

data/app/workflows/spree/stock_transfers/cancel.rb

@@ -49,11 +49,11 @@ module Spree
       private
 
       def ensure_cancelable
-        failure(stock_transfer, Spree.t('stock_transfer.errors.already_closed')) if stock_transfer.closed?
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.already_closed')) if stock_transfer.closed?
         return unless stock_transfer.in_flight?
         return if IN_TRANSIT_RESOLUTIONS.include?(on_in_transit)
 
-        failure(stock_transfer, Spree.t('stock_transfer.errors.in_transit_resolution_required'))
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.in_transit_resolution_required'))
       end
 
       # Whether the units come back or are written off, the destination is no

data/app/workflows/spree/stock_transfers/close.rb

@@ -8,7 +8,7 @@ module Spree
     # destination counted in, records why the rest never arrived, and leaves
     # the outstanding count on each line as the record of the loss.
     class Close < Spree::Workflow
-      include Spree::Receivables::IncomingCounter
+      include Spree::Receivables::ClosingShort
 
       hooks :validate, :after_close
 
@@ -18,39 +18,12 @@ module Spree
       # @param reason [String, nil] what happened to the balance
       def perform(stock_transfer:, reason: nil)
         super
-
-        stock_transfer.with_lock do
-          step :ensure_closable
-          run_hooks :validate
-          step :uncount_awaited_units
-          step :close_short
-        end
-
-        run_hooks :after_close
-        stock_transfer.publish_event('stock_transfer.received')
-        success(stock_transfer.reload)
+        close
       end
 
       private
 
-      def ensure_closable
-        return if stock_transfer.partially_received?
-
-        failure(stock_transfer, Spree.t('stock_transfer.errors.not_partially_received'))
-      end
-
-      # The missing units are not going to turn up, so the destination stops
-      # expecting them; each line's outstanding count keeps the record.
-      def uncount_awaited_units
-        uncount_incoming(stock_transfer)
-      end
-
-      def close_short
-        now = Time.current
-        attributes = { status: 'received', received_at: now, closed_short_at: now, close_reason: reason.presence }
-
-        failure(stock_transfer) unless stock_transfer.update(attributes)
-      end
+      def receivable = stock_transfer
     end
   end
 end

data/app/workflows/spree/stock_transfers/create.rb

@@ -16,9 +16,10 @@ module Spree
       #   may legitimately open empty and gain lines as the merchant packs
       # @param reference [String, nil] the merchant's own label for the trip
       # @param notes [String, nil]
+      # @param metadata [Hash, nil]
       # @param created_by [Object, nil]
       def perform(store:, source_location:, destination_location:, items: [],
-                  reference: nil, notes: nil, created_by: nil)
+                  reference: nil, notes: nil, metadata: nil, created_by: nil)
         super
 
         step :build_transfer
@@ -46,6 +47,7 @@ module Spree
           created_by: created_by,
           status: Spree::StockTransfer.default_status
         )
+        @stock_transfer.metadata = metadata if metadata
 
         Array(items).each do |item|
           @stock_transfer.items.build(variant: item[:variant], quantity_shipped: item[:quantity_shipped])

data/app/workflows/spree/stock_transfers/mark_draft.rb

@@ -30,7 +30,7 @@ module Spree
       def ensure_returnable
         return if stock_transfer.ready_to_ship?
 
-        failure(stock_transfer, Spree.t('stock_transfer.errors.not_ready_to_ship'))
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.not_ready_to_ship'))
       end
 
       def return_to_draft

data/app/workflows/spree/stock_transfers/mark_in_transit.rb

@@ -46,9 +46,9 @@ module Spree
 
       def ensure_shippable
         unless stock_transfer.draft? || stock_transfer.ready_to_ship?
-          failure(stock_transfer, Spree.t('stock_transfer.errors.not_shippable'))
+          failure(stock_transfer, I18n.t('spree.stock_transfer.errors.not_shippable'))
         end
-        failure(stock_transfer, Spree.t('stock_transfer.errors.must_have_variant')) if stock_transfer.items.empty?
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.must_have_variant')) if stock_transfer.items.empty?
       end
 
       # Every line needs enough available stock for the quantity being moved,
@@ -65,7 +65,7 @@ module Spree
         return if unavailable_items.empty?
 
         failure(stock_transfer,
-                Spree.t('stock_transfer.errors.variants_unavailable', stock: source.name))
+                I18n.t('spree.stock_transfer.errors.variants_unavailable', stock: source.name))
       end
 
       def write_shipped_movements

data/app/workflows/spree/stock_transfers/mark_ready.rb

@@ -24,8 +24,8 @@ module Spree
       private
 
       def ensure_draft
-        failure(stock_transfer, Spree.t('stock_transfer.errors.not_draft')) unless stock_transfer.draft?
-        failure(stock_transfer, Spree.t('stock_transfer.errors.must_have_variant')) if stock_transfer.items.empty?
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.not_draft')) unless stock_transfer.draft?
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.must_have_variant')) if stock_transfer.items.empty?
       end
 
       def mark_ready

data/app/workflows/spree/stock_transfers/receive.rb

@@ -46,7 +46,7 @@ module Spree
       def ensure_receivable
         return if stock_transfer.in_flight?
 
-        failure(stock_transfer, Spree.t('stock_transfer.errors.not_in_transit'))
+        failure(stock_transfer, I18n.t('spree.stock_transfer.errors.not_in_transit'))
       end
 
       def line_belongs?(line)

data/app/workflows/spree/stock_transfers/update.rb

@@ -4,6 +4,8 @@ module Spree
     # matter of record, so this refuses anything past `draft` rather than
     # quietly rewriting a document the warehouse is already acting on.
     class Update < Spree::Workflow
+      include Spree::Receivables::DraftEditing
+
       hooks :validate, :after_update
 
       # @param stock_transfer [Spree::StockTransfer]
@@ -13,43 +15,13 @@ module Spree
       #   replacing the current lines; nil leaves them alone
       def perform(stock_transfer:, attributes: {}, items: nil)
         super
-
-        step :ensure_editable
-        run_hooks :validate
-
-        ApplicationRecord.transaction do
-          step :apply_changes
-          step :save_transfer
-        end
-
-        run_hooks :after_update
-        success(stock_transfer.reload)
+        edit
       end
 
       private
 
-      def ensure_editable
-        return if stock_transfer.editable?
-
-        failure(stock_transfer, Spree.t('stock_transfer.errors.not_editable'))
-      end
-
-      # A whole-list replacement rather than a per-line diff: a draft's lines
-      # are what the merchant is still deciding, and sending the list they
-      # want is simpler for a client than working out which rows to delete.
-      def apply_changes
-        stock_transfer.assign_attributes(attributes) if attributes.present?
-        return if items.nil?
-
-        stock_transfer.items.destroy_all
-        Array(items).each do |item|
-          stock_transfer.items.build(variant: item[:variant], quantity_shipped: item[:quantity_shipped])
-        end
-      end
-
-      def save_transfer
-        failure(stock_transfer) unless stock_transfer.save
-      end
+      def receivable = stock_transfer
+      def item_attributes = %i[quantity_shipped]
     end
   end
 end

data/config/currency_exponents.json

@@ -0,0 +1,180 @@
+{
+  "AED": 2,
+  "AFN": 2,
+  "ALL": 2,
+  "AMD": 2,
+  "ANG": 2,
+  "AOA": 2,
+  "ARS": 2,
+  "AUD": 2,
+  "AWG": 2,
+  "AZN": 2,
+  "BAM": 2,
+  "BBD": 2,
+  "BDT": 2,
+  "BGN": 2,
+  "BHD": 3,
+  "BIF": 0,
+  "BMD": 2,
+  "BND": 2,
+  "BOB": 2,
+  "BRL": 2,
+  "BSD": 2,
+  "BTN": 2,
+  "BWP": 2,
+  "BYN": 2,
+  "BYR": 0,
+  "BZD": 2,
+  "CAD": 2,
+  "CDF": 2,
+  "CHF": 2,
+  "CLF": 4,
+  "CLP": 0,
+  "CNY": 2,
+  "COP": 2,
+  "CRC": 2,
+  "CUC": 2,
+  "CUP": 2,
+  "CVE": 2,
+  "CZK": 2,
+  "DJF": 0,
+  "DKK": 2,
+  "DOP": 2,
+  "DZD": 2,
+  "EEK": 2,
+  "EGP": 2,
+  "ERN": 2,
+  "ETB": 2,
+  "EUR": 2,
+  "FJD": 2,
+  "FKP": 2,
+  "GBP": 2,
+  "GEL": 2,
+  "GHS": 2,
+  "GIP": 2,
+  "GMD": 2,
+  "GNF": 0,
+  "GTQ": 2,
+  "GYD": 2,
+  "HKD": 2,
+  "HNL": 2,
+  "HRK": 2,
+  "HTG": 2,
+  "HUF": 2,
+  "IDR": 2,
+  "ILS": 2,
+  "INR": 2,
+  "IQD": 3,
+  "IRR": 2,
+  "ISK": 0,
+  "JMD": 2,
+  "JOD": 3,
+  "JPY": 0,
+  "KES": 2,
+  "KGS": 2,
+  "KHR": 2,
+  "KMF": 0,
+  "KPW": 2,
+  "KRW": 0,
+  "KWD": 3,
+  "KYD": 2,
+  "KZT": 2,
+  "LAK": 2,
+  "LBP": 2,
+  "LKR": 2,
+  "LRD": 2,
+  "LSL": 2,
+  "LTL": 2,
+  "LVL": 2,
+  "LYD": 3,
+  "MAD": 2,
+  "MDL": 2,
+  "MGA": 2,
+  "MKD": 2,
+  "MMK": 2,
+  "MNT": 2,
+  "MOP": 2,
+  "MRO": 2,
+  "MRU": 2,
+  "MTL": 2,
+  "MUR": 2,
+  "MVR": 2,
+  "MWK": 2,
+  "MXN": 2,
+  "MYR": 2,
+  "MZN": 2,
+  "NAD": 2,
+  "NGN": 2,
+  "NIO": 2,
+  "NOK": 2,
+  "NPR": 2,
+  "NZD": 2,
+  "OMR": 3,
+  "PAB": 2,
+  "PEN": 2,
+  "PGK": 2,
+  "PHP": 2,
+  "PKR": 2,
+  "PLN": 2,
+  "PYG": 0,
+  "QAR": 2,
+  "RON": 2,
+  "RSD": 2,
+  "RUB": 2,
+  "RWF": 0,
+  "SAR": 2,
+  "SBD": 2,
+  "SCR": 2,
+  "SDG": 2,
+  "SEK": 2,
+  "SGD": 2,
+  "SHP": 2,
+  "SKK": 2,
+  "SLE": 2,
+  "SLL": 2,
+  "SOS": 2,
+  "SRD": 2,
+  "SSP": 2,
+  "STD": 2,
+  "STN": 2,
+  "SVC": 2,
+  "SYP": 2,
+  "SZL": 2,
+  "THB": 2,
+  "TJS": 2,
+  "TMM": 2,
+  "TMT": 2,
+  "TND": 3,
+  "TOP": 2,
+  "TRY": 2,
+  "TTD": 2,
+  "TWD": 2,
+  "TZS": 2,
+  "UAH": 2,
+  "UGX": 0,
+  "USD": 2,
+  "UYI": 0,
+  "UYU": 2,
+  "UYW": 4,
+  "UZS": 2,
+  "VED": 2,
+  "VEF": 2,
+  "VES": 2,
+  "VND": 0,
+  "VUV": 0,
+  "WST": 2,
+  "XAF": 0,
+  "XCD": 2,
+  "XCG": 2,
+  "XOF": 0,
+  "XPF": 0,
+  "YER": 2,
+  "ZAR": 2,
+  "ZMK": 2,
+  "ZMW": 2,
+  "ZWD": 2,
+  "ZWG": 2,
+  "ZWL": 2,
+  "ZWN": 2,
+  "ZWR": 2
+}

data/config/i18n-tasks.yml

@@ -14,11 +14,13 @@ data:
   # adapter: I18n::Tasks::Data::FileSystem
 
   # Locale files or `Dir.glob` patterns where translations are read from:
+  ## This one config checks every Spree gem: core's keys are used from all of
+  ## them, and their own keys from core.
   read:
-    ## Default:
-    # - config/locales/%{locale}.yml
-    ## More files:
-    # - config/locales/**/*.%{locale}.yml
+    - config/locales/%{locale}.yml
+<% %w[api emails].map { |gem| "../#{gem}" }.concat(Dir['../providers/*']).each do |gem| %>
+    - "<%= File.expand_path("#{gem}/config/locales", Dir.pwd) %>/%{locale}.yml"
+<% end %>
 
   # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
   # `i18n-tasks normalize -p` will force move the keys according to these rules
@@ -52,9 +54,14 @@ data:
 
 # Find translate calls
 search:
-  ## Paths or `Find.find` patterns to search in:
-  # paths:
-  #  - app/
+  ## Paths or `Find.find` patterns to search in. Core keys are read by every
+  ## Spree gem, so all of them are searched.
+  paths:
+    - app/
+    - lib/
+<% (%w[api emails dashboard opentelemetry].map { |gem| "../#{gem}" } + Dir['../providers/*']).product(%w[app lib]).each do |gem, folder| %>
+    - "<%= File.expand_path("#{gem}/#{folder}", Dir.pwd) %>"
+<% end %>
 
   ## Root directories for relative keys resolution.
   # relative_roots:
@@ -143,12 +150,18 @@ ignore_missing:
   - 'unauthorized.default'
 
 ## Consider these keys used:
-# ignore_unused:
-# - 'activerecord.attributes.*'
-# - '{devise,kaminari,will_paginate}.*'
-# - 'simple_form.{yes,no}'
-# - 'simple_form.{placeholders,hints,labels}.*'
-# - 'simple_form.{error_notification,required}.:'
+ignore_unused:
+  # Read by Rails itself (model names, attribute names, validation messages, formats).
+  - 'activerecord.*'
+  - 'activemodel.*'
+  - 'errors.*'
+  - 'number.*'
+  # Keys built with interpolation, which the scanner cannot follow.
+  - 'spree.reporting.*'
+  - 'spree.permissions_catalog.*'
+  # Spree::TypeLabels reads <family>_types.<api_type>.{name,description}.
+  - 'spree.{collection_rule,commission_rule,delivery_method_rule,order_routing_rule,promotion_action,promotion_rule,seller_requirement}_types.*'
+  - 'spree.i18n.this_file_language'
 
 ## Exclude these keys from the `i18n-tasks eq-base' report:
 # ignore_eq_base:
@@ -172,8 +185,9 @@ ignore_missing:
 # <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
 #       only: %w(*.html.haml *.html.slim),
 #       patterns: [['= title\b', '.page_title']] %>
-#
-# The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
-#
-# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
-#       patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>
+
+# Email templates translate Spree keys with Liquid's `t` filter, and shared
+# partials take a key to translate (`label: 'some.key', translate: true`).
+<% I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+      only: %w(*.liquid),
+      patterns: [['%{key}\s*\|\s*t\b', 'spree.%{key}'], ['\blabel:\s*%{key}', 'spree.%{key}']] %>

data/config/initializers/alba.rb

@@ -0,0 +1,7 @@
+Alba.backend = :oj_rails
+Alba.inflector = :active_support
+
+# Custom types
+Alba.register_type :iso8601, converter: ->(time) { time&.iso8601(3) }, auto_convert: true
+# Decimals and money rendered as their exact string form instead of JSON numbers
+Alba.register_type :string, check: ->(value) { value.is_a?(String) }, converter: ->(value) { value.to_s }, auto_convert: true