[Spree Upgrade] Remove variant.count_on_hand (keep variant.on_hand only)

app/assets/javascripts/darkswarm/services/cart.js.coffee

@@ -57,18 +57,20 @@ Darkswarm.factory 'Cart', (CurrentOrder, Variants, $timeout, $http, $modal, $roo
       scope = $rootScope.$new(true)
       scope.variants = []
 
-      # TODO: These changes to quantity/max_quantity trigger another cart update, which
-      #       is unnecessary.
-
+      # TODO: These changes to quantity/max_quantity trigger another cart update, which is unnecessary.
       for li in @line_items when li.quantity > 0
-        if stockLevels[li.variant.id]?
-          li.variant.count_on_hand = stockLevels[li.variant.id].on_hand
-          if li.quantity > li.variant.count_on_hand
-            li.quantity = li.variant.count_on_hand
-            scope.variants.push li.variant
-          if li.variant.count_on_hand == 0 && li.max_quantity > li.variant.count_on_hand
-            li.max_quantity = li.variant.count_on_hand
-            scope.variants.push(li.variant) unless li.variant in scope.variants
+        continue unless stockLevels[li.variant.id]?
+
+        li.variant.on_hand = stockLevels[li.variant.id].on_hand
+        li.variant.on_demand = stockLevels[li.variant.id].on_demand
+        continue if li.variant.on_demand
+
+        if li.quantity > li.variant.on_hand
+          li.quantity = li.variant.on_hand
+          scope.variants.push li.variant
+        if li.variant.on_hand == 0 && li.max_quantity > li.variant.on_hand
+          li.max_quantity = li.variant.on_hand
+          scope.variants.push(li.variant) unless li.variant in scope.variants
 
       if scope.variants.length > 0
         $modal.open(templateUrl: "out_of_stock.html", scope: scope, windowClass: 'out-of-stock-modal')

app/assets/javascripts/templates/out_of_stock.html.haml

@@ -9,7 +9,7 @@
 
 %p{'ng-repeat' => "v in variants"}
   %em {{ v.name_to_display }} - {{ v.unit_to_display }}
-  %span{'ng-if' => "v.count_on_hand == 0"}
+  %span{'ng-if' => "v.on_hand == 0"}
     {{ 'js.out_of_stock.now_out_of_stock' | t }}
-  %span{'ng-if' => "v.count_on_hand > 0"}
-    {{ 'js.out_of_stock.only_n_remainging' | t:{ num: v.count_on_hand } }}
+  %span{'ng-if' => "v.on_hand > 0"}
+    {{ 'js.out_of_stock.only_n_remainging' | t:{ num: v.on_hand } }}

app/assets/javascripts/templates/partials/shop_variant_no_group_buy.html.haml

@@ -7,6 +7,6 @@
   placeholder: "0",
   "ofn-disable-scroll" => true,
   "ng-model" => "variant.line_item.quantity",
-  "ofn-on-hand" => "{{variant.on_demand && 9999 || variant.count_on_hand }}",
-  "ng-disabled" => "!variant.on_demand && variant.count_on_hand == 0",
+  "ofn-on-hand" => "{{variant.on_demand && 9999 || variant.on_hand }}",
+  "ng-disabled" => "!variant.on_demand && variant.on_hand == 0",
   name: "variants[{{::variant.id}}]", id: "variants_{{::variant.id}}"}

app/assets/javascripts/templates/partials/shop_variant_with_group_buy.html.haml

@@ -9,7 +9,7 @@
       "ng-model" => "variant.line_item.quantity",
       placeholder: "{{::'shop_variant_quantity_min' | t}}",
       "ofn-disable-scroll" => true,
