spree_core 4.5.5 → 4.6.0

data/app/models/spree/product.rb

@@ -22,9 +22,11 @@ module Spree
   class Product < Spree::Base
     extend FriendlyId
     include ProductScopes
-    include Spree::MultiStoreResource
-    include Spree::MemoizedData
-    include Spree::Metadata
+    include MultiStoreResource
+    include TranslatableResource
+    include TranslatableResourceSlug
+    include MemoizedData
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -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/promotion.rb

@@ -1,7 +1,7 @@
 module Spree
   class Promotion < Spree::Base
-    include Spree::MultiStoreResource
-    include Spree::Metadata
+    include MultiStoreResource
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/property.rb

@@ -1,12 +1,18 @@
 module Spree
   class Property < Spree::Base
     include Spree::FilterParam
-    include Spree::Metadata
+    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/prototype.rb

@@ -1,6 +1,6 @@
 module Spree
   class Prototype < Spree::Base
-    include Spree::Metadata
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/refund.rb

@@ -1,6 +1,6 @@
 module Spree
   class Refund < Spree::Base
-    include Spree::Metadata
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/reimbursement.rb

@@ -1,7 +1,7 @@
 module Spree
   class Reimbursement < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RI', length: 9)
-    include Spree::NumberIdentifier
+    include NumberIdentifier
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/return_authorization.rb

@@ -1,7 +1,7 @@
 module Spree
   class ReturnAuthorization < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
-    include Spree::NumberIdentifier
+    include NumberIdentifier
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/shipment.rb

@@ -3,9 +3,9 @@ require 'ostruct'
 module Spree
   class Shipment < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
-    include Spree::NumberIdentifier
-    include Spree::NumberAsParam
-    include Spree::Metadata
+    include NumberIdentifier
+    include NumberAsParam
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -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/shipping_method.rb

@@ -2,7 +2,7 @@ module Spree
   class ShippingMethod < Spree::Base
     acts_as_paranoid
     include Spree::CalculatedAdjustments
-    include Spree::Metadata
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/stock/estimator.rb

@@ -1,7 +1,7 @@
 module Spree
   module Stock
     class Estimator
-      include Spree::VatPriceCalculation
+      include VatPriceCalculation
 
       attr_reader :order, :currency
 

data/app/models/spree/stock_item.rb

@@ -2,7 +2,7 @@ module Spree
   class StockItem < Spree::Base
     acts_as_paranoid
 
-    include Spree::Metadata
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/stock_transfer.rb

@@ -1,9 +1,9 @@
 module Spree
   class StockTransfer < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'T')
-    include Spree::NumberIdentifier
-    include Spree::NumberAsParam
-    include Spree::Metadata
+    include NumberIdentifier
+    include NumberAsParam
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     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
 

data/app/models/spree/store_credit.rb

@@ -1,7 +1,7 @@
 module Spree
   class StoreCredit < Spree::Base
     include SingleStoreResource
-    include Spree::Metadata
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end

data/app/models/spree/taxon.rb

@@ -3,7 +3,9 @@ require 'stringex'
 
 module Spree
   class Taxon < Spree::Base
-    include Spree::Metadata
+    include TranslatableResource
+    include TranslatableResourceSlug
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -27,7 +29,7 @@ module Spree
     has_many :promotion_rule_taxons, class_name: 'Spree::PromotionRuleTaxon', dependent: :destroy
     has_many :promotion_rules, through: :promotion_rule_taxons, class_name: 'Spree::PromotionRule'
 
-    validates :name, presence: true, uniqueness: { scope: [:parent_id, :taxonomy_id], allow_blank: true, case_sensitive: false }
+    validates :name, presence: true, uniqueness: { scope: [:parent_id, :taxonomy_id], case_sensitive: false }
     validates :taxonomy, presence: true
     validates :permalink, uniqueness: { case_sensitive: false, scope: [:parent_id, :taxonomy_id] }
     validates :hide_from_nav, inclusion: { in: [true, false] }
@@ -54,6 +56,24 @@ module Spree
 
     scope :for_stores, ->(stores) { joins(:taxonomy).where(spree_taxonomies: { store_id: stores.ids }) }
 
