spree_core 5.4.0.rc4 → 5.4.0.rc4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bc3a50296fda5fe9d3f9cfa5ec4547b44e8dc7c718634f0de73314d55210479
-  data.tar.gz: 74757285458b4d4a322d5cdc0ea550c4fe7e9ca9de25095fba0371b6c1fb1e93
+  metadata.gz: 0445fa1595f6f1abf4bc08b4f961ce9be32e84085e27cf64d0f85ffda00eec7f
+  data.tar.gz: 98519e65a1214f7b9a27e95c1cb29ecfcd5faea8b07f453bee23a96be92e2f29
 SHA512:
-  metadata.gz: c9ce63a0797b37332944d4d1df8e60f132c27af526e970fd290f993d03b0d9fbf1fcbb1c2c3b55d37184cc10f72b884c79ec68b42398928cbc490a5b55a982c5
-  data.tar.gz: 14e3357af8ce8cdb75764e15b14759fe4ff37f132a32242b87c269d3137c6f41d11071415be24975c71e4086df5a45b5853840a68dca91ea9541857bd7b18d78
+  metadata.gz: cf023f4b0a51304733d7a502bc59df945e3b09c67124f7c8b0578deb8d5f29a1ec3b92bd6cbdbcb3681b818189eb8615342fb25d1c6051e9c85ea5c667af0c53
+  data.tar.gz: 8c3a926ca0ac60e7ca2f4e99eae97d2686175095ec414066e04d9d5631d92ca94bf28fb4e6678499cdf7b28994e9d05744eae34c737fd369cfff7fce43ebbbdf

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

@@ -22,6 +22,16 @@ module Spree
       self.private_metadata = value
     end
 
+    def public_metadata=(value)
+      unless value.blank? || value == {}
+        Spree::Deprecation.warn(
+          'public_metadata is deprecated and will be removed in Spree 6.0. ' \
+          'Use metadata instead. For customer-visible structured data, use metafields with display_on: \'both\'.'
+        )
+      end
+      super
+    end
+
     # https://nandovieira.com/using-postgresql-and-jsonb-with-ruby-on-rails
     class HashSerializer
       def self.dump(hash)

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

@@ -45,8 +45,6 @@ module Spree
       end
     end
 
-    private
-
     def enqueue_search_index
       return unless search_indexing_enabled?
 

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

@@ -0,0 +1,19 @@
+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
+
+      def presenter_class
+        Spree::DataFeeds::GooglePresenter
+      end
+    end
+  end
+end

data/app/models/spree/data_feed.rb

@@ -0,0 +1,47 @@
+module Spree
+  class DataFeed < Spree.base_class
+    has_prefix_id :df
+
+    belongs_to :store, class_name: 'Spree::Store', foreign_key: 'store_id'
+
+    scope :for_store, ->(store) { where(store: store) }
+    scope :active, -> { where(active: true) }
+
+    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/v3/store/feeds/#{slug}.xml"
+    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 presenter_class
+        raise NotImplementedError
+      end
+
+      def available_types
+        Spree.data_feed_types
+      end
+    end
+  end
+end

data/app/models/spree/metafield.rb

@@ -1,6 +1,6 @@
 module Spree
   class Metafield < Spree.base_class
-    has_prefix_id :mf
+    has_prefix_id :cf
 
     #
     # Associations

data/app/models/spree/metafield_definition.rb

@@ -1,6 +1,6 @@
 module Spree
   class MetafieldDefinition < Spree.base_class
-    has_prefix_id :mfdef
+    has_prefix_id :cfdef
 
     include Spree::DisplayOn
 

data/app/models/spree/order/checkout.rb

@@ -122,7 +122,6 @@ module Spree
               after_transition to: :complete, do: :use_all_coupon_codes
               after_transition to: :complete, do: :redeem_gift_card
               after_transition to: :complete, do: :subscribe_to_newsletter
-              after_transition to: :complete, do: :publish_order_completed_event
 
               after_transition from: any - :cart, to: any - [:confirm, :complete] do |order|
                 order.update_totals
@@ -133,10 +132,6 @@ module Spree
             alias_method :save_state, :save
           end
 
-          def publish_order_completed_event
-            publish_event('order.completed')
-          end
-
           def subscribe_to_newsletter
             return unless accept_marketing?
 

data/app/models/spree/store.rb

@@ -91,6 +91,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'
 

data/app/models/spree/variant.rb

@@ -292,9 +292,11 @@ module Spree
     end
 
     # Returns first Image for Variant.
+    # @deprecated Use #primary_media instead.
     # @return [Spree::Image, nil]
     def primary_image
-      images.first
+      Spree::Deprecation.warn('Spree::Variant#primary_image is deprecated and will be removed in Spree 6.0. Please use Spree::Variant#primary_media instead.')
+      primary_media
     end
 
     # Returns second Image for Variant (for hover effects).