-      "ofn-on-hand" => "{{variant.on_demand && 9999 || variant.count_on_hand }}",
+      "ofn-on-hand" => "{{variant.on_demand && 9999 || variant.on_hand }}",
       name: "variants[{{::variant.id}}]", id: "variants_{{::variant.id}}"}
     %span.bulk-input
       %input.bulk.second{type: :number,

app/models/concerns/variant_stock.rb

@@ -20,61 +20,30 @@ module VariantStock
     after_update :save_stock
   end
 
-  # Returns the number of items of the variant available in the stock. When
-  # allowing on demand, it returns infinite.
-  #
-  # Spree computes it as the sum of the count_on_hand of all its stock_items.
+  # Returns the number of items of the variant available.
+  # Spree computes total_on_hand as the sum of the count_on_hand of all its stock_items.
   #
   # @return [Float|Integer]
   def on_hand
     warn_deprecation(__method__, '#total_on_hand')
 
-    if on_demand
-      Float::INFINITY
-    else
-      total_on_hand
-    end
-  end
-
-  # Returns the number of items available in the stock for this variant
-  #
-  # @return [Float|Integer]
-  def count_on_hand
-    warn_deprecation(__method__, '#total_on_hand')
     total_on_hand
   end
 
-  # Sets the stock level when `track_inventory_levels` config is
-  # set. It raises otherwise.
+  # Sets the stock level of the variant.
+  # This will only work if `track_inventory_levels` config is set
+  #   and if there is a stock item for the variant.
   #
-  # @raise [StandardError] when the track_inventory_levels config
-  # key is not set.
+  # @raise [StandardError] when the track_inventory_levels config key is not set
+  #   and when the variant has no stock item
   def on_hand=(new_level)
     warn_deprecation(__method__, '#total_on_hand')
 
     error = 'Cannot set on_hand value when Spree::Config[:track_inventory_levels] is false'
     raise error unless Spree::Config.track_inventory_levels
 
-    self.count_on_hand = new_level
-  end
-
-  # Sets the stock level. As opposed to #on_hand= it does not check
-  # `track_inventory_levels`'s value as it was previously an ActiveModel
-  # setter of the database column of the `spree_variants` table. That is why
-  # #on_hand= is more widely used in Spree's codebase using #count_on_hand=
-  # underneath.
-  #
-  # So, if #count_on_hand= is used, `track_inventory_levels` won't be taken
-  # into account thus dismissing instance's configuration.
-  #
-  # It does ensure there's a stock item for the variant however. See
-  # #raise_error_if_no_stock_item_available for details.
-  #
-  # @raise [StandardError] when the variant has no stock item yet
-  def count_on_hand=(new_level)
-    warn_deprecation(__method__, '#total_on_hand')
-
     raise_error_if_no_stock_item_available
+
     overwrite_stock_levels(new_level)
   end
 
@@ -131,7 +100,7 @@ def can_supply?(quantity)
   # Here we depend only on variant.total_on_hand and variant.on_demand.
   #   This way, variant_overrides only need to override variant.total_on_hand and variant.on_demand.
   def fill_status(quantity)
-    if count_on_hand >= quantity
+    if on_hand >= quantity
       on_hand = quantity
       backordered = 0
     else

app/models/product_import/entry_processor.rb

@@ -218,7 +218,7 @@ def assign_defaults(object, entry)
           end
         when 'overwrite_empty'
           if object.public_send(attribute).blank? ||
-             ((attribute == 'on_hand' || attribute == 'count_on_hand') &&
+             ((attribute == 'on_hand') &&
              entry.on_hand_nil)
 
             object.assign_attributes(attribute => setting['value'])

app/models/product_import/entry_validator.rb

@@ -372,7 +372,6 @@ 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
 

app/models/product_import/products_reset_strategy.rb

@@ -9,7 +9,7 @@ def reset(enterprise_ids)
 
       return 0 if enterprise_ids.blank?
 
-      reset_variants_count_on_hand(enterprise_variants_relation)
+      reset_variants_on_hand(enterprise_variants_relation)
     end
 
     private
@@ -29,17 +29,17 @@ def enterprise_variants_relation
       relation.where('spree_variants.id NOT IN (?)', excluded_items_ids)
     end
 
-    def reset_variants_count_on_hand(variants)
+    def reset_variants_on_hand(variants)
       updated_records_count = 0
       variants.each do |variant|
-        updated_records_count += 1 if reset_variant_count_on_hand(variant)
+        updated_records_count += 1 if reset_variant_on_hand(variant)
       end
       updated_records_count
     end
 
-    def reset_variant_count_on_hand(variant)
-      variant.count_on_hand = 0
-      variant.count_on_hand.zero?
+    def reset_variant_on_hand(variant)
+      variant.on_hand = 0
+      variant.on_hand.zero?
     end
   end
 end

app/models/product_import/spreadsheet_entry.rb

@@ -16,7 +16,7 @@ class SpreadsheetEntry
                   :distributor_id, :name, :display_name, :sku, :unit_value,
                   :unit_description, :variant_unit, :variant_unit_scale,
                   :variant_unit_name, :display_as, :category, :primary_taxon_id,
-                  :price, :on_hand, :count_on_hand, :on_demand,
+                  :price, :on_hand, :on_demand,
                   :tax_category_id, :shipping_category_id, :description,
                   :import_date, :enterprise, :enterprise_id
 

app/models/spree/line_item_decorator.rb

@@ -64,6 +64,7 @@
 
   def cap_quantity_at_stock!
     scoper.scope(variant)
+    return if variant.on_demand
     update_attributes!(quantity: variant.on_hand) if quantity > variant.on_hand
   end
 

app/serializers/api/admin/product_serializer.rb

@@ -25,7 +25,8 @@ def thumb_url
   end
 
   def on_hand
-    object.on_hand.nil? ? 0 : object.on_hand.to_f.finite? ? object.on_hand : I18n.t(:on_demand)
+    return 0 if object.on_hand.nil?
+    object.on_hand
   end
 
   def price

app/serializers/api/admin/variant_serializer.rb

@@ -4,7 +4,8 @@ class Api::Admin::VariantSerializer < ActiveModel::Serializer
   has_many :variant_overrides
 
   def on_hand
-    object.on_hand.nil? ? 0 : ( object.on_hand.to_f.finite? ? object.on_hand : I18n.t(:on_demand) )
+    return 0 if object.on_hand.nil?
+    object.on_hand
   end
 
   def price

app/serializers/api/variant_serializer.rb

@@ -1,5 +1,5 @@
 class Api::VariantSerializer < ActiveModel::Serializer
-  attributes :id, :is_master, :count_on_hand, :name_to_display, :unit_to_display, :unit_value
+  attributes :id, :is_master, :on_hand, :name_to_display, :unit_to_display, :unit_value
   attributes :options_text, :on_demand, :price, :fees, :price_with_fees, :product_name
   attributes :tag_list
 

app/services/order_factory.rb

@@ -45,7 +45,7 @@ def build_line_items
     attrs[:line_items].each do |li|
       next unless variant = Spree::Variant.find_by_id(li[:variant_id])
       scoper.scope(variant)
-      li[:quantity] = stock_limited_quantity(variant.count_on_hand, li[:quantity])
+      li[:quantity] = stock_limited_quantity(variant.on_hand, li[:quantity])
       li[:price] = variant.price
       build_item_from(li)
     end

app/services/variants_stock_levels.rb

@@ -10,8 +10,8 @@ def call(order, requested_variant_ids)
     order_variant_ids = variant_stock_levels.keys
     missing_variant_ids = requested_variant_ids - order_variant_ids
     missing_variant_ids.each do |variant_id|
-      variant_on_hand = Spree::Variant.find(variant_id).on_hand
-      variant_stock_levels[variant_id] = { quantity: 0, max_quantity: 0, on_hand: variant_on_hand }
+      variant = Spree::Variant.find(variant_id)
+      variant_stock_levels[variant_id] = { quantity: 0, max_quantity: 0, on_hand: variant.on_hand, on_demand: variant.on_demand }
     end
 
     # The code above is most probably dead code, this bugsnag notification will confirm it
@@ -37,14 +37,9 @@ def variant_stock_levels(line_items)
         [line_item.variant.id,
          { quantity: line_item.quantity,
            max_quantity: line_item.max_quantity,
-           on_hand: wrap_json_infinity(line_item.variant.on_hand) }]
+           on_hand: line_item.variant.on_hand,
+           on_demand: line_item.variant.on_demand }]
       end
     ]
   end
