spree_core 4.3.0.rc1 → 4.4.0.rc1

data/app/models/spree/store_credit.rb

@@ -1,6 +1,7 @@
 module Spree
   class StoreCredit < Spree::Base
     include SingleStoreResource
+    include Metadata
 
     acts_as_paranoid
 
@@ -16,7 +17,7 @@ module Spree
 
     belongs_to :user, class_name: Spree.user_class.to_s, foreign_key: 'user_id'
     belongs_to :category, class_name: 'Spree::StoreCreditCategory'
-    belongs_to :created_by, class_name: Spree.user_class.to_s, foreign_key: 'created_by_id'
+    belongs_to :created_by, class_name: Spree.admin_user_class.to_s, foreign_key: 'created_by_id'
     belongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id'
     belongs_to :store, class_name: 'Spree::Store'
     has_many :store_credit_events, class_name: 'Spree::StoreCreditEvent'
@@ -41,6 +42,9 @@ module Spree
     extend Spree::DisplayMoney
     money_methods :amount, :amount_used
 
+    self.whitelisted_ransackable_attributes = %w[user_id created_by_id amount currency type_id]
+    self.whitelisted_ransackable_associations = %w[type user created_by]
+
     def amount_remaining
       amount - amount_used - amount_authorized
     end

data/app/models/spree/store_credit_category.rb

@@ -7,6 +7,8 @@ module Spree
     GIFT_CARD_CATEGORY_NAME = 'Gift Card'.freeze
     DEFAULT_NON_EXPIRING_TYPES = [GIFT_CARD_CATEGORY_NAME]
 
+    self.whitelisted_ransackable_attributes = %w[name]
+
     def non_expiring?
       non_expiring_category_types.include? name
     end

data/app/models/spree/store_credit_event.rb

@@ -10,13 +10,8 @@ module Spree
 
     delegate :currency, :store, to: :store_credit
 
-    def display_amount
-      Spree::Money.new(amount, currency: currency)
-    end
-
-    def display_user_total_amount
-      Spree::Money.new(user_total_amount, currency: currency)
-    end
+    extend DisplayMoney
+    money_methods :amount, :user_total_amount
 
     def display_action
       case action

data/app/models/spree/store_credit_type.rb

@@ -2,5 +2,7 @@ module Spree
   class StoreCreditType < Spree::Base
     DEFAULT_TYPE_NAME = 'Expiring'.freeze
     has_many :store_credits, class_name: 'Spree::StoreCredit', foreign_key: 'type_id'
+
+    validates :name, presence: true
   end
 end

data/app/models/spree/tax_category.rb

@@ -1,12 +1,14 @@
 module Spree
   class TaxCategory < Spree::Base
     acts_as_paranoid
-    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: :deleted_at }
+    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope.push(:deleted_at) }
 
     has_many :tax_rates, dependent: :destroy, inverse_of: :tax_category
 
     before_save :set_default_category
 
+    self.whitelisted_ransackable_attributes = %w[name is_default tax_code]
+
     def set_default_category
       # set existing default tax category to false if this one has been marked as default
 

data/app/models/spree/tax_rate.rb

@@ -13,7 +13,7 @@ module Spree
 
     with_options presence: true do
       validates :amount, numericality: { allow_nil: true }
-      validates :tax_category
+      validates :tax_category, :name
     end
 
     scope :by_zone, ->(zone) { where(zone_id: zone.id) }
@@ -27,6 +27,8 @@ module Spree
           ->(category) { where(tax_category_id: category.try(:id)) }
     scope :included_in_price, -> { where(included_in_price: true) }
 
+    self.whitelisted_ransackable_attributes = %w[amount zone_id tax_category_id included_in_price name]
+
     # Gets the array of TaxRates appropriate for the specified tax zone
     def self.match(order_tax_zone)
       return [] unless order_tax_zone

data/app/models/spree/taxon.rb

@@ -3,6 +3,8 @@ require 'stringex'
 
 module Spree
   class Taxon < Spree::Base
+    include Metadata
+
     extend FriendlyId
     friendly_id :permalink, slug_column: :permalink, use: :history
     before_validation :set_permalink, on: :create, if: :name
@@ -37,6 +39,7 @@ module Spree
 
     before_validation :copy_taxonomy_from_parent
     after_save :touch_ancestors_and_taxonomy
