spree_core 4.5.3 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c07dcb2b230c430ef669d130077a6b37328bad3d4a684358f3c462611cb2d4
-  data.tar.gz: 1f2fe362ca2d556585c55d69c6a339c87cc34cd3566097a1f2b66a494eab8262
+  metadata.gz: 619f5416fb099c1cccaeb2432fd6002b53aa605aff90c9b4078f2a51ba73e89b
+  data.tar.gz: e53a5c780f9c4e79c50cc38d2fdd055dc20b04bef93c89e33e88b7a4fd9facce
 SHA512:
-  metadata.gz: 1019730fe49fd1809896d281545897eeb14c3795a56ebcf13238299292516eefe925ca5dae258de512b36eab8df475c4dc45b8119b8c1f91471e0e694a15ff2b
-  data.tar.gz: bd6af18b359d118d2392b1a36cfd997b8521b0444cd803e97a2b72b24b035920acdcee35c8ac25df35a5adf108b592706706e8aa9cba48a8b4ff99314dde8f01
+  metadata.gz: 7e8cc84789a7c8564b45576c2aa9f8974f62da3b2c752869a9950497b01382b073b50a4d7746d9f2142bee4248115b58a527637b104f3750504499f2a6608459
+  data.tar.gz: fab84d0b2eb02221f96209f11c118feb77928d69269b009abb4c9a773089f1a011a96bbb3b731abce9cd8af45208eaabdef464c27244b7fd954554de1203c15b

data/app/finders/spree/option_values/find_available.rb

@@ -9,7 +9,7 @@ module Spree
       end
 
       def execute
-        find_available(scope, products_scope).select(select_args).order(order_args)
+        find_available(scope, products_scope).includes(:translations).select(select_args).order(order_args)
       end
 
       private

data/app/finders/spree/product_properties/find_available.rb

@@ -9,7 +9,7 @@ module Spree
       end
 
       def execute
-        find_available(scope, products_scope)
+        find_available(scope, products_scope).includes(:translations)
       end
 
       private

data/app/finders/spree/products/find.rb

@@ -146,7 +146,10 @@ module Spree
       def by_name(products)
         return products unless name?
 
-        products.like_any([:name], [name])
+        product_name = name
+
+        # i18n mobility scope doesn't automatically get set for query blocks (Mobility issue #599) - set it explicitly
+        products.i18n { name.matches("%#{product_name}%") }
       end
 
       def by_options(products)
@@ -183,7 +186,7 @@ module Spree
 
           next if values.empty?
 
-          ids = products.with_property_values(property_filter_param, values).ids
+          ids = scope.unscope(:order, :includes).with_property_values(property_filter_param, values).ids
           product_ids = index == 0 ? ids : product_ids & ids
           index += 1
         end
@@ -209,21 +212,19 @@ module Spree
             products
           end
         when 'name-a-z'
-          products.order(name: :asc)
+          # workaround for Mobility issue #596 - explicitly select fields to avoid error when selecting distinct
+          products.i18n.
+            select("#{Product.table_name}.*").select(:name).order(name: :asc)
         when 'name-z-a'
-          products.order(name: :desc)
+          # workaround for Mobility issue #596
+          products.i18n.
+            select("#{Product.table_name}.*").select(:name).order(name: :desc)
         when 'newest-first'
           products.order(available_on: :desc)
         when 'price-high-to-low'
-          products.
-            select("#{Product.table_name}.*, #{Spree::Price.table_name}.amount").
-            reorder('').
-            send(:descend_by_master_price)
+          order_by_price(products, :descend_by_master_price)
         when 'price-low-to-high'
-          products.
-            select("#{Product.table_name}.*, #{Spree::Price.table_name}.amount").
-            reorder('').
-            send(:ascend_by_master_price)
+          order_by_price(products, :ascend_by_master_price)
         end
       end
 
@@ -265,6 +266,13 @@ module Spree
         taxons = store.taxons.where(id: taxons_ids.to_s.split(','))
         taxons.map(&:cached_self_and_descendants_ids).flatten.compact.uniq.map(&:to_s)
       end
+
+      def order_by_price(scope, order_type)
+        scope.
+          select("#{Product.table_name}.*, #{Spree::Price.table_name}.amount").
+          reorder('').
+          send(order_type)
+      end
     end
   end
 end

data/app/finders/spree/taxons/find.rb

@@ -50,10 +50,6 @@ module Spree
         name.present?
       end
 
-      def name_matcher
-        Spree::Taxon.arel_table[:name].matches("%#{name}%")
-      end
-
       def by_ids(taxons)
         return taxons unless ids?
 
