Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Dependencies 2.0 - improve developer experience

Damian Legawiecb4958831becb
diff --git a/api/lib/spree/api.rb b/api/lib/spree/api.rb
index d91f4cfbe0..2f4230c886 100644
--- a/api/lib/spree/api.rb
+++ b/api/lib/spree/api.rb
@@ -3,6 +3,51 @@ require 'spree/core'
module Spree
module Api
end
+
+ # API dependencies accessor for cleaner access to API dependencies
+ #
+ # @example Getting a dependency (returns resolved class)
+ # Spree.api.storefront_coupon_handler.call(order: order, coupon_code: code)
+ #
+ # @example Setting a dependency
+ # Spree.api.storefront_coupon_handler = MyApp::CouponHandler
+ #
+ # @return [Spree::ApiDependenciesAccessor] the API dependencies accessor
+ def self.api
+ @api_accessor ||= ApiDependenciesAccessor.new
+ end
+
+ class ApiDependenciesAccessor
+ def method_missing(method_name, *args, &block)
+ base_name = method_name.to_s.chomp('=').to_sym
+
+ return super unless api_dependency?(base_name)
+
+ if method_name.to_s.end_with?('=')
+ Spree::Api::Dependencies.send(method_name, args.first)
+ else
+ # Returns resolved class
+ Spree::Api::Dependencies.send("#{method_name}_class")
+ end
+ end
+
+ def respond_to_missing?(method_name, include_private = false)
+ base_name = method_name.to_s.chomp('=').to_sym
+ api_dependency?(base_name) || super
+ end
+
+ # Direct access to raw dependencies object for backwards compatibility
+ def dependencies
+ Spree::Api::Dependencies
+ end
+
+ private
+
+ def api_dependency?(name)
+ defined?(Spree::Api::Dependencies) &&
+ Spree::Api::Dependencies.class::INJECTION_POINTS.include?(name)
+ end
+ end
end
require 'spree/api/engine'
diff --git a/api/spec/models/spree/api_dependencies_spec.rb b/api/spec/models/spree/api_dependencies_spec.rb
index fc375ca3d0..42c0c60d94 100644
--- a/api/spec/models/spree/api_dependencies_spec.rb
+++ b/api/spec/models/spree/api_dependencies_spec.rb
@@ -9,20 +9,111 @@ end
class MyCustomCreateService
end
+class MyCustomCouponHandler
+end
+
describe Spree::Api::ApiDependencies, type: :model do
- let (:deps) { described_class.new }
+ let(:deps) { described_class.new }
+
+ describe 'backwards compatibility' do
+ it 'returns the default value as string' do
+ expect(deps.storefront_cart_serializer).to eq('Spree::V2::Storefront::CartSerializer')
+ end
+
+ it 'allows to overwrite the value' do
+ deps.storefront_cart_serializer = MyNewSerializer
+ expect(deps.storefront_cart_serializer).to eq MyNewSerializer
+ end
+
+ it 'respects global dependencies' do
+ original_value = Spree::Dependencies.cart_create_service
+ begin
+ Spree::Dependencies.cart_create_service = MyCustomCreateService
+ expect(deps.storefront_cart_create_service).to eq(MyCustomCreateService)
+ ensure
+ Spree::Dependencies.instance_variable_set(:@cart_create_service, original_value)
+ Spree::Dependencies.remove_instance_variable(:@cart_create_service_resolved) if Spree::Dependencies.instance_variable_defined?(:@cart_create_service_resolved)
+ end
+ end
+ end
+
+ describe '#<dependency>_class' do
+ it 'returns the constantized class for string values' do
+ expect(deps.storefront_cart_serializer_class).to eq Spree::V2::Storefront::CartSerializer
+ end
+
+ it 'returns the class directly when set as class' do
+ deps.storefront_cart_serializer = MyNewSerializer
+ expect(deps.storefront_cart_serializer_class).to eq MyNewSerializer
+ end
+
+ it 'resolves proc-based dependencies from core' do
+ expect(deps.storefront_cart_create_service_class).to eq Spree::Cart::Create
+ end
+ end
+
+ describe '#overrides' do
+ it 'tracks overridden dependencies' do
+ deps.storefront_cart_serializer = MyNewSerializer
+ expect(deps.overrides).to have_key(:storefront_cart_serializer)
+ end
+ end
+
+ describe '#current_values' do
+ it 'returns all dependencies with metadata' do
+ values = deps.current_values
+ expect(values).to be_an(Array)
+ expect(values.first).to include(:name, :current, :default, :overridden)
+ end
+ end
- it 'returns the default value' do
- expect(deps.storefront_cart_serializer).to eq('Spree::V2::Storefront::CartSerializer')
+ describe '#validate!' do
+ it 'raises Spree::DependencyError for invalid dependencies' do
+ deps.storefront_cart_serializer = 'NonExistentClass'
+ expect { deps.validate! }.to raise_error(Spree::DependencyError)
+ end
end
+end
+
+describe 'Spree.api accessor' do
+ describe 'Spree.api.<dependency>' do
+ it 'returns the resolved class' do
+ expect(Spree.api.storefront_cart_serializer).to eq Spree::V2::Storefront::CartSerializer
+ end
+
+ it 'responds to dependency methods' do
+ expect(Spree.api.respond_to?(:storefront_cart_serializer)).to be true
+ expect(Spree.api.respond_to?(:storefront_cart_serializer=)).to be true
+ end
+
+ it 'does not respond to non-dependency methods' do
+ expect(Spree.api.respond_to?(:non_existent_dependency)).to be false
+ end
+ end
+
+ describe 'Spree.api.<dependency>=' do
+ let(:original_value) { Spree::Api::Dependencies.storefront_coupon_handler }
+
+ after do
+ # Restore original value
+ Spree::Api::Dependencies.instance_variable_set(:@storefront_coupon_handler, original_value)
+ Spree::Api::Dependencies.instance_variable_set(:@overrides, {})
+ end
+
+ it 'sets the dependency via Spree.api' do
+ Spree.api.storefront_coupon_handler = MyCustomCouponHandler
+ expect(Spree::Api::Dependencies.storefront_coupon_handler).to eq MyCustomCouponHandler
+ end
- it 'allows to overwrite the value' do
- deps.storefront_cart_serializer = MyNewSerializer
- expect(deps.storefront_cart_serializer).to eq MyNewSerializer
+ it 'returns the new class via Spree.api' do
+ Spree.api.storefront_coupon_handler = MyCustomCouponHandler
+ expect(Spree.api.storefront_coupon_handler).to eq MyCustomCouponHandler
+ end
end
- it 'respects global dependecies' do
- Spree::Dependencies.cart_create_service = MyCustomCreateService
- expect(deps.storefront_cart_create_service).to eq(MyCustomCreateService)
+ describe 'Spree.api.dependencies' do
+ it 'returns the raw dependencies object' do
+ expect(Spree.api.dependencies).to eq Spree::Api::Dependencies
+ end
end
end
diff --git a/core/app/finders/spree/line_items/find_by_variant.rb b/core/app/finders/spree/line_items/find_by_variant.rb
index bb8d4cef0d..13a6861a33 100644
--- a/core/app/finders/spree/line_items/find_by_variant.rb
+++ b/core/app/finders/spree/line_items/find_by_variant.rb
@@ -5,7 +5,7 @@ module Spree
line_item = order.line_items.loaded? ? order.line_items.detect { |li| li.variant_id == variant.id } : order.line_items.find_by(variant_id: variant.id)
if line_item
- Spree::Dependencies.cart_compare_line_items_service.constantize.call(order: order, line_item: line_item, options: options).value
+ Spree.cart_compare_line_items_service.call(order: order, line_item: line_item, options: options).value
end
line_item
diff --git a/core/app/jobs/spree/variants/remove_line_item_job.rb b/core/app/jobs/spree/variants/remove_line_item_job.rb
index 9e4459d8ab..d2d1395e3b 100644
--- a/core/app/jobs/spree/variants/remove_line_item_job.rb
+++ b/core/app/jobs/spree/variants/remove_line_item_job.rb
@@ -4,7 +4,7 @@ module Spree
queue_as Spree.queues.variants
def perform(line_item:)
- Spree::Dependencies.cart_remove_line_item_service.constantize.call(order: line_item.order, line_item: line_item)
+ Spree.cart_remove_line_item_service.call(order: line_item.order, line_item: line_item)
end
end
end
diff --git a/core/app/models/spree/export.rb b/core/app/models/spree/export.rb
index e2a0ac561a..e1b1114ef4 100644
--- a/core/app/models/spree/export.rb
+++ b/core/app/models/spree/export.rb
@@ -157,7 +157,7 @@ module Spree
end
def current_ability
- @current_ability ||= Spree::Dependencies.ability_class.constantize.new(user, { store: store })
+ @current_ability ||= Spree.ability_class.new(user, { store: store })
end
# eg. Spree::Exports::Products => products-store-my-store-code-20241030133348.csv
diff --git a/core/app/models/spree/import.rb b/core/app/models/spree/import.rb
index cfbe5ccd65..2f2eba89b9 100644
--- a/core/app/models/spree/import.rb
+++ b/core/app/models/spree/import.rb
@@ -217,7 +217,7 @@ module Spree
# Returns the current ability for the import
# @return [Spree::Ability]
def current_ability
- @current_ability ||= Spree::Dependencies.ability_class.constantize.new(user, { store: store })
+ @current_ability ||= Spree.ability_class.new(user, { store: store })
end
class << self
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index 572e02b1f3..2c2f9220fb 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -349,7 +349,7 @@ module Spree
end
def updater
- @updater ||= Spree::Dependencies.order_updater.constantize.new(self)
+ @updater ||= Spree.order_updater.new(self)
end
def update_with_updater!
@@ -407,7 +407,7 @@ module Spree
def find_line_item_by_variant(variant, options = {})
line_items.detect do |line_item|
line_item.variant_id == variant.id &&
- Spree::Dependencies.cart_compare_line_items_service.constantize.new.call(order: self, line_item: line_item, options: options).value
+ Spree.cart_compare_line_items_service.new.call(order: self, line_item: line_item, options: options).value
end
end
@@ -578,7 +578,7 @@ module Spree
def empty!
raise Spree.t(:cannot_empty_completed_order) if completed?
- result = Spree::Dependencies.cart_empty_service.constantize.call(order: self)
+ result = Spree.cart_empty_service.call(order: self)
result.value
end
@@ -957,7 +957,7 @@ module Spree
if gift_card.present?
recalculate_gift_card
elsif using_store_credit?
- Spree::Dependencies.checkout_add_store_credit_service.constantize.call(order: self)
+ Spree.checkout_add_store_credit_service.call(order: self)
end
end
end
diff --git a/core/app/models/spree/order/gift_card.rb b/core/app/models/spree/order/gift_card.rb
index 379612cefd..55a6431930 100644
--- a/core/app/models/spree/order/gift_card.rb
+++ b/core/app/models/spree/order/gift_card.rb
@@ -25,13 +25,13 @@ module Spree
# @param gift_card [Spree::GiftCard] the gift card to apply
# @return [Spree::Order] the order with the gift card applied
def apply_gift_card(gift_card)
- Spree::Dependencies.gift_card_apply_service.constantize.call(gift_card: gift_card, order: self)
+ Spree.gift_card_apply_service.call(gift_card: gift_card, order: self)
end
# Removes a gift card from the order
# @return [Spree::Order] the order with the gift card removed
def remove_gift_card
- Spree::Dependencies.gift_card_remove_service.constantize.call(order: self)
+ Spree.gift_card_remove_service.call(order: self)
end
def recalculate_gift_card
@@ -44,7 +44,7 @@ module Spree
def redeem_gift_card
return unless gift_card.present?
- Spree::Dependencies.gift_card_redeem_service.constantize.call(gift_card: gift_card)
+ Spree.gift_card_redeem_service.call(gift_card: gift_card)
end
end
end
diff --git a/core/app/models/spree/order/store_credit.rb b/core/app/models/spree/order/store_credit.rb
index f8edd74fe9..1a894b73b6 100644
--- a/core/app/models/spree/order/store_credit.rb
+++ b/core/app/models/spree/order/store_credit.rb
@@ -2,11 +2,11 @@ module Spree
class Order < Spree.base_class
module StoreCredit
def add_store_credit_payments(amount = nil)
- Spree::Dependencies.checkout_add_store_credit_service.constantize.call(order: self, amount: amount)
+ Spree.checkout_add_store_credit_service.call(order: self, amount: amount)
end
def remove_store_credit_payments
- Spree::Dependencies.checkout_remove_store_credit_service.constantize.call(order: self)
+ Spree.checkout_remove_store_credit_service.call(order: self)
end
def covered_by_store_credit?
diff --git a/core/app/models/spree/order_contents.rb b/core/app/models/spree/order_contents.rb
index d28a20847f..ab87eda210 100644
--- a/core/app/models/spree/order_contents.rb
+++ b/core/app/models/spree/order_contents.rb
@@ -7,17 +7,17 @@ module Spree
end
def add(variant, quantity = 1, options = {})
- Spree::Dependencies.cart_add_item_service.constantize.call(order: order,
- variant: variant,
- quantity: quantity,
- options: options).value
+ Spree.cart_add_item_service.call(order: order,
+ variant: variant,
+ quantity: quantity,
+ options: options).value
end
def remove(variant, quantity = 1, options = {})
- Spree::Dependencies.cart_remove_item_service.constantize.call(order: order,
- variant: variant,
- quantity: quantity,
- options: options).value
+ Spree.cart_remove_item_service.call(order: order,
+ variant: variant,
+ quantity: quantity,
+ options: options).value
end
def remove_line_item(line_item, options = {})
@@ -25,7 +25,7 @@ module Spree
end
def update_cart(params)
- Spree::Dependencies.cart_update_service.constantize.call(order: order, params: params).value
+ Spree.cart_update_service.call(order: order, params: params).value
end
end
end
diff --git a/core/app/models/spree/order_merger.rb b/core/app/models/spree/order_merger.rb
index 03432b8c91..9d08ce36e0 100644
--- a/core/app/models/spree/order_merger.rb
+++ b/core/app/models/spree/order_merger.rb
@@ -35,9 +35,9 @@ module Spree
def find_matching_line_item(other_order_line_item)
order.line_items.detect do |my_li|
my_li.variant == other_order_line_item.variant &&
- Spree::Dependencies.cart_compare_line_items_service.constantize.new.call(order: order,
- line_item: my_li,
- options: other_order_line_item.serializable_hash).value
+ Spree.cart_compare_line_items_service.new.call(order: order,
+ line_item: my_li,
+ options: other_order_line_item.serializable_hash).value
end
end
diff --git a/core/app/models/spree/page_sections/featured_taxon.rb b/core/app/models/spree/page_sections/featured_taxon.rb
index 6efcba064a..5c60296c8a 100644
--- a/core/app/models/spree/page_sections/featured_taxon.rb
+++ b/core/app/models/spree/page_sections/featured_taxon.rb
@@ -61,8 +61,7 @@ module Spree
sort_by: 'default'
}
- products_finder = Spree::Dependencies.products_finder.constantize
- products_finder.new(scope: store.products, params: finder_params).execute.limit(preferred_max_products_to_show)
+ Spree.products_finder.new(scope: store.products, params: finder_params).execute.limit(preferred_max_products_to_show)
end
end
diff --git a/core/app/models/spree/promotion/actions/create_line_items.rb b/core/app/models/spree/promotion/actions/create_line_items.rb
index 43a045557b..f1dc755c2f 100644
--- a/core/app/models/spree/promotion/actions/create_line_items.rb
+++ b/core/app/models/spree/promotion/actions/create_line_items.rb
@@ -47,9 +47,9 @@ module Spree
current_quantity = order.quantity_of(item.variant)
next unless current_quantity < item.quantity && item_available?(item)
- line_item = Spree::Dependencies.cart_add_item_service.constantize.call(order: order,
- variant: item.variant,
- quantity: item.quantity - current_quantity).value
+ line_item = Spree.cart_add_item_service.call(order: order,
+ variant: item.variant,
+ quantity: item.quantity - current_quantity).value
action_taken = true if line_item.try(:valid?)
end
action_taken
@@ -68,9 +68,9 @@ module Spree
line_item = order.find_line_item_by_variant(item.variant)
next unless line_item.present?
- Spree::Dependencies.cart_remove_item_service.constantize.call(order: order,
- variant: item.variant,
- quantity: (item.quantity || 1))
+ Spree.cart_remove_item_service.call(order: order,
+ variant: item.variant,
+ quantity: (item.quantity || 1))
action_taken = true
end
diff --git a/core/app/models/spree/promotion_handler/coupon.rb b/core/app/models/spree/promotion_handler/coupon.rb
index 5c3f16d427..38644c0cab 100644
--- a/core/app/models/spree/promotion_handler/coupon.rb
+++ b/core/app/models/spree/promotion_handler/coupon.rb
@@ -133,7 +133,7 @@ module Spree
line_item = order.find_line_item_by_variant(item.variant)
next if line_item.blank?
- Spree::Dependencies.cart_remove_item_service.constantize.call(order: order, variant: item.variant, quantity: item.quantity)
+ Spree.cart_remove_item_service.call(order: order, variant: item.variant, quantity: item.quantity)
end
end
diff --git a/core/app/models/spree/shipping_method.rb b/core/app/models/spree/shipping_method.rb
index dc43e27914..06bf10d14e 100644
--- a/core/app/models/spree/shipping_method.rb
+++ b/core/app/models/spree/shipping_method.rb
@@ -77,7 +77,7 @@ module Spree
# your shipping method subclasses can override this method to provide a custom tracking number service
def tracking_number_service(tracking)
- @tracking_number_service ||= Spree::Dependencies.tracking_number_service.constantize.new(tracking)
+ @tracking_number_service ||= Spree.tracking_number_service.new(tracking)
end
def self.calculators
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index 97b435ca9a..f4b2978155 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -210,7 +210,7 @@ module Spree
def self.current(url = nil)
if url.present?
- Spree::Dependencies.current_store_finder.constantize.new(url: url).execute
+ Spree.current_store_finder.new(url: url).execute
else
Spree::Current.store
end
diff --git a/core/app/services/spree/cart/add_item.rb b/core/app/services/spree/cart/add_item.rb
index bedb7220d8..aa9fc69d7b 100644
--- a/core/app/services/spree/cart/add_item.rb
+++ b/core/app/services/spree/cart/add_item.rb
@@ -6,7 +6,7 @@ module Spree
def call(order:, variant:, quantity: nil, public_metadata: {}, private_metadata: {}, options: {})
ApplicationRecord.transaction do
run :add_to_line_item
- run Spree::Dependencies.cart_recalculate_service.constantize
+ run Spree.cart_recalculate_service
end
end
@@ -18,7 +18,7 @@ module Spree
return failure(variant, "#{variant.name} is not available in #{order.currency}") if variant.amount_in(order.currency).nil?
- line_item = Spree::Dependencies.line_item_by_variant_finder.constantize.new.execute(order: order, variant: variant, options: options)
+ line_item = Spree.line_item_by_variant_finder.new.execute(order: order, variant: variant, options: options)
line_item_created = line_item.nil?
if line_item.nil?
diff --git a/core/app/services/spree/cart/remove_item.rb b/core/app/services/spree/cart/remove_item.rb
index fba7799338..6045f954a0 100644
--- a/core/app/services/spree/cart/remove_item.rb
+++ b/core/app/services/spree/cart/remove_item.rb
@@ -9,9 +9,9 @@ module Spree
ActiveRecord::Base.transaction do
line_item = remove_from_line_item(order: order, variant: variant, quantity: quantity, options: options)
- Spree::Dependencies.cart_recalculate_service.constantize.call(line_item: line_item,
- order: order,
- options: options)
+ Spree.cart_recalculate_service.call(line_item: line_item,
+ order: order,
+ options: options)
success(line_item)
end
end
@@ -19,7 +19,7 @@ module Spree
private
def remove_from_line_item(order:, variant:, quantity:, options:)
- line_item = Spree::Dependencies.line_item_by_variant_finder.constantize.new.execute(order: order, variant: variant, options: options)
+ line_item = Spree.line_item_by_variant_finder.new.execute(order: order, variant: variant, options: options)
raise ActiveRecord::RecordNotFound if line_item.nil?
diff --git a/core/app/services/spree/cart/remove_line_item.rb b/core/app/services/spree/cart/remove_line_item.rb
index c7e6ffc321..9dfc602f47 100644
--- a/core/app/services/spree/cart/remove_line_item.rb
+++ b/core/app/services/spree/cart/remove_line_item.rb
@@ -7,9 +7,9 @@ module Spree
options ||= {}
ActiveRecord::Base.transaction do
order.line_items.destroy(line_item)
- Spree::Dependencies.cart_recalculate_service.constantize.new.call(order: order,
- line_item: line_item,
- options: options)
+ Spree.cart_recalculate_service.new.call(order: order,
+ line_item: line_item,
+ options: options)
end
success(line_item)
end
diff --git a/core/app/services/spree/cart/remove_out_of_stock_items.rb b/core/app/services/spree/cart/remove_out_of_stock_items.rb
index 68e6fe1f19..6b68a256d3 100644
--- a/core/app/services/spree/cart/remove_out_of_stock_items.rb
+++ b/core/app/services/spree/cart/remove_out_of_stock_items.rb
@@ -49,7 +49,7 @@ module Spree
end
def cart_remove_line_item_service
- Spree::Dependencies.cart_remove_line_item_service.constantize
+ Spree.cart_remove_line_item_service
end
end
end
diff --git a/core/app/services/spree/cart/set_quantity.rb b/core/app/services/spree/cart/set_quantity.rb
index 20ccd5e8cb..bd1e3c6349 100644
--- a/core/app/services/spree/cart/set_quantity.rb
+++ b/core/app/services/spree/cart/set_quantity.rb
@@ -6,7 +6,7 @@ module Spree
def call(order:, line_item:, quantity: nil)
ActiveRecord::Base.transaction do
run :change_item_quantity
- run Spree::Dependencies.cart_recalculate_service.constantize
+ run Spree.cart_recalculate_service
end
end
diff --git a/core/app/services/spree/checkout/advance.rb b/core/app/services/spree/checkout/advance.rb
index 6f967816dc..6addcd6dbb 100644
--- a/core/app/services/spree/checkout/advance.rb
+++ b/core/app/services/spree/checkout/advance.rb
@@ -15,7 +15,7 @@ module Spree
transitions_count = 0
until cannot_make_transition?(order, state)
- next_result = Spree::Dependencies.checkout_next_service.constantize.call(order: order)
+ next_result = Spree.checkout_next_service.call(order: order)
return failure(order, order.errors) if next_result.failure? && (transitions_count.zero? || state.present?)
transitions_count +=1
diff --git a/core/app/services/spree/checkout/complete.rb b/core/app/services/spree/checkout/complete.rb
index 111675b752..a5cc659e72 100644
--- a/core/app/services/spree/checkout/complete.rb
+++ b/core/app/services/spree/checkout/complete.rb
@@ -4,7 +4,7 @@ module Spree
prepend Spree::ServiceModule::Base
def call(order:)
- Spree::Dependencies.checkout_next_service.constantize.call(order: order) until cannot_make_transition?(order)
+ Spree.checkout_next_service.call(order: order) until cannot_make_transition?(order)
if order.reload.complete?
success(order)
diff --git a/core/app/services/spree/data_feeds/google/rss.rb b/core/app/services/spree/data_feeds/google/rss.rb
index 0e29c8e07a..b7eaacb047 100644
--- a/core/app/services/spree/data_feeds/google/rss.rb
+++ b/core/app/services/spree/data_feeds/google/rss.rb
@@ -87,19 +87,19 @@ module Spree
end
def optional_attributes
- Spree::Dependencies.data_feeds_google_optional_attributes_service.constantize.new
+ Spree.data_feeds_google_optional_attributes_service.new
end
def required_attributes
- Spree::Dependencies.data_feeds_google_required_attributes_service.constantize.new
+ Spree.data_feeds_google_required_attributes_service.new
end
def optional_sub_attributes
- Spree::Dependencies.data_feeds_google_optional_sub_attributes_service.constantize.new
+ Spree.data_feeds_google_optional_sub_attributes_service.new
end
def products_list
- Spree::Dependencies.data_feeds_google_products_list.constantize.new
+ Spree.data_feeds_google_products_list.new
end
end
end
diff --git a/core/app/services/spree/line_items/helper.rb b/core/app/services/spree/line_items/helper.rb
index 3d4bc22bbe..c598dad332 100644
--- a/core/app/services/spree/line_items/helper.rb
+++ b/core/app/services/spree/line_items/helper.rb
@@ -4,7 +4,7 @@ module Spree
protected
def recalculate_service
- Spree::Dependencies.cart_recalculate_service.constantize
+ Spree.cart_recalculate_service
end
end
end
diff --git a/core/app/services/spree/shipments/helper.rb b/core/app/services/spree/shipments/helper.rb
index 8e9c126b8d..079480a845 100644
--- a/core/app/services/spree/shipments/helper.rb
+++ b/core/app/services/spree/shipments/helper.rb
@@ -12,11 +12,11 @@ module Spree
end
def add_item_service
- Spree::Dependencies.cart_add_item_service.constantize
+ Spree.cart_add_item_service
end
def remove_item_service
- Spree::Dependencies.cart_remove_item_service.constantize
+ Spree.cart_remove_item_service
end
end
end
diff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rb
index 913b1e4c5b..c90c8c4e72 100644
--- a/core/lib/spree/core.rb
+++ b/core/lib/spree/core.rb
@@ -374,6 +374,40 @@ module Spree
@permissions ||= PermissionConfiguration.new
end
+ class << self
+ # Dynamic methods for core dependencies
+ #
+ # @example Getting a dependency (returns resolved class)
+ # Spree.cart_add_item_service.call(order: order, variant: variant)
+ #
+ # @example Setting a dependency
+ # Spree.cart_add_item_service = MyApp::CartAddItem
+ def method_missing(method_name, *args, &block)
+ base_name = method_name.to_s.chomp('=').to_sym
+
+ return super unless core_dependency?(base_name)
+
+ if method_name.to_s.end_with?('=')
+ Spree::Dependencies.send(method_name, args.first)
+ else
+ # Returns resolved class (not string)
+ Spree::Dependencies.send("#{method_name}_class")
+ end
+ end
+
+ def respond_to_missing?(method_name, include_private = false)
+ base_name = method_name.to_s.chomp('=').to_sym
+ core_dependency?(base_name) || super
+ end
+
+ private
+
+ def core_dependency?(name)
+ defined?(Spree::Dependencies) &&
+ Spree::Dependencies.class::INJECTION_POINTS.include?(name)
+ end
+ end
+
module Core
autoload :ProductFilters, 'spree/core/product_filters'
autoload :TokenGenerator, 'spree/core/token_generator'
diff --git a/core/lib/spree/core/controller_helpers/auth.rb b/core/lib/spree/core/controller_helpers/auth.rb
index 53e299acb6..e151b4877d 100644
--- a/core/lib/spree/core/controller_helpers/auth.rb
+++ b/core/lib/spree/core/controller_helpers/auth.rb
@@ -17,7 +17,7 @@ module Spree
# Needs to be overridden so that we use Spree's Ability rather than anyone else's.
def current_ability
- @current_ability ||= Spree::Dependencies.ability_class.constantize.new(try_spree_current_user, { store: current_store })
+ @current_ability ||= Spree.ability_class.new(try_spree_current_user, { store: current_store })
end
def redirect_back_or_default(default)
diff --git a/core/lib/spree/core/controller_helpers/store.rb b/core/lib/spree/core/controller_helpers/store.rb
index d62fb4e6cb..e0b1b86457 100644
--- a/core/lib/spree/core/controller_helpers/store.rb
+++ b/core/lib/spree/core/controller_helpers/store.rb
@@ -64,7 +64,7 @@ module Spree
end
def current_store_finder
- Spree::Dependencies.current_store_finder.constantize
+ Spree.current_store_finder
end
def raise_record_not_found_if_store_is_not_found
diff --git a/core/lib/spree/core/dependencies_helper.rb b/core/lib/spree/core/dependencies_helper.rb
index c58dfa1841..491a95e3c7 100644
--- a/core/lib/spree/core/dependencies_helper.rb
+++ b/core/lib/spree/core/dependencies_helper.rb
@@ -1,21 +1,95 @@
module Spree
+ class DependencyError < StandardError; end
+
module DependenciesHelper
def self.included(base)
injection_points = base::INJECTION_POINTS_WITH_DEFAULTS.keys.freeze
base.const_set(:INJECTION_POINTS, injection_points)
- base.attr_accessor(*injection_points)
+
+ injection_points.each do |point|
+ # Original getter - returns raw value (string, class, or proc result)
+ # BACKWARDS COMPATIBLE: Spree::Dependencies.foo.constantize still works
+ base.attr_reader(point)
+
+ # Setter with override tracking
+ # BACKWARDS COMPATIBLE: Spree::Dependencies.foo = "MyClass" still works
+ base.define_method("#{point}=") do |value|
+ @overrides ||= {}
+ @overrides[point] = {
+ value: value,
+ source: caller_locations(1, 1).first.to_s,
+ set_at: Time.current
+ }
+ # Clear memoized class when value changes
+ remove_instance_variable("@#{point}_resolved") if instance_variable_defined?("@#{point}_resolved")
+ instance_variable_set("@#{point}", value)
+ end
+
+ # Returns resolved class with memoization
+ # Usage: Spree::Dependencies.foo_class or Spree.foo
+ base.define_method("#{point}_class") do
+ return instance_variable_get("@#{point}_resolved") if instance_variable_defined?("@#{point}_resolved")
+
+ value = send(point)
+ resolved = case value
+ when String then value.constantize
+ when Proc then value.call.then { |v| v.is_a?(String) ? v.constantize : v }
+ else value
+ end
+ instance_variable_set("@#{point}_resolved", resolved)
+ resolved
+ end
+ end
end
def initialize
set_default_values
end
+ # Returns hash of all overridden dependencies with metadata
+ def overrides
+ @overrides || {}
+ end
+
+ # Check if a specific dependency has been overridden
+ def overridden?(name)
+ overrides.key?(name.to_sym)
+ end
+
+ # Get override info for a specific dependency
+ def override_info(name)
+ overrides[name.to_sym]
+ end
+
+ # Returns array of all dependencies with current values and metadata
def current_values
- values = []
- self.class::INJECTION_POINTS.each do |injection_point|
- values << { injection_point.to_s => instance_variable_get("@#{injection_point}") }
+ self.class::INJECTION_POINTS.map do |point|
+ default = self.class::INJECTION_POINTS_WITH_DEFAULTS[point]
+ default_val = default.respond_to?(:call) ? default.call : default
+ current = send(point)
+
+ {
+ name: point,
+ current: current,
+ default: default_val,
+ overridden: current != default_val,
+ override_info: overrides[point]
+ }
end
- values
+ end
+
+ # Validate all dependencies can be resolved to classes
+ # Raises Spree::DependencyError if any dependency is invalid
+ def validate!
+ errors = []
+ self.class::INJECTION_POINTS.each do |point|
+ send("#{point}_class")
+ rescue NameError => e
+ errors << { name: point, value: send(point), error: e.message }
+ end
+ raise Spree::DependencyError, "Invalid dependencies: #{errors.map { |e| e[:name] }.join(', ')}" if errors.any?
+
+ true
end
private
diff --git a/core/lib/spree/core/search/base.rb b/core/lib/spree/core/search/base.rb
index 831169e9e4..03a26ca998 100644
--- a/core/lib/spree/core/search/base.rb
+++ b/core/lib/spree/core/search/base.rb
@@ -32,7 +32,7 @@ module Spree
def extended_base_scope
base_scope = current_store.products.spree_base_scopes
base_scope = get_products_conditions_for(base_scope, keywords)
- base_scope = Spree::Dependencies.products_finder.constantize.new(**product_finder_params(base_scope)).execute
+ base_scope = Spree.products_finder.new(**product_finder_params(base_scope)).execute
base_scope = add_search_scopes(base_scope)
add_eagerload_scopes(base_scope)
end
diff --git a/core/lib/spree/testing_support/authorization_helpers.rb b/core/lib/spree/testing_support/authorization_helpers.rb
index bf57ce9b41..52b6a69e61 100644
--- a/core/lib/spree/testing_support/authorization_helpers.rb
+++ b/core/lib/spree/testing_support/authorization_helpers.rb
@@ -30,7 +30,7 @@ module Spree
def stub_authorization!
ability = build_ability
- ability_class = Spree::Dependencies.ability_class.constantize
+ ability_class = Spree.ability_class
after(:all) do
ability_class.remove_ability(ability)
@@ -51,7 +51,7 @@ module Spree
def custom_authorization!(&block)
ability = build_ability(&block)
- ability_class = Spree::Dependencies.ability_class.constantize
+ ability_class = Spree.ability_class
after(:all) do
ability_class.remove_ability(ability)
diff --git a/core/lib/tasks/dependencies.rake b/core/lib/tasks/dependencies.rake
new file mode 100644
index 0000000000..71b8bc683d
--- /dev/null
+++ b/core/lib/tasks/dependencies.rake
@@ -0,0 +1,76 @@
+namespace :spree do
+ namespace :dependencies do
+ desc 'List all Spree dependencies with their current values'
+ task list: :environment do
+ print_dependencies('CORE', Spree::Dependencies)
+ print_dependencies('API', Spree::Api::Dependencies) if defined?(Spree::Api::Dependencies)
+ end
+
+ desc 'Show only overridden dependencies'
+ task overrides: :environment do
+ core_overrides = Spree::Dependencies.current_values.select { |d| d[:overridden] }
+ api_overrides = if defined?(Spree::Api::Dependencies)
+ Spree::Api::Dependencies.current_values.select { |d| d[:overridden] }
+ else
+ []
+ end
+
+ if core_overrides.empty? && api_overrides.empty?
+ puts 'No dependencies have been overridden.'
+ else
+ print_overrides('Core', core_overrides) if core_overrides.any?
+ print_overrides('API', api_overrides) if api_overrides.any?
+ end
+ end
+
+ desc 'Validate all dependencies resolve to valid classes'
+ task validate: :environment do
+ errors = validate_dependencies('Core', Spree::Dependencies)
+ errors += validate_dependencies('API', Spree::Api::Dependencies) if defined?(Spree::Api::Dependencies)
+
+ puts "\n"
+ if errors.any?
+ puts "\n\e[31m#{errors.size} invalid dependencies:\e[0m"
+ errors.each { |err| puts " [#{err[:source]}] #{err[:name]}: #{err[:error]}" }
+ exit 1
+ else
+ puts "\e[32mAll dependencies valid\e[0m"
+ end
+ end
+
+ def print_dependencies(name, deps)
+ puts "\n[#{name}]"
+
+ # Calculate max width for alignment
+ max_name_width = deps.class::INJECTION_POINTS.map(&:length).max
+
+ deps.current_values.each do |dep|
+ status = dep[:overridden] ? ' [OVERRIDDEN]' : ''
+ puts "#{dep[:name].to_s.ljust(max_name_width)} #{dep[:current]}#{status}"
+ end
+ end
+
+ def print_overrides(name, overrides)
+ puts "\n[#{name} OVERRIDES]"
+
+ max_name_width = overrides.map { |d| d[:name].length }.max
+
+ overrides.each do |dep|
+ source = dep[:override_info] ? " (#{dep[:override_info][:source]})" : ''
+ puts "#{dep[:name].to_s.ljust(max_name_width)} #{dep[:default]} -> #{dep[:current]}#{source}"
+ end
+ end
+
+ def validate_dependencies(name, deps)
+ errors = []
+ deps.class::INJECTION_POINTS.each do |point|
+ deps.send("#{point}_class")
+ print "\e[32m.\e[0m"
+ rescue NameError => e
+ errors << { source: name, name: point, error: e.message }
+ print "\e[31mF\e[0m"
+ end
+ errors
+ end
+ end
+end
diff --git a/core/spec/models/spree/app_dependencies_spec.rb b/core/spec/models/spree/app_dependencies_spec.rb
index 115cbf36ea..fe4795c6ce 100644
--- a/core/spec/models/spree/app_dependencies_spec.rb
+++ b/core/spec/models/spree/app_dependencies_spec.rb
@@ -3,15 +3,177 @@ require 'spec_helper'
class MyCustomCreateService
end
+class MyCustomAddItemService
+end
+
describe Spree::Core::Dependencies, type: :model do
- let (:deps) { described_class.new }
+ let(:deps) { described_class.new }
+
+ describe 'backwards compatibility' do
+ it 'returns the default value as string' do
+ expect(deps.cart_create_service).to eq('Spree::Cart::Create')
+ end
+
+ it 'allows to overwrite the value with a class' do
+ deps.cart_create_service = MyCustomCreateService
+ expect(deps.cart_create_service).to eq MyCustomCreateService
+ end
+
+ it 'allows to overwrite the value with a string' do
+ deps.cart_create_service = 'MyCustomCreateService'
+ expect(deps.cart_create_service).to eq 'MyCustomCreateService'
+ end
+
+ it 'works with constantize for string values' do
+ expect(deps.cart_create_service.constantize).to eq Spree::Cart::Create
+ end
+ end
+
+ describe '#<dependency>_class' do
+ it 'returns the constantized class for string values' do
+ expect(deps.cart_create_service_class).to eq Spree::Cart::Create
+ end
+
+ it 'returns the class directly when set as class' do
+ deps.cart_create_service = MyCustomCreateService
+ expect(deps.cart_create_service_class).to eq MyCustomCreateService
+ end
+
+ it 'memoizes the resolved class' do
+ deps.cart_create_service_class
+ expect(deps.instance_variable_get(:@cart_create_service_resolved)).to eq Spree::Cart::Create
+ end
+
+ it 'clears memoization when value changes' do
+ deps.cart_create_service_class
+ deps.cart_create_service = MyCustomCreateService
+ expect(deps.instance_variable_defined?(:@cart_create_service_resolved)).to be false
+ end
+ end
+
+ describe '#overrides' do
+ it 'returns empty hash when no overrides' do
+ expect(deps.overrides).to eq({})
+ end
+
+ it 'tracks overridden dependencies' do
+ deps.cart_create_service = MyCustomCreateService
+ expect(deps.overrides).to have_key(:cart_create_service)
+ end
+
+ it 'includes override metadata' do
+ deps.cart_create_service = MyCustomCreateService
+ override = deps.overrides[:cart_create_service]
+
+ expect(override[:value]).to eq MyCustomCreateService
+ expect(override[:source]).to be_a(String)
+ expect(override[:set_at]).to be_a(Time)
+ end
+ end
+
+ describe '#overridden?' do
+ it 'returns false for non-overridden dependencies' do
+ expect(deps.overridden?(:cart_create_service)).to be false
+ end
+
+ it 'returns true for overridden dependencies' do
+ deps.cart_create_service = MyCustomCreateService
+ expect(deps.overridden?(:cart_create_service)).to be true
+ end
+
+ it 'works with string argument' do
+ deps.cart_create_service = MyCustomCreateService
+ expect(deps.overridden?('cart_create_service')).to be true
+ end
+ end
+
+ describe '#override_info' do
+ it 'returns nil for non-overridden dependencies' do
+ expect(deps.override_info(:cart_create_service)).to be_nil
+ end
+
+ it 'returns override info for overridden dependencies' do
+ deps.cart_create_service = MyCustomCreateService
+ info = deps.override_info(:cart_create_service)
+
+ expect(info[:value]).to eq MyCustomCreateService
+ expect(info[:source]).to include('app_dependencies_spec.rb')
+ end
+ end
+
+ describe '#current_values' do
+ it 'returns all dependencies with metadata' do
+ values = deps.current_values
+ expect(values).to be_an(Array)
+ expect(values.first).to include(:name, :current, :default, :overridden)
+ end
+
+ it 'marks non-overridden dependencies correctly' do
+ cart_create = deps.current_values.find { |v| v[:name] == :cart_create_service }
+ expect(cart_create[:overridden]).to be false
+ expect(cart_create[:current]).to eq cart_create[:default]
+ end
+
+ it 'marks overridden dependencies correctly' do
+ deps.cart_create_service = MyCustomCreateService
+ cart_create = deps.current_values.find { |v| v[:name] == :cart_create_service }
+
+ expect(cart_create[:overridden]).to be true
+ expect(cart_create[:current]).to eq MyCustomCreateService
+ expect(cart_create[:default]).to eq 'Spree::Cart::Create'
+ end
+ end
- it 'returns the default value' do
- expect(deps.cart_create_service).to eq('Spree::Cart::Create')
+ describe '#validate!' do
+ it 'raises Spree::DependencyError for invalid dependencies' do
+ deps.cart_create_service = 'NonExistentClass'
+ expect { deps.validate! }.to raise_error(Spree::DependencyError)
+ end
+
+ it 'includes dependency names in error message' do
+ deps.cart_create_service = 'NonExistentClass'
+ deps.cart_add_item_service = 'AnotherNonExistentClass'
+ expect { deps.validate! }.to raise_error(Spree::DependencyError, /cart_create_service/)
+ end
+ end
+end
+
+describe 'Spree module dependency accessors' do
+ # These tests use the global Spree::Dependencies instance
+ # We need to be careful to restore original values after tests
+
+ describe 'Spree.<dependency>' do
+ it 'returns the resolved class' do
+ expect(Spree.cart_create_service).to eq Spree::Cart::Create
+ end
+
+ it 'responds to dependency methods' do
+ expect(Spree.respond_to?(:cart_create_service)).to be true
+ expect(Spree.respond_to?(:cart_create_service=)).to be true
+ end
+
+ it 'does not respond to non-dependency methods' do
+ expect(Spree.respond_to?(:non_existent_dependency)).to be false
+ end
end
- it 'allows to overwrite the value' do
- deps.cart_create_service = MyCustomCreateService
- expect(deps.cart_create_service).to eq MyCustomCreateService
+ describe 'Spree.<dependency>=' do
+ let(:original_value) { Spree::Dependencies.cart_add_item_service }
+
+ after do
+ # Restore original value
+ Spree::Dependencies.instance_variable_set(:@cart_add_item_service, original_value)
+ Spree::Dependencies.instance_variable_set(:@overrides, {})
+ end
+
+ it 'sets the dependency via Spree module' do
+ Spree.cart_add_item_service = MyCustomAddItemService
+ expect(Spree::Dependencies.cart_add_item_service).to eq MyCustomAddItemService
+ end
+
+ it 'returns the new class via Spree module' do
+ Spree.cart_add_item_service = MyCustomAddItemService
+ expect(Spree.cart_add_item_service).to eq MyCustomAddItemService
+ end
end
end