+    after_save :sync_taxonomy_name
     after_touch :touch_ancestors_and_taxonomy
 
     has_one :icon, as: :viewable, dependent: :destroy, class_name: 'Spree::TaxonImage'
@@ -44,6 +47,7 @@ module Spree
     scope :for_store, ->(store) { joins(:taxonomy).where(spree_taxonomies: { store_id: store.id }) }
 
     self.whitelisted_ransackable_associations = %w[taxonomy]
+    self.whitelisted_ransackable_attributes = %w[name permalink]
 
     scope :for_stores, ->(stores) { joins(:taxonomy).where(spree_taxonomies: { store_id: stores.ids }) }
 
@@ -102,6 +106,14 @@ module Spree
 
     private
 
+    def sync_taxonomy_name
+      if saved_change_to_name? && root?
+        return if taxonomy.name.to_s == name.to_s
+
+        taxonomy.update(name: name)
+      end
+    end
+
     def touch_ancestors_and_taxonomy
       # Touches all ancestors at once to avoid recursive taxonomy touch, and reduce queries.
       ancestors.update_all(updated_at: Time.current)

data/app/models/spree/taxon_image/configuration/active_storage.rb

@@ -5,10 +5,10 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          validate :check_attachment_content_type
-
           has_one_attached :attachment
 
+          validates :attachment, content_type: /\Aimage\/.*\z/
+
           default_scope { includes(attachment_attachment: :blob) }
 
           def self.styles
@@ -21,16 +21,6 @@ module Spree
           def default_style
             :mini
           end
-
-          def accepted_image_types
-            %w(image/jpeg image/jpg image/png image/gif)
-          end
-
-          def check_attachment_content_type
-            if attachment.attached? && !attachment.content_type.in?(accepted_image_types)
-              errors.add(:attachment, :not_allowed_content_type)
-            end
-          end
         end
       end
     end

data/app/models/spree/taxon_image.rb

@@ -2,6 +2,7 @@ module Spree
   class TaxonImage < Asset
     include Configuration::ActiveStorage
     include Rails.application.routes.url_helpers
+    include ::Spree::ImageMethods
 
     def styles
       self.class.styles.map do |_, size|

data/app/models/spree/taxonomy.rb

@@ -1,5 +1,7 @@
 module Spree
   class Taxonomy < Spree::Base
+    include Metadata
+
     acts_as_list
 
     validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true, scope: :store_id }
@@ -14,6 +16,8 @@ module Spree
 
     default_scope { order("#{table_name}.position, #{table_name}.created_at") }
 
+    self.whitelisted_ransackable_associations = %w[root]
+
     private
 
     def set_root
@@ -21,6 +25,9 @@ module Spree
     end
 
     def set_root_taxon_name
+      return unless saved_change_to_name?
+      return if name.to_s == root.name.to_s
+
       root.update(name: name)
     end
   end

data/app/models/spree/variant.rb

@@ -4,6 +4,7 @@ module Spree
     acts_as_list scope: :product
 
     include MemoizedData
+    include Metadata
 
     MEMOIZED_METHODS = %w(purchasable in_stock backorderable tax_category options_text compare_at_price)
 
@@ -42,6 +43,10 @@ module Spree
              dependent: :destroy,
              inverse_of: :variant
 
+    has_many :wished_items, dependent: :destroy
+
+    has_many :digitals
+
     before_validation :set_cost_currency
 
     validate :check_price
@@ -52,7 +57,7 @@ module Spree
       validates :cost_price
       validates :price
     end
-    validates :sku, uniqueness: { conditions: -> { where(deleted_at: nil) }, case_sensitive: false },
+    validates :sku, uniqueness: { conditions: -> { where(deleted_at: nil) }, case_sensitive: false, scope: spree_base_uniqueness_scope },
                     allow_blank: true, unless: :disable_sku_validation?
 
     after_create :create_stock_items
@@ -60,7 +65,7 @@ module Spree
 
     after_touch :clear_in_stock_cache
 
-    scope :in_stock, -> { joins(:stock_items).where('count_on_hand > ? OR track_inventory = ?', 0, false) }
+    scope :in_stock, -> { joins(:stock_items).where("#{Spree::StockItem.table_name}.count_on_hand > ? OR #{Spree::Variant.table_name}.track_inventory = ?", 0, false) }
     scope :backorderable, -> { joins(:stock_items).where(spree_stock_items: { backorderable: true }) }
     scope :in_stock_or_backorderable, -> { in_stock.or(backorderable) }
 
