spree_core 5.2.6 → 5.3.0.rc1

data/app/models/spree/product.rb

@@ -22,7 +22,7 @@ module Spree
   class Product < Spree.base_class
     acts_as_paranoid
     acts_as_taggable_on :tags, :labels
-    auto_strip_attributes :name
+    normalizes :name, with: ->(value) { value&.to_s&.squish&.presence }
 
     include Spree::ProductScopes
     include Spree::MultiStoreResource
@@ -30,17 +30,20 @@ module Spree
     include Spree::MemoizedData
     include Spree::Metafields
     include Spree::Metadata
-    include Spree::Linkable
     include Spree::Product::Webhooks
     include Spree::Product::Slugs
     if defined?(Spree::VendorConcern)
       include Spree::VendorConcern
     end
 
+    publishes_lifecycle_events
+
     MEMOIZED_METHODS = %w[total_on_hand taxonomy_ids taxon_and_ancestors category
-                          default_variant_id tax_category default_variant
-                          default_image secondary_image
-                          purchasable? in_stock? backorderable? has_variants? digital?]
+                          default_variant_id tax_category default_variant variant_for_images
+                          category_taxon brand_taxon main_taxon
+                          purchasable? in_stock? backorderable? digital?]
+
+    STATUSES = %w[draft active archived].freeze
 
     STATUS_TO_WEBHOOK_EVENT = {
       'active' => 'activated',
@@ -52,6 +55,8 @@ module Spree
     translates(*TRANSLATABLE_FIELDS, column_fallback: !Spree.always_use_translations?)
 
     self::Translation.class_eval do
+      normalizes :name, :meta_title, with: ->(value) { value&.to_s&.squish&.presence }
+
       if defined?(PgSearch)
         include PgSearch::Model
 
@@ -107,6 +112,7 @@ module Spree
 
     has_many :line_items, through: :variants_including_master
     has_many :orders, through: :line_items
+    has_many :completed_orders, -> { reorder(nil).distinct.complete }, through: :line_items, source: :order
 
     has_many :variant_images, -> { order(:position) }, source: :images, through: :variants_including_master
     has_many :variant_images_without_master, -> { order(:position) }, source: :images, through: :variants
@@ -203,17 +209,6 @@ module Spree
                            joins(:stock_items).where("#{Spree::Variant.table_name}.track_inventory = ? OR #{Spree::StockItem.table_name}.count_on_hand <= ?", false, 0)
                          }
 