+    TRANSLATABLE_FIELDS = %i[name description permalink].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      alias_attribute :slug, :permalink
+
+      before_create :set_permalink
+
+      def set_permalink
+        parent = translated_model.parent
+        if parent.present?
+          self.permalink = [parent.permalink, (permalink.blank? ? name.to_url : permalink.split('/').last)].join('/')
+        else
+          self.permalink = name.to_url if permalink.blank?
+        end
+      end
+    end
+
     # indicate which filters should be used for a taxon
     # this method should be customized to your own site
     def applicable_filters
@@ -73,11 +93,7 @@ module Spree
 
     # Creates permalink base for friendly_id
     def set_permalink
-      if parent.present?
-        self.permalink = [parent.permalink, (permalink.blank? ? name.to_url : permalink.split('/').last)].join('/')
-      else
-        self.permalink = name.to_url if permalink.blank?
-      end
+      translations.each(&:set_permalink)
     end
 
     def active_products

data/app/models/spree/taxonomy.rb

@@ -1,10 +1,14 @@
 module Spree
   class Taxonomy < Spree::Base
-    include Spree::Metadata
+    include TranslatableResource
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
+    TRANSLATABLE_FIELDS = %i[name].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
     acts_as_list
 
     validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true, scope: :store_id }

data/app/models/spree/variant.rb

@@ -3,8 +3,8 @@ module Spree
     acts_as_paranoid
     acts_as_list scope: :product
 
-    include Spree::MemoizedData
-    include Spree::Metadata
+    include MemoizedData
+    include Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -122,16 +122,13 @@ module Spree
     self.whitelisted_ransackable_scopes = %i(product_name_or_sku_cont search_by_product_name_or_sku)
 
     def self.product_name_or_sku_cont(query)
