solidus_core 2.10.0 → 2.11.0

data/app/models/spree/address/state_validator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Spree
+  class Address::StateValidator
+    attr_reader :address
+    delegate :state, :state_name, :country, to: :address
+
+    def initialize(address)
+      @address = address
+    end
+
+    def perform
+      return unless state_required?
+
+      if country.present?
+        normalize_state if state.present?
+        normalize_state_name if state_name.present?
+      end
+
+      validate_not_blank
+      validate_matches_country
+    end
+
+    private
+
+    def normalize_state
+      # discard the 'state' attribute when having a country with no states
+      address.state = nil if country.states.blank?
+    end
+
+    def normalize_state_name
+      # discard the 'state_name' when having a valid 'state' and country combo
+      if state.present? && state.country == country
+        address.state_name = nil
+        return
+      end
+
+      # set the state from the state name if the country contains one with that name
+      states_from_name = country.states.with_name_or_abbr(state_name)
+      if states_from_name.size == 1
+        address.state = states_from_name.first
+        address.state_name = nil
+      end
+    end
+
+    def validate_not_blank
+      if state.blank? && state_name.blank?
+        address.errors.add(:state, :blank)
+      end
+    end
+
+    def validate_matches_country
+      if state.present? && state.country != country
+        address.errors.add(:state, :does_not_match_country)
+      end
+    end
+
+    # Don't require a state if disabled at config level or
+    # the associated country doesn't require states
+    def state_required?
+      Spree::Config.address_requires_state && country_requires_states?
+    end
+
+    def country_requires_states?
+      # default to `true` if country not present
+      return true if country.blank?
+
+      country.states_required
+    end
+  end
+end

data/app/models/spree/address.rb

@@ -8,21 +8,39 @@ module Spree
   class Address < Spree::Base
     extend ActiveModel::ForbiddenAttributesProtection
 
+    mattr_accessor :state_validator_class
+    self.state_validator_class = Spree::Address::StateValidator
+
     belongs_to :country, class_name: "Spree::Country", optional: true
     belongs_to :state, class_name: "Spree::State", optional: true
 
-    validates :firstname, :address1, :city, :country_id, presence: true
+    validates :address1, :city, :country_id, presence: true
     validates :zipcode, presence: true, if: :require_zipcode?
     validates :phone, presence: true, if: :require_phone?
 
-    validate :state_validate
-    validate :validate_state_matches_country
+    validate :validate_name
+
+    validate do
+      if Spree::Config.use_legacy_address_state_validator
+        begin
+          @silence_state_deprecations = true
+          state_validate
+          validate_state_matches_country
+        ensure
+          @silence_state_deprecations = false
+        end
+      else
+        self.class.state_validator_class.new(self).perform
+      end
+    end
 
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
+    alias_attribute :full_name, :name
 
     DB_ONLY_ATTRS = %w(id updated_at created_at)
     TAXATION_ATTRS = %w(state_id country_id zipcode)
+    LEGACY_NAME_ATTRS = %w(firstname lastname full_name)
 
     self.whitelisted_ransackable_attributes = %w[firstname lastname]
 
@@ -30,6 +48,11 @@ module Spree
       where(value_attributes(attributes))
     end
 
+    Spree::Deprecation.deprecate_methods(
+      Spree::Address,
+      LEGACY_NAME_ATTRS.product([:name]).to_h
+    )
+
     # @return [Address] an address with default attributes
     def self.build_default(*args, &block)
       where(country: Spree::Country.default).build(*args, &block)
@@ -62,10 +85,13 @@ module Spree
     def self.value_attributes(base_attributes, merge_attributes = {})
       base = base_attributes.stringify_keys.merge(merge_attributes.stringify_keys)
 
-      # TODO: Deprecate these aliased attributes
-      base['firstname'] = base['first_name'] if base.key?('first_name')
-      base['lastname'] = base['last_name'] if base.key?('last_name')
-
+      name_from_attributes = Spree::Address::Name.from_attributes(base)
+      if base['firstname'].presence || base['first_name'].presence
+        base['firstname'] = name_from_attributes.first_name
+      end
+      if base['lastname'].presence || base['last_name'].presence
+        base['lastname'] = name_from_attributes.last_name
+      end
       excluded_attributes = DB_ONLY_ATTRS + %w(first_name last_name)
 
       base.except(*excluded_attributes)
