spree_core 4.10.1 → 5.0.0.rc1

data/app/models/spree/store_credit_event.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StoreCreditEvent < Spree::Base
+  class StoreCreditEvent < Spree.base_class
     acts_as_paranoid
 
     belongs_to :store_credit
@@ -29,5 +29,25 @@ module Spree
     def order
       store.payments.find_by(response_code: authorization_code).try(:order)
     end
+
+    def allocation?
+      action == Spree::StoreCredit::ALLOCATION_ACTION
+    end
+
+    def credit?
+      action == Spree::StoreCredit::CREDIT_ACTION
+    end
+
+    def captured?
+      action == Spree::StoreCredit::CAPTURE_ACTION
+    end
+
+    def voided?
+      action == Spree::StoreCredit::VOID_ACTION
+    end
+
+    def authorized?
+      action == Spree::StoreCredit::AUTHORIZE_ACTION
+    end
   end
 end

data/app/models/spree/store_credit_type.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StoreCreditType < Spree::Base
+  class StoreCreditType < Spree.base_class
     DEFAULT_TYPE_NAME = 'Expiring'.freeze
     has_many :store_credits, class_name: 'Spree::StoreCredit', foreign_key: 'type_id'
 

data/app/models/spree/store_payment_method.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StorePaymentMethod < Spree::Base
+  class StorePaymentMethod < Spree.base_class
     self.table_name = 'spree_payment_methods_stores'
 
     belongs_to :store, class_name: 'Spree::Store', touch: true

data/app/models/spree/store_product.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StoreProduct < Spree::Base
+  class StoreProduct < Spree.base_class
     self.table_name = 'spree_products_stores'
 
     belongs_to :store, class_name: 'Spree::Store', touch: true

data/app/models/spree/store_promotion.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StorePromotion < Spree::Base
+  class StorePromotion < Spree.base_class
     self.table_name = 'spree_promotions_stores'
 
     belongs_to :store, class_name: 'Spree::Store', touch: true

data/app/models/spree/tax_category.rb

@@ -1,5 +1,5 @@
 module Spree
-  class TaxCategory < Spree::Base
+  class TaxCategory < Spree.base_class
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -12,9 +12,17 @@ module Spree
     has_many :variants, dependent: :nullify
 
     before_save :set_default_category
+    after_update :delete_cache
+    after_create :delete_cache
 
     self.whitelisted_ransackable_attributes = %w[name is_default tax_code]
 
+    def self.default
+      Rails.cache.fetch('default_tax_category') do
+        find_by(is_default: true)
+      end
+    end
+
     def set_default_category
       # set existing default tax category to false if this one has been marked as default
 
@@ -22,5 +30,11 @@ module Spree
         tax_category.update_columns(is_default: false, updated_at: Time.current)
       end
     end
+
+    private
+
+    def delete_cache
+      Rails.cache.delete('default_tax_category')
+    end
   end
 end

data/app/models/spree/tax_rate.rb

@@ -1,5 +1,5 @@
 module Spree
-  class TaxRate < Spree::Base
+  class TaxRate < Spree.base_class
     acts_as_paranoid
 
     include Spree::CalculatedAdjustments

data/app/models/spree/taxon.rb

@@ -2,7 +2,19 @@
 require 'stringex'
 
 module Spree
-  class Taxon < Spree::Base
+  class Taxon < Spree.base_class
+    RULES_MATCH_POLICIES = %w[all any].freeze
+    SORT_ORDERS = %w[
+      manual
+      best-selling
+      name-a-z
+      name-z-a
+      price-high-to-low
+      price-low-to-high
+      newest-first
+      oldest-first
+    ]
+
     include Spree::TranslatableResource
     include Spree::TranslatableResourceSlug
     include Spree::Metadata
@@ -10,20 +22,21 @@ module Spree
       include Spree::Webhooks::HasWebhooks
     end
 
+    #
+    # Magic methods
+    #
     extend FriendlyId
     friendly_id :permalink, slug_column: :permalink, use: :history
