Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 3.33 KB

dependencies.md

File metadata and controls

88 lines (59 loc) · 3.33 KB
title section order
Dependency system
customization
3

Dependencies

Overview

With Dependencies you can easily replace parts of Spree internals with your custom classes. You can replace Services, Abilities and Serializers. More will come in the future.

Controller level customization

To replace serializers or Services in a specific API endpoint you can create a simple decorator:

Create a app/controllers/my_store/spree/cart_controller_decorator.rb

  module MyStore
    module Spree
      module CartControllerDecorator
        def resource_serializer
          MyNewAwesomeCartSerializer
        end

        def add_item_service
          MyNewAwesomeAddItemToCart
        end
      end
    end
  end
  Spree::Api::V2::Storefront::CartController.prepend MyStore::Spree::CartControllerDecorator

This will change the serializer in this API endpoint to MyNewAwesomeCartSerializer and also it will swap the default add_item_service to MyNewAwesomeAddItemToCart.

Different API endpoints can have different dependency injection points. You can review their source code to see what you can configure.

API level customization

Storefront and Platform APIs have separate Dependencies injection points so you can easily customize one without touching the other.

In your Spree initializer (config/initializers/spree.rb) please add:

Spree::Api::Dependencies.storefront_cart_serializer = 'MyNewAwesomeCartSerializer'
Spree::Api::Dependencies.storefront_cart_add_item_service = 'MyNewAwesomeAddItemToCart'

This will swap the default Cart serializer and Add Item to Cart service for your custom ones within all Storefront API endpoints that uses those classes.

Values set in the initializer has to be strings, eg. `'MyNewAwesomeAddItemToCart'`

Application (global) customization

You can also inject classes globally to the entire Spree stack. Be careful about this though as this touches every aspect of the application (both APIs, Admin Panel and default Rails frontend if you're using it).

Spree::Dependencies.cart_add_item_service = 'MyNewAwesomeAddItemToCart'

or

Spree.dependencies do |dependencies|
  dependencies.cart_add_item_service = 'MyNewAwesomeAddItemToCart'
end

You can mix and match both global and API level customizations:

Spree::Dependencies.cart_add_item_service = 'MyNewAwesomeAddItemToCart'
Spree::Api::Dependencies.storefront_cart_add_item_service = 'AnotherAddItemToCart'

The second line will have precedence over the first one, and the Storefront API will use AnotherAddItemToCart and the rest of the application will use MyNewAwesomeAddItemToCart

Values set in the initializer have to be strings, eg. 'MyNewAwesomeAddItemToCart'

Default values

Default values can be easily checked looking at the source code of Dependencies classes: