spree_core 4.3.0 → 4.6.1

data/app/models/concerns/spree/product_scopes.rb

@@ -27,16 +27,22 @@ module Spree
           next if name.to_s.include?('master_price')
 
           parts = name.to_s.match(/(.*)_by_(.*)/)
-          scope(name.to_s, -> { order(Arel.sql("#{Product.quoted_table_name}.#{parts[2]} #{parts[1] == 'ascend' ? 'ASC' : 'DESC'}")) })
+          scope(name.to_s, -> { order(Arel.sql(sanitize_sql("#{Product.quoted_table_name}.#{parts[2]} #{parts[1] == 'ascend' ? 'ASC' : 'DESC'}"))) })
         end
       end
 
       def self.property_conditions(property)
-        properties = Property.table_name
+        properties_table = Property.table_name
+        property_translations_table = Property.translation_table_alias
         case property
-        when String   then { "#{properties}.name" => property }
-        when Property then { "#{properties}.id" => property.id }
-        else { "#{properties}.id" => property.to_i }
+        when Property then { "#{properties_table}.id" => property.id }
+        when Integer  then { "#{properties_table}.id" => property }
+        else
+          if Property.column_for_attribute('id').type == :uuid
+            ["#{property_translations_table.name} = ? OR #{properties_table.id} = ?", property, property]
+          else
+            { "#{property_translations_table}.name" => property }
+          end
         end
       end
 
@@ -121,44 +127,61 @@ module Spree
 
       # a scope that finds all products having property specified by name, object or id
       add_search_scope :with_property do |property|
-        joins(:properties).where(property_conditions(property))
+        joins(:properties).join_translation_table(Property).where(property_conditions(property))
       end
 
       # a simple test for product with a certain property-value pairing
       # note that it can test for properties with NULL values, but not for absent values
       add_search_scope :with_property_value do |property, value|
         joins(:properties).
-          where("#{ProductProperty.table_name}.value = ?", value).
+          join_translation_table(Property).
+          join_translation_table(ProductProperty).
+          where("#{ProductProperty.translation_table_alias}.value = ?", value).
           where(property_conditions(property))
       end
 
       add_search_scope :with_property_values do |property_filter_param, property_values|
         joins(product_properties: :property).
-          where(Property.table_name => { filter_param: property_filter_param }).
-          where(ProductProperty.table_name => { filter_param: property_values.map(&:parameterize) })
+          join_translation_table(Property).
+          join_translation_table(ProductProperty).
+          where(Property.translation_table_alias => { filter_param: property_filter_param }).
+          where(ProductProperty.translation_table_alias => { filter_param: property_values.map(&:parameterize) })
       end
 
       add_search_scope :with_option do |option|
-        option_types = OptionType.table_name
-        conditions = case option
-                     when String     then { "#{option_types}.name" => option }
-                     when OptionType then { "#{option_types}.id" => option.id }
-                     else { "#{option_types}.id" => option.to_i }
-                     end
-
-        joins(:option_types).where(conditions)
+        if option.is_a?(OptionType)
+          joins(:option_types).where(spree_option_types: { id: option.id })
+        elsif option.is_a?(Integer)
+          joins(:option_types).where(spree_option_types: { id: option })
+        elsif OptionType.column_for_attribute('id').type == :uuid
+          joins(:option_types).where(spree_option_types: { name: option }).or(Product.joins(:option_types).where(spree_option_types: { id: option }))
+        else
+          joins(:option_types).
+            join_translation_table(OptionType).
+            where(OptionType.translation_table_alias => { name: option })
+        end
       end
 
       add_search_scope :with_option_value do |option, value|
-        option_values = OptionValue.table_name
         option_type_id = case option
-                         when String then OptionType.find_by(name: option) || option.to_i
                          when OptionType then option.id
-                         else option.to_i
+                         when Integer then option
+                         else
+                           if OptionType.column_for_attribute('id').type == :uuid
+                             OptionType.where(id: option).or(OptionType.where(name: option))&.first&.id
+                           else
+                             OptionType.where(name: option)&.first&.id
+                             OptionType.where(name: option)&.first&.id
+                           end
                          end
 
-        conditions = "#{option_values}.name = ? AND #{option_values}.option_type_id = ?", value, option_type_id
-        group('spree_products.id').joins(variants_including_master: :option_values).where(conditions)
+        return Product.group("#{Spree::Product.table_name}.id").none if option_type_id.blank?
+
+        group("#{Spree::Product.table_name}.id").
+          joins(variants_including_master: :option_values).
+          join_translation_table(Spree::OptionValue).
+          where(Spree::OptionValue.translation_table_alias => { name: value },
+                Spree::OptionValue.table_name => { option_type_id: option_type_id })
       end
 
       # Finds all products which have either:
@@ -223,7 +246,7 @@ module Spree
 
       def self.not_discontinued(only_not_discontinued = true)
         if only_not_discontinued != '0' && only_not_discontinued
-          where("#{Product.quoted_table_name}.discontinue_on IS NULL or #{Product.quoted_table_name}.discontinue_on >= ?", Time.zone.now)
+          where.not(status: 'archived')
         else
           all
         end
@@ -240,12 +263,14 @@ module Spree
 
       # Can't use add_search_scope for this as it needs a default argument
       def self.available(available_on = nil, currency = nil)
-        available_on ||= Time.current
-
-        scope = not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
+        if available_on
+          scope = not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
+        else
+          scope = where(status: 'active')
+        end
 
         unless Spree::Config.show_products_without_price
-          currency ||= Spree::Config[:currency]
+          currency ||= Spree::Store.default.default_currency
           scope = scope.with_currency(currency)
         end
 
@@ -269,7 +294,7 @@ module Spree
         if user.try(:has_spree_role?, 'admin')
           with_deleted
         else
-          not_deleted.not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", Time.current)
+          not_deleted.where(status: 'active')
         end
       end
 
@@ -277,6 +302,17 @@ module Spree
         group('spree_products.id').joins(:taxons).where(Taxon.arel_table[:name].eq(name))
       end
 
+      # .search_by_name
+      if defined?(PgSearch)
+        include PgSearch::Model
+        pg_search_scope :search_by_name, against: :name, using: { tsearch: { any_word: true, prefix: true } }
+      else
+        def self.search_by_name(query)
+          i18n { name.lower.matches("%#{query.downcase}%") }
+        end
+      end
+      search_scopes << :search_by_name
+
       def self.price_table_name
         Price.quoted_table_name
       end
@@ -300,14 +336,14 @@ module Spree
       private_class_method :prepare_words
 
       def self.get_taxons(*ids_or_records_or_names)
-        taxons = Taxon.table_name
         ids_or_records_or_names.flatten.map do |t|
           case t
-          when Integer then Taxon.find_by(id: t)
           when ApplicationRecord then t
-          when String
-            Taxon.find_by(name: t) ||
-              Taxon.where("#{taxons}.permalink LIKE ? OR #{taxons}.permalink = ?", "%/#{t}/", "#{t}/").first
+          else
+            Taxon.where(name: t).
+              or(Taxon.where(Taxon.arel_table[:id].eq(t))).
+              or(Taxon.where(Taxon.arel_table[:permalink].matches("%/#{t}/"))).
+              or(Taxon.where(Taxon.arel_table[:permalink].matches("#{t}/"))).first
           end
         end.compact.flatten.uniq
       end

data/app/models/concerns/spree/translatable_resource.rb

@@ -0,0 +1,25 @@
+module Spree
+  module TranslatableResource
+    extend ActiveSupport::Concern
+
+    included do
+      extend Mobility
+      default_scope { i18n }
+
+      def get_field_with_locale(locale, field_name, fallback: false)
+        # method will return nil if no translation is present due to fallback: false setting
+        public_send(field_name, locale: locale, fallback: fallback)
+      end
+    end
+
+    class_methods do
+      def translatable_fields
+        const_get(:TRANSLATABLE_FIELDS)
+      end
+
+      def translation_table_alias
+        "#{self::Translation.table_name}_#{Mobility.locale}"
+      end
+    end
+  end
+end

data/app/models/concerns/spree/translatable_resource_scopes.rb