-    before_validation :set_permalink, on: :create, if: :name
-
     acts_as_nested_set dependent: :destroy
 
+    #
+    # Associations
+    #
     belongs_to :taxonomy, class_name: 'Spree::Taxonomy', inverse_of: :taxons
-    has_many :classifications, -> { order(:position) }, dependent: :delete_all, inverse_of: :taxon
+    has_one :store, through: :taxonomy
+    has_many :classifications, -> { order(:position) }, dependent: :destroy_async, inverse_of: :taxon
     has_many :products, through: :classifications
-
-    delegate :store, to: :taxonomy
-
-    has_many :menu_items, as: :linked_resource
-    has_many :cms_sections, as: :linked_resource
+    has_one :icon, as: :viewable, dependent: :destroy, class_name: 'Spree::TaxonImage' # TODO: remove this as this is deprecated
 
     has_many :prototype_taxons, class_name: 'Spree::PrototypeTaxon', dependent: :destroy
     has_many :prototypes, through: :prototype_taxons, class_name: 'Spree::Prototype'
@@ -31,6 +44,17 @@ 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'
 
+    has_many :page_links, as: :linkable, class_name: 'Spree::PageLink', dependent: :destroy
+
+    #
+    # Attachments
+    #
+    has_one_attached :image, service: Spree.public_storage_service_name
+    has_one_attached :square_image, service: Spree.public_storage_service_name
+
+    #
+    # Validations
+    #
     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] }
@@ -43,7 +67,12 @@ module Spree
       validates :meta_description
       validates :meta_title
     end
+    validates :image, :square_image, content_type: Rails.application.config.active_storage.web_image_content_types
 
+    #
+    # Callbacks
+    #
+    before_validation :set_permalink, on: :create, if: :name
     before_validation :copy_taxonomy_from_parent
     before_save :set_pretty_name
     before_save :set_permalink
@@ -52,21 +81,134 @@ module Spree
     after_touch :touch_ancestors_and_taxonomy
     after_commit :regenerate_pretty_name_and_permalink, on: :update, if: :should_regenerate_pretty_name_and_permalink?
     after_move :regenerate_pretty_name_and_permalink
+    after_move :regenerate_translations_pretty_name_and_permalink
 
-    has_one :store, through: :taxonomy
-
-    has_one :icon, as: :viewable, dependent: :destroy, class_name: 'Spree::TaxonImage'
+    after_commit :touch_featured_sections, on: [:update]
+    after_touch :touch_featured_sections
+    after_destroy :remove_featured_sections, if: -> { featured? }
 
+    #
+    # Scopes
+    #
     scope :for_store, ->(store) { joins(:taxonomy).where(spree_taxonomies: { store_id: store.id }) }
+    scope :for_stores, ->(stores) { joins(:taxonomy).where(spree_taxonomies: { store_id: stores.ids }) }
+    scope :for_taxonomy, lambda { |taxonomy_name|
+      if Spree.use_translations?
+        joins(:taxonomy).
+          join_translation_table(Taxonomy).
+          where(["LOWER(#{Taxonomy.translation_table_alias}.name) = ?", taxonomy_name.downcase.strip])
+      else
+        joins(:taxonomy).where(["LOWER(#{Spree::Taxonomy.table_name}.name) = ?", taxonomy_name.downcase.strip])
+      end
+    }
 
-    self.whitelisted_ransackable_associations = %w[taxonomy]
-    self.whitelisted_ransackable_attributes = %w[name permalink]
+    #
+    # Search
+    #
+    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
 
-    scope :for_stores, ->(stores) { joins(:taxonomy).where(spree_taxonomies: { store_id: stores.ids }) }
+    #
+    #  Ransack
+    #
+    self.whitelisted_ransackable_associations = %w[taxonomy]
+    self.whitelisted_ransackable_attributes = %w[name permalink automatic]
 
