spree_core 4.0.0 → 4.6.0

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

@@ -0,0 +1,30 @@
+module Spree
+  module DisplayLink
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :linked_resource, polymorphic: true
+
+      def link
+        case linked_resource_type
+        when 'Spree::Taxon'
+          return if linked_resource&.permalink.blank?
+
+          "/#{Spree::Config[:storefront_taxons_path]}/#{linked_resource.permalink}"
+        when 'Spree::Product'
+          return if linked_resource&.slug.blank?
+
+          "/#{Spree::Config[:storefront_products_path]}/#{linked_resource.slug}"
+        when 'Spree::CmsPage'
+          return if linked_resource&.slug.blank?
+
+          "/#{Spree::Config[:storefront_pages_path]}/#{linked_resource.slug}"
+        when 'Spree::Linkable::Homepage'
+          '/'
+        when 'Spree::Linkable::Uri'
+          destination
+        end
+      end
+    end
+  end
+end

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

@@ -17,13 +17,19 @@ module Spree
     # Decorate a method, but with some additional options
     #     extend Spree::DisplayMoney
     #     money_methods tax_amount: { currency: "CAD", no_cents: true }, :price
+    # Use generated method with the same arguments as in wrapped method
+    #     def tax_amount(order, country)
+    #     display_tax_amount(order, country)
     def money_methods(*args)
       args.each do |money_method|
         money_method = { money_method => {} } unless money_method.is_a? Hash
         money_method.each do |method_name, opts|
-          define_method("display_#{method_name}") do
+          define_method("display_#{method_name}") do |**args_list|
             default_opts = respond_to?(:currency) ? { currency: currency } : {}
-            Spree::Money.new(send(method_name), default_opts.merge(opts))
+
+            amount = args_list.blank? ? send(method_name) : send(method_name, **args_list)
+
+            Spree::Money.new(amount, default_opts.merge(opts).merge(args_list.slice(:currency)))
           end
         end
       end

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

@@ -0,0 +1,21 @@
+module Spree
+  module FilterParam
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :set_filter_param
+    end
+
+    protected
+
+    def set_filter_param
+      return if param_candidate.blank?
+
+      self.filter_param = param_candidate.parameterize
+    end
+
+    def param_candidate
+      name
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Spree
+  module ImageMethods
+    extend ActiveSupport::Concern
+
+    def generate_url(size:, gravity: 'centre', quality: 80, background: [0, 0, 0])
+      return if size.blank?
+
+      size = size.gsub(/\s+/, '')
+
+      return unless size.match(/(\d+)x(\d+)/)
+
+      width, height = size.split('x').map(&:to_i)
+      gravity = translate_gravity_for_mini_magick(gravity)
+
+      # FIXME: bring back support for background color
+
+      cdn_image_url(attachment.variant(resize_and_pad: [width, height, { gravity: gravity }], saver: { quality: quality }))
+    end
+
+    def original_url
+      cdn_image_url(attachment)
+    end
+
+    private
+
+    def translate_gravity_for_mini_magick(gravity)
+      variant_processor = Rails.application.config.active_storage.variant_processor
+
+      if gravity.downcase == 'centre' && [:mini_magick, nil].include?(variant_processor)
+        'center'
+      else
+        gravity
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Spree
+  module MemoizedData
+    extend ActiveSupport::Concern
+
+    included do
+      # reset cache on save inside transaction and transaction commit
+      after_save :reset_memoized_data
+      after_commit :reset_memoized_data
+
+      def reload(options = {})
+        reset_memoized_data
+        super(options)
+      end
+
+      private
+
+      def reset_memoized_data
+        self.class.const_get('MEMOIZED_METHODS').each do |v|
+          instance_variable_set(:"@#{v.gsub(/\?/, '')}", nil)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Spree
+  module Metadata
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :public_metadata, default: {}
+      attribute :private_metadata, default: {}
+      serialize :public_metadata, HashSerializer
+      serialize :private_metadata, HashSerializer
+    end
+
+    # https://nandovieira.com/using-postgresql-and-jsonb-with-ruby-on-rails
+    class HashSerializer
+      def self.dump(hash)
+        hash
+      end
+
+      def self.load(hash)
+        (hash || {}).with_indifferent_access
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Spree
+  module MultiStoreResource
+    extend ActiveSupport::Concern
+
+    included do
+      scope :for_store, ->(store) { joins(:stores).where(Store.table_name => { id: store.id }) }
+
+      validate :must_have_one_store, unless: :disable_store_presence_validation?
+    end
+
+    protected
+
+    def must_have_one_store
+      return if stores.any?
+
+      errors.add(:stores, Spree.t(:must_have_one_store))
+    end
+
+    # this can be overridden on model basis
+    def disable_store_presence_validation?
+      Spree::Config[:disable_store_presence_validation]
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Spree
       scope :active, -> { where(active: true) }
       default_scope { order(Arel.sql("LOWER(#{table_name}.name)")) }
 