@@ -0,0 +1,24 @@
+module Spree
+  module TranslatableResourceScopes
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # To be used when joining on the resource itself does not automatically join on its translations table
+      # This method is to be used when you've already joined on the translatable table itself
+      #
+      # If the resource table is aliased, pass the alias to `join_on_table_alias`, otherwise omit the param
+      def join_translation_table(translatable_class, join_on_table_alias = nil)
+        join_on_table_name = if join_on_table_alias.nil?
+                               translatable_class.table_name
+                             else
+                               join_on_table_alias
+                             end
+        translatable_class_foreign_key = "#{translatable_class.table_name.singularize}_id"
+
+        joins("LEFT OUTER JOIN #{translatable_class::Translation.table_name} #{translatable_class.translation_table_alias}
+             ON #{translatable_class.translation_table_alias}.#{translatable_class_foreign_key} = #{join_on_table_name}.id
+             AND #{translatable_class.translation_table_alias}.locale = '#{Mobility.locale}'")
+      end
+    end
+  end
+end

data/app/models/concerns/spree/translatable_resource_slug.rb

@@ -0,0 +1,15 @@
+module Spree
+  module TranslatableResourceSlug
+    extend ActiveSupport::Concern
+
+    included do
+      def localized_slugs_for_store(store)
+        supported_locales = store.supported_locales_list
+
+        supported_locales.each_with_object({}) do |locale, hash|
+          hash[locale] = I18n.with_locale(locale) { slug }
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/spree/unique_name.rb

@@ -0,0 +1,10 @@
+module Spree
+  module UniqueName
+    extend ActiveSupport::Concern
+
+    included do
+      validates :name, presence: true,
+                       uniqueness: { case_sensitive: false, allow_blank: true, scope: spree_base_uniqueness_scope }
+    end
+  end
+end

data/app/models/concerns/spree/user_methods.rb

@@ -25,6 +25,8 @@ module Spree
       belongs_to :ship_address, class_name: 'Spree::Address', optional: true
       belongs_to :bill_address, class_name: 'Spree::Address', optional: true
 
+      has_many :wishlists, class_name: 'Spree::Wishlist', foreign_key: :user_id
+
       self.whitelisted_ransackable_associations = %w[bill_address ship_address addresses]
       self.whitelisted_ransackable_attributes = %w[id email]
 
@@ -66,6 +68,13 @@ module Spree
       end
     end
 
+    def default_wishlist_for_store(current_store)
+      wishlists.find_or_create_by(is_default: true, store_id: current_store.id) do |wishlist|
+        wishlist.name = Spree.t(:default_wishlist_name)
+        wishlist.save
+      end
+    end
+
     private
 
     def check_completed_orders

data/app/models/concerns/spree/user_reporting.rb

@@ -41,7 +41,7 @@ module Spree
     end
 
     def completed_orders(store)
-      orders.for_store(store).complete
+      orders.for_store(store).complete.order(currency: :desc)
     end
   end
 end

data/app/models/concerns/spree/user_roles.rb

@@ -6,18 +6,36 @@ module Spree
       has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, dependent: :destroy
       has_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :role
 
-      scope :admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: 'admin' }) }
+      scope :spree_admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: 'admin' }) }
 
       # has_spree_role? simply needs to return true or false whether a user has a role or not.
       def has_spree_role?(role_name)
         spree_roles.exists?(name: role_name)
       end
 
+      def self.admin
+        ActiveSupport::Deprecation.warn('`User#admin` is deprecated and will be removed in Spree 5. Please use `User#spree_admin`')
+
+        spree_admin
+      end
+
       def self.admin_created?
-        admin.exists?
+        ActiveSupport::Deprecation.warn('`User#admin_created?` is deprecated and will be removed in Spree 5. Please use `User#spree_admin_created?`')
+
+        spree_admin_created?
       end
 
       def admin?
+        ActiveSupport::Deprecation.warn('`User#admin?` is deprecated and will be removed in Spree 5. Please use `User#spree_admin?`')
+
+        spree_admin?
+      end
+
+      def self.spree_admin_created?
+        spree_admin.exists?
+      end
+
+      def spree_admin?
         has_spree_role?('admin')
       end
     end

data/app/models/spree/ability.rb

@@ -1,8 +1,9 @@
-# Implementation class for Cancan gem.  Instead of overriding this class, consider adding new permissions
+# Implementation class for Cancan gem. Instead of overriding this class, consider adding new permissions
 # using the special +register_ability+ method which allows extensions to add their own abilities.
 #
-# See http://github.com/ryanb/cancan for more details on cancan.
+# See https://github.com/CanCanCommunity/cancancan for more details.
 require 'cancan'
