spree_core 6.0.0.rc1 → 6.0.0.rc2

data/app/models/spree/fulfillment_group.rb

@@ -72,12 +72,17 @@ module Spree
       fulfillments.sum { |fulfillment| fulfillment.discounted_cost.to_d }
     end
 
+    # @return [String] the currency the parcel was quoted in
+    def currency
+      primary.currency
+    end
+
     # @return [String, Spree::Money] the forwarder's placeholder while a
     #   freight rate is unpriced, money otherwise
     def display_cost(**options)
       return primary.display_cost(**options) if unpriced?
 
-      Spree::Money.new(cost, { currency: primary.currency }.merge(options))
+      Spree::Money.new(cost, { currency: currency }.merge(options))
     end
 
     # @return [Boolean]

data/app/models/spree/gateway/bogus.rb

@@ -1,5 +1,7 @@
 module Spree
   class Gateway::Bogus < Gateway
+    self.accepts_money_amounts = true
+
     TEST_VISA = ['4111111111111111', '4012888888881881', '4222222222222']
     TEST_MC   = ['5500000000000004', '5555555555554444', '5105105105105100', '2223000010309703']
     TEST_AMEX = ['378282246310005', '371449635398431', '378734493671000', '340000000000009']

data/app/models/spree/gateway.rb

@@ -1,6 +1,6 @@
 module Spree
   class Gateway < PaymentMethod
-    FROM_DOLLAR_TO_CENT_RATE = 100.0
+    FROM_DOLLAR_TO_CENT_RATE = 100
 
     delegate :authorize, :purchase, :capture, :void, :credit, to: :provider
 

data/app/models/spree/gift_card.rb

@@ -5,6 +5,9 @@ module Spree
     extend DisplayMoney
     include Spree::SingleStoreResource
     include Spree::HasCustomFields
+    include Spree::CanonicalDecimals
+
+    canonical_decimals :amount
     include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
 
     publishes_lifecycle_events
@@ -62,10 +65,12 @@ module Spree
     # Ransack
     #
     ransack_alias :state, :status # @deprecated filter alias — removed in 6.1
-    self.whitelisted_ransackable_attributes = %w[code customer_id status state gift_card_batch_id created_by_id]
+    self.whitelisted_ransackable_attributes = %w[code customer_id status state gift_card_batch_id created_by_id currency expires_at]
+    search_by :code
     # `users` is the pre-6.0 name for `customers` — removed in 6.1.
     self.whitelisted_ransackable_associations = %w[customers users orders batch]
     self.whitelisted_ransackable_scopes = %w[active expired redeemed partially_redeemed]
+    self.ransackable_scope_types = %w[active expired redeemed partially_redeemed].index_with('boolean')
 
     normalizes :code, with: ->(value) { value&.to_s&.squish&.presence }
 
@@ -82,12 +87,6 @@ module Spree
     #
     money_methods :amount, :amount_used, :amount_authorized, :amount_remaining
 
-    # Sets the amount
-    # @param amount [String]
-    def amount=(amount)
-      self[:amount] = Spree::LocalizedNumber.parse(amount)
-    end
-
     # Calculates the remaining amount
     # @return [Decimal]
     def amount_remaining

data/app/models/spree/gift_card_batch.rb

@@ -4,6 +4,9 @@ module Spree
 
     extend DisplayMoney
     include Spree::SingleStoreResource
+    include Spree::CanonicalDecimals
+
+    canonical_decimals :amount
 
     publishes_lifecycle_events
 
@@ -34,10 +37,6 @@ module Spree
 
     money_methods :amount
 
-    def amount=(amount)
-      self[:amount] = Spree::LocalizedNumber.parse(amount)
-    end
-
     self.whitelisted_ransackable_attributes = %w[prefix]
 
     def generate_gift_cards

data/app/models/spree/import.rb

@@ -55,6 +55,7 @@ module Spree
     # Ransack configuration
     #
     self.whitelisted_ransackable_attributes = %w[number type status seller_id]
+    search_by :number
     # Lets an operator filter their list by who ran the job — the seller's
     # name, not an id they would have to look up first.
     self.whitelisted_ransackable_associations = %w[seller]
