spree_core 4.5.0 → 4.7.3

data/app/models/spree/stock_item.rb

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

data/app/models/spree/stock_location.rb

@@ -1,6 +1,6 @@
 module Spree
   class StockLocation < Spree::Base
-    include UniqueName
+    include Spree::UniqueName
     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 NumberIdentifier
-    include NumberAsParam
-    include Metadata
+    include Spree::NumberIdentifier
+    include Spree::NumberAsParam
+    include Spree::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 Spree::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'
 
@@ -98,7 +112,7 @@ module Spree
     alias_attribute :contact_email, :customer_support_email
 
     def self.current(url = nil)
-      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+      Spree::Deprecation.warn(<<-DEPRECATION, caller)
         `Spree::Store.current` is deprecated and will be removed in Spree 5.0
         Please use `Spree::Stores::FindCurrent.new(url: "https://example.com").execute` instead
       DEPRECATION
@@ -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
 
@@ -175,7 +194,7 @@ module Spree
     end
 
     def checkout_zone_or_default
-      ActiveSupport::Deprecation.warn('Store#checkout_zone_or_default is deprecated and will be removed in Spree 5')
+      Spree::Deprecation.warn('Store#checkout_zone_or_default is deprecated and will be removed in Spree 5')
 
       @checkout_zone_or_default ||= checkout_zone || Spree::Zone.default_checkout_zone
     end

data/app/models/spree/store_credit.rb

@@ -1,7 +1,7 @@
 module Spree
   class StoreCredit < Spree::Base
-    include SingleStoreResource
-    include Metadata
+    include Spree::SingleStoreResource
+    include Spree::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 Metadata
+    include Spree::TranslatableResource
+    include Spree::TranslatableResourceSlug
+    include Spree::Metadata
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -11,6 +13,7 @@ module Spree
     extend FriendlyId
     friendly_id :permalink, slug_column: :permalink, use: :history
     before_validation :set_permalink, on: :create, if: :name
+    alias_attribute :slug, :permalink
 
     acts_as_nested_set dependent: :destroy
 
@@ -27,7 +30,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 +57,47 @@ 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_save :set_permalink
+
+      def set_permalink
+        self.permalink = generate_slug
+      end
+
+      private
+
+      def generate_slug
+        if parent.present?
+          generate_permalink_including_parent
+        elsif permalink.blank?
+          name_with_fallback.to_url
+        else
+          permalink.to_url
+        end
+      end
+
+      def generate_permalink_including_parent
+        [parent_permalink_with_fallback, (permalink.blank? ? name_with_fallback.to_url : permalink.split('/').last.to_url)].join('/')
+      end
+
+      def name_with_fallback
+        name.blank? ? translated_model.name : name
+      end
+
+      def parent
+        translated_model.parent
+      end
+
+      def parent_permalink_with_fallback
+        localized_parent = parent.translations.find_by(locale: locale)
+        localized_parent.present? ? localized_parent.permalink : parent.permalink
+      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 +117,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/taxon_image.rb

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

data/app/models/spree/taxonomy.rb

@@ -1,10 +1,14 @@
 module Spree
   class Taxonomy < Spree::Base
-    include Metadata
+    include Spree::TranslatableResource
+    include Spree::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 MemoizedData
-    include Metadata
+    include Spree::MemoizedData
+    include Spree::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/models/spree/wishlist.rb

@@ -1,11 +1,15 @@
 module Spree
   class Wishlist < Spree::Base
-    include SingleStoreResource
+    include Spree::SingleStoreResource
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
 
-    has_secure_token
+    if Rails::VERSION::STRING >= '7.1.0'
+      has_secure_token on: :save
+    else
+      has_secure_token
+    end
 
     belongs_to :user, class_name: "::#{Spree.user_class}", touch: true
     belongs_to :store, class_name: 'Spree::Store'

data/app/models/spree/zone.rb

@@ -1,6 +1,6 @@
 module Spree
   class Zone < Spree::Base