@@ -70,9 +66,13 @@ module Spree
         return taxons unless parent_permalink?
 
         if Rails::VERSION::STRING >= '6.1'
-          taxons.joins(:parent).where(parent: { permalink: parent_permalink })
+          taxons.joins(:parent).
+            join_translation_table(Taxon, 'parents_spree_taxons').
+            where(["#{Taxon.translation_table_alias}.permalink = ?", parent_permalink])
         else
-          taxons.joins("INNER JOIN #{Spree::Taxon.table_name} AS parent_taxon ON parent_taxon.id = #{Spree::Taxon.table_name}.parent_id").where(["parent_taxon.permalink = ?", parent_permalink])
+          taxons.joins("INNER JOIN #{Spree::Taxon.table_name} AS parent_taxon ON parent_taxon.id = #{Spree::Taxon.table_name}.parent_id").
+            join_translation_table(Taxon, 'parent_taxon').
+            where(["#{Taxon.translation_table_alias}.permalink = ?", parent_permalink])
         end
       end
 
@@ -91,7 +91,10 @@ module Spree
       def by_name(taxons)
         return taxons unless name?
 
-        taxons.where(name_matcher)
+        taxon_name = name
+
+        # i18n mobility scope doesn't automatically get set for query blocks (Mobility issue #599) - set it explicitly
+        taxons.i18n { name.matches("%#{taxon_name}%") }
       end
     end
   end

data/app/helpers/spree/base_helper.rb

@@ -113,8 +113,8 @@ module Spree
       meta = {}
 
       if object.is_a? ApplicationRecord
-        meta[:keywords] = object.meta_keywords if object[:meta_keywords].present?
-        meta[:description] = object.meta_description if object[:meta_description].present?
+        meta[:keywords] = object.meta_keywords if object.try(:meta_keywords).present?
+        meta[:description] = object.meta_description if object.try(:meta_description).present?
       end
 
       if meta[:description].blank? && object.is_a?(Spree::Product)

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

@@ -32,15 +32,16 @@ module Spree
       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 Property then { "#{properties}.id" => property.id }
-        when Integer  then { "#{properties}.id" => property }
+        when Property then { "#{properties_table}.id" => property.id }
+        when Integer  then { "#{properties_table}.id" => property }
         else
           if Property.column_for_attribute('id').type == :uuid
-            ["#{properties.name} = ? OR #{properties.id} = ?", property, property]
+            ["#{property_translations_table.name} = ? OR #{properties_table.id} = ?", property, property]
           else
-            { "#{properties}.name" => property }
+            { "#{property_translations_table}.name" => property }
           end
         end
       end
@@ -126,21 +127,25 @@ 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|
@@ -151,7 +156,9 @@ module Spree
         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).where(spree_option_types: { name: option })
+          joins(:option_types).
+            join_translation_table(OptionType).
+            where(OptionType.translation_table_alias => { name: option })
         end
       end
 
@@ -164,6 +171,7 @@ module Spree
                              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
 
@@ -171,7 +179,9 @@ module Spree
 
         group("#{Spree::Product.table_name}.id").
           joins(variants_including_master: :option_values).
-          where(Spree::OptionValue.table_name => { name: value, option_type_id: option_type_id })
+          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:
@@ -295,19 +305,10 @@ module Spree
       # .search_by_name
       if defined?(PgSearch)
         include PgSearch::Model
-
-        if defined?(SpreeGlobalize)
-          pg_search_scope :search_by_name, associated_against: { translations: :name }, using: { tsearch: { any_word: true, prefix: true } }
-        else
-          pg_search_scope :search_by_name, against: :name, using: { tsearch: { any_word: true, prefix: true } }
-        end
+        pg_search_scope :search_by_name, against: :name, using: { tsearch: { any_word: true, prefix: true } }
       else
         def self.search_by_name(query)
-          if defined?(SpreeGlobalize)
-            joins(:translations).order(:name).where("LOWER(#{Product::Translation.table_name}.name) LIKE LOWER(:query)", query: "%#{query}%").distinct
-          else
-            where("LOWER(#{Product.table_name}.name) LIKE LOWER(:query)", query: "%#{query}%")
-          end
+          i18n { name.lower.matches("%#{query.downcase}%") }
         end
       end
       search_scopes << :search_by_name
@@ -339,7 +340,10 @@ module Spree
           case t
           when ApplicationRecord then t
           else