@@ -72,6 +73,7 @@ module Spree
     # Attachments
     #
     has_one_attached :attachment, service: Spree.private_storage_service_name
+    signed_id_attachments :attachment
 
     #
     # Status
@@ -87,6 +89,7 @@ module Spree
     # Preferences
     #
     preference :delimiter, :string, default: ','
+    exposes_preferences :delimiter
     # Run the pipeline in-process instead of enqueuing it. For rake tasks, seeds
     # and the console, where the caller needs the data to exist when the call
     # returns and there may be no worker attached. Never set it from a request:

data/app/models/spree/integration.rb

@@ -98,7 +98,7 @@ module Spree
           group: klass.integration_group,
           description: klass.human_description,
           **klass.provider_listing,
-          preference_schema: klass.serialized_preference_schema
+          schema: klass.preference_json_schema
         }
       end.sort_by { |entry| entry[:name] }
     end

data/app/models/spree/line_item.rb

@@ -119,7 +119,7 @@ module Spree
 
     self.whitelisted_ransackable_associations = %w[variant order tax_category]
     self.whitelisted_ransackable_attributes = %w[variant_id order_id tax_category_id quantity
-                                                 price cost_price cost_currency adjustment_total
+                                                 price cost_price adjustment_total
                                                  additional_tax_total discount_total included_tax_total
                                                  pre_tax_amount taxable_adjustment_total
                                                  non_taxable_adjustment_total]
@@ -231,7 +231,7 @@ module Spree
     #
     # @return [BigDecimal]
     def amount
-      price * quantity
+      Spree::Money::Rounding.to_currency(price * quantity, currency)
     end
 
     # Returns the compare at amount (compare at price * quantity) of the line item

data/app/models/spree/market.rb

@@ -8,6 +8,9 @@ module Spree
     acts_as_paranoid
     acts_as_list scope: :store_id
 
+    self.whitelisted_ransackable_attributes = %w[currency default_locale]
+    search_by :name
+
     #
     # Associations
     #
@@ -74,7 +77,9 @@ module Spree
               inclusion: { in: ->(_market) { Spree.tax_providers.map(&:to_s) } },
               allow_blank: true
     validates :currency, presence: true
+    normalizes :default_locale, with: ->(value) { value.to_s.strip.presence }
     validates :default_locale, presence: true
+    validates_with Spree::LocaleCodesValidator, attributes: %i[default_locale supported_locales]
     validates :countries, presence: true
 
     #
@@ -142,7 +147,7 @@ module Spree
     #
     # @return [Array<String>]
     def supported_locales_list
-      @supported_locales_list ||= (supported_locales.to_s.split(',').map(&:strip) << default_locale).compact.uniq.sort
+      @supported_locales_list ||= (supported_locales.to_s.split(',').map(&:strip) << default_locale).compact_blank.uniq.sort
     end
 
     # Accepts an Array of locale codes and persists them as a comma-separated
@@ -153,7 +158,7 @@ module Spree
     # @param value [Array<String>, String, nil]
     def supported_locales=(value)
       @supported_locales_list = nil
-      normalized = value.is_a?(Array) ? value.compact.uniq.reject(&:blank?).join(',') : value
+      normalized = value.is_a?(Array) ? value.map { |code| code.to_s.strip }.reject(&:empty?).uniq.join(',') : value
       super(normalized)
     end
 

data/app/models/spree/media.rb

@@ -31,15 +31,6 @@ module Spree
     EXTERNAL_URL_CUSTOM_FIELD_KEY = 'external.url'
     MEDIA_TYPES = %w[image video external_video].freeze
 
-    # Domain attributes a client may write, shared by every write path — the
-    # media endpoints and the inline `media:` list on a product. Each path adds
-    # its own transport keys (an upload's signed id, a row id) on top. Adding a
-    # field here reaches both, so it can't be dropped on the one a client uses.
-    WRITABLE_ATTRIBUTES = %i[
-      alt position media_type external_video_url poster_signed_id
-      focal_point_x focal_point_y
-    ].freeze
-
     after_initialize { self.media_type ||= 'image' }
 
     belongs_to :viewable, polymorphic: true, touch: true, optional: true