data/app/presenters/spree/data_feeds/base_presenter.rb

@@ -0,0 +1,23 @@
+module Spree
+  module DataFeeds
+    class BasePresenter
+      def initialize(data_feed)
+        @data_feed = data_feed
+        @store = data_feed.store
+      end
+
+      attr_reader :data_feed, :store
+
+      # @return [String] the feed content (XML, CSV, etc.)
+      def call
+        raise NotImplementedError
+      end
+
+      private
+
+      def products
+        store.products.active
+      end
+    end
+  end
+end

data/app/presenters/spree/data_feeds/google_presenter.rb

@@ -0,0 +1,89 @@
+require 'nokogiri'
+
+module Spree
+  module DataFeeds
+    class GooglePresenter < BasePresenter
+      # @return [String] RSS XML feed for Google Merchant Center
+      def call
+        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
+              build_store_info(xml)
+              build_items(xml)
+            end
+          end
+        end
+
+        builder.to_xml
+      end
+
+      private
+
+      def build_store_info(xml)
+        xml.title store.name
+        xml.link store.storefront_url
+        xml.description store.meta_description
+      end
+
+      def build_items(xml)
+        products.includes(:primary_media, public_metafields: :metafield_definition, variants_including_master: [:primary_media, option_values: :option_type]).find_each do |product|
+          product.variants_including_master.active.each do |variant|
+            next if variant.is_master? && product.has_variants?
+
+            build_item(xml, product, variant)
+          end
+        end
+      end
+
+      def build_item(xml, product, variant)
+        image_url = image_link(variant, product)
+        return if image_url.nil?
+
+        xml.item do
+          build_required_attributes(xml, product, variant, image_url)
+          build_optional_attributes(xml, product)
+        end
+      end
+
+      def build_required_attributes(xml, product, variant, image_url)
+        xml['g'].id variant.id
+        xml['g'].item_group_id product.id
+        xml['g'].title format_title(product, variant)
+        xml['g'].description product.description || format_title(product, variant)
+        xml['g'].link "#{store.storefront_url}/products/#{product.slug}"
+        xml['g'].image_link image_url
+        xml['g'].price "#{variant.price} #{variant.cost_currency}"
+        xml['g'].availability availability(product)
+        xml['g'].availability_date product.available_on.xmlschema if product.available_on.present?
+      end
+
+      def build_optional_attributes(xml, product)
+        product.public_metafields.each do |metafield|
+          xml['g'].send(metafield.metafield_definition.key.parameterize.underscore, metafield.value)
+        end
+      end
+
+      def format_title(product, variant)
+        parts = [product.name]
+        variant.option_values.each do |option_value|
+          parts << option_value.name
+        end
+        parts.join(' - ')
+      end
+
+      def image_link(variant, product)
+        image = variant.primary_media || product.primary_media
+        return if image.nil?
+
+        Rails.application.routes.url_helpers.cdn_image_url(image.attachment.variant(:xlarge))
+      end
+
+      def availability(product)
+        return 'in stock' if product.available? && (product.available_on.nil? || product.available_on.past?)
+        return 'backorder' if product.backorderable? && product.backordered? && product.available_on&.future?
+
+        'out of stock'
+      end
+    end
+  end
+end

data/app/services/spree/sample_data/loader.rb

@@ -26,6 +26,8 @@ module Spree
             puts 'Loading sample posts...'
             load_ruby_file('posts')
 
+            clear_jobs_queue
+
             puts 'Sample data loaded successfully!'
           end
         end
@@ -73,6 +75,11 @@ module Spree
       ensure
         Spree::Config[:geocode_addresses] = previous
       end
+
+      def clear_jobs_queue
+        adapter = ActiveJob::Base.queue_adapter
+        adapter.enqueued_jobs.clear if adapter.respond_to?(:enqueued_jobs)
+      end
     end
   end
 end

data/app/services/spree/taxons/add_products.rb

@@ -34,8 +34,10 @@ module Spree
         taxon_ids.each { |id| Spree::Taxon.reset_counters(id, :classifications) }
         product_ids.each { |id| Spree::Product.reset_counters(id, :classifications) }
 
-        # clearing cache
+        # clear cache & index products
         Spree::Product.where(id: product_ids).touch_all
+        products.each(&:enqueue_search_index)
+
         Spree::Taxon.where(id: taxon_ids).touch_all
         Spree::Taxons::TouchFeaturedSections.call(taxon_ids: taxon_ids) if defined?(Spree::Taxons::TouchFeaturedSections)
 

data/app/services/spree/taxons/regenerate_products.rb

@@ -32,7 +32,9 @@ module Spree
           Spree::Classification.insert_all(records_to_insert)
 
           # expire product cache