-    scope :by_best_selling, lambda { |order_direction = :desc|
-      left_joins(variants_including_master: { line_items: :order }).
-        select(
-          "#{Spree::Product.table_name}.*",
-          "COUNT(DISTINCT CASE WHEN #{Spree::Order.table_name}.completed_at IS NOT NULL THEN #{Spree::Order.table_name}.id END) AS completed_orders_count",
-          "COALESCE(SUM(CASE WHEN #{Spree::Order.table_name}.completed_at IS NOT NULL THEN (#{Spree::LineItem.table_name}.price * #{Spree::LineItem.table_name}.quantity) END), 0) AS completed_orders_total"
-        ).
-        group("#{Spree::Product.table_name}.id").
-        order(completed_orders_count: order_direction, completed_orders_total: order_direction)
-    }
-
     attr_accessor :option_values_hash
 
     accepts_nested_attributes_for :product_properties, allow_destroy: true, reject_if: lambda { |pp|
@@ -263,12 +258,12 @@ module Spree
       event :activate do
         transition to: :active
       end
-      after_transition to: :active, do: [:after_activate, :send_product_activated_webhook]
+      after_transition to: :active, do: [:after_activate, :send_product_activated_webhook, :publish_product_activated_event]
 
       event :archive do
         transition to: :archived
       end
-      after_transition to: :archived, do: [:after_archive, :send_product_archived_webhook]
+      after_transition to: :archived, do: [:after_archive, :send_product_archived_webhook, :publish_product_archived_event]
 
       event :draft do
         transition to: :draft
@@ -316,9 +311,13 @@ module Spree
       master || build_master
     end
 
-    # the master variant is not a member of the variants array
+    # Checks if product has variants (non-master variants)
+    # Uses variant_count counter cache for performance
+    # @return [Boolean]
     def has_variants?
-      @has_variants ||= variants.loaded? ? variants.size.positive? : variants.any?
+      return variants.size.positive? if variants.loaded?
+
+      variant_count.positive?
     end
 
     # Returns default Variant for Product
@@ -330,7 +329,7 @@ module Spree
     #
     # @return [Spree::Variant]
     def default_variant
-      @default_variant ||= if Spree::Config[:track_inventory_levels] && available_variant = variants.detect(&:purchasable?)
+      @default_variant ||= if Spree::Config[:track_inventory_levels] && has_variants? && available_variant = variants.detect(&:purchasable?)
                              available_variant
                            else
                              has_variants? ? variants.first : find_or_build_master
@@ -343,31 +342,52 @@ module Spree
       @default_variant_id ||= default_variant.id
     end
 
-    # Returns default Image for Product
-    # @return [Spree::Image]
+    # Returns true if any variant (including master) has images.
+    # Uses loaded association when available, otherwise falls back to counter cache.
+    # @return [Boolean]
+    def has_variant_images?
+      return variant_images.any? if association(:variant_images).loaded?
+
+      total_image_count.positive?
+    end
+
+    # Alias for has_variant_images? for consistency with Variant#has_images?
+    alias has_images? has_variant_images?
+
+    # Returns the variant that should be used for displaying images.
+    # Priority: master > default_variant > first variant with images
+    # @return [Spree::Variant, nil]
+    def variant_for_images
+      @variant_for_images ||= find_variant_for_images
+    end
+
+    # Returns default Image for Product.
+    # @return [Spree::Image, nil]
     def default_image
-      @default_image ||= if images.any?
-                           images.first
-                         elsif default_variant.images.any?
-                           default_variant.default_image
-                         elsif variant_images.any?
-                           variant_images.first
-                         end
+      variant_for_images&.primary_image
     end
-    alias featured_image default_image
 
-    # Returns secondary Image for Product
-    # @return [Spree::Image]
+    # Returns secondary Image for Product (for hover effects).
+    # @return [Spree::Image, nil]
     def secondary_image
-      @secondary_image ||= if images.size > 1
-                             images.second
-                           elsif images.size == 1 && default_variant.images.size.positive?
-                             default_variant.images.first
-                           elsif default_variant.images.size > 1
-                             default_variant.secondary_image
-                           elsif variant_images.size > 1
-                             variant_images.second
-                           end
+      variant_for_images&.secondary_image
+    end
+
+    # Alias for default_image for consistency.
+    alias primary_image default_image
+
+    # Returns the image count from the variant used for displaying images.
+    # @return [Integer]
+    def image_count
+      variant_for_images&.image_count || 0
+    end
+
+    # Finds first variant with images using preloaded data when available.
+    # @return [Spree::Variant, nil]
+    def find_variant_with_images
+      return variants.find(&:has_images?) if variants.loaded?
+
+      variants.joins(:images).first
     end
 
     # Returns the short description for the product
@@ -558,7 +578,7 @@ module Spree
       if self.class.reflect_on_association(:brand)
         super
       else
-        Spree::Deprecation.warn('Spree::Product#brand is deprecated and will be removed in Spree 6. Please use Spree::Product#brand_taxon instead.')
+        Spree::Deprecation.warn('Spree::Product#brand is deprecated and will be removed in Spree 5.5. Please use Spree::Product#brand_taxon instead.')
         brand_taxon
       end
     end
@@ -566,17 +586,19 @@ module Spree
     # Returns the brand taxon for the product
     # @return [Spree::Taxon]
     def brand_taxon
-      @brand ||= if Spree.use_translations?
-                   taxons.joins(:taxonomy).
-                     join_translation_table(Taxonomy).
-                     find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_brands_name) })
-                 else
-                   if taxons.loaded?
-                     taxons.find { |taxon| taxon.taxonomy.name == Spree.t(:taxonomy_brands_name) }
-                   else
-                     taxons.joins(:taxonomy).find_by(Taxonomy.table_name => { name: Spree.t(:taxonomy_brands_name) })
-                   end
-                 end
+      @brand_taxon ||= if classification_count.zero?
+                         nil
+                       elsif Spree.use_translations?
+                         taxons.joins(:taxonomy).
+                            join_translation_table(Taxonomy).
+                            find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_brands_name) })
+                        else
+                          if taxons.loaded?
+                            taxons.find { |taxon| taxon.taxonomy.name == Spree.t(:taxonomy_brands_name) }
+                          else
+                            taxons.joins(:taxonomy).find_by(Taxonomy.table_name => { name: Spree.t(:taxonomy_brands_name) })
+                          end
+                        end
     end
 
     # Returns the brand name for the product