@@ -93,6 +84,7 @@ module Spree
 
     self.whitelisted_ransackable_attributes = %w[alt media_type created_at updated_at]
     self.whitelisted_ransackable_scopes = %w[attached unattached filename_cont]
+    self.ransackable_scope_types = { 'attached' => 'boolean', 'unattached' => 'boolean' }
 
     delegate :key, :attached?, :variant, :variable?, :blob, :filename, :variation, to: :attachment
 

data/app/models/spree/newsletter_subscriber.rb

@@ -48,6 +48,7 @@ module Spree
     #
     self.whitelisted_ransackable_attributes = %w[email verified_at]
     self.whitelisted_ransackable_scopes = %w[verified unverified]
+    self.ransackable_scope_types = %w[verified unverified].index_with('boolean')
 
     def accepts_email_marketing
       return customer.accepts_email_marketing if customer.present?

data/app/models/spree/option_type.rb

@@ -24,7 +24,8 @@ module Spree
     self.whitelisted_ransackable_scopes = %w[search_by_name]
     # `label` is what admin surfaces display, so it has to be filterable —
     # matching Spree::OptionValue, which already allows it.
-    self.whitelisted_ransackable_attributes = %w[label name]
+    self.whitelisted_ransackable_attributes = %w[label name kind]
+    search_by :name, :label
 
     normalizes :name, with: ->(value) { value&.to_s&.squish&.presence }
 

data/app/models/spree/option_value.rb

@@ -18,7 +18,8 @@ module Spree
     #
     # Attachments
     #
-    has_one_attached :image
+    has_one_attached :image, service: Spree.public_storage_service_name
+    signed_id_attachments :image
 
     #
     # Associations

data/app/models/spree/order.rb

@@ -154,6 +154,7 @@ module Spree
       order_group_id po_number
     ]
     self.whitelisted_ransackable_scopes = %w[complete incomplete refunded partially_refunded search]
+    self.ransackable_scope_types = %w[complete incomplete refunded partially_refunded].index_with('boolean')
     # A seller never sees the buyer's email, and a company member filtering the
     # company's orders must not learn a colleague's; the risk flag and coupon
     # are back-office data. `search` matches on the email too.
@@ -415,7 +416,7 @@ module Spree
 
     # Returns the subtotal used for analytics integrations
     # It's a sum of the item total and the promo total
-    # @return [Float]
+    # @return [Float] a JSON number, as analytics providers expect
     def analytics_subtotal
       (item_total + line_items.sum(:discount_total)).to_f
     end
@@ -458,7 +459,7 @@ module Spree
     end
 
     def refunds_total
-      refunds.loaded? ? refunds.sum(&:amount) : refunds.sum(:amount)
+      read_association_in_memory?(:refunds) ? refunds.sum(0.to_d, &:amount) : refunds.sum(:amount)
     end
 
     # Checks if the order is partially refunded
@@ -707,7 +708,7 @@ module Spree
     #
     # @return [BigDecimal]
     def returned_items_refund_total
-      return refunds.select(&:for_returned_items?).sum(0.to_d, &:amount) if refunds.loaded?
+      return refunds.select(&:for_returned_items?).sum(0.to_d, &:amount) if read_association_in_memory?(:refunds)
 
       refunds.for_returned_items.sum(:amount)
     end
@@ -829,7 +830,6 @@ module Spree
     end
 
     def fulfill!
-      fulfillments.each { |shipment| shipment.update!(self) if shipment.persisted? }
       save!
       update_statuses!
     end
@@ -1274,7 +1274,7 @@ module Spree
     end
 
     def credit_card_nil_payment?(attributes)
-      payments.store_credits.present? && attributes[:amount].to_f.zero?
+      payments.store_credits.present? && Spree::Money::Rounding.blank_or_zero?(attributes[:amount])
     end
   end
 end

data/app/models/spree/order_group.rb

@@ -100,9 +100,14 @@ module Spree
     # the children loaded already (a serializer renders them, a gateway call
     # reads four of these in a row), and an aggregate per figure would issue a
     # query each time even against rows sitting in memory.