+    #
+    # Translations
+    #
     TRANSLATABLE_FIELDS = %i[name pretty_name description permalink].freeze
     translates(*TRANSLATABLE_FIELDS, column_fallback: !Spree.always_use_translations?)
 
+    #
+    # Action Text
+    #
+    translates :description, backend: :action_text
+
+    # Automatic taxons
+    validates :rules_match_policy, inclusion: { in: RULES_MATCH_POLICIES }, presence: true
+    validates :sort_order, inclusion: { in: SORT_ORDERS }, presence: true
+
+    has_many :taxon_rules, class_name: 'Spree::TaxonRule', dependent: :destroy
+    accepts_nested_attributes_for :taxon_rules, allow_destroy: true, reject_if: proc { |attributes| attributes['value'].blank? }
+    alias rules taxon_rules
+
+    scope :manual, -> { where.not(automatic: true) }
+    scope :automatic, -> { where(automatic: true) }
+
+    after_commit :regenerate_taxon_products, on: [:update], if: -> { automatic? && saved_change_to_rules_match_policy? }
+    attribute :marked_for_regenerate_taxon_products, :boolean, default: true
+
+    def manual?
+      !automatic?
+    end
+
+    def manual_sort_order?
+      sort_order == 'manual'
+    end
+
+    def active_products_with_descendants
+      @active_products_with_descendants ||= store.products.
+                                            joins(:classifications).
+                                            active.
+                                            where(
+                                              Spree::Classification.table_name => {
+                                                taxon_id: descendants.ids + [id]
+                                              }
+                                            )
+    end
+
+    def products_matching_rules(opts = {})
+      return Spree::Product.none if manual? || rules.empty?
+
+      storefront = opts[:storefront] || false
+      currency = opts[:currency] || store.default_currency
+
+      all_products = store.products.not_archived
+
+      products_matcher_cache_key = [
+        'products_matching_rules',
+        cache_key_with_version,
+        storefront,
+        currency,
+        all_products.cache_key_with_version
+      ]
+
+      all_products = all_products.active(currency: currency) if storefront
+
+      any_rules_match_policy = rules_match_policy == 'any'
+      products = any_rules_match_policy ? Spree::Product.none : all_products
+
+      rules.each do |rule|
+        if any_rules_match_policy
+          product_ids = rule.apply(all_products).ids
+          # it's safer to use this approach with ids as it will not break if the rule is not a simple where clause
+          # and we will avoid `ArgumentError (Relation passed to #or must be structurally compatible. Incompatible values: [:group, :order, :joins, :readonly])` error
+          products = products.or(all_products.where(id: product_ids)) if product_ids.any?
+        else
+          products = rule.apply(products)
+        end
+      end
+
+      products
+    end
+
+    # we need to create a new taxon product (classification) record for each product that matches the rules
+    # so we can later use them for product filtering and so on
+    # if we want to fire the service once during object lifecycle - pass only_once: true
+    def regenerate_taxon_products(only_once: false)
+      if marked_for_regenerate_taxon_products?
+        Spree::Taxons::RegenerateProducts.call(taxon: self)
+        self.marked_for_regenerate_taxon_products = false if !frozen? && only_once
+      end
+    end
+
     def slug
       permalink
     end
@@ -78,6 +220,7 @@ module Spree
     self::Translation.class_eval do
       before_save :set_permalink
       before_save :set_pretty_name
+      after_save :regenerate_pretty_name_and_permalink, if: :should_regenerate_pretty_name_and_permalink?
 
       def slug
         permalink
@@ -92,15 +235,23 @@ module Spree
       end
 
       def set_pretty_name
-        self[:pretty_name] = generate_pretty_name
+        self.pretty_name = generate_pretty_name
       end
 
       def name_with_fallback
-        name.blank? ? translated_model.name : name
+        name.blank? ? translated_model[:name] : name
       end
 
       def pretty_name_with_fallback