@@ -593,7 +615,7 @@ module Spree
       if self.class.reflect_on_association(:category)
         super
       else
-        Spree::Deprecation.warn('Spree::Product#category is deprecated and will be removed in Spree 6. Please use Spree::Product#category_taxon instead.')
+        Spree::Deprecation.warn('Spree::Product#category is deprecated and will be removed in Spree 5.5. Please use Spree::Product#category_taxon instead.')
         category_taxon
       end
     end
@@ -601,27 +623,33 @@ module Spree
     # Returns the category taxon for the product
     # @return [Spree::Taxon]
     def category_taxon
-      @category ||= if Spree.use_translations?
-                      taxons.joins(:taxonomy).
-                        join_translation_table(Taxonomy).
-                        order(depth: :desc).
-                        find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_categories_name) })
-                    else
-                      if taxons.loaded?
-                        taxons.find { |taxon| taxon.taxonomy.name == Spree.t(:taxonomy_categories_name) }
-                      else
-                        taxons.joins(:taxonomy).order(depth: :desc).find_by(Taxonomy.table_name => { name: Spree.t(:taxonomy_categories_name) })
-                      end
-                    end
+      @category_taxon ||= if classification_count.zero?
+                            nil
+                          elsif Spree.use_translations?
+                            taxons.joins(:taxonomy).
+                              join_translation_table(Taxonomy).
+                              order(depth: :desc).
+                              find_by(Taxonomy.translation_table_alias => { name: Spree.t(:taxonomy_categories_name) })
+                          else
+                            if taxons.loaded?
+                              taxons.find { |taxon| taxon.taxonomy.name == Spree.t(:taxonomy_categories_name) }
+                            else
+                              taxons.joins(:taxonomy).order(depth: :desc).find_by(Taxonomy.table_name => { name: Spree.t(:taxonomy_categories_name) })
+                            end
+                          end
     end
 
     def main_taxon
-      category_taxon || taxons.first
+      return if classification_count.zero?
+
+      @main_taxon ||= category_taxon || taxons.first
     end
 
     def taxons_for_store(store)
+      return if classification_count.zero?
+
       Rails.cache.fetch("#{cache_key_with_version}/taxons-per-store/#{store.id}") do
-        taxons.for_store(store)
+        taxons.loaded? ? taxons.find_all { |taxon| taxon.taxonomy.store_id == store.id } : taxons.for_store(store)
       end
     end
 
@@ -674,7 +702,8 @@ module Spree
 
       if has_variants?
         variants_including_master.each_with_index do |variant, index|
-          csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, index, properties_for_csv, taxons_for_csv, store, metafields_for_csv).call
+          csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, index, properties_for_csv, taxons_for_csv, store,
+                                                               metafields_for_csv).call
         end
       else
         csv_lines << Spree::CSV::ProductVariantPresenter.new(self, master, 0, properties_for_csv, taxons_for_csv, store, metafields_for_csv).call
@@ -683,13 +712,17 @@ module Spree
       csv_lines
     end
 
-    def page_builder_url
-      return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:product_path)
+    private
 
-      Spree::Core::Engine.routes.url_helpers.product_path(self)
-    end
+    # Determines which variant should be used for displaying images.
+    # Priority: master > default_variant > first variant with images
+    def find_variant_for_images
+      return master if master.has_images?
+      return default_variant if has_variants? && default_variant.has_images?
+      return find_variant_with_images if has_variant_images?
 