+    #
+    # +tax_total+ is each child's own derivation rather than a column, summed
+    # like the rest: asking the children keeps the group's answer the one they
+    # gave, where re-deriving it here from the two halves above would be a
+    # second way to reach the same figure.
     ROLLED_UP_TOTALS = %i[
       total item_total delivery_total additional_tax_total included_tax_total
-      discount_total fee_total
+      tax_total discount_total fee_total
     ].freeze
 
     ROLLED_UP_TOTALS.each do |figure|
@@ -112,7 +117,7 @@ module Spree
     end
 
     money_methods(*ROLLED_UP_TOTALS)
-    money_methods :gift_card_total
+    money_methods :gift_card_total, :amount_due
 
     alias ship_total delivery_total
 

data/app/models/spree/package_type.rb

@@ -94,6 +94,7 @@ module Spree
     # `seller_id` is what the operator's list filters by to see one seller's
     # packaging, or (blank) the marketplace's own.
     self.whitelisted_ransackable_attributes = %w[name kind default seller_id]
+    search_by :name
     self.whitelisted_ransackable_associations = %w[seller]
 
     # The unit the geometry is expressed in, falling back to what the store's

data/app/models/spree/payment/gateway_options.rb

@@ -67,7 +67,7 @@ module Spree
       private
 
       def exchange_multiplier
-        payment.payment_method.try(:exchange_multiplier) || 1.0
+        payment.payment_method.try(:exchange_multiplier) || 1
       end
     end
   end

data/app/models/spree/payment.rb

@@ -6,6 +6,9 @@ module Spree
     derives_number infix: 'P'
     include Spree::HasCustomFields
     include Spree::Metadata
+    include Spree::CanonicalDecimals
+
+    canonical_decimals :amount
     if defined?(Spree::Security::Payments)
       include Spree::Security::Payments
     end
@@ -255,16 +258,6 @@ module Spree
       end
     end
 
-    def amount=(amount)
-      self[:amount] =
-        case amount
-        when String
-          separator = I18n.t('number.currency.format.separator')
-          number    = amount.delete("^0-9-#{separator}\.").tr(separator, '.')
-          number.to_d if number.present?
-        end || amount
-    end
-
     # Resizes a store credit payment that has not been taken yet. Completion
     # takes it against the eligibility event recorded for its amount, so the
     # new amount needs one of its own.

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

@@ -1,5 +1,7 @@
 module Spree
   class PaymentMethod::Check < ::Spree::PaymentMethod
+    self.accepts_money_amounts = true
+
     def actions
       %w{capture void}
     end

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

@@ -1,5 +1,7 @@
 module Spree
   class PaymentMethod::StoreCredit < ::Spree::PaymentMethod
+    self.accepts_money_amounts = true
+
     def payment_source_class
       ::Spree::StoreCredit
     end
@@ -20,13 +22,13 @@ module Spree
       payment.pending?
     end
 
-    def authorize(amount_in_cents, store_credit, gateway_options = {})
+    def authorize(money, store_credit, gateway_options = {})
       if store_credit.nil?
         Spree::PaymentResponse.new(false, I18n.t('spree.store_credit_payment_method.unable_to_find'), {}, {})
       else
         action = lambda do |store_credit|
           store_credit.authorize(
-            amount_in_cents / 100.0.to_d,
+            money.to_d,
             gateway_options[:currency],
             action_originator: gateway_options[:originator]
           )
@@ -35,10 +37,10 @@ module Spree
       end
     end
 