-        pretty_name.blank? ? translated_model.pretty_name : pretty_name
+        pretty_name.blank? ? translated_model[:pretty_name] : pretty_name
+      end
+
+      def regenerate_pretty_name_and_permalink
+        Spree::Taxon::Translation.where(spree_taxon_id: translated_model.cached_self_and_descendants_ids).each(&:update_pretty_name_and_permalink)
+      end
+
+      def update_pretty_name_and_permalink
+        update_columns(pretty_name: generate_pretty_name, permalink: generate_slug, updated_at: Time.current)
       end
 
       private
@@ -119,7 +270,7 @@ module Spree
         if parent.present?
           generate_pretty_name_including_parent
         elsif pretty_name.blank?
-          pretty_name_with_fallback
+          name_with_fallback
         else
           pretty_name
         end
@@ -130,7 +281,7 @@ module Spree
       end
 
       def generate_pretty_name_including_parent
-        [parent_pretty_name_with_fallback, (pretty_name.blank? ? name_with_fallback : pretty_name)].compact.join(' -> ')
+        [parent_pretty_name_with_fallback, (name.blank? ? name_with_fallback : name)].compact.join(' -> ')
       end
 
       def parent
@@ -139,12 +290,16 @@ module Spree
 
       def parent_permalink_with_fallback
         localized_parent = parent.translations.find_by(locale: locale)
-        localized_parent.present? ? localized_parent.permalink : parent.permalink
+        localized_parent.present? ? localized_parent.permalink : parent[:permalink]
       end
 
       def parent_pretty_name_with_fallback
         localized_parent = parent.translations.find_by(locale: locale)
-        localized_parent.present? ? localized_parent.pretty_name : parent.pretty_name
+        localized_parent.present? ? localized_parent.pretty_name : parent[:pretty_name]
+      end
+
+      def should_regenerate_pretty_name_and_permalink?
+        saved_changes.key?(:name) || saved_changes.key?(:permalink)
       end
     end
 
@@ -166,7 +321,7 @@ module Spree
     end
 
     def set_pretty_name
-      self[:pretty_name] = generate_pretty_name
+      self.pretty_name = generate_pretty_name
     end
 
     def generate_pretty_name
@@ -196,15 +351,17 @@ module Spree
     end
 
     def regenerate_pretty_name_and_permalink
-      set_permalink
-      update_columns(pretty_name: generate_pretty_name, updated_at: Time.current)
+      Mobility.with_locale(nil) do
+        update_columns(pretty_name: generate_pretty_name, permalink: generate_slug, updated_at: Time.current)
+      end
 
       children.reload.each(&:regenerate_pretty_name_and_permalink_as_child)
     end
 
     def regenerate_pretty_name_and_permalink_as_child
-      set_permalink
-      update_columns(pretty_name: generate_pretty_name, updated_at: Time.current)
+      Mobility.with_locale(nil) do
+        update_columns(pretty_name: generate_pretty_name, permalink: generate_slug, updated_at: Time.current)
+      end
 
       children.reload.each(&:regenerate_pretty_name_and_permalink_as_child)
     end
@@ -225,6 +382,20 @@ module Spree
       move_to_child_with_index(parent, idx.to_i) unless new_record?
     end
 
+    def page_builder_url
+      return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:nested_taxons_path)
+
+      Spree::Core::Engine.routes.url_helpers.nested_taxons_path(self)
+    end
+
+    def featured?
+      featured_sections.any?
+    end
+
+    def featured_sections
+      @featured_sections ||= Spree::PageSections::FeaturedTaxon.published.by_taxon_id(id)
+    end
+
     private
 
     def should_regenerate_pretty_name_and_permalink?
@@ -261,5 +432,17 @@ module Spree
     def copy_taxonomy_from_parent
       self.taxonomy = parent.taxonomy if parent.present? && taxonomy.blank?
     end
+
+    def regenerate_translations_pretty_name_and_permalink
+      translations.each(&:regenerate_pretty_name_and_permalink)
+    end
+
+    def touch_featured_sections
+      Spree::Taxons::TouchFeaturedSections.call(taxon_ids: [id])
+    end
+
+    def remove_featured_sections
+      featured_sections.destroy_all
+    end
   end
 end

