/solidus_related_products

:fork_and_knife: Related products extension for Solidus

Primary LanguageRubyBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Related Products

CircleCI Gem License

This extension provides a generic way for you to define different types of relationships between your products, by defining a RelationType for each type of relationship you'd like to maintain.

You can manage RelationTypes via the admin configuration menu, and you can maintain product relationships via Related Products tab on the edit product UI or via Related Products section on the edit variant UI.

Installation

Add to Gemfile:

gem 'solidus_related_products'

Run:

$ bundle install
$ bundle exec rails g solidus_related_products:install

Possible uses

  • Accessories
  • Cross Sells
  • Up Sells
  • Compatible Products
  • Replacement Products
  • Warranty & Support Products

Relation Types

You can create four different RelationTypes:

Applies From Applies To Bi-Directional available
Spree::Product Spree::Product Yes
Spree::Product Spree::Variant No
Spree::Variant Spree::Product No
Spree::Variant Spree::Variant Yes

Bi-Directional You can optionally set the bi-directional flag (if available) to automatically create the inverse relation, the flag can be set only on the type creation and can't be changed later, this is needed to avoid unpredictable behavior in the case that the flag is changed. Keep in mind that if you remove one side of the relation, also the other hand will be removed, the same way happens for the description. The discounts are disabled for Bi-Directional by setting the discount amount to be only zero, this is needed because it's not clear how this feature should behave in this case.

The following examples use a Spree::Product -> Spree::Product relation type.

When you create a RelationType you can access that set of related products by referencing the relation_type name, see below for an example:

rt = Spree::RelationType.create(name: 'Accessories', applies_from: 'Spree::Product', applies_to: 'Spree::Product')
 => #<Spree::RelationType id: 4, name: "Accessories" ...>
product = Spree::Product.last
 => #<Spree::Product id: 1060500592 ...>
product.accessories
 => []

Since respond_to? will not work in this case, you can test whether a relation_type method exists with has_related_products?(method):

product.has_related_products?('accessories')
# => true

if product.has_related_products?('accessories')
  # Display an accessories box..
end

You can access all related products regardless of RelationType by:

product.relations
 => []

Discounts You can optionally specify a discount amount to be applied if a customer purchases both products.

Note: In order for the coupon to be automatically applied, you must create a promotion leaving the code value empty, and adding an Action of type : RelatedProductDiscount (blank codes are required for coupons to be automatically applied).

Contributing

See corresponding guidelines


Copyright (c) 2010-2015 Brian Quinn and contributors, released under the New BSD License