-            Taxon.where(Taxon.arel_table[:name].eq(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
+            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,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/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?

data/app/models/spree/data_feed/google.rb

@@ -0,0 +1,15 @@
+require_dependency 'spree/data_feed'
+
+module Spree
+  class DataFeed::Google < DataFeed
+    class << self
+      def label
+        'Google Merchant Center Feed'
+      end
+
+      def provider_name
+        'google'
+      end
+    end
+  end
+end

data/app/models/spree/data_feed.rb

@@ -0,0 +1,40 @@
+module Spree
+  class DataFeed < Base
+    belongs_to :store, class_name: 'Spree::Store', foreign_key: 'store_id'
+
+    scope :for_store, ->(store) { where(store: store) }
+
+    before_validation :generate_slug
+
+    with_options presence: true do
+      validates :store
+      validates :name, uniqueness: true
+      validates :slug, uniqueness: { scope: :store_id }
+    end
+
+    def formatted_url
+      "#{store.formatted_url}/api/v2/data_feeds/#{self.class.provider_name}/#{slug}.rss"
+    end
+
+    private
+
+    def generate_slug
+      new_slug = slug.blank? ? SecureRandom.uuid : slug.parameterize
+      write_attribute(:slug, new_slug)
+    end
+
+    class << self
+      def label
+        raise NotImplementedError
+      end
+
+      def provider_name
+        raise NotImplementedError
+      end
+
+      def available_types
+        Rails.application.config.spree.data_feed_types
+      end
+    end
+  end
+end

data/app/models/spree/option_type.rb

@@ -2,10 +2,14 @@ module Spree
   class OptionType < Spree::Base
     include UniqueName
     include Metadata
+    include TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
+    TRANSLATABLE_FIELDS = %i[name presentation].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
     acts_as_list
     auto_strip_attributes :name, :presentation
 

data/app/models/spree/option_value.rb

@@ -1,10 +1,14 @@
 module Spree
   class OptionValue < Spree::Base
     include Metadata
+    include TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
+    TRANSLATABLE_FIELDS = %i[name presentation].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
     belongs_to :option_type, class_name: 'Spree::OptionType', touch: true, inverse_of: :option_values
 
     acts_as_list scope: :option_type

data/app/models/spree/product.rb

@@ -23,6 +23,8 @@ module Spree
     extend FriendlyId
     include ProductScopes
     include MultiStoreResource
+    include TranslatableResource
+    include TranslatableResourceSlug
     include MemoizedData
     include Metadata
     if defined?(Spree::Webhooks)
@@ -32,12 +34,20 @@ module Spree
       include Spree::VendorConcern
     end
 
-    MEMOIZED_METHODS = %w(total_on_hand taxonomy_ids taxon_and_ancestors category
+    MEMOIZED_METHODS = %w[total_on_hand taxonomy_ids taxon_and_ancestors category
                           default_variant_id tax_category default_variant
-                          purchasable? in_stock? backorderable?)
+                          purchasable? in_stock? backorderable?]
 
-    friendly_id :slug_candidates, use: :history
+    TRANSLATABLE_FIELDS = %i[name description slug meta_description meta_keywords meta_title].freeze
+    translates(*TRANSLATABLE_FIELDS)
 
+    self::Translation.class_eval do
+      acts_as_paranoid
+      # deleted translation values also need to be accessible for index views listing deleted resources
+      default_scope { unscope(where: :deleted_at) }
+    end
+
+    friendly_id :slug_candidates, use: [:history, :mobility]
     acts_as_paranoid
     auto_strip_attributes :name
 
@@ -306,14 +316,26 @@ module Spree
     end
 
     def property(property_name)
-      product_properties.joins(:property).find_by(spree_properties: { name: property_name }).try(:value)
+      product_properties.joins(:property).
+        join_translation_table(Property).
+        find_by(Property.translation_table_alias => { name: property_name }).try(:value)
     end
 
     def set_property(property_name, property_value, property_presentation = property_name)
       ApplicationRecord.transaction do
-        # Works around spree_i18n #301
-        property = Property.create_with(presentation: property_presentation).find_or_create_by(name: property_name)
-        product_property = ProductProperty.where(product: self, property: property).first_or_initialize
+        # Manual first_or_create to work around Mobility bug
+        property = if Property.where(name: property_name).exists?
+                     Property.where(name: property_name).first
+                   else
+                     Property.create(name: property_name, presentation: property_presentation)
+                   end
+
+        product_property = if ProductProperty.where(product: self, property: property).exists?
+                             ProductProperty.where(product: self, property: property).first
+                           else
+                             ProductProperty.create(product: self, property: property)
+                           end
+
         product_property.value = property_value
         product_property.save!
       end
@@ -337,11 +359,16 @@ module Spree
     end
 
     def brand
-      @brand ||= taxons.joins(:taxonomy).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_brands_name) })
+      @brand ||= taxons.joins(:taxonomy).
+                 join_translation_table(Taxonomy).
+                 find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_brands_name) })
     end
 
     def category