@@ -80,18 +106,13 @@ module Spree
       self.class.value_attributes(attributes.slice(*TAXATION_ATTRS))
     end
 
-    # @return [String] the full name on this address
-    def full_name
-      "#{firstname} #{lastname}".strip
-    end
-
     # @return [String] a string representation of this state
     def state_text
       state.try(:abbr) || state.try(:name) || state_name
     end
 
     def to_s
-      "#{full_name}: #{address1}"
+      "#{name}: #{address1}"
     end
 
     # @note This compares the addresses based on only the fields that make up
@@ -130,7 +151,7 @@ module Spree
     # @return [Hash] an ActiveMerchant compatible address hash
     def active_merchant_hash
       {
-        name: full_name,
+        name: name,
         address1: address1,
         address2: address2,
         city: city,
@@ -143,13 +164,13 @@ module Spree
 
     # @todo Remove this from the public API if possible.
     # @return [true] whether or not the address requires a phone number to be
-    #   valid
+    #   present
     def require_phone?
-      true
+      Spree::Config[:address_requires_phone]
     end
 
     # @todo Remove this from the public API if possible.
-    # @return [true] whether or not the address requires a zipcode to be valid
+    # @return [true] whether or not the address requires a zipcode to be present
     def require_zipcode?
       true
     end
@@ -172,9 +193,54 @@ module Spree
       country && country.iso
     end
 
+    # @return [String] the full name on this address
+    def name
+      Spree::Address::Name.new(
+        read_attribute(:firstname),
+        read_attribute(:lastname)
+      ).value
+    end
+
+    def name=(value)
+      return if value.nil?
+
+      name_from_value = Spree::Address::Name.new(value)
+      write_attribute(:firstname, name_from_value.first_name)
+      write_attribute(:lastname, name_from_value.last_name)
+    end
+
+    def as_json(options = {})
+      if Spree::Config.use_combined_first_and_last_name_in_address
+        super(options.merge(except: LEGACY_NAME_ATTRS)).tap do |hash|
+          hash['name'] = name
+        end
+      else
+        super
+      end
+    end
+
     private
 
+    def validate_name
+      return if name.present?
+
+      name_attribute = if Spree::Config.use_combined_first_and_last_name_in_address
+        :name
+      else
+        :firstname
+      end
+      errors.add(name_attribute, :blank)
+    end
+
     def state_validate
+      unless @silence_state_deprecations
+        Spree::Deprecation.warn \
+          "#{self.class}#state_validate private method has been deprecated" \
+          " and will be removed in Solidus v3." \
+          " Check https://github.com/solidusio/solidus/pull/3129 for more details.",
+          caller
+      end
+
       # Skip state validation without country (also required)
       # or when disabled by preference
       return if country.blank? || !Spree::Config[:address_requires_state]
@@ -210,6 +276,17 @@ module Spree
     end
 
     def validate_state_matches_country
+      unless @silence_state_deprecations
+        Spree::Deprecation.warn \
+          "#{self.class}#validate_state_matches_country private method has been deprecated" \
+          " and will be removed in Solidus v3." \
+          " Check https://github.com/solidusio/solidus/pull/3129 for more details.",
+          caller
+      end
+
+      return unless country
+
+      self.state = nil if country.states.empty?
       if state && state.country != country
         errors.add(:state, :does_not_match_country)
       end

data/app/models/spree/adjustment.rb

@@ -159,7 +159,7 @@ module Spree
     private
 
     def require_promotion_code?
-      promotion? && source.promotion.codes.any?
+      promotion? && !source.promotion.apply_automatically && source.promotion.codes.any?
     end
 
     def repair_adjustments_associations_on_create

data/app/models/spree/base.rb

@@ -2,6 +2,7 @@
 
 class Spree::Base < ActiveRecord::Base
   include Spree::Preferences::Preferable
+  include Spree::Core::Permalinks
   serialize :preferences, Hash
 
   include Spree::RansackableAttributes

data/app/models/spree/calculator/default_tax.rb

@@ -54,7 +54,7 @@ module Spree
     end
 
     def sum_of_included_tax_rates(item)
-      rates_for_item(item).map(&:amount).sum
+      rates_for_item(item).sum(&:amount)
     end
   end
 end

data/app/models/spree/calculator/percent_per_item.rb

@@ -16,9 +16,9 @@ module Spree
 
     def compute(object = nil)
       return 0 if object.nil?
-      object.line_items.map { |line_item|
+      object.line_items.sum { |line_item|
         value_for_line_item(line_item)
-      }.sum
+      }
     end
 
     private
@@ -28,9 +28,9 @@ module Spree
     # Copied from per_item.rb
     def matching_products
       if compute_on_promotion?
-        calculable.promotion.rules.map do |rule|
+        calculable.promotion.rules.flat_map do |rule|
           rule.respond_to?(:products) ? rule.products : []
-        end.flatten
+        end
       end
     end
 

data/app/models/spree/calculator/price_sack.rb

@@ -12,7 +12,7 @@ module Spree
     # as object we always get line items, as calculable we have Coupon, ShippingMethod
     def compute(object)
       if object.is_a?(Array)
-        base = object.map { |element| element.respond_to?(:amount) ? element.amount : BigDecimal(element.to_s) }.sum
+        base = object.sum { |element| element.respond_to?(:amount) ? element.amount : BigDecimal(element.to_s) }
       else
         base = object.respond_to?(:amount) ? object.amount : BigDecimal(object.to_s)
       end

data/app/models/spree/credit_card.rb

@@ -163,7 +163,7 @@ module Spree
     #   the object to ActiveMerchant.
     # @return [String] the first name on this credit card
     def first_name
-      name.to_s.split(/[[:space:]]/, 2)[0]
+      Spree::Address::Name.new(name).first_name
     end
 
     # @note ActiveMerchant needs first_name/last_name because we pass it a
@@ -172,7 +172,7 @@ module Spree
     #   the object to ActiveMerchant.
     # @return [String] the last name on this credit card
     def last_name
-      name.to_s.split(/[[:space:]]/, 2)[1]
+      Spree::Address::Name.new(name).last_name
     end
 
     # @return [ActiveMerchant::Billing::CreditCard] an ActiveMerchant credit

data/app/models/spree/customer_return.rb

@@ -17,6 +17,8 @@ module Spree
 
     accepts_nested_attributes_for :return_items
 
+    self.whitelisted_ransackable_attributes = ['number']
+
     extend DisplayMoney
     money_methods :pre_tax_total, :total, :total_excluding_vat, :amount
     deprecate display_pre_tax_total: :display_total_excluding_vat, deprecator: Spree::Deprecation
@@ -25,11 +27,11 @@ module Spree
     delegate :id, to: :order, prefix: true, allow_nil: true
 
     def total
-      return_items.map(&:total).sum
+      return_items.sum(&:total)
     end
 
     def total_excluding_vat
-      return_items.map(&:total_excluding_vat).sum
+      return_items.sum(&:total_excluding_vat)
     end
     alias pre_tax_total total_excluding_vat
     deprecate pre_tax_total: :total_excluding_vat, deprecator: Spree::Deprecation

data/app/models/spree/exchange.rb

@@ -17,7 +17,7 @@ module Spree
     end
 
     def display_amount
-      Spree::Money.new @reimbursement_objects.map(&:total).sum
+      Spree::Money.new @reimbursement_objects.sum(&:total)
     end
 
     def perform!

data/app/models/spree/image/active_storage_attachment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Spree::Image::ActiveStorageAttachment
+  extend ActiveSupport::Concern
+  include Spree::ActiveStorageAdapter
+
+  delegate :width, :height, to: :attachment, prefix: true
+
+  included do
+    has_attachment :attachment,
+                   styles: {
+                   mini: '48x48>',
+                   small: '400x400>',
+                   product: '680x680>',
+                   large: '1200x1200>'
+                 },
+                 default_style: :product
+    validates :attachment, presence: true
+    validate :attachment_is_an_image
+  end
+end

data/app/models/spree/inventory_unit.rb

@@ -8,7 +8,7 @@ module Spree
     POST_SHIPMENT_STATES = %w(returned)
     CANCELABLE_STATES = ['on_hand', 'backordered', 'shipped']
 
-    belongs_to :variant, -> { with_deleted }, class_name: "Spree::Variant", inverse_of: :inventory_units, optional: true
+    belongs_to :variant, -> { with_discarded }, class_name: "Spree::Variant", inverse_of: :inventory_units, optional: true
     belongs_to :shipment, class_name: "Spree::Shipment", touch: true, inverse_of: :inventory_units, optional: true
     belongs_to :carton, class_name: "Spree::Carton", inverse_of: :inventory_units, optional: true
     belongs_to :line_item, class_name: "Spree::LineItem", inverse_of: :inventory_units, optional: true

data/app/models/spree/line_item.rb

@@ -13,7 +13,7 @@ module Spree
     class CurrencyMismatch < StandardError; end
 
     belongs_to :order, class_name: "Spree::Order", inverse_of: :line_items, touch: true, optional: true
-    belongs_to :variant, -> { with_deleted }, class_name: "Spree::Variant", inverse_of: :line_items, optional: true
+    belongs_to :variant, -> { with_discarded }, class_name: "Spree::Variant", inverse_of: :line_items, optional: true
     belongs_to :tax_category, class_name: "Spree::TaxCategory", optional: true
 
     has_one :product, through: :variant
@@ -33,6 +33,7 @@ module Spree
       greater_than: -1
     }
     validates :price, numericality: true