-      validates :name, presence: true, uniqueness: { case_sensitive: false }
+      include UniqueName
     end
   end
 end

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

@@ -0,0 +1,18 @@
+module Spree
+  module NumberIdentifier
+    extend ActiveSupport::Concern
+
+    included do
+      before_validation :uppercase_number
+
+      validates :number, presence: true, length: { maximum: 32, allow_blank: true },
+                         uniqueness: { allow_blank: true, case_sensitive: true, scope: spree_base_uniqueness_scope }
+    end
+
+    protected
+
+    def uppercase_number
+      number&.to_s&.upcase!
+    end
+  end
+end

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

@@ -27,39 +27,57 @@ 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
 
       add_simple_scopes simple_scopes
 
       add_search_scope :ascend_by_master_price do
-        joins(master: :default_price).order("#{price_table_name}.amount ASC")
+        order("#{price_table_name}.amount ASC")
       end
 
       add_search_scope :descend_by_master_price do
-        joins(master: :default_price).order("#{price_table_name}.amount DESC")
+        order("#{price_table_name}.amount DESC")
       end
 
       add_search_scope :price_between do |low, high|
-        joins(master: :default_price).where(Price.table_name => { amount: low..high })
+        where(Price.table_name => { amount: low..high })
       end
 
       add_search_scope :master_price_lte do |price|
-        joins(master: :default_price).where("#{price_table_name}.amount <= ?", price)
+        where("#{price_table_name}.amount <= ?", price)
       end
 
       add_search_scope :master_price_gte do |price|
-        joins(master: :default_price).where("#{price_table_name}.amount >= ?", price)
+        where("#{price_table_name}.amount >= ?", price)
+      end
+
+      add_search_scope :in_stock do
+        joins(:variants_including_master).merge(Spree::Variant.in_stock)
+      end
+
+      add_search_scope :backorderable do
+        joins(:variants_including_master).merge(Spree::Variant.backorderable)
+      end
+
+      add_search_scope :in_stock_or_backorderable do
+        joins(:variants_including_master).merge(Spree::Variant.in_stock_or_backorderable)
       end
 
       # This scope selects products in taxon AND all its descendants
@@ -81,7 +99,7 @@ module Spree
       #   SELECT COUNT(*) ...
       add_search_scope :in_taxon do |taxon|
         includes(:classifications).
-          where('spree_products_taxons.taxon_id' => taxon.self_and_descendants.pluck(:id)).
+          where('spree_products_taxons.taxon_id' => taxon.cached_self_and_descendants_ids).
           order('spree_products_taxons.position ASC')
       end
 
@@ -94,40 +112,76 @@ module Spree
         taxons.first ? prepare_taxon_conditions(taxons) : where(nil)
       end
 
+      add_search_scope :ascend_by_taxons_min_position do |taxon_ids|
+        joins(:classifications).
+          where(Classification.table_name => { taxon_id: taxon_ids }).
+          select(
+            [
+              "#{Product.table_name}.*",
+              "MIN(#{Classification.table_name}.position) AS min_position"
+            ].join(', ')
+          ).
+          group(:id).
+          order(min_position: :asc)
+      end
+
       # 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_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
+      add_search_scope :with_property_values do |property_filter_param, property_values|
+        joins(product_properties: :property).
+          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
 
-        joins(:option_types).where(conditions)
+      add_search_scope :with_option do |option|
+        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:
@@ -192,16 +246,35 @@ 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
       end
       search_scopes << :not_discontinued