@@ -89,7 +94,7 @@ module Spree
     scope :not_deleted, -> { where("#{Spree::Variant.quoted_table_name}.deleted_at IS NULL") }
 
     scope :for_currency_and_available_price_amount, ->(currency = nil) do
-      currency ||= Spree::Config[:currency]
+      currency ||= Spree::Store.default.default_currency
       joins(:prices).where('spree_prices.currency = ?', currency).where('spree_prices.amount IS NOT NULL').distinct
     end
 
@@ -106,8 +111,8 @@ module Spree
       end
     end
 
-    self.whitelisted_ransackable_associations = %w[option_values product prices default_price]
-    self.whitelisted_ransackable_attributes = %w[weight sku]
+    self.whitelisted_ransackable_associations = %w[option_values product tax_category prices default_price]
+    self.whitelisted_ransackable_attributes = %w[weight depth width height sku discontinue_on is_master cost_price cost_currency track_inventory deleted_at]
     self.whitelisted_ransackable_scopes = %i(product_name_or_sku_cont search_by_product_name_or_sku)
 
     def self.product_name_or_sku_cont(query)
@@ -127,6 +132,10 @@ module Spree
       !discontinued? && product.available?
     end
 
+    def in_stock_or_backorderable?
+      self.class.in_stock_or_backorderable.exists?(id: id)
+    end
+
     def tax_category
       @tax_category ||= if self[:tax_category_id].nil?
                           product.tax_category
@@ -256,7 +265,13 @@ module Spree
       end
     end
 
-    delegate :total_on_hand, :can_supply?, :backorderable?, to: :quantifier
+    def backorderable?
+      @backorderable ||= Rails.cache.fetch(['variant-backorderable', cache_key_with_version]) do
+        quantifier.backorderable?
+      end
+    end
+
+    delegate :total_on_hand, :can_supply?, to: :quantifier
 
     alias is_backorderable? backorderable?
 
@@ -270,10 +285,6 @@ module Spree
       track_inventory? && Spree::Config.track_inventory_levels
     end
 
-    def track_inventory
-      should_track_inventory?
-    end
-
     def volume
       (width || 0) * (height || 0) * (depth || 0)
     end
@@ -291,7 +302,12 @@ module Spree
     end
 
     def backordered?
-      @backordered ||= total_on_hand <= 0 && stock_items.exists?(backorderable: true)
+      @backordered ||= !in_stock? && stock_items.exists?(backorderable: true)
+    end
+
+    # Is this variant to be downloaded by the customer?
+    def digital?
+      digitals.present?
     end
 
     private
@@ -323,12 +339,12 @@ module Spree
         self.price = product.master.price
       end
       if price.present? && currency.nil?
-        self.currency = Spree::Config[:currency]
+        self.currency = Spree::Store.default.default_currency
       end
     end
 
     def set_cost_currency
-      self.cost_currency = Spree::Config[:currency] if cost_currency.blank?
+      self.cost_currency = Spree::Store.default.default_currency if cost_currency.blank?
     end
 
     def create_stock_items

data/app/models/spree/wished_item.rb

@@ -0,0 +1,29 @@
+module Spree
+  class WishedItem < Spree::Base
+    extend DisplayMoney
+    money_methods :total, :price
+
+    belongs_to :variant, class_name: 'Spree::Variant'
+    belongs_to :wishlist, class_name: 'Spree::Wishlist'
+
+    has_one :product, class_name: 'Spree::Product', through: :variant
+
+    validates :variant, :wishlist, presence: true
+    validates :variant, uniqueness: { scope: [:wishlist] }
+    validates :quantity, numericality: { only_integer: true, greater_than: 0 }
+
+    def price(currency)
+      variant.amount_in(currency[:currency])
+    end
+
+    def total(currency)
+      variant_price = variant.amount_in(currency[:currency])
+
+      if variant_price.nil?
+        variant_price
+      else
+        quantity * variant_price
+      end
+    end
+  end
+end

data/app/models/spree/wishlist.rb

