Merge pull request openfoodfoundation#12787 from rioug/move-variant-u…

…nit-attributes-to-variant [Product Refactor] Move variant unit sizes to variant
mkllnk · Oct 15, 2024 · 97b6289 · 97b6289
2 parents 781fcf2 + 01337c1
commit 97b6289
Show file tree

Hide file tree

Showing 110 changed files with 2,865 additions and 1,892 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -5,6 +5,7 @@
 *.yaml
 *.json
 *.html
+**/*.rb
 
 # JS
 # Enabled: app/webpacker/controllers/*.js and app/webpacker/packs/*.js
@@ -27,6 +28,5 @@ postcss.config.js
 /coverage/
 /engines/
 /public/
-/spec/
 /tmp/
 /vendor/
diff --git a/app/assets/javascripts/admin/bulk_product_update.js.coffee b/app/assets/javascripts/admin/bulk_product_update.js.coffee
@@ -187,9 +187,8 @@ angular.module("ofn.admin").controller "AdminProductEditCtrl", ($scope, $timeout
     product.variants.length > 0
 
 
-  $scope.hasUnit = (product) ->
-    product.variant_unit_with_scale?
-
+  $scope.hasUnit = (variant) ->
+    variant.variant_unit_with_scale?
 
   $scope.variantSaved = (variant) ->
     variant.hasOwnProperty('id') && variant.id > 0
@@ -242,32 +241,28 @@ angular.module("ofn.admin").controller "AdminProductEditCtrl", ($scope, $timeout
     $window.location = destination
 
   $scope.packProduct = (product) ->
-    if product.variant_unit_with_scale
-      match = product.variant_unit_with_scale.match(/^([^_]+)_([\d\.]+)$/)
-      if match
-        product.variant_unit = match[1]
-        product.variant_unit_scale = parseFloat(match[2])
-      else
-        product.variant_unit = product.variant_unit_with_scale
-        product.variant_unit_scale = null
-    else
-      product.variant_unit = product.variant_unit_scale = null
-
-
     if product.variants
       for id, variant of product.variants
-        $scope.packVariant product, variant
+        $scope.packVariant variant
+
 
+  $scope.packVariant = (variant) ->
+    if variant.variant_unit_with_scale
+      match = variant.variant_unit_with_scale.match(/^([^_]+)_([\d\.]+)$/)
+      if match
+        variant.variant_unit = match[1]
+        variant.variant_unit_scale = parseFloat(match[2])
+      else
+        variant.variant_unit = variant.variant_unit_with_scale
+        variant.variant_unit_scale = null
 
-  $scope.packVariant = (product, variant) ->
     if variant.hasOwnProperty("unit_value_with_description")
       match = variant.unit_value_with_description.match(/^([\d\.\,]+(?= |$)|)( |)(.*)$/)
       if match
-        product = BulkProducts.find product.id
         variant.unit_value  = parseFloat(match[1].replace(",", "."))
         variant.unit_value  = null if isNaN(variant.unit_value)
-        if variant.unit_value && product.variant_unit_scale
-          variant.unit_value = parseFloat(window.bigDecimal.multiply(variant.unit_value, product.variant_unit_scale, 2))
+        if variant.unit_value && variant.variant_unit_scale
+          variant.unit_value = parseFloat(window.bigDecimal.multiply(variant.unit_value, variant.variant_unit_scale, 2))
         variant.unit_description = match[3]
 
   $scope.incrementLimit = ->
@@ -321,13 +316,6 @@ filterSubmitProducts = (productsToFilter) ->
         if product.hasOwnProperty("price")
           filteredProduct.price = product.price
           hasUpdatableProperty = true
-        if product.hasOwnProperty("variant_unit_with_scale")
-          filteredProduct.variant_unit       = product.variant_unit
-          filteredProduct.variant_unit_scale = product.variant_unit_scale
-          hasUpdatableProperty = true
-        if product.hasOwnProperty("variant_unit_name")
-          filteredProduct.variant_unit_name = product.variant_unit_name
-          hasUpdatableProperty = true
         if product.hasOwnProperty("on_hand") and filteredVariants.length == 0 #only update if no variants present
           filteredProduct.on_hand = product.on_hand
           hasUpdatableProperty = true
@@ -383,6 +371,14 @@ filterSubmitVariant = (variant) ->
     if variant.hasOwnProperty("producer_id")
       filteredVariant.supplier_id = variant.producer_id
       hasUpdatableProperty = true
+    if variant.hasOwnProperty("variant_unit_with_scale")
+      filteredVariant.variant_unit       = variant.variant_unit
+      filteredVariant.variant_unit_scale = variant.variant_unit_scale
+      hasUpdatableProperty = true
+    if variant.hasOwnProperty("variant_unit_name")
+      filteredVariant.variant_unit_name = variant.variant_unit_name
+      hasUpdatableProperty = true
+
   {filteredVariant: filteredVariant, hasUpdatableProperty: hasUpdatableProperty}
 
 

diff --git a/app/assets/javascripts/admin/directives/display_as.js.coffee b/app/assets/javascripts/admin/directives/display_as.js.coffee
@@ -4,31 +4,30 @@ angular.module("ofn.admin").directive "ofnDisplayAs", (OptionValueNamer) ->
     scope.$watchCollection ->
       return [
         scope.$eval(attrs.ofnDisplayAs).unit_value_with_description
-        scope.product.variant_unit_name
-        scope.product.variant_unit_with_scale
+        scope.variant.variant_unit_name
+        scope.variant.variant_unit_with_scale
       ]
     , ->
       [variant_unit, variant_unit_scale] = productUnitProperties()
       [unit_value, unit_description] = variantUnitProperties(variant_unit_scale)
-      variant_object = 
+      variant_object =
         unit_value: unit_value
         unit_description: unit_description
-        product:
-          variant_unit_scale: variant_unit_scale
-          variant_unit: variant_unit
-          variant_unit_name: scope.product.variant_unit_name
+        variant_unit_scale: variant_unit_scale
+        variant_unit: variant_unit
+        variant_unit_name: scope.variant.variant_unit_name
 
       scope.placeholder_text = new OptionValueNamer(variant_object).name()
 
     productUnitProperties = ->
       # get relevant product properties
-      if scope.product.variant_unit_with_scale?
-        match = scope.product.variant_unit_with_scale.match(/^([^_]+)_([\d\.]+)$/)
+      if scope.variant.variant_unit_with_scale?
+        match = scope.variant.variant_unit_with_scale.match(/^([^_]+)_([\d\.]+)$/)
         if match
           variant_unit = match[1]
           variant_unit_scale = parseFloat(match[2])
         else
-          variant_unit = scope.product.variant_unit_with_scale
+          variant_unit = scope.variant.variant_unit_with_scale
           variant_unit_scale = null
       else
         variant_unit = variant_unit_scale = null
@@ -45,4 +44,4 @@ angular.module("ofn.admin").directive "ofnDisplayAs", (OptionValueNamer) ->
           unit_value  = null if isNaN(unit_value)
           unit_value *= variant_unit_scale if unit_value && variant_unit_scale
           unit_description = match[3]
-      [unit_value, unit_description]
+      [unit_value, unit_description]
diff --git a/app/assets/javascripts/admin/directives/maintain_unit_scale.js.coffee b/app/assets/javascripts/admin/directives/maintain_unit_scale.js.coffee
diff --git a/app/assets/javascripts/admin/directives/track_master.js.coffee b/app/assets/javascripts/admin/directives/track_master.js.coffee
diff --git a/app/assets/javascripts/admin/line_items/controllers/line_items_controller.js.coffee b/app/assets/javascripts/admin/line_items/controllers/line_items_controller.js.coffee
@@ -199,22 +199,22 @@ angular.module("admin.lineItems").controller 'LineItemsCtrl', ($scope, $timeout,
     $scope.refreshData()
 
   $scope.getLineItemScale = (lineItem) ->
-    if lineItem.units_product && lineItem.units_variant && (lineItem.units_product.variant_unit == "weight" || lineItem.units_product.variant_unit == "volume")
-      lineItem.units_product.variant_unit_scale
+    if lineItem.units_variant && lineItem.units_variant.variant_unit_scale && (lineItem.units_variant.variant_unit == "weight" || lineItem.units_variant.variant_unit == "volume")
+      lineItem.units_variant.variant_unit_scale
     else
       1
 
   $scope.sumUnitValues = ->
     sum = $scope.filteredLineItems?.reduce (sum, lineItem) ->
-      if lineItem.units_product.variant_unit == "items"
+      if lineItem.units_variant.variant_unit == "items"
         sum + lineItem.quantity
       else
         sum + $scope.roundToThreeDecimals(lineItem.final_weight_volume / $scope.getLineItemScale(lineItem))
     , 0
 
   $scope.sumMaxUnitValues = ->
     sum = $scope.filteredLineItems?.reduce (sum,lineItem) ->
-      if lineItem.units_product.variant_unit == "items"
+      if lineItem.units_variant.variant_unit == "items"
         sum + lineItem.max_quantity
       else
         sum + lineItem.max_quantity * $scope.roundToThreeDecimals(lineItem.units_variant.unit_value / $scope.getLineItemScale(lineItem))
@@ -228,39 +228,41 @@ angular.module("admin.lineItems").controller 'LineItemsCtrl', ($scope, $timeout,
       return false if !lineItem.hasOwnProperty('final_weight_volume') || !(lineItem.final_weight_volume > 0)
     true
 
-  $scope.getScale = (unitsProduct, unitsVariant) ->
-    if unitsProduct.hasOwnProperty("variant_unit") && (unitsProduct.variant_unit == "weight" || unitsProduct.variant_unit == "volume")
-      unitsProduct.variant_unit_scale
-    else if unitsProduct.hasOwnProperty("variant_unit") && unitsProduct.variant_unit == "items"
+  $scope.getScale = (unitsVariant) ->
+    if unitsVariant.hasOwnProperty("variant_unit") && (unitsVariant.variant_unit == "weight" || unitsVariant.variant_unit == "volume")
+      unitsVariant.variant_unit_scale
+    else if unitsVariant.hasOwnProperty("variant_unit") && unitsVariant.variant_unit == "items"
       1
     else
       null
 
-  $scope.getFormattedValueWithUnitName = (value, unitsProduct, unitsVariant, scale) ->
-    unit_name = VariantUnitManager.getUnitName(scale, unitsProduct.variant_unit)
+  $scope.getFormattedValueWithUnitName = (value, unitsVariant, scale) ->
+    unit_name = VariantUnitManager.getUnitName(scale, unitsVariant.variant_unit)
     $scope.roundToThreeDecimals(value) + " " + unit_name
 
-  $scope.getGroupBySizeFormattedValueWithUnitName = (value, unitsProduct, unitsVariant) ->
-    scale = $scope.getScale(unitsProduct, unitsVariant)
+  $scope.getGroupBySizeFormattedValueWithUnitName = (value, unitsVariant) ->
+    scale = $scope.getScale(unitsVariant)
     if scale && value
       value = value / scale if scale != 28.35 && scale != 1 && scale != 453.6 # divide by scale if not smallest unit
-      $scope.getFormattedValueWithUnitName(value, unitsProduct, unitsVariant, scale)
+      $scope.getFormattedValueWithUnitName(value, unitsVariant, scale)
     else
       ''
 
-  $scope.formattedValueWithUnitName = (value, unitsProduct, unitsVariant) ->
-    scale = $scope.getScale(unitsProduct, unitsVariant)
+  $scope.formattedValueWithUnitName = (value, unitsVariant) ->
+    scale = $scope.getScale(unitsVariant)
     if scale
-      $scope.getFormattedValueWithUnitName(value, unitsProduct, unitsVariant, scale)
+      $scope.getFormattedValueWithUnitName(value, unitsVariant, scale)
     else
       ''
 
   $scope.fulfilled = (sumOfUnitValues) ->
     # A Units Variant is an API object which holds unit properies of a variant
-    if $scope.selectedUnitsProduct.hasOwnProperty("group_buy_unit_size")&& $scope.selectedUnitsProduct.group_buy_unit_size > 0 &&
-      $scope.selectedUnitsProduct.hasOwnProperty("variant_unit")
-        if $scope.selectedUnitsProduct.variant_unit == "weight" || $scope.selectedUnitsProduct.variant_unit == "volume"
-          scale = $scope.selectedUnitsProduct.variant_unit_scale
+    if $scope.selectedUnitsProduct.hasOwnProperty("group_buy_unit_size") && $scope.selectedUnitsProduct.group_buy_unit_size > 0 &&
+      $scope.selectedUnitsVariant.hasOwnProperty("variant_unit")
+
+        if $scope.selectedUnitsVariant.variant_unit == "weight" || $scope.selectedUnitsVariant.variant_unit == "volume"
+
+          scale = $scope.selectedUnitsVariant.variant_unit_scale
           sumOfUnitValues = sumOfUnitValues * scale unless scale == 28.35 || scale == 453.6
         $scope.roundToThreeDecimals(sumOfUnitValues / $scope.selectedUnitsProduct.group_buy_unit_size)
     else

diff --git a/app/assets/javascripts/admin/products/controllers/edit_units_controller.js.coffee b/app/assets/javascripts/admin/products/controllers/edit_units_controller.js.coffee
diff --git a/app/assets/javascripts/admin/products/controllers/units_controller.js.coffee b/app/assets/javascripts/admin/products/controllers/units_controller.js.coffee
@@ -1,15 +1,14 @@
 # Controller for "New Products" form (spree/admin/products/new)
 angular.module("admin.products")
   .controller "unitsCtrl", ($scope, VariantUnitManager, OptionValueNamer, UnitPrices, PriceParser) ->
-    $scope.product = { master: {} }
-    $scope.product.master.product = $scope.product
+    $scope.product = {}
     $scope.placeholder_text = ""
 
-    $scope.$watchCollection '[product.variant_unit_with_scale, product.master.unit_value_with_description, product.price, product.variant_unit_name]', ->
+    $scope.$watchCollection '[product.variant_unit_with_scale, product.unit_value_with_description, product.price, product.variant_unit_name]', ->
       $scope.processVariantUnitWithScale()
       $scope.processUnitValueWithDescription()
       $scope.processUnitPrice()
-      $scope.placeholder_text = new OptionValueNamer($scope.product.master).name() if $scope.product.variant_unit_scale
+      $scope.placeholder_text = new OptionValueNamer($scope.product).name() if $scope.product.variant_unit_scale
 
     $scope.variant_unit_options = VariantUnitManager.variantUnitOptions()
 
@@ -38,24 +37,24 @@ angular.module("admin.products")
     # Extract unit_value and unit_description from text field unit_value_with_description,
     # and update hidden variant fields
     $scope.processUnitValueWithDescription = ->
-      if $scope.product.master.hasOwnProperty("unit_value_with_description")
-        match = $scope.product.master.unit_value_with_description.match(/^([\d\.,]+(?= *|$)|)( *)(.*)$/)
+      if $scope.product.hasOwnProperty("unit_value_with_description")
+        match = $scope.product.unit_value_with_description.match(/^([\d\.,]+(?= *|$)|)( *)(.*)$/)
         if match
-          $scope.product.master.unit_value  = PriceParser.parse(match[1])
-          $scope.product.master.unit_value  = null if isNaN($scope.product.master.unit_value)
-          $scope.product.master.unit_value = window.bigDecimal.multiply($scope.product.master.unit_value, $scope.product.variant_unit_scale, 2) if $scope.product.master.unit_value && $scope.product.variant_unit_scale
-          $scope.product.master.unit_description = match[3]
+          $scope.product.unit_value  = PriceParser.parse(match[1])
+          $scope.product.unit_value  = null if isNaN($scope.product.unit_value)
+          $scope.product.unit_value = window.bigDecimal.multiply($scope.product.unit_value, $scope.product.variant_unit_scale, 2) if $scope.product.unit_value && $scope.product.variant_unit_scale
+          $scope.product.unit_description = match[3]
       else
-        value = $scope.product.master.unit_value
-        value = window.bigDecimal.divide(value, $scope.product.variant_unit_scale, 2) if $scope.product.master.unit_value && $scope.product.variant_unit_scale
-        $scope.product.master.unit_value_with_description = value + " " + $scope.product.master.unit_description
+        value = $scope.product.unit_value
+        value = window.bigDecimal.divide(value, $scope.product.variant_unit_scale, 2) if $scope.product.unit_value && $scope.product.variant_unit_scale
+        $scope.product.unit_value_with_description = value + " " + $scope.product.unit_description
 
     # Calculate unit price based on product price and variant_unit_scale
     $scope.processUnitPrice = ->
       price = $scope.product.price
       scale = $scope.product.variant_unit_scale
       unit_type = $scope.product.variant_unit
-      unit_value = $scope.product.master.unit_value
+      unit_value = $scope.product.unit_value
       variant_unit_name = $scope.product.variant_unit_name
       $scope.unit_price = UnitPrices.displayableUnitPrice(price, scale, unit_type, unit_value, variant_unit_name)
 

diff --git a/app/assets/javascripts/admin/products/controllers/variant_units_controller.js.coffee b/app/assets/javascripts/admin/products/controllers/variant_units_controller.js.coffee
diff --git a/app/assets/javascripts/admin/products/directives/set_variant_on_demand.js.coffee b/app/assets/javascripts/admin/products/directives/set_variant_on_demand.js.coffee