-    def capture(amount_in_cents, auth_code, gateway_options = {})
+    def capture(money, auth_code, gateway_options = {})
       action = lambda do |store_credit|
         store_credit.capture(
-          amount_in_cents / 100.0.to_d,
+          money.to_d,
           auth_code,
           gateway_options[:currency],
           action_originator: gateway_options[:originator]
@@ -47,9 +49,9 @@ module Spree
       handle_action(action, :capture, auth_code)
     end
 
-    def purchase(amount_in_cents, store_credit, gateway_options = {})
+    def purchase(money, store_credit, gateway_options = {})
       eligible_events = store_credit.store_credit_events.where(
-        amount: amount_in_cents / 100.0.to_d,
+        amount: money.to_d,
         action: Spree::StoreCredit::ELIGIBLE_ACTION
       )
       event = eligible_events.detect do |eligible_event|
@@ -60,7 +62,7 @@ module Spree
       if event.blank?
         Spree::PaymentResponse.new(false, I18n.t('spree.store_credit_payment_method.unable_to_find'), {}, {})
       else
-        capture(amount_in_cents, event.authorization_code, gateway_options)
+        capture(money, event.authorization_code, gateway_options)
       end
     end
 
@@ -71,12 +73,12 @@ module Spree
       handle_action(action, :void, auth_code)
     end
 
-    def credit(amount_in_cents, auth_code, gateway_options)
+    def credit(money, auth_code, gateway_options)
       action = lambda do |store_credit|
         currency = gateway_options[:currency] || store_credit.currency
         originator = gateway_options[:originator]
 
-        store_credit.credit(amount_in_cents / 100.0.to_d, auth_code, currency, action_originator: originator)
+        store_credit.credit(money.to_d, auth_code, currency, action_originator: originator)
       end
 
       handle_action(action, :credit, auth_code)

data/app/models/spree/payment_method.rb

@@ -20,6 +20,13 @@ module Spree
       include Spree::Security::PaymentMethods
     end
 
+    # Whether authorize, purchase, capture and credit take the amount as a
+    # Spree::Money (amount and currency) and convert it to the provider's own
+    # unit. Methods that have not opted in receive an integer in hundredths of
+    # the currency, which is wrong for yen and dinar; that bridge is removed in
+    # Spree 6.1.
+    class_attribute :accepts_money_amounts, default: false, instance_writer: false
+
     # Blank falls back to the store, so a method only overrides when a merchant
     # deliberately picks one — the meaning the auto_capture boolean already had.
     normalizes :capture_method, with: ->(value) { value.presence }
@@ -48,8 +55,9 @@ module Spree
     scope :storefront_visible, -> { where(storefront_visible: true) }
     scope :admin_only, -> { where(storefront_visible: false) }
 
-    # Real column, so admin clients filter it directly — no ransacker needed.
-    self.whitelisted_ransackable_attributes = %w[storefront_visible]
+    # Real columns, so admin clients filter them directly — no ransacker needed.
+    self.whitelisted_ransackable_attributes = %w[storefront_visible active type]
+    search_by :name
 
     after_initialize :set_name, if: :new_record?
 
@@ -339,6 +347,27 @@ module Spree
       self.storefront_visible = value.to_s != 'back_end'
     end
 
+
+    # The amount in the form this payment method's gateway calls take.
+    #
+    # @param amount [BigDecimal] in the currency's own units ("19.99")
+    # @param currency [String]
+    # @return [Spree::Money, Integer] a Spree::Money for methods that accept
+    #   money amounts, otherwise hundredths of the currency (deprecated)
+    def gateway_amount(amount, currency)
+      return Spree::Money.new(amount, currency: currency) if accepts_money_amounts
+
+      warn_about_hundredths
+      hundredths = Spree::Money::Rounding.to_hundredths(amount)
+      # A hundredth is the smallest amount these gateways can be sent; zero
+      # reads as "the whole amount" to many of them.
+      if hundredths.zero? && !amount.zero?
+        raise Spree::Core::GatewayError, "#{self.class.name} cannot take an amount below a hundredth of #{currency}"
+      end
+
+      hundredths
+    end
+
     protected
 
     def public_preference_keys
@@ -348,5 +377,16 @@ module Spree
     def set_name
       self.name ||= default_name
     end
+
+    def warn_about_hundredths
+      return if self.class.instance_variable_get(:@warned_about_hundredths)
+
+      self.class.instance_variable_set(:@warned_about_hundredths, true)
+      Spree::Deprecation.warn(
+        "#{self.class.name} receives amounts as an integer in hundredths, which is wrong for currencies " \
+        'without two decimals. Set `self.accepts_money_amounts = true` and take a Spree::Money ' \
+        '(amount and currency); hundredths are removed in Spree 6.1.'
+      )
+    end
   end
 end

data/app/models/spree/policy.rb

@@ -62,6 +62,7 @@ module Spree
     #  Ransack
     #
     self.whitelisted_ransackable_attributes = %w[name owner_type owner_id]
+    search_by :name
 
     before_destroy :really_destroy_slugs!
 

data/app/models/spree/price.rb

@@ -11,12 +11,16 @@ module Spree
 
     include Spree::VatPriceCalculation
     include Spree::StorePreferences
+    include Spree::CanonicalDecimals
+
+    canonical_decimals :amount, :compare_at_amount, places: Spree::Money::Rounding::UNIT_PRICE_DECIMALS
 
     publishes_lifecycle_events
 
     acts_as_paranoid
 
-    MAXIMUM_AMOUNT = BigDecimal('99_999_999.99')
+    # The largest amount decimal(19,4) holds.
+    MAXIMUM_AMOUNT = BigDecimal('999_999_999_999_999.9999')
 
     # How many breaks one variant may carry on one list in one currency. A UI
     # sanity bound rather than a technical one — but enforced here so no
@@ -24,7 +28,7 @@ module Spree
     # every priced line (docs/plans/6.0-volume-pricing.md).
     MAXIMUM_BREAKS_PER_VARIANT = 10
 
-    belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant', inverse_of: :prices, touch: true
+    belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant', inverse_of: :prices
     belongs_to :price_list, class_name: 'Spree::PriceList', optional: true
 
     has_many :price_histories, class_name: 'Spree::PriceHistory', dependent: :delete_all
@@ -32,6 +36,8 @@ module Spree
     before_validation :ensure_currency
     before_save :remove_compare_at_amount_if_equals_amount
     after_save :record_price_history, if: :should_record_price_history?
+    after_save :touch_variant, if: -> { saved_changes? && (amount.present? || amount_before_last_save.present?) }
+    after_destroy :touch_variant, if: -> { amount.present? }
 
     # legacy behavior
     validates :amount, allow_nil: true, numericality: {
@@ -100,10 +106,6 @@ module Spree
       Spree::Money.new(amount || 0, currency: currency.upcase)
     end
 
-    def amount=(amount)
-      self[:amount] = amount.blank? ? nil : Spree::LocalizedNumber.parse(amount)
-    end
-
     # Returns the amount in cents
     # @return [Integer]
     def amount_in_cents
@@ -114,12 +116,6 @@ module Spree
       Spree::Money.new(compare_at_amount || 0, currency: currency)
     end
 
-    def compare_at_amount=(value)
-      calculated_value = Spree::LocalizedNumber.parse(value) if value.present?
-
-      self[:compare_at_amount] = calculated_value
-    end
-
     # Returns the compare at amount for display
     # @return [Spree::Money, nil]
     def display_compare_at_amount
@@ -137,9 +133,7 @@ module Spree
     end
 
     alias_attribute :price, :amount
-    alias_method :price=, :amount=
     alias_attribute :compare_at_price, :compare_at_amount
-    alias_method :compare_at_price=, :compare_at_amount=
 
     # Whether this figure is the merchant's answer for the buyer's geography
     # already. A price list narrowed by market or country states its prices for
@@ -342,6 +336,15 @@ module Spree
       rungs.sort_by(&:first)
     end
 
+    # Stands in for `touch: true` on the variant, skipping placeholder rows: a
+    # price list holds one without an amount for every variant and currency
+    # nobody has priced yet, and it charges nothing, so writing one changes no
+    # price a shopper sees — yet the touch would expire the product's cached
+    # responses and reindex it for search.
+    def touch_variant
+      variant&.touch_later
+    end
+
     def should_record_price_history?
       price_list_id.nil? &&
         amount.present? &&

data/app/models/spree/price_adjustment_tier.rb

@@ -10,6 +10,10 @@ module Spree
   # and not twenty percent off an already-discounted number
   # (docs/plans/6.0-volume-pricing.md).
   class PriceAdjustmentTier < Spree.base_class
+    include Spree::CanonicalDecimals
+
+    canonical_decimals :percentage, places: 3
+
     has_prefix_id :pat
 
     # How many bands one list may carry, matching the break cap so a merchant