solidus_core 2.11.10 → 3.3.1

data/app/models/spree/variant/price_selector.rb

@@ -26,11 +26,41 @@ module Spree
       # @param [Spree::Variant::PricingOptions] price_options Pricing Options to abide by
       # @return [Spree::Money, nil] The most specific price for this set of pricing options.
       def price_for(price_options)
-        variant.currently_valid_prices.detect do |price|
-          ( price.country_iso == price_options.desired_attributes[:country_iso] ||
-            price.country_iso.nil?
+        Spree::Deprecation.warn(
+          "price_for is deprecated and will be removed. The price_for method
+          should return a Spree::Price as described. Please use
+          #price_for_options and adjust your frontend code to explicitly call
+          &.money where required"
+        )
+        price_for_options(price_options)&.money
+      end
+
+      # The variant's Spree::Price record, given a set of pricing options
+      # @param [Spree::Variant::PricingOptions] price_options Pricing Options to abide by
+      # @return [Spree::Price, nil] The most specific price for this set of pricing options.
+      def price_for_options(price_options)
+        sorted_prices_for(variant).detect do |price|
+          (price.country_iso == price_options.desired_attributes[:country_iso] ||
+           price.country_iso.nil?
           ) && price.currency == price_options.desired_attributes[:currency]
-        end.try!(:money)
+        end
+      end
+
+      private
+
+      # Returns `#prices` prioritized for being considered as default price
+      #
+      # @return [Array<Spree::Price>]
+      def sorted_prices_for(variant)
+        variant.prices.select do |price|
+          variant.discarded? || price.kept?
+        end.sort_by do |price|
+          [
+            price.country_iso.nil? ? 0 : 1,
+            price.updated_at || Time.zone.now,
+            price.id || Float::INFINITY,
+          ]
+        end.reverse
       end
     end
   end

data/app/models/spree/variant.rb

@@ -23,20 +23,21 @@ module Spree
     after_discard do
       stock_items.discard_all
       images.destroy_all
-      prices.discard_all
-      currently_valid_prices.discard_all
     end
 
     attr_writer :rebuild_vat_prices
     include Spree::DefaultPrice
 
-    belongs_to :product, -> { with_discarded }, touch: true, class_name: 'Spree::Product', inverse_of: :variants, optional: false
+    belongs_to :product, -> { with_discarded }, touch: true, class_name: 'Spree::Product', inverse_of: :variants_including_master, optional: false
     belongs_to :tax_category, class_name: 'Spree::TaxCategory', optional: true
+    belongs_to :shipping_category, class_name: "Spree::ShippingCategory", optional: true
 
     delegate :name, :description, :slug, :available_on, :discontinue_on, :discontinued?,
-             :shipping_category_id, :meta_description, :meta_keywords, :shipping_category,
+             :meta_description, :meta_keywords,
              to: :product
     delegate :tax_category, to: :product, prefix: true
+    delegate :shipping_category, :shipping_category_id,
+      to: :product, prefix: true
     delegate :tax_rates, to: :tax_category
 
     has_many :inventory_units, inverse_of: :variant
@@ -53,13 +54,7 @@ module Spree
     has_many :images, -> { order(:position) }, as: :viewable, dependent: :destroy, class_name: "Spree::Image"
 
     has_many :prices,
-      class_name: 'Spree::Price',
-      dependent: :destroy,
-      inverse_of: :variant,
-      autosave: true
-
-    has_many :currently_valid_prices,
-      -> { currently_valid },
+      -> { with_discarded },
       class_name: 'Spree::Price',
       dependent: :destroy,
       inverse_of: :variant,
@@ -74,7 +69,7 @@ module Spree
 
     validates :cost_price, numericality: { greater_than_or_equal_to: 0, allow_nil: true }
     validates :price,      numericality: { greater_than_or_equal_to: 0, allow_nil: true }
-    validates_uniqueness_of :sku, allow_blank: true, case_sensitive: true, if: :enforce_unique_sku?
+    validates_uniqueness_of :sku, allow_blank: true, case_sensitive: true, conditions: -> { where(deleted_at: nil) }, if: :enforce_unique_sku?
 
     after_create :create_stock_items
     after_create :set_position
@@ -83,7 +78,7 @@ module Spree
     after_save :clear_in_stock_cache
     after_touch :clear_in_stock_cache
 
-    after_real_destroy :destroy_option_values_variants
+    after_destroy :destroy_option_values_variants
 
     # Returns variants that are in stock. When stock locations are provided as
     # a parameter, the scope is limited to variants that are in stock in the
@@ -118,19 +113,8 @@ module Spree
       joins(:stock_items).where(arel_conditions.inject(:or)).distinct
     end
 
-    self.whitelisted_ransackable_associations = %w[option_values product prices default_price]
-    self.whitelisted_ransackable_attributes = %w[weight sku]
-
-    # Returns variants that are not deleted and have a price in the given
-    # currency.
-    #
-    # @deprecated Please use the .with_prices scope instead
-    # @param currency [String] the currency to filter by; defaults to Spree's default
-    # @return [ActiveRecord::Relation]
-    def self.active(currency = nil)
-      Spree::Deprecation.warn("`Variant.active(currency)` is deprecated. Please use `Variant.with_prices(pricing_options)` instead.", caller)
-      joins(:prices).where(deleted_at: nil).where('spree_prices.currency' => currency || Spree::Config[:currency]).where('spree_prices.amount IS NOT NULL')
-    end
+    self.allowed_ransackable_associations = %w[option_values product prices default_price]
+    self.allowed_ransackable_attributes = %w[weight sku]
 
     # Returns variants that have a price for the given pricing options
     # If you have modified the pricing options class, you might want to modify this scope too.
@@ -161,6 +145,23 @@ module Spree
       super || product_tax_category
     end
 
+    # @return [Spree::ShippingCategory] the variant's shipping category
+    #
+    # This returns the product's shipping category if the shipping category ID on the variant is nil. It looks
+    # like an association, but really is an override.
+    #
+    def shipping_category
+      super || product_shipping_category
+    end
+
+    # @return [Integer] the variant's shipping category id
+    #
+    # This returns the product's shipping category if if the shipping category ID on the variant is nil.
+    #
+    def shipping_category_id
+      super || product_shipping_category_id
+    end
+
     # Sets the cost_price for the variant.
     #
     # @param price [Any] the price to set
@@ -229,8 +230,8 @@ module Spree
 
     # Assign given options hash to option values.
     #
-    # @param options [Array] array of hashes with a name and value.
-    def options=(options = {})
+    # @param options [Array<Hash{name: String, value: String}>] array of hashes with a name and value.
+    def options=(options = [])
       options.each do |option|
         set_option_value(option[:name], option[:value])
       end
@@ -287,16 +288,17 @@ module Spree
     end
 
     # Chooses an appropriate price for the given pricing options
+    # This has been deprecated in favor of #price_for_options.
     #
-    # @see Spree::Variant::PriceSelector#price_for
+    # @see Spree::Variant::PriceSelector#price_for_options
     delegate :price_for, to: :price_selector
 
     # Returns the difference in price from the master variant
     def price_difference_from_master(pricing_options = Spree::Config.default_pricing_options)
-      master_price = product.master.price_for(pricing_options)
-      variant_price = price_for(pricing_options)
+      master_price = product.master.price_for_options(pricing_options)
+      variant_price = price_for_options(pricing_options)
       return unless master_price && variant_price
-      variant_price - master_price
+      Spree::Money.new(variant_price.amount - master_price.amount, currency: pricing_options.currency)
     end
 
     def price_same_as_master?(pricing_options = Spree::Config.default_pricing_options)
@@ -304,25 +306,16 @@ module Spree
       diff && diff.zero?
     end
 
-    # Converts the variant's price to the given currency.
-    #
-    # @deprecated Please use #price_for(pricing_options) instead
-    # @param currency [String] the desired currency
-    # @return [Spree::Price] the price in the desired currency
-    def price_in(currency)
-      prices.currently_valid.find_by(currency: currency)
-    end
-    deprecate price_in: :price_for, deprecator: Spree::Deprecation
+    def price_for_options(price_options)
+      if price_selector.respond_to?(:price_for_options)
+        price_selector.price_for_options(price_options)
+      else
+        money = price_for(price_options)
+        return if money.nil?
 
-    # Fetches the price amount in the specified currency.
-    #
-    # @deprecated Please use #price_for instead and use a money object rathern than a BigDecimal.
-    # @param currency (see #price)
-    # @return [Float] the amount in the specified currency.
-    def amount_in(currency)
-      price_in(currency).try(:amount)
+        Spree::Price.new(amount: money.to_d, variant: self, currency: price_options.currency)
+      end
     end
-    deprecate amount_in: :price_for, deprecator: Spree::Deprecation
 
     # Generates a friendly name and sku string.
     #
@@ -346,16 +339,22 @@ module Spree
     end
 
     # @param quantity [Fixnum] how many are desired
+    # @param stock_location [Spree::StockLocation] Optionally restrict stock
+    #   quantity check to a specific stock location. If unspecified it will
+    #   check inventory in all available StockLocations.
     # @return [Boolean] true if the desired quantity can be supplied
-    def can_supply?(quantity = 1)
-      Spree::Stock::Quantifier.new(self).can_supply?(quantity)
+    def can_supply?(quantity = 1, stock_location = nil)
+      Spree::Stock::Quantifier.new(self, stock_location).can_supply?(quantity)
     end
 
     # Fetches the on-hand quantity of the variant.
     #
+    # @param stock_location [Spree::StockLocation] Optionally restrict stock
+    #   quantity check to a specific stock location. If unspecified it will
+    #   check inventory in all available StockLocations.
     # @return [Fixnum] the number currently on-hand
-    def total_on_hand
-      Spree::Stock::Quantifier.new(self).total_on_hand
+    def total_on_hand(stock_location = nil)
+      Spree::Stock::Quantifier.new(self, stock_location).total_on_hand
     end
 
     # Shortcut method to determine if inventory tracking is enabled for this
@@ -367,19 +366,6 @@ module Spree
       track_inventory? && Spree::Config.track_inventory_levels
     end
 
-    # Image that can be used for the variant.
-    #
-    # Will first search for images on the variant. If it doesn't find any,
-    # it'll fallback to any variant image (unless +fallback+ is +false+) or to
-    # a new {Spree::Image}.
-    # @param fallback [Boolean] whether or not we should fallback to an image
-    #   not from this variant
-    # @return [Spree::Image] the image to display
-    def display_image(fallback: true)
-      Spree::Deprecation.warn('Spree::Variant#display_image is DEPRECATED. Choose an image from Spree::Variant#gallery instead')
-      images.first || (fallback && product.variant_images.first) || Spree::Image.new
-    end
-
     # Determines the variant's property values by verifying which of the product's
     # variant property rules apply to itself.
     #

data/app/models/spree/zone.rb

@@ -42,7 +42,7 @@ module Spree
     alias :members :zone_members
     accepts_nested_attributes_for :zone_members, allow_destroy: true, reject_if: proc { |member| member['zoneable_id'].blank? }
 
-    self.whitelisted_ransackable_attributes = %w[name description]
+    self.allowed_ransackable_attributes = %w[name description]
 
     # Returns all zones that contain any of the zone members of the zone passed
     # in. This also includes any country zones that contain the state of the

data/app/subscribers/spree/mailer_subscriber.rb

@@ -3,6 +3,10 @@
 require 'spree/event/subscriber'
 
 module Spree
+  # Legacy subscriber
+  #
+  # This subscriber module is used by the legacy pub/sub system (see
+  # {Spree::Event}).
   module MailerSubscriber
     include Spree::Event::Subscriber
 

data/app/subscribers/spree/order_mailer_subscriber.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spree
+  # Mailing after events on a {Spree::Order}
+  class OrderMailerSubscriber
+    include Omnes::Subscriber
+
+    handle :order_finalized,
+           with: :send_confirmation_email,
+           id: :spree_order_mailer_send_confirmation_email
+
+    handle :reimbursement_reimbursed,
+           with: :send_reimbursement_email,
+           id: :spree_order_mailer_send_reimbursement_email
+
+    # Sends confirmation email to the user
+    #
+    # @param event [Omnes::UnstructuredEvent]
+    def send_confirmation_email(event)
+      order = event[:order]
+      unless order.confirmation_delivered?
+        Spree::Config.order_mailer_class.confirm_email(order).deliver_later
+        order.update_column(:confirmation_delivered, true)
+      end
+    end
+
+    # Sends reimbursement email to the user
+    #
+    # @param event [Omnes::UnstructuredEvent]
+    def send_reimbursement_email(event)
+      reimbursement = event[:reimbursement]
+      Spree::Config.reimbursement_mailer_class.reimbursement_email(reimbursement.id).deliver_later
+    end
+  end
+end

data/config/i18n-tasks.yml

@@ -0,0 +1,134 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `File.find` patterns where translations are read from:
+  read:
+    ## Default:
+    # - config/locales/%{locale}.yml
+    ## More files:
+    # - config/locales/**/*.%{locale}.yml
+
+  # 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
+  write:
+    ## For example, write devise and simple form keys to their respective files:
+    # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+
+  # External locale data (e.g. gems).
+  # This data is not considered unused and is never written to.
+  external:
+    ## Example (replace %#= with %=):
+    # - "<%#= %x[bundle info vagrant --path].chomp %>/templates/locales/%{locale}.yml"
+
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: conservative_router
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/mailers
+  #   - app/presenters
+  #   - app/views
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+    - app/assets/videos
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # only: ["*.rb", "*.html.slim"]
+
+  ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
+  # strict: true
+
+  ## Multiple scanners can be used. Their results are merged.
+  ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
+  ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
+
+## Translation Services
+# translation:
+#   # Google Translate
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   google_translate_api_key: "AbC-dEf5"
+#   # DeepL Pro Translate
+#   # Get an API key and subscription at https://www.deepl.com/pro to use DeepL Pro
+#   deepl_api_key: "48E92789-57A3-466A-9959-1A1A1A1A1A1A"
+
+## Do not consider these keys missing:
+ignore_missing:
+  - 'number.currency.format.separator'
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## 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}.:'
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Exclude these keys from the `i18n-tasks check-consistent-interpolations` report:
+# ignore_inconsistent_interpolations:
+# - 'activerecord.attributes.*'
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*
+
+## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
+## e.g. in case of a relative key defined in a helper method.
+## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
+#
+# <%# 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}']] %>