Fix stock configuration examples in documentation

[gugaiz]

Fix an issue with the documentation related to the custom configuration
of the stock location filter and sorter. The way it was documented
didn't work.

Checklist:

• I have followed Pull Request guidelines
• I have added a detailed description into each commit message
• I have updated Guides and README accordingly to this change (if needed)
• I have added tests to cover this change (if needed)
• I have attached screenshots to this PR for visual changes (if needed)

[kennyadsl]

Thanks for your contribution! Maybe Spree.config.spree.stock.location_filter_class = 'Spree::Stock::LocationFilter::SameOrderCountry' without the block is enough?

[gugaiz]

@kennyadsl, I tried that but didn't work for me neither.
getting 'config': no block given (yield) (LocalJumpError)

[kennyadsl]

Just to be sure, are you restarting the rails server after these changes?

[gugaiz]

yes

[kennyadsl]

Sorry, my fault, it should be:

Spree::Config.stock.location_filter_class = 'Spree::Stock::LocationFilter::SameOrderCountry'

[gugaiz]

Ok, that worked. I can change it with a new commit if you prefer that way

[kennyadsl]

Yes, I think it's better. And please, can you also squash commits into a single one before pushing? Thanks again! 🙂

[gugaiz]

Done

[kennyadsl]

Thanks!

[spaghetticode]

Out of curiosity, I tried to verify the issue locally.

So, I generated a sandbox app with rake sandbox, then edited the config/initializers/spree.rb like this:

class CustomAllocator
end
class CustomFilter
end
class CustomSorter
end

Spree.config do |config|
  config.stock.allocator_class = 'CustomAllocator'
  config.stock.location_filter_class = 'CustomFilter'
  config.stock.location_sorter_class = 'CustomSorter'
  # ...
end

then starting the sandbox console with rails c I got the expected custom configuration values:

Loading development environment (Rails 6.0.2.1)
2.6.3 :001 > Spree::Config.stock.allocator_class
 => CustomAllocator 
2.6.3 :002 > Spree::Config.stock.location_filter_class
 => CustomFilter 
2.6.3 :003 > Spree::Config.stock.location_sorter_class
 => CustomSorter 

So, in this case it seems that following the existing documentation work properly. @gugaiz can you explain in detail what kind of issues you experienced?

[gugaiz]

@spaghetticode that works and that was my first proposal, but @kennyadsl preferred the way is documented on this PR ( Spree::Config.stock.location_filter_class )
The current documentation suggest to use Rails.application.config.spree.stock.location_filter_class which does not work.

[spaghetticode]

@gugaiz thanks for the clarification. So, the documentation is wrong only for the two files that used Rails.application.config. I verified in the sandbox console that the correct way to access/set that configuration via Rails.application.config would be with:

Rails.application.config.spree.preferences.stock.location_filter_class

and

Rails.application.config.spree.preferences.stock.location_sorter_class

I have no idea if we should prefer one way or the other(s) for this case, maybe we should document them all?

[gugaiz]

@spaghetticode I guess someone else might answer that. If you ask me, I prefer the way below because is what you find when you open the config/initializer/spree.rb file

Spree.config do |config|
  config.stock.allocator_class = 'CustomAllocator'
  config.stock.location_filter_class = 'CustomFilter'
  config.stock.location_sorter_class = 'CustomSorter'
  # ...
end

[tvdeyen]

@spaghetticode I guess someone else might answer that. If you ask me, I prefer the way below because is what you find when you open the config/initializer/spree.rb file

Spree.config do |config|
  config.stock.allocator_class = 'CustomAllocator'
  config.stock.location_filter_class = 'CustomFilter'
  config.stock.location_sorter_class = 'CustomSorter'
  # ...
end

I also prefer that way

[kennyadsl]

I'm fine with both, so 👍 if @gugaiz has time to change it.

[spaghetticode]

@gugaiz thanks 👍

[gugaiz]

@kennyadsl I think is done

[spaghetticode]

@gugaiz thank you ❤️

[kennyadsl]

Thanks!