Introducing product brand using taxon_brand_selector

[shahmayur001]

Summary

This implementation introduces a brand concept to Spree products by adding a brand method to the Spree::Product model. This method delegates brand selection to a configurable class, enabling modularity and customization.

The new Spree::TaxonBrandSelector class fetches brands based on the Brands taxonomy. Developers can customize this functionality through the brand_selector_class attribute in Spree::AppConfiguration.

---

Implementation

Model Method Implementation

A brand method has been added to the Spree::Product model to retrieve the associated brand.

Changes in Spree::Product

The new brand method is implemented as follows:

def brand
  Spree::Config.brand_selector_class.new(self).call
end 

Class Implementation

The 'Spree::TaxonBrandSelector' class encapsulates the logic for identifying the brand:

module Spree
  class TaxonBrandSelector
	BRANDS_TAXONOMY_NAME = "Brands"

	def initialize(product)
  	@product = product
	end

	def call
  	product.taxons
         	.joins(:taxonomy)
         	.where(spree_taxonomies: { name: BRANDS_TAXONOMY_NAME })
         	.first
	end

	private

	attr_reader :product
  end
end

This class queries the database for taxons associated with the product and matches the 'Brands' taxonomy.

Configuration Implementation
A new configuration attribute was added to 'Spree::AppConfiguration' to specify the class responsible for selecting the brand for a product:

class_name_attribute :brand_selector_class, default: 'Spree::TaxonBrandSelector'

This configuration allows developers to override the default behavior by providing a custom class. By default, it uses 'Spree::TaxonBrandSelector'.

Testing
Unit tests were added to verify that the selector correctly identifies the first 'Brands' taxon.

RSpec Example

require 'rails_helper'

RSpec.describe Spree::TaxonBrandSelector, type: :model do
  let(:taxonomy) { create(:taxonomy, name: "Brands") }
  let(:taxon) { create(:taxon, taxonomy: taxonomy, name: "Brand A") }
  let(:product) { create(:product, taxons: [taxon]) }

  subject { described_class.new(product) }

  describe "#call" do
	context "when the product has a taxon under the 'Brands' taxonomy" do
  	it "returns the first taxon under 'Brands'" do
    	expect(subject.call).to eq(taxon)
  	end
	end
  end
end

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

• I have written a thorough PR description.
• I have kept my commits small and atomic.
• I have used clear, explanatory commit messages.

The following are not always needed:

• 📖 I have updated the README to account for my changes.
• 📑 I have documented new code with YARD.
• 🛣️ I have opened a PR to update the guides.
• ✅ I have added automated tests to cover my changes.
• 📸 I have attached screenshots to demo visual changes.

[fthobe]

Documentation has also be added here: solidusio/edgeguides#138

[kennyadsl]

Thanks for the contribution, again.

The failure seems related. Also, there's still an extra merge commit. Let me know if I can help with doing a proper rebase.

[codecov]

Codecov Report

Attention: Patch coverage is 91.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 89.46%. Comparing base (f7a1391) to head (603714a).
Report is 29 commits behind head on main.

Files with missing lines	Patch %	Lines
core/app/models/spree/product.rb	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5989   +/-   ##
=======================================
  Coverage   89.46%   89.46%           
=======================================
  Files         782      783    +1     
  Lines       17999    18011   +12     
=======================================
+ Hits        16102    16113   +11     
- Misses       1897     1898    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[fthobe]

@kennyadsl should be fine now, sorry for not cleaning up behind ourselves :)

[jarednorman]

Do we think this change requires a minor version bump? My main worry is that I know of existing stores that already have a brand column, and this is a breaking change for them, even if it's trivial to implement the selector in that case.

[fthobe]

@jarednorman yes, I'd also polish the edge guide a little to contain backend instructions.

[fthobe]

Do we think this change requires a minor version bump? My main worry is that I know of existing stores that already have a brand column, and this is a breaking change for them, even if it's trivial to implement the selector in that case.

It would be indicated. Let's see if we manage also to place meta data in that release. Deal?

[kennyadsl]

Do we think this change requires a minor version bump?

Do you mean major @jarednorman? BTW I dont' think we need to treat this change as a backward incompatibility, as it's not changing something existing. A special note in the next minor version changelog would be enough IMO.

[kennyadsl]

Thanks!