-
-  # Rails to_json encodes Float::INFINITY as Infinity, which is not valid JSON
-  # Return it as a large integer (max 32 bit signed int)
-  def wrap_json_infinity(number)
-    number == Float::INFINITY ? 2_147_483_647 : number
-  end
 end

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

@@ -31,7 +31,7 @@
     %div.pad-top{ "infinite-scroll" => "incrementLimit()", "infinite-scroll-distance" => "1", "infinite-scroll-disabled" => 'filteredProducts.length <= limit' }
       %product.animate-repeat{"ng-controller" => "ProductNodeCtrl", "ng-repeat" => "product in visibleProducts track by product.id", "id" => "product-{{ product.id }}"}
         = render "shop/products/summary"
-        %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}"}
+        %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.on_hand == 0}"}
 
       %product{"ng-show" => "Products.loading"}
         .row.summary

app/views/spree/admin/products/index/_products_variant.html.haml

@@ -16,7 +16,8 @@
     %input{ 'ng-model' => 'variant.price', 'ofn-decimal' => :true, :name => 'variant_price', 'ofn-track-variant' => 'price', :type => 'text' }
   %td{ 'ng-show' => 'columns.on_hand.visible' }
     %input.field{ 'ng-model' => 'variant.on_hand', 'ng-change' => 'updateOnHand(product)', :name => 'variant_on_hand', 'ng-if' => '!variant.on_demand', 'ofn-track-variant' => 'on_hand', :type => 'number' }