+
+      def self.with_currency(currency)
+        joins(variants_including_master: :prices).
+          where(Price.table_name => { currency: currency.upcase }).
+          where.not(Price.table_name => { amount: nil }).
+          distinct
+      end
+      search_scopes << :with_currency
+
       # 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
-        not_discontinued.joins(master: :prices).where("#{Product.quoted_table_name}.available_on <= ?", available_on)
+      def self.available(available_on = nil, currency = nil)
+        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::Store.default.default_currency
+          scope = scope.with_currency(currency)
+        end
+
+        scope
       end
       search_scopes << :available
 
@@ -210,10 +283,36 @@ module Spree
       end
       search_scopes << :active
 
+      def self.for_filters(currency, taxon: nil)
+        scope = active(currency)
+        scope = scope.in_taxon(taxon) if taxon.present?
+        scope
+      end
+      search_scopes << :for_filters
+
+      def self.for_user(user = nil)
+        if user.try(:has_spree_role?, 'admin')
+          with_deleted
+        else
+          not_deleted.where(status: 'active')
+        end
+      end
+
       add_search_scope :taxons_name_eq do |name|
         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
@@ -221,7 +320,7 @@ module Spree
 
       # specifically avoid having an order for taxon search (conflicts with main order)
       def self.prepare_taxon_conditions(taxons)
-        ids = taxons.map { |taxon| taxon.self_and_descendants.pluck(:id) }.flatten.uniq
+        ids = taxons.map(&:cached_self_and_descendants_ids).flatten.uniq
         joins(:classifications).where(Classification.table_name => { taxon_id: ids })
       end
       private_class_method :prepare_taxon_conditions
@@ -237,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/single_store_resource.rb

@@ -0,0 +1,19 @@
+module Spree
+  module SingleStoreResource
+    extend ActiveSupport::Concern
+
+    included do
+      validate :ensure_store_association_is_not_changed
+
+      scope :for_store, ->(store) { where(store_id: store.id) }
+    end
+
+    protected
+
+    def ensure_store_association_is_not_changed
+      if store_id_changed? && persisted?
+        errors.add(:store, Spree.t('errors.messages.store_association_can_not_be_changed'))
+      end
+    end
+  end
+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,17 @@
+module Spree
+  module TranslatableResourceSlug
+    extend ActiveSupport::Concern
+
+    included do
+      def localized_slugs_for_store(store)
+        localized_slugs = Hash[translations.pluck(:locale, :slug)]
+        default_locale = store.default_locale
+        supported_locales = store.supported_locales_list
+
+        supported_locales.each_with_object({}) do |locale, hash|
+          hash[locale] = localized_slugs[locale] || localized_slugs[default_locale]
+        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_address.rb

@@ -16,7 +16,12 @@ module Spree
       has_many :addresses, -> { where(deleted_at: nil).order('updated_at DESC') },
                            class_name: 'Spree::Address', foreign_key: :user_id
 
+      validate :address_not_associated_with_other_user, :address_not_deprecated_in_completed_order
+
       def persist_order_address(order)
+        # FIXME: we should check if the User's address is associated with country accepted by Store
+        # if not we should try to find an address with valid country in User's address book
+        # or we should call `build_bill_address`
         b_address = bill_address || build_bill_address
         b_address.attributes = order.bill_address.value_attributes
         b_address.save
@@ -30,6 +35,20 @@ module Spree
           update(ship_address_id: s_address.id)
         end
       end
+
+      private
+
+      def address_not_associated_with_other_user
+        errors.add(:bill_address_id, :belongs_to_other_user) if bill_address&.user_id && self != bill_address&.user
+        errors.add(:ship_address_id, :belongs_to_other_user) if ship_address&.user_id && self != ship_address&.user
+      end
+
+      def address_not_deprecated_in_completed_order
+        errors.add(:bill_address_id, :deprecated_in_completed_order) if
+          orders.complete.with_deleted_bill_address.where(bill_address: bill_address_id).any?
+        errors.add(:ship_address_id, :deprecated_in_completed_order) if
+          orders.complete.with_deleted_ship_address.where(ship_address: ship_address_id).any?
+      end
     end
   end
 end