-    private
+      nil
+    end
 
     def add_associations_from_prototype
       if prototype_id && prototype = Spree::Prototype.find_by(id: prototype_id)
@@ -727,7 +760,7 @@ module Spree
     end
 
     def default_variant_cache_key
-      Spree::Deprecation.warn('Spree::Product#default_variant_cache_key is deprecated and will be removed in Spree 6. Please remove any occurrences of it.')
+      Spree::Deprecation.warn('Spree::Product#default_variant_cache_key is deprecated and will be removed in Spree 5.5. Please remove any occurrences of it.')
 
       "spree/default-variant/#{cache_key_with_version}/#{Spree::Config[:track_inventory_levels]}"
     end
@@ -855,5 +888,13 @@ module Spree
     def after_draft
       # Implement your logic here
     end
+
+    def publish_product_activated_event
+      publish_event('product.activated')
+    end
+
+    def publish_product_archived_event
+      publish_event('product.archived')
+    end
   end
 end

data/app/models/spree/product_property.rb

@@ -12,10 +12,10 @@ module Spree
     end
 
     self::Translation.class_eval do
-      auto_strip_attributes :value
+      normalizes :value, with: ->(value) { value&.to_s&.squish&.presence }
     end
 
-    auto_strip_attributes :value
+    normalizes :value, with: ->(value) { value&.to_s&.squish&.presence }
 
     acts_as_list scope: :product
 

data/app/models/spree/promotion/rules/customer_group.rb

@@ -0,0 +1,22 @@
+module Spree
+  class Promotion
+    module Rules
+      class CustomerGroup < PromotionRule
+        preference :customer_group_ids, :array, default: []
+
+        def applicable?(promotable)
+          promotable.is_a?(Spree::Order)
+        end
+
+        def eligible?(order, _options = {})
+          return false unless order.user_id.present?
+          return false if preferred_customer_group_ids.empty?
+
+          user_customer_group_ids = Spree::CustomerGroupUser.where(user_id: order.user_id).pluck(:customer_group_id).map(&:to_s)
+
+          (preferred_customer_group_ids.map(&:to_s) & user_customer_group_ids).any?
+        end
+      end
+    end
+  end
+end

data/app/models/spree/promotion/rules/user.rb

@@ -34,7 +34,7 @@ module Spree
 
         def user_ids_string
           ActiveSupport::Deprecation.warn(
-            'Spree::Promotion::Rules::User#user_ids_string is deprecated and will be removed in Spree 6.0. ' \
+            'Spree::Promotion::Rules::User#user_ids_string is deprecated and will be removed in Spree 5.5. ' \
             'Please use `user_ids` instead.'
           )
           user_ids.join(',')
@@ -42,7 +42,7 @@ module Spree
 
         def user_ids_string=(s)
           ActiveSupport::Deprecation.warn(
-            'Spree::Promotion::Rules::User#user_ids_string= is deprecated and will be removed in Spree 6.0. ' \
+            'Spree::Promotion::Rules::User#user_ids_string= is deprecated and will be removed in Spree 5.5. ' \
             'Please use `user_ids=` instead.'
           )
           self.user_ids = s

data/app/models/spree/promotion.rb

@@ -3,13 +3,12 @@ module Spree
     include Spree::MultiStoreResource
     include Spree::Metafields
     include Spree::Metadata
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
     if defined?(Spree::Security::Promotions)
       include Spree::Security::Promotions
     end
 
+    publishes_lifecycle_events
+
     MATCH_POLICIES = %w(all any)
     UNACTIVATABLE_ORDER_STATES = ['complete', 'awaiting_return', 'returned']
 
@@ -18,7 +17,7 @@ module Spree
     #
     # Magic methods
     #
-    auto_strip_attributes :code, :path, :name
+    normalizes :code, :path, :name, with: ->(value) { value&.to_s&.squish&.presence }
 
     #
     # Enums

data/app/models/spree/promotion_handler/coupon.rb