-      @category ||= taxons.joins(:taxonomy).order(depth: :desc).find_by(spree_taxonomies: { name: Spree.t(:taxonomy_categories_name) })
+      @category ||= taxons.joins(:taxonomy).
+                    join_translation_table(Taxonomy).
+                    order(depth: :desc).
+                    find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_categories_name) })
     end
 
     def taxons_for_store(store)
@@ -415,7 +442,11 @@ module Spree
 
     def punch_slug
       # punch slug with date prefix to allow reuse of original
-      update_column :slug, "#{Time.current.to_i}_#{slug}"[0..254] unless frozen?
+      return if frozen?
+
+      translations.with_deleted.each do |t|
+        t.update_column :slug, "#{Time.current.to_i}_#{t.slug}"[0..254]
+      end
     end
 
     def update_slug_history

data/app/models/spree/product_property.rb

@@ -1,8 +1,14 @@
 module Spree
   class ProductProperty < Spree::Base
     include Spree::FilterParam
+    include TranslatableResource
 
-    auto_strip_attributes :value
+    TRANSLATABLE_FIELDS = %i[value filter_param].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      auto_strip_attributes :value
+    end
 
     acts_as_list scope: :product
 
@@ -31,8 +37,11 @@ module Spree
         `ProductProperty#property_name=` is deprecated and will be removed in Spree 5.0.
       DEPRECATION
       if name.present?
-        # don't use `find_by :name` to workaround globalize/globalize#423 bug
-        self.property = Property.where(name: name).first_or_create(presentation: name)
+        self.property = if Property.where(name: name).exists?
+                          Property.where(name: name).first
+                        else
+                          Property.create(name: name, presentation: name)
+                        end
       end
     end
 

data/app/models/spree/property.rb

@@ -2,11 +2,17 @@ module Spree
   class Property < Spree::Base
     include Spree::FilterParam
     include Metadata
+    include TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
-    auto_strip_attributes :name, :presentation
+    TRANSLATABLE_FIELDS = %i[name presentation filter_param].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      auto_strip_attributes :name, :presentation
+    end
 
     has_many :property_prototypes, class_name: 'Spree::PropertyPrototype'
     has_many :prototypes, through: :property_prototypes, class_name: 'Spree::Prototype'

data/app/models/spree/shipment.rb

@@ -249,8 +249,8 @@ module Spree
     end
 
     def selected_shipping_rate_id=(id)
-      shipping_rates.update_all(selected: false)
-      shipping_rates.touch_all # Bust cache dependent on "updated_at" timestamp
+      # Explicitly updates the timestamp in order to bust cache dependent on "updated_at"
+      shipping_rates.update_all(selected: false, updated_at: Time.current)
       shipping_rates.update(id, selected: true)
       save!
     end

data/app/models/spree/store.rb

@@ -1,5 +1,6 @@
 module Spree
   class Store < Spree::Base
+    include TranslatableResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -7,6 +8,17 @@ module Spree
       include Spree::Security::Stores
     end
 
+    TRANSLATABLE_FIELDS = %i[name meta_description meta_keywords seo_title facebook
+                             twitter instagram customer_support_email description
+                             address contact_phone new_order_notifications_email].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      acts_as_paranoid
+      # deleted translation values still need to be accessible - remove deleted_at scope
+      default_scope { unscope(where: :deleted_at) }
+    end
+
     typed_store :settings, coder: ActiveRecord::TypedStore::IdentityCoder do |s|
       # Spree Digital Asset Configurations
       s.boolean :limit_digital_download_count, default: true, null: false
@@ -55,6 +67,8 @@ module Spree
 
     has_many :wishlists, class_name: 'Spree::Wishlist'
 
+    has_many :data_feeds, class_name: 'Spree::DataFeed'
+
     belongs_to :default_country, class_name: 'Spree::Country'
     belongs_to :checkout_zone, class_name: 'Spree::Zone'
 
@@ -109,7 +123,12 @@ module Spree
     # this behaviour is very buggy and unpredictable
     def self.default
       Rails.cache.fetch('default_store') do
-        where(default: true).first_or_initialize
+        # workaround for Mobility bug with first_or_initialize
+        if where(default: true).any?
+          where(default: true).first
+        else
+          new(default: true)
+        end
       end
     end