+    validate :price_match_order_currency
 
     after_save :update_inventory
 
@@ -42,7 +43,7 @@ module Spree
     delegate :name, :description, :sku, :should_track_inventory?, to: :variant
     delegate :currency, to: :order, allow_nil: true
 
-    attr_accessor :target_shipment
+    attr_accessor :target_shipment, :price_currency
 
     self.whitelisted_ransackable_associations = ['variant']
     self.whitelisted_ransackable_attributes = ['variant_id']
@@ -111,9 +112,11 @@ module Spree
     def money_price=(money)
       if !money
         self.price = nil
-      elsif money.currency.iso_code != currency
-        raise CurrencyMismatch, "Line item price currency must match order currency!"
+      elsif money.currency.iso_code != currency && Spree::Config.raise_with_invalid_currency
+        line_item_errors = ActiveModel::Errors.new(self)
+        raise CurrencyMismatch, line_item_errors.generate_message(:price, :does_not_match_order_currency, locale: :en)
       else
+        self.price_currency = money.currency.iso_code
         self.price = money.to_d
       end
     end
@@ -202,5 +205,11 @@ module Spree
     def destroy_inventory_units
       inventory_units.destroy_all
     end
+
+    def price_match_order_currency
+      return if price_currency.blank? || price_currency == currency
+
+      errors.add(:price, :does_not_match_order_currency)
+    end
   end
 end