-    include UniqueName
+    include Spree::UniqueName
     if defined?(Spree::Webhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -74,7 +74,7 @@ module Spree
     end
 
     def self.default_checkout_zone
-      ActiveSupport::Deprecation.warn('Spree::Zone.default_checkout_zone is deprecated and will be removed in Spree 5')
+      Spree::Deprecation.warn('Spree::Zone.default_checkout_zone is deprecated and will be removed in Spree 5')
 
       first
     end

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

data/app/services/spree/locales/set_fallback_locale_for_store.rb

@@ -0,0 +1,16 @@
+module Spree
+  module Locales
+    class SetFallbackLocaleForStore
+      def call(store:)
+        store_default_locale = store.default_locale
+        fallbacks = store.supported_locales_list.each_with_object({}) do |locale, object|
+          object[locale] = [store_default_locale]
+        end
+
+        fallbacks_instance = I18n::Locale::Fallbacks.new(fallbacks)
+
+        Mobility.store_based_fallbacks = fallbacks_instance
+      end
+    end
+  end
+end

data/app/services/spree/seeds/countries.rb

@@ -9,34 +9,19 @@ module Spree
 
       def call
         ApplicationRecord.transaction do
-          if Rails::VERSION::MAJOR >= 6
-            new_countries = Carmen::Country.all.map do |country|
-              # Skip the creation of some territories, uninhabited islands and the Antarctic.
-              next if EXCLUDED_COUNTRIES.include?(country.alpha_2_code)
+          new_countries = Carmen::Country.all.map do |country|
+            # Skip the creation of some territories, uninhabited islands and the Antarctic.
+            next if EXCLUDED_COUNTRIES.include?(country.alpha_2_code)
 
-              Hash[
-                'name': country.name,
-                'iso3': country.alpha_3_code,
-                'iso': country.alpha_2_code,
-                'iso_name': country.name.upcase,
-                'numcode': country.numeric_code,
-              ]
-            end.compact.uniq
-            Spree::Country.insert_all(new_countries)
-          else
-            Carmen::Country.all.each do |country|
-              # Skip the creation of some territories, uninhabited islands and the Antarctic.
-              next if EXCLUDED_COUNTRIES.include?(country.alpha_2_code)
-
-              Spree::Country.where(
-                name: country.name,
-                iso3: country.alpha_3_code,
-                iso: country.alpha_2_code,
-                iso_name: country.name.upcase,
-                numcode: country.numeric_code
-              ).first_or_create!
-            end
-          end
+            Hash[
+              'name': country.name,
+              'iso3': country.alpha_3_code,
+              'iso': country.alpha_2_code,
+              'iso_name': country.name.upcase,
+              'numcode': country.numeric_code,
+            ]
+          end.compact.uniq
+          Spree::Country.insert_all(new_countries)
 
           # Find countries that do not use postal codes (by iso) and set 'zipcode_required' to false for them.
           Spree::Country.where(iso: Spree::Address::NO_ZIPCODE_ISO_CODES).update_all(zipcode_required: false)

data/app/services/spree/seeds/states.rb

@@ -49,23 +49,14 @@ module Spree
       end
 
       def province_level(country, subregion)
-        if Rails::VERSION::MAJOR >= 6
-          new_states = subregion.subregions.map do |province|
-            Hash[
-              name: province.name,
-              abbr: province.code,
-              country_id: country.id
-            ]
-          end.compact.uniq
-          Spree::State.insert_all(new_states)
-        else
-          subregion.subregions.each do |province|
-            country.states.where(
-              name: province.name,
-              abbr: province.code
-            ).first_or_create!
-          end
-        end
+        new_states = subregion.subregions.map do |province|
+          Hash[
+            name: province.name,
+            abbr: province.code,
+            country_id: country.id
+          ]
+        end.compact.uniq
+        Spree::State.insert_all(new_states)
       end
     end
   end

data/app/services/spree/stock_locations/stock_items/create.rb

@@ -5,24 +5,18 @@ module Spree
         prepend Spree::ServiceModule::Base
 
         def call(stock_location:, variants_scope: Spree::Variant)
-          if Rails::VERSION::MAJOR >= 6
-            prepared_stock_items = variants_scope.ids.map do |variant_id|
-              Hash[
-                'stock_location_id', stock_location.id,
-                'variant_id', variant_id,
-                'backorderable', stock_location.backorderable_default,
-                'created_at', Time.current,
-                'updated_at', Time.current
-              ]
-            end
-            if prepared_stock_items.any?
-              stock_location.stock_items.insert_all(prepared_stock_items)
-              variants_scope.touch_all
-            end
-          else
-            variants_scope.find_each do |variant|
-              stock_location.propagate_variant(variant)
-            end
+          prepared_stock_items = variants_scope.ids.map do |variant_id|
+            Hash[
+              'stock_location_id', stock_location.id,
+              'variant_id', variant_id,
+              'backorderable', stock_location.backorderable_default,
+              'created_at', Time.current,
+              'updated_at', Time.current
+            ]
+          end
+          if prepared_stock_items.any?
+            stock_location.stock_items.insert_all(prepared_stock_items)
+            variants_scope.touch_all
           end
         end
       end