Refactor uses of spree_variants.count_on_hand

[oeoeaio]

VariantOverride is particularly coupled to this column, but we should be able to override the new variant.total_on_hand method instead of variant.count_on_hand to achieve the same result. This is a bandaid solution but a longer term solution to this issue will likely appear out of Networked Products discussions.

[mkllnk]

Spree::Variant decorator

scope :in_stock: Not on Spree's model. Plenty of use of method in_stock?, but no use of the scope in_stock.

VariantOverride

It has its own count_on_hand value. If this value is present, it uses it for stock management. Otherwise it expects that it's not used for stock. increment_stock! will intentionally raise an error instead of using the variant's count_on_hand value.

ScopeVariantToHub

This is a nasty one. Whenever code wants to deal with variants from a distributor's perspective, it doesn't deal with VariantOverride directly. It calls ScopeVariantToHub.scope to override some of the variant's methods to use the variant override if present. For example, it overrides count_on_hand. The old Spree code uses count_on_hand in methods like in_stock?. These are not overridden, because they just add logic to the overridden values from the variant override and everything "works". Now, Spree 2 changes that logic, not using count_on_hand and therefore getting the value from our variant override. That means that we have to override all these methods as well.

In old Spree, but not in Spree 2. We need to replace them:

• count_on_hand issue [Spree 2 Upgrade] Restore Variant.on_hand methods #2575
• count_on_hand= issue [Spree 2 Upgrade] Restore Variant.on_hand methods #2575
• on_hand issue [Spree 2 Upgrade] Restore Variant.on_hand methods #2575
• on_hand= issue [Spree 2 Upgrade] Restore Variant.on_hand methods #2575
• available? - not used in our code base

Modified in Spree 2. We need to override this for VariantOverrides:

• in_stock? 2014 refactor variant count on hand #2413

New in Spree 2:

• total_on_hand

More uses of count_on_hand:

I made a task list of all code that references count_on_hand. We can tick them off when we create pull requests for them.

WIP feature Product Import

• openfoodnetwork/app/models/product_import/entry_processor.rb

  Lines 69 to 74 in eb9064f

  	unless suppliers_to_reset_inventories.empty?
  	@products_reset_count += VariantOverride.
  	where('variant_overrides.hub_id IN (?)
  	AND variant_overrides.id NOT IN (?)', suppliers_to_reset_inventories, @updated_ids).
  	update_all(count_on_hand: 0)
  	end

  This is assigning VariantOverride which is not affected by the Spree upgrade.

• openfoodnetwork/app/models/product_import/entry_processor.rb

  Lines 196 to 198 in eb9064f

  	if object.send(attribute).blank? || ((attribute == 'on_hand' || attribute == 'count_on_hand') && entry.on_hand_nil)
  	object.assign_attributes(attribute => setting['value'])
  	end

  The use of assign_attributes will send on_hand= to the object which should work once we implemented the old API in [Spree 2 Upgrade] Restore Variant.on_hand methods #2575.

• openfoodnetwork/app/models/product_import/entry_validator.rb

  Lines 265 to 271 in eb9064f

  	def check_on_hand_nil(entry, object)
  	return if entry.on_hand.present?
  	object.on_hand = 0 if object.respond_to?(:on_hand)
  	object.count_on_hand = 0 if object.respond_to?(:count_on_hand)
  	entry.on_hand_nil = true
  	end

  This also uses the Spree API which will be restored in [Spree 2 Upgrade] Restore Variant.on_hand methods #2575

Code calling method count_on_hand

• Proposal in [WIP] Import count_on_hand methods for Spree 2 #2417

  openfoodnetwork/app/serializers/api/variant_serializer.rb

  Line 2 in eb9064f

  attributes :id, :is_master, :count_on_hand, :name_to_display, :unit_to_display, :unit_value

• Proposal in [WIP] Import count_on_hand methods for Spree 2 #2417

  openfoodnetwork/app/services/order_factory.rb

  Line 46 in eb9064f

  li[:quantity] = stock_limited_quantity(variant.count_on_hand, li[:quantity])

• Proposal in [WIP] Import count_on_hand methods for Spree 2 #2417

  openfoodnetwork/app/views/shop/products/_form.html.haml

  Line 34 in eb9064f

  %shop-variant{variant: 'variant', "ng-repeat" => "variant in product.variants | orderBy: ['name_to_display','unit_value'] track by variant.id", "id" => "variant-{{ variant.id }}", "ng-class" => "{'out-of-stock': !variant.on_demand && variant.count_on_hand == 0}"}

• Proposal in [WIP] Import count_on_hand methods for Spree 2 #2417

  openfoodnetwork/app/views/spree/admin/variants/_autocomplete.js.erb

  Line 19 in eb9064f

  <li class='variant-on_hand'><strong>{{t 'on_hand'}}:</strong> {{variant.count_on_hand}}</li>

• Proposal in [WIP] Import count_on_hand methods for Spree 2 #2417

  openfoodnetwork/app/views/spree/admin/variants/search.rabl

  Line 5 in eb9064f

  attributes :sku, :options_text, :count_on_hand, :id, :cost_price

Code using count_on_hand in SQL

• 2014 refactor variant count on hand #2413

  openfoodnetwork/lib/open_food_network/products_and_inventory_report_base.rb

  Line 41 in eb9064f

  variants.where('spree_variants.count_on_hand > 0')

Code calling decrement! or increment!

• openfoodnetwork/lib/open_food_network/scope_variant_to_hub.rb

  Lines 43 to 47 in eb9064f

  	if attribute == :count_on_hand && @variant_override.andand.stock_overridden?
  	@variant_override.decrement_stock! by
  	else
  	super
  	end

  This is on VariantOverride, not Spree::Variant.

• openfoodnetwork/lib/open_food_network/scope_variant_to_hub.rb

  Lines 51 to 55 in eb9064f

  	if attribute == :count_on_hand && @variant_override.andand.stock_overridden?
  	@variant_override.increment_stock! by
  	else
  	super
  	end

  This is on VariantOverride, not Spree::Variant.

Other code

• openfoodnetwork/lib/open_food_network/scope_variant_to_hub.rb

  Line 25 in eb9064f

  @variant_override.andand.count_on_hand || super

  this call is to VariantOverride and still valid
• Lots of specs

[mkllnk]

After reviewing all uses again, I found that #2575 is the only issue left to do. That should solve all listed issues. Closing this one.