@@ -0,0 +1,35 @@
+module Spree
+  class Wishlist < Spree::Base
+    include SingleStoreResource
+
+    has_secure_token
+
+    belongs_to :user, class_name: Spree.user_class.name, touch: true
+    belongs_to :store, class_name: 'Spree::Store'
+
+    has_many :wished_items, class_name: 'Spree::WishedItem', dependent: :destroy
+
+    after_commit :ensure_default_exists_and_is_unique
+    validates :name, :store, :user, presence: true
+
+    def include?(variant_id)
+      wished_items.exists?(variant_id: variant_id)
+    end
+
+    def to_param
+      token
+    end
+
+    def self.get_by_param(param)
+      find_by(token: param)
+    end
+
+    private
+
+    def ensure_default_exists_and_is_unique
+      if is_default?
+        Wishlist.where(is_default: true, user_id: user_id, store_id: store_id).where.not(id: id).update_all(is_default: false)
+      end
+    end
+  end
+end

data/app/models/spree/zone.rb

@@ -1,5 +1,7 @@
 module Spree
   class Zone < Spree::Base
+    include UniqueName
+
     with_options dependent: :destroy, inverse_of: :zone do
       has_many :zone_members, class_name: 'Spree::ZoneMember'
       has_many :tax_rates
@@ -12,8 +14,6 @@ module Spree
     has_many :shipping_method_zones, class_name: 'Spree::ShippingMethodZone'
     has_many :shipping_methods, through: :shipping_method_zones, class_name: 'Spree::ShippingMethod'
 
-    validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true }
-
     scope :with_default_tax, -> { where(default_tax: true) }
 
     after_save :remove_defunct_members
@@ -71,7 +71,9 @@ module Spree
     end
 
     def self.default_checkout_zone
-      find_by(name: Spree::Config[:checkout_zone])
+      ActiveSupport::Deprecation.warn('Spree::Zone.default_checkout_zone is deprecated and will be removed in Spree 5')
+
+      first
     end
 
     def kind
@@ -109,10 +111,10 @@ module Spree
     def country_list
       @countries ||= case kind
                      when 'country' then
-                       zoneables
+                       Country.where(id: country_ids)
                      when 'state' then
-                       zoneables.collect(&:country)
-                     end.flatten.compact.uniq
+                       Country.where(id: zoneables.collect(&:country_id))
+                     end
     end
 
     def <=>(other)

data/app/presenters/spree/filters/options_presenter.rb

@@ -3,6 +3,26 @@ module Spree
     class OptionsPresenter
       FilterableOptionType = Struct.new(:option_type, :option_values, keyword_init: true) do
         delegate_missing_to :option_type
+
+        def to_h
+          {
+            id: option_type.id,
+            name: option_type.name,
+            presentation: option_type.presentation,
+            option_values: option_values.map { |e| option_value_hash(e) }
+          }
+        end
+
+        private
+
+        def option_value_hash(option_value)
+          {
+            id: option_value.id,
+            name: option_value.name,
+            presentation: option_value.presentation,
+            position: option_value.position
+          }
+        end
       end
 
       def initialize(option_values_scope:)

data/app/presenters/spree/filters/property_presenter.rb

@@ -14,9 +14,29 @@ module Spree
         property.uniq_values(product_properties_scope: product_properties)
       end
 
+      def to_h
+        {
+          id: property.id,
+          name: property.name,
+          presentation: property.presentation,
+          values: values_hash
+        }
+      end
+
       private
 
       attr_reader :property
+
+      def values_hash
+        value_hashes = uniq_values.map do |filter_param, value|
+          {
+            value: value,
+            filter_param: filter_param
+          }
+        end
+
+        value_hashes.sort_by { |e| e[:value] }
+      end
     end
   end
 end

data/app/services/spree/account/addresses/create.rb

@@ -1,23 +1,7 @@
 module Spree
   module Account
     module Addresses
-      class Create
-        prepend Spree::ServiceModule::Base
-        include Spree::Account::Addresses::Helper
-
-        attr_accessor :country
-
-        def call(user:, address_params:)
-          fill_country_and_state_ids(address_params)
-
-          address = user.addresses.new(address_params)
-          if address.save
-            assign_to_user_as_default(user: user, address_id: address.id)
-            success(address)
-          else
-            failure(address)
-          end
-        end
+      class Create < Spree::Addresses::Create
       end
     end
   end

data/app/services/spree/account/addresses/update.rb

@@ -1,28 +1,7 @@
 module Spree
   module Account
     module Addresses