data/app/models/spree/option_type.rb

@@ -15,7 +15,7 @@ module Spree
     has_many :product_option_types, dependent: :destroy, inverse_of: :option_type
     has_many :products, through: :product_option_types
 
-    validates :name, presence: true, uniqueness: { allow_blank: true }
+    validates :name, presence: true, uniqueness: { allow_blank: true, case_sensitive: true }
     validates :presentation, presence: true
 
     default_scope -> { order(:position) }

data/app/models/spree/option_value.rb

@@ -8,13 +8,13 @@ module Spree
     has_many :option_values_variants, dependent: :destroy
     has_many :variants, through: :option_values_variants
 
-    validates :name, presence: true, uniqueness: { scope: :option_type_id, allow_blank: true }
+    validates :name, presence: true, uniqueness: { scope: :option_type_id, allow_blank: true, case_sensitive: true }
     validates :presentation, presence: true
 
     after_save :touch, if: :saved_changes?
     after_touch :touch_all_variants
 
-    delegate :name, :presentation, to: :option_type, prefix: :option_type
+    delegate :name, :presentation, to: :option_type, prefix: :option_type, allow_nil: true
 
     self.whitelisted_ransackable_attributes = %w[name presentation]
 

data/app/models/spree/order/checkout.rb

@@ -82,6 +82,7 @@ module Spree
 
               after_transition to: :complete, do: :add_payment_sources_to_wallet
               before_transition to: :payment, do: :add_default_payment_from_wallet
+              before_transition to: :payment, do: :ensure_billing_address
 
               before_transition to: :confirm, do: :add_store_credit_payments