-          Spree::Product.where(id: (previous_products_ids + product_ids_to_insert).uniq).touch_all
+          products = Spree::Product.where(id: (previous_products_ids + product_ids_to_insert).uniq)
+          products.touch_all
+          products.each(&:enqueue_search_index)
         end
 
         # update counter caches

data/app/services/spree/taxons/remove_products.rb

@@ -49,8 +49,10 @@ module Spree
         taxon_ids.each { |id| Spree::Taxon.reset_counters(id, :classifications) }
         product_ids.each { |id| Spree::Product.reset_counters(id, :classifications) }
 
-        # clear cache
+        # clear cache & index products
         Spree::Product.where(id: product_ids).touch_all
+        products.each(&:enqueue_search_index)
+
         Spree::Taxon.where(id: taxon_ids).touch_all
         Spree::Taxons::TouchFeaturedSections.call(taxon_ids: taxon_ids) if defined?(Spree::Taxons::TouchFeaturedSections)
 

data/config/locales/en.yml

@@ -532,11 +532,11 @@ en:
         one: Tax Rate
         other: Tax Rates
       spree/taxon:
-        one: Taxon
-        other: Taxons
+        one: Category
+        other: Categories
       spree/taxonomy:
-        one: Taxonomy
-        other: Taxonomies
+        one: Category
+        other: Categories
       spree/theme:
         one: Theme
         other: Themes
@@ -1451,7 +1451,7 @@ en:
     new_image: New Image
     new_line_item: Add line item
     new_metafield_definition: New Metafield Definition
-    new_nested_taxon: New nested taxon
+    new_nested_taxon: New nested subcategory
     new_option_type: New Option Type
     new_order: New Order
     new_order_completed: New Order Completed
@@ -1486,8 +1486,8 @@ en:
     new_store_credit_category: New Store Credit Category
     new_tax_category: New Tax Category
     new_tax_rate: New Tax Rate
-    new_taxon: New Taxon
-    new_taxonomy: New Taxonomy
+    new_taxon: New Subcategory
+    new_taxonomy: New Category
     new_tracker: New Tracker
     new_user: New User
     new_variant: New Variant
@@ -2332,15 +2332,15 @@ en:
       label: Order must contain x amount of these taxons
       match_all: all
       match_any: at least one
-    taxonomies: Taxonomies
-    taxonomy: Taxonomy
+    taxonomies: Categories
+    taxonomy: Category
     taxonomy_brands_name: Brands
     taxonomy_categories_name: Categories
     taxonomy_collections_name: Collections
     taxonomy_edit: Edit taxonomy
     taxonomy_tree_error: The requested change has not been accepted and the tree has been returned to its previous state, please try again.
     taxonomy_tree_instruction: "* Right click (or double tap on iOS device) a child in the tree to access the menu for adding, deleting or sorting a child."
-    taxons: Taxons
+    taxons: Categories
     terms_of_service: Terms of Service
     test: Test
     test_mode: Test Mode

data/db/migrate/20221229132350_create_spree_data_feed_settings.rb

@@ -0,0 +1,14 @@
+class CreateSpreeDataFeedSettings < ActiveRecord::Migration[6.0]
+  def change
+    create_table :spree_data_feed_settings do |t|
+      t.references :spree_store
+
+      t.string :name
+      t.string :provider
+      t.string :uuid, unique: true
+      t.boolean :enabled, default: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230415155958_rename_data_feed_settings_table.rb

@@ -0,0 +1,5 @@
+class RenameDataFeedSettingsTable < ActiveRecord::Migration[6.1]
+  def change
+    rename_table :spree_data_feed_settings, :spree_data_feeds
+  end
+end

data/db/migrate/20230415160828_rename_data_feed_table_columns.rb

@@ -0,0 +1,7 @@
+class RenameDataFeedTableColumns < ActiveRecord::Migration[6.1]
+  def change
+    rename_column :spree_data_feeds, :spree_store_id, :store_id
+    rename_column :spree_data_feeds, :enabled, :active
+    rename_column :spree_data_feeds, :uuid, :slug
+  end
+end

data/db/migrate/20230415161226_add_indexes_to_data_feeds_table.rb

@@ -0,0 +1,5 @@
+class AddIndexesToDataFeedsTable < ActiveRecord::Migration[6.1]
+  def change
+    add_index :spree_data_feeds, [:store_id, :slug, :provider]
+  end
+end

data/db/migrate/20230512094803_rename_data_feeds_column_provider_to_type.rb

@@ -0,0 +1,5 @@
+class RenameDataFeedsColumnProviderToType < ActiveRecord::Migration[6.1]
+  def change
+    rename_column :spree_data_feeds, :provider, :type
+  end
+end