-      joins(:product).where("LOWER(#{Product.table_name}.name) LIKE LOWER(:query) OR LOWER(sku) LIKE LOWER(:query)", query: "%#{query}%")
+      joins(:product).join_translation_table(Product).
+        where("LOWER(#{Product.translation_table_alias}.name) LIKE LOWER(:query)
+               OR LOWER(sku) LIKE LOWER(:query)", query: "%#{query}%")
     end
 
     def self.search_by_product_name_or_sku(query)
-      if defined?(SpreeGlobalize)
-        joins(product: :translations).where("LOWER(#{Product::Translation.table_name}.name) LIKE LOWER(:query) OR LOWER(sku) LIKE LOWER(:query)",
-                                            query: "%#{query}%")
-      else
-        product_name_or_sku_cont(query)
-      end
+      product_name_or_sku_cont(query)
     end
 
     def available?

data/app/services/spree/data_feeds/google/optional_attributes.rb

@@ -0,0 +1,23 @@
+module Spree
+  module DataFeeds
+    module Google
+      class OptionalAttributes
+        prepend Spree::ServiceModule::Base
+
+        def call(input)
+          information = {}
+
+          input[:product].property_ids.each do |key|
+            name = Spree::Property.find(key)&.name
+            value = input[:product].property(name)
+            unless value.nil?
+              information[name] = value
+            end
+          end
+
+          success(information: information)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/data_feeds/google/optional_sub_attributes.rb

@@ -0,0 +1,21 @@
+module Spree
+  module DataFeeds
+    module Google
+      class OptionalSubAttributes
+        prepend Spree::ServiceModule::Base
+
+        def call(input)
+          information = {}
+
+          # This is a place where you can put attributes that have sub-attributes, example for shipping:
+          #
+          # information['shipping'] = {}
+          # information['shipping']['price'] = calculate_shipping(input[:product])
+          # information['shipping']['country'] = input[:store].default_country
+
+          success(information: information)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/data_feeds/google/products_list.rb

@@ -0,0 +1,14 @@
+module Spree
+  module DataFeeds
+    module Google
+      class ProductsList
+        prepend Spree::ServiceModule::Base
+
+        def call(store)
+          products = store.products.active
+          success(products: products)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/data_feeds/google/required_attributes.rb

@@ -0,0 +1,67 @@
+module Spree
+  module DataFeeds
+    module Google
+      class RequiredAttributes
+        prepend Spree::ServiceModule::Base
+
+        def call(input)
+          information = {}
+
+          return failure(nil, error: 'No image link') if get_image_link(input[:variant], input[:product]).nil?
+
+          information['id'] = input[:variant].id
+          information['title'] = format_title(input[:product], input[:variant])
+          information['description'] = get_description(input[:product], input[:variant])
+          information['link'] = "#{input[:store].url}/#{input[:product].slug}"
+          information['image_link'] = get_image_link(input[:variant], input[:product])
+          information['price'] = format_price(input[:variant])
+          information['availability'] = get_availability(input[:product])
+          information['availability_date'] = input[:product].available_on&.xmlschema unless input[:product].available_on.nil?
+
+          success(information: information)
+        end
+
+        private
+
+        def format_title(product, variant)
+          # Title of a variant is created by joining title of a product and variant's option_values, as they are
+          # what differentiates it from other variants.
+          title = product.name
+          variant.option_values.find_each do |option_value|
+            title << " - #{option_value.name}"
+          end
+          title
+        end
+
+        def get_description(product, variant)
+          return product.description unless product.description.nil?
+
+          format_title(product, variant)
+        end
+
+        def get_image_link(variant, product)
+          # try getting image from variant
+          img = variant.images.first&.plp_url
+
+          # if no image specified for variant try getting product image
+          if img.nil?
+            img = product.images.first&.plp_url
+          end
+
+          img
+        end
+
+        def format_price(variant)
+          "#{variant.price} #{variant.cost_currency}"
+        end
+
+        def get_availability(product)
+          return 'in stock' if product.available? && product.available_on&.past?
+          return 'backorder' if product.backorderable? && product.backordered? && product.available_on&.future?
+
+          'out of stock'
+        end
+      end
+    end
+  end
+end

data/app/services/spree/data_feeds/google/rss.rb

@@ -0,0 +1,107 @@
+require 'nokogiri'
+
+module Spree
+  module DataFeeds
+    module Google
+      class Rss
+        prepend Spree::ServiceModule::Base
+
+        def call(settings)
+          @settings = settings
+
+          return failure(store, error: "Store with id: #{settings.store_id} does not exist.") if store.nil?
+
+          builder = Nokogiri::XML::Builder.new do |xml|
+            xml.rss('xmlns:g' => 'http://base.google.com/ns/1.0', 'version' => '2.0') do
+              xml.channel do
+                add_store_information_to_xml(xml)
+                result = products_list.call(store)
+                if result.success?
+                  result.value[:products].find_each do |product|
+                    product.variants.active.find_each do |variant|
+                      add_variant_information_to_xml(xml, product, variant)
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          success(file: builder.to_xml)
+        end
+
+        private
+
+        def store
+          return @store if defined? @store
+
+          @store ||= Spree::Store.find_by(id: @settings.store_id)
+        end
+
+        def add_store_information_to_xml(xml)
+          xml.title store.name
+          xml.link store.url
+          xml.description store.meta_description
+        end
+
+        def add_variant_information_to_xml(xml, product, variant)
+          input = { product: product, variant: variant, settings: @settings, store: store }
+          result = required_attributes.call(input)
+
+          if result.success
+            xml.item do
+              result.value[:information]&.each do |key, value|
+                xml['g'].send(key, value)
+              end
+
+              add_optional_information(xml, product, variant)
+              add_optional_sub_attributes(xml, product, variant)
+            end
+          end
+        end
+
+        def add_optional_information(xml, product, variant)
+          input = { product: product, variant: variant, settings: @settings, store: store }
+          result = optional_attributes.call(input)
+          if result.success?
+            information = result.value[:information]
+            information.each do |key, value|
+              xml['g'].send(key, value)
+            end
+          end
+        end
+
+        def add_optional_sub_attributes(xml, product, variant)
+          input = { product: product, variant: variant, settings: @settings, store: store }
+          result = optional_sub_attributes.call(input)
+          if result.success?
+            information = result.value[:information]
+            information.each do |key, value|
+              xml['g'].send(key) do
+                value.each do |subkey, subvalue|
+                  xml['g'].send(subkey, subvalue)
+                end
+              end
+            end
+          end
+        end
+
+        def optional_attributes
+          Spree::Dependencies.data_feeds_google_optional_attributes_service.constantize.new
+        end
+
+        def required_attributes
+          Spree::Dependencies.data_feeds_google_required_attributes_service.constantize.new
+        end
+
+        def optional_sub_attributes
+          Spree::Dependencies.data_feeds_google_optional_sub_attributes_service.constantize.new
+        end
+
+        def products_list
+          Spree::Dependencies.data_feeds_google_products_list.constantize.new
+        end
+      end
+    end
+  end
+end