@@ -177,8 +177,8 @@ module Spree
 
         # Check for applied adjustments.
         discount = order.all_adjustments.promotion.eligible.detect do |p|
-          p.source.promotion.code.try(:downcase) == coupon_code ||
-            p.source.promotion.coupon_codes.unused.where(code: coupon_code).exists?
+          p.cached_source.promotion.code.try(:downcase) == coupon_code ||
+            Spree::CouponCode.unused.where(promotion_id: p.cached_source.promotion_id, code: coupon_code).exists?
         end
 
         # Check for applied line items.
@@ -209,7 +209,7 @@ module Spree
       end
 
       def handle_coupon_code(discount, coupon_code)
-        discount.source.promotion.coupon_codes.unused.find_by(code: coupon_code)&.apply_order!(order)
+        Spree::CouponCode.unused.find_by(promotion_id: discount.cached_source.promotion_id, code: coupon_code)&.apply_order!(order)
       end
 
       def load_gift_card_code

data/app/models/spree/property.rb

@@ -6,15 +6,12 @@ module Spree
     include Spree::UniqueName
     include Spree::DisplayOn
     include Spree::TranslatableResource
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
 
     TRANSLATABLE_FIELDS = %i[presentation].freeze
     translates(*TRANSLATABLE_FIELDS, column_fallback: !Spree.always_use_translations?)
 
     self::Translation.class_eval do
-      auto_strip_attributes :presentation
+      normalizes :presentation, with: ->(value) { value&.to_s&.squish&.presence }
     end
 
     acts_as_list
@@ -46,7 +43,7 @@ module Spree
       with_uniq_values_cache_key(product_properties_scope) do
         properties = product_properties
         properties = properties.where(id: product_properties_scope) if product_properties_scope.present?
-        properties.where.not(value: [nil, '']).pluck(:filter_param, :value).uniq
+        properties.where('value IS NOT NULL AND value != ?', '').pluck(:filter_param, :value).uniq
       end
     end
 
@@ -83,7 +80,7 @@ module Spree
     def ensure_product_properties_have_filter_params
       return unless filterable?
 
-      product_properties.where(filter_param: [nil, '']).where.not(value: [nil, '']).find_each(&:save)
+      product_properties.where(filter_param: [nil, '']).where('value IS NOT NULL AND value != ?', '').find_each(&:save)
     end
   end
 end

data/app/models/spree/prototype.rb

@@ -1,9 +1,6 @@
 module Spree
   class Prototype < Spree.base_class
     include Spree::Metadata
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
 
     has_many :property_prototypes, class_name: 'Spree::PropertyPrototype'
     has_many :properties, through: :property_prototypes, class_name: 'Spree::Property'

data/app/models/spree/refund.rb

@@ -2,13 +2,12 @@ module Spree
   class Refund < Spree.base_class
     include Spree::Metafields
     include Spree::Metadata
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
     if defined?(Spree::Security::Refunds)
       include Spree::Security::Refunds
     end
 
+    publishes_lifecycle_events
+
     with_options inverse_of: :refunds do
       belongs_to :payment
       belongs_to :reimbursement, optional: true

data/app/models/spree/reimbursement.rb

@@ -2,9 +2,6 @@ module Spree
   class Reimbursement < Spree.base_class
     include Spree::Core::NumberGenerator.new(prefix: 'RI', length: 9)
     include Spree::NumberIdentifier
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
     include Spree::Reimbursement::Emails
 
     class IncompleteReimbursementError < StandardError; end
@@ -76,6 +73,7 @@ module Spree
       event :reimbursed do
         transition to: :reimbursed, from: [:pending, :errored]
       end
+      after_transition to: :reimbursed, do: :publish_reimbursement_reimbursed_event
     end
 
     class << self
@@ -138,6 +136,10 @@ module Spree
 
     private
 
+    def publish_reimbursement_reimbursed_event
+      publish_event('reimbursement.reimbursed')
+    end
+
     def validate_return_items_belong_to_same_order
       if return_items.any? { |ri| ri.inventory_unit.order_id != order_id }
         errors.add(:base, :return_items_order_id_does_not_match)

data/app/models/spree/report.rb