-      class Update
-        prepend Spree::ServiceModule::Base
-        include Spree::Account::Addresses::Helper
-
-        attr_accessor :country
-
-        def call(address:, address_params:)
-          address_params[:country_id] ||= address.country_id
-          fill_country_and_state_ids(address_params)
-
-          if address&.editable?
-            address.update(address_params) ? success(address) : failure(address)
-          else
-            new_address(address_params).valid? ? address.destroy && success(new_address) : failure(new_address)
-          end
-        end
-
-        private
-
-        def new_address(address_params = {})
-          @new_address ||= ::Spree::Address.find_or_create_by(address_params.except(:id, :updated_at, :created_at))
-        end
+      class Update < Spree::Addresses::Update
       end
     end
   end

data/app/services/spree/addresses/create.rb

@@ -0,0 +1,24 @@
+module Spree
+  module Addresses
+    class Create
+      prepend Spree::ServiceModule::Base
+      include Spree::Addresses::Helper
+
+      attr_accessor :country
+
+      def call(address_params: {}, user: nil)
+        fill_country_and_state_ids(address_params)
+
+        address = Spree::Address.new(address_params)
+        address.user = user if user.present?
+
+        if address.save
+          assign_to_user_as_default(user: user, address_id: address.id) if user.present?
+          success(address)
+        else
+          failure(address)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/addresses/helper.rb

@@ -0,0 +1,41 @@
+module Spree
+  module Addresses
+    module Helper
+      private
+
+      attr_accessor :country
+
+      def fill_country_and_state_ids(params)
+        replace_country_iso_with_id(params)
+        fill_state_id(params)
+      end
+
+      def replace_country_iso_with_id(params)
+        iso = params[:country_iso]
+        return params unless iso.present?
+
+        country = Spree::Country.by_iso(iso)
+        params[:country_id] = country&.id
+        params.delete(:country_iso)
+        params
+      end
+
+      def fill_state_id(params)
+        state_name = params[:state_name]
+        return params unless state_name.present?
+
+        country ||= Spree::Country.find(params[:country_id]) if params[:country_id].present?
+        return params unless country
+
+        params[:state_id] = country.states.find_by(name: state_name)&.id
+        params
+      end
+
+      def assign_to_user_as_default(user:, address_id:)
+        if user.addresses.pluck(:id) == [address_id] # check if it's user first address
+          user.update(bill_address_id: address_id, ship_address_id: address_id)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/addresses/update.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Addresses
+    class Update
+      prepend Spree::ServiceModule::Base
+      include Spree::Addresses::Helper
+
+      attr_accessor :country
+
+      def call(address:, address_params:)
+        address_params[:country_id] ||= address.country_id
+        fill_country_and_state_ids(address_params)
+
+        if address&.editable?
+          address.update(address_params) ? success(address) : failure(address)
+        else
+          new_address(address_params).valid? ? address.destroy && success(new_address) : failure(new_address)
+        end
+      end
+
+      private
+
+      def new_address(address_params = {})
+        @new_address ||= ::Spree::Address.find_or_create_by(address_params.except(:id, :updated_at, :created_at))
+      end
+    end
+  end
+end

data/app/services/spree/cart/add_item.rb

@@ -3,7 +3,7 @@ module Spree
     class AddItem
       prepend Spree::ServiceModule::Base
 
-      def call(order:, variant:, quantity: nil, options: {})
+      def call(order:, variant:, quantity: nil, public_metadata: {}, private_metadata: {}, options: {})
         ApplicationRecord.transaction do
           run :add_to_line_item
           run Spree::Dependencies.cart_recalculate_service.constantize
@@ -12,7 +12,7 @@ module Spree
 
       private
 
-      def add_to_line_item(order:, variant:, quantity: nil, options: {})
+      def add_to_line_item(order:, variant:, quantity: nil, public_metadata: {}, private_metadata: {}, options: {})
         options ||= {}
         quantity ||= 1
 
@@ -32,6 +32,8 @@ module Spree
         end
 
         line_item.target_shipment = options[:shipment] if options.key? :shipment
+        line_item.public_metadata = public_metadata.to_h if public_metadata
+        line_item.private_metadata = private_metadata.to_h if private_metadata
 
         return failure(line_item) unless line_item.save
 

data/app/services/spree/cart/associate.rb

@@ -0,0 +1,16 @@
+module Spree
+  module Cart
+    class Associate
+      prepend Spree::ServiceModule::Base
+
+      def call(guest_order:, user:)
+        if guest_order.user.nil?
+          guest_order.associate_user!(user)
+          success(guest_order)
+        else
+          failure(guest_order, 'Already assigned to a user')
+        end
+      end
+    end
+  end
+end