data/app/models/spree/taxon_image/configuration/active_storage.rb

@@ -5,7 +5,7 @@ module Spree
         extend ActiveSupport::Concern
 
         included do
-          validates :attachment, content_type: /\Aimage\/.*\z/
+          validates :attachment, content_type: Rails.application.config.active_storage.web_image_content_types
 
           default_scope { includes(attachment_attachment: :blob) }
 

data/app/models/spree/taxon_rule.rb

@@ -0,0 +1,25 @@
+module Spree
+  class TaxonRule < Spree.base_class
+    MATCH_POLICIES = %w[
+      is_equal_to
+      is_not_equal_to
+      contains
+      does_not_contain
+    ].freeze
+
+    belongs_to :taxon, class_name: 'Spree::Taxon', inverse_of: :taxon_rules, touch: true
+
+    validates :taxon, :type, :value, presence: true
+    validates :match_policy, inclusion: { in: MATCH_POLICIES }, presence: true
+
+    after_commit :regenerate_taxon_products, if: -> { saved_change_to_value? || destroyed? || saved_change_to_match_policy? }
+
+    delegate :store, to: :taxon
+
+    private
+
+    def regenerate_taxon_products
+      taxon.regenerate_taxon_products(only_once: true)
+    end
+  end
+end

data/app/models/spree/taxon_rules/available_on.rb

@@ -0,0 +1,20 @@
+module Spree
+  module TaxonRules
+    class AvailableOn < Spree::TaxonRule
+      def apply(scope)
+        # value here is no of weeks
+        # eg. return products that become available in the last 2 weeks
+        timezone = taxon.store.preferred_timezone
+        date = value.to_i.days.ago.beginning_of_day.in_time_zone(timezone)
+
+        if match_policy == 'is_equal_to'
+          scope.where(['spree_products.created_at >= ?', date]).or(
+            scope.where(['spree_products.available_on >= ?', date])
+          )
+        else
+          scope
+        end
+      end
+    end
+  end
+end

data/app/models/spree/taxon_rules/sale.rb

@@ -0,0 +1,16 @@
+module Spree
+  module TaxonRules
+    class Sale < Spree::TaxonRule
+      def apply(scope)
+        case match_policy
+        when 'is_equal_to' || 'contains'
+          scope.on_sale(store.default_currency)
+        when 'is_not_equal_to' || 'does_not_contain'
+          scope.where.not(id: scope.on_sale(store.default_currency))
+        else
+          scope
+        end
+      end
+    end
+  end
+end

data/app/models/spree/taxon_rules/tag.rb

@@ -0,0 +1,19 @@
+module Spree
+  module TaxonRules
+    class Tag < Spree::TaxonRule
+      def apply(scope)
+        if match_policy == 'is_equal_to'
+          scope.tagged_with(value)
+        elsif match_policy == 'is_not_equal_to'
+          scope.tagged_with(value, exclude: true)
+        elsif match_policy == 'contains'
+          scope.tagged_with(value, any: true)
+        elsif match_policy == 'does_not_contain'
+          scope.tagged_with(value, any: true, exclude: true)
+        else
+          scope
+        end
+      end
+    end
+  end
+end

data/app/models/spree/taxonomy.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Taxonomy < Spree::Base
+  class Taxonomy < Spree.base_class
     include Spree::TranslatableResource
     include Spree::Metadata
     include Spree::SingleStoreResource
@@ -12,7 +12,7 @@ module Spree
 
     acts_as_list
 
-    validates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true, scope: :store_id }
+    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: :store_id }
     validates :store, presence: true
 
     has_many :taxons, inverse_of: :taxonomy
@@ -24,6 +24,7 @@ module Spree
 
     default_scope { order("#{table_name}.position, #{table_name}.created_at") }
 
+    self.whitelisted_ransackable_attributes = %w[name]
     self.whitelisted_ransackable_associations = %w[root]
 
     private