-    %span{ 'ng-bind' => 'variant.on_hand', :name => 'variant_on_hand', 'ng-if' => 'variant.on_demand' }
+    %span{ :name => 'variant_on_hand', 'ng-if' => 'variant.on_demand' }
+      = t(:on_demand)
   %td{ 'ng-show' => 'columns.on_demand.visible' }
     %input.field{ 'ng-model' => 'variant.on_demand', :name => 'variant_on_demand', 'ofn-track-variant' => 'on_demand', :type => 'checkbox' }
   %td{ 'ng-show' => 'columns.category.visible' }

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

@@ -16,7 +16,7 @@
       </ul>
       <ul class='variant-data'>
         <li class='variant-sku'><strong><%= t('admin.sku') %>:</strong> {{variant.sku}}</li>
-        <li class='variant-on_hand'><strong><%= t('on_hand') %>:</strong> {{variant.count_on_hand}}</li>
+        <li class='variant-on_hand'><strong><%= t('on_hand') %>:</strong> {{variant.on_hand}}</li>
       </ul>
 
       {{#if variant.option_values}}
@@ -41,7 +41,7 @@
         </colgroup>
         <thead>
           <th><%= Spree.t(:location) %></th>
-          <th><%= Spree.t(:count_on_hand) %></th>
+          <th><%= Spree.t(:on_hand) %></th>
           <th><%= Spree.t(:quantity) %></th>
           <th class="actions"></th>
         </thead>
@@ -53,7 +53,7 @@
                 <td>Spree.t(:on_demand)</td>
               {{else}}
                 <td>
-                  {{variant.count_on_hand}}
+                  {{variant.on_hand}}
                 </td>
               {{/if}}                  
               <td>

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

@@ -2,7 +2,7 @@
 # overriding spree/core/app/views/spree/admin/variants/search.rabl
 #
 collection @variants
-attributes :sku, :options_text, :in_stock?, :on_demand, :count_on_hand, :id, :cost_price
+attributes :sku, :options_text, :in_stock?, :on_demand, :on_hand, :id, :cost_price
 
 node(:name) do |v|
   # TODO: when products must have a unit, full_name will always be present

spec/controllers/cart_controller_spec.rb

@@ -63,8 +63,8 @@
     let!(:line_item) { create(:line_item, order: order, variant: variant_in_the_order, quantity: 2, max_quantity: 3) }
 
     before do
-      variant_in_the_order.count_on_hand = 4
-      variant_not_in_the_order.count_on_hand = 2
+      variant_in_the_order.on_hand = 4
+      variant_not_in_the_order.on_hand = 2
       order_cycle.exchanges.outgoing.first.variants = [variant_in_the_order, variant_not_in_the_order]
       order.order_cycle = order_cycle
       order.distributor = hub

spec/controllers/spree/admin/variants_controller_spec.rb

@@ -22,7 +22,7 @@ module Admin
         it "applies variant overrides" do
           spree_get :search, q: 'Prod', distributor_id: d.id.to_s
           assigns(:variants).should == [v1]
-          assigns(:variants).first.count_on_hand.should == 44
+          assigns(:variants).first.on_hand.should == 44
         end
 
         it "filters by order cycle" do

spec/factories.rb

@@ -604,7 +604,7 @@
 
     after(:create) do |variant, evaluator|
       variant.on_demand = evaluator.on_demand
-      variant.count_on_hand = evaluator.on_hand
+      variant.on_hand = evaluator.on_hand
       variant.save
     end
   end

spec/features/admin/reports_spec.rb

@@ -308,11 +308,11 @@
       product2.set_property 'Organic', 'NASAA 12345'
       product1.taxons = [taxon]
       product2.taxons = [taxon]
-      variant1.count_on_hand = 10
+      variant1.on_hand = 10
       variant1.update_column(:sku, "sku1")
-      variant2.count_on_hand = 20
+      variant2.on_hand = 20
       variant2.update_column(:sku, "sku2")
-      variant3.count_on_hand = 9
+      variant3.on_hand = 9
       variant3.update_column(:sku, "")
       variant1.option_values = [create(:option_value, :presentation => "Test")]
       variant2.option_values = [create(:option_value, :presentation => "Something")]