@@ -3,6 +3,12 @@ module Spree
     include Spree::SingleStoreResource
     include Spree::VendorConcern if defined?(Spree::VendorConcern)
 
+    publishes_lifecycle_events
+
+    # Set event prefix for all Report subclasses
+    # This ensures Spree::Reports::SalesTotal publishes 'report.create' not 'sales_total.create'
+    self.event_prefix = 'report'
+
     #
     # Associations
     #
@@ -13,7 +19,7 @@ module Spree
     # Callbacks
     #
     after_initialize :set_default_values
-    after_commit :generate_async, on: :create
+    # NOTE: generate_async is now handled by Spree::ReportSubscriber listening to 'report.create' event
 
     #
     # Validations

data/app/models/spree/reports/products_performance.rb

@@ -17,7 +17,7 @@ module Spree
                                currency: currency
                              },
                              spree_orders: {
-                               completed_at: (date_from.to_time.beginning_of_day)..(date_to.to_time.end_of_day)
+                               completed_at: date_from..date_to
                              }
                            )
 

data/app/models/spree/reports/sales_total.rb

@@ -5,7 +5,7 @@ module Spree
         scope = store.line_items.where(
           order: Spree::Order.complete.where(
             currency: currency,
-            completed_at: (date_from.to_time.beginning_of_day)..(date_to.to_time.end_of_day)
+            completed_at: date_from..date_to
           )
         ).includes(:order, shipments: :inventory_units, variant: :product)
 

data/app/models/spree/return_authorization.rb

@@ -2,9 +2,8 @@ module Spree
   class ReturnAuthorization < Spree.base_class
     include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
     include Spree::NumberIdentifier
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
+
+    publishes_lifecycle_events
 
     belongs_to :order, class_name: 'Spree::Order', inverse_of: :return_authorizations
 
@@ -34,6 +33,7 @@ module Spree
 
     state_machine initial: :authorized do
       before_transition to: :canceled, do: :cancel_return_items
+      after_transition to: :canceled, do: :publish_return_authorization_canceled_event
 
       event :cancel do
         transition to: :canceled, from: :authorized, if: ->(return_authorization) { return_authorization.can_cancel_return_items? }
@@ -79,6 +79,10 @@ module Spree
       return_items.each { |item| item.cancel! if item.can_cancel? }
     end
 
+    def publish_return_authorization_canceled_event
+      publish_event('return_authorization.canceled')
+    end
+
     def generate_expedited_exchange_reimbursements
       return unless Spree::Config[:expedited_exchanges]
 

data/app/models/spree/return_item.rb

@@ -2,10 +2,6 @@ module Spree
   class ReturnItem < Spree.base_class
     COMPLETED_RECEPTION_STATUSES = %w(received given_to_customer)
 
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
-
     class_attribute :return_eligibility_validator
     self.return_eligibility_validator = ReturnItem::EligibilityValidator::Default
 
@@ -85,6 +81,7 @@ module Spree
     state_machine :reception_status, initial: :awaiting do
       after_transition to: :received, do: :attempt_accept
       after_transition to: :received, do: :process_inventory_unit!
+      after_transition to: :received, do: :publish_return_item_received_event
 
       event :receive do
         transition to: :received, from: :awaiting
@@ -93,10 +90,12 @@ module Spree
       event :cancel do
         transition to: :cancelled, from: :awaiting
       end
+      after_transition to: :cancelled, do: :publish_return_item_canceled_event
 
       event :give do
         transition to: :given_to_customer, from: :awaiting
       end
+      after_transition to: :given_to_customer, do: :publish_return_item_given_event
     end
 
     extend DisplayMoney
@@ -270,5 +269,17 @@ module Spree
     def should_restock?
       resellable? && variant.should_track_inventory? && stock_item && Spree::Config[:restock_inventory]
     end
+
+    def publish_return_item_received_event
+      publish_event('return_item.received')
+    end
+
+    def publish_return_item_canceled_event
+      publish_event('return_item.canceled')
+    end
+
+    def publish_return_item_given_event
+      publish_event('return_item.given')
+    end
   end
 end