+
 module Spree
   class Ability
     include CanCan::Ability
@@ -27,7 +28,7 @@ module Spree
 
       user ||= Spree.user_class.new
 
-      if user.respond_to?(:has_spree_role?) && user.has_spree_role?('admin')
+      if user.persisted? && user.try(:spree_admin?)
         apply_admin_permissions(user)
       else
         apply_user_permissions(user)
@@ -85,6 +86,13 @@ module Spree
       can :read, ::Spree::Taxonomy
       can :read, ::Spree::Variant
       can :read, ::Spree::Zone
+      can :manage, ::Spree::Wishlist, user_id: user.id
+      can :show, ::Spree::Wishlist do |wishlist|
+        wishlist.user == user || wishlist.is_private == false
+      end
+      can [:create, :update, :destroy], ::Spree::WishedItem do |wished_item|
+        wished_item.wishlist.user == user
+      end
     end
 
     def protect_admin_role

data/app/models/spree/address.rb

@@ -2,6 +2,14 @@ module Spree
   class Address < Spree::Base
     require 'validates_zipcode'
 
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Addresses)
+      include Spree::Security::Addresses
+    end
+
     if Rails::VERSION::STRING >= '6.1'
       serialize :preferences, Hash, default: {}
     end
@@ -23,13 +31,13 @@ module Spree
     # we're not freezing this on purpose so developers can extend and manage
     # those attributes depending of the logic of their applications
     ADDRESS_FIELDS = %w(firstname lastname company address1 address2 city state zipcode country phone)
-    EXCLUDED_KEYS_FOR_COMPARISION = %w(id updated_at created_at deleted_at label user_id)
+    EXCLUDED_KEYS_FOR_COMPARISON = %w(id updated_at created_at deleted_at label user_id)
 
     scope :not_deleted, -> { where(deleted_at: nil) }
 
     belongs_to :country, class_name: 'Spree::Country'
     belongs_to :state, class_name: 'Spree::State', optional: true
-    belongs_to :user, class_name: Spree.user_class.name, optional: true
+    belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
 
     has_many :shipments, inverse_of: :address
 
@@ -117,7 +125,7 @@ module Spree
     end
 
     def value_attributes
-      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISION)
+      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISON)
     end
 
     def empty?

data/app/models/spree/adjustment.rb

@@ -42,6 +42,7 @@ module Spree
       end
     end
 
+    # FIXME: we should check if we also need to fire this action after update
     after_create :update_adjustable_adjustment_total
     after_destroy :update_adjustable_adjustment_total
 

data/app/models/spree/asset/support/active_storage.rb

@@ -8,7 +8,7 @@ module Spree
           def url(style)
             return placeholder(style) unless attachment.attached?
 
-            attachment.variant(resize: dimensions_for_style(style))
+            attachment.variant(resize_to_limit: dimensions_for_style(style))
           end
 
           def placeholder(style)
@@ -16,7 +16,8 @@ module Spree
           end
 
           def dimensions_for_style(style)
-            self.class.styles.with_indifferent_access[style] || self.class.styles.with_indifferent_access[default_style]
+            dimensions = self.class.styles.with_indifferent_access[style] || self.class.styles.with_indifferent_access[default_style]
+            dimensions.split('x').map(&:to_i)
           end
         end
       end

data/app/models/spree/asset.rb

@@ -1,6 +1,10 @@
 module Spree
   class Asset < Spree::Base
     include Support::ActiveStorage
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     belongs_to :viewable, polymorphic: true, touch: true
     acts_as_list scope: [:viewable_id, :viewable_type]

data/app/models/spree/base.rb

@@ -3,6 +3,7 @@ class Spree::Base < ApplicationRecord
   serialize :preferences, Hash
 
   include Spree::RansackableAttributes
+  include Spree::TranslatableResourceScopes
 
   after_initialize do
     if has_attribute?(:preferences) && !preferences.nil?
@@ -36,6 +37,10 @@ class Spree::Base < ApplicationRecord
     where(nil)
   end
 
+  def self.spree_base_uniqueness_scope
+    ApplicationRecord.try(:spree_base_uniqueness_scope) || []
+  end
+
   # FIXME: https://github.com/rails/rails/issues/40943
   def self.has_many_inversing
     false
@@ -45,6 +50,16 @@ class Spree::Base < ApplicationRecord
     column_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }
   end
 
+  def self.json_api_permitted_attributes
+    skipped_attributes = %w[id]
+
+    if included_modules.include?(CollectiveIdea::Acts::NestedSet::Model)
+      skipped_attributes.push('lft', 'rgt', 'depth')
+    end
+
+    column_names.reject { |c| skipped_attributes.include?(c.to_s) }
+  end
+
   def self.json_api_type
     to_s.demodulize.underscore
   end

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

@@ -3,7 +3,7 @@ require_dependency 'spree/calculator'
 module Spree
   class Calculator::FlatRate < Calculator
     preference :amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flat_rate_per_order)

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

@@ -5,7 +5,7 @@ module Spree
     preference :first_item,      :decimal, default: 0.0
     preference :additional_item, :decimal, default: 0.0
     preference :max_items,       :integer, default: 0
-    preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+    preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flexible_rate)

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

@@ -5,7 +5,7 @@ module Spree
     preference :minimal_amount, :decimal, default: 0
     preference :normal_amount, :decimal, default: 0
     preference :discount_amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:price_sack)

data/app/models/spree/calculator/shipping/digital_delivery.rb

@@ -0,0 +1,22 @@
+require_dependency 'spree/shipping_calculator'
+
+module Spree
+  module Calculator::Shipping
+    class DigitalDelivery < ShippingCalculator
+      preference :amount, :decimal, default: 0
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
+
+      def self.description
+        Spree.t('digital.digital_delivery')
+      end
+
+      def compute_package(_package = nil)
+        preferred_amount
+      end
+
+      def available?(package)
+        package.contents.all? { |content| content.variant.digital? }
+      end
+    end
+  end
+end

data/app/models/spree/calculator/shipping/flat_rate.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class FlatRate < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_order)

data/app/models/spree/calculator/shipping/flexi_rate.rb

@@ -6,7 +6,7 @@ module Spree
       preference :first_item,      :decimal, default: 0.0
       preference :additional_item, :decimal, default: 0.0
       preference :max_items,       :integer, default: 0
-      preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+      preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flexible_rate)

data/app/models/spree/calculator/shipping/per_item.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class PerItem < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_item)

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

@@ -6,7 +6,7 @@ module Spree
       preference :minimal_amount, :decimal, default: 0
       preference :normal_amount, :decimal, default: 0
       preference :discount_amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_price_sack)

data/app/models/spree/calculator.rb

@@ -2,9 +2,9 @@ module Spree
   class Calculator < Spree::Base
     acts_as_paranoid
 
-    belongs_to :calculable, polymorphic: true, optional: true
+    belongs_to :calculable, polymorphic: true, optional: true, inverse_of: :calculator
 
-    # This method calls a compute_<computable> method. must be overriden in concrete calculator.
+    # This method calls a compute_<computable> method. must be overridden in concrete calculator.
     #
     # It should return amount computed based on #calculable and the computable parameter
     def compute(computable)

data/app/models/spree/cms_page.rb

@@ -3,6 +3,10 @@ module Spree
     include SingleStoreResource
     include DisplayLink
 
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     acts_as_paranoid
 
     TYPES = ['Spree::Cms::Pages::StandardPage',
@@ -16,7 +20,7 @@ module Spree
 
     before_validation :handle_slug
 
-    validates :title, :store, :locale, presence: true
+    validates :title, :store, :locale, :type, presence: true
     validates :slug, uniqueness: { scope: :store_id, allow_nil: true, case_sensitive: true }
     validates :locale, uniqueness: { scope: [:store, :type] }, if: :homepage?
 
@@ -28,7 +32,7 @@ module Spree
     scope :standard, -> { where(type: 'Spree::Cms::Pages::StandardPage') }
     scope :feature, -> { where(type: 'Spree::Cms::Pages::FeaturePage') }
 
-    self.whitelisted_ransackable_attributes = %w[title type locale store_id]
+    self.whitelisted_ransackable_attributes = %w[title type locale]
 
     def seo_title
       if meta_title.present?
@@ -38,7 +42,7 @@ module Spree
       end
     end
 
-    # Overide this if your page type uses cms_sections
+    # Override this if your page type uses cms_sections
     def sections?
       false
     end