Merge pull request #237 from AtlasOfLivingAustralia/feature/issue236

Support control of trailing zeros #236
AtlasOfLivingAustralia · Feb 22, 2024 · 84df20c · 84df20c
2 parents 6eb04b3 + 510e0ae
commit 84df20c
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 63 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/grails-app/assets/javascripts/knockout-utils.js b/grails-app/assets/javascripts/knockout-utils.js
@@ -164,7 +164,22 @@
  * @param precision the number of decimal places allowed.
  * @returns {Computed<any>}
  */
- ko.extenders.numericString = function(target, precision) {
+ ko.extenders.numericString = function(target, options) {
+ var defaults = {
+ decimalPlaces: 2,
+ removeTrailingZeros: true // backwards compatibility
+ };
+ if (_.isNumber(options)) {
+ options = {decimalPlaces: options};
+ }
+ options = _.extend({}, defaults, options);
+
+ function roundAndToString(value) {
+ var roundingMultiplier = Math.pow(10, options.decimalPlaces);
+ var roundedValue = Math.round(value * roundingMultiplier) / roundingMultiplier;
+ return roundedValue.toString();
+ }
+
  //create a writable computed observable to intercept writes to our observable
  var result = ko.computed({
  read: target, //always return the original observables value
@@ -173,18 +188,18 @@
  if (typeof val === 'string') {
  val = newValue.replace(/,|\$/g, '');
  }
- var current = target(),
-  roundingMultiplier = Math.pow(10, precision),
- newValueAsNum = isNaN(val) ? 0 : parseFloat(+val),
-  valueToWrite = Math.round(newValueAsNum * roundingMultiplier) / roundingMultiplier;
+ var current = target();
+ var newValueAsNum = isNaN(val) ? 0 : parseFloat(+val);
+
+ var valueToWrite = options.removeTrailingZeros ? roundAndToString(newValueAsNum) : newValueAsNum.toFixed(options.decimalPlaces);
 
  //only write if it changed
- if (valueToWrite.toString() !== current || isNaN(val)) {
- target(isNaN(val) ? newValue : valueToWrite.toString());
+ if (valueToWrite !== current || isNaN(val)) {
+ target(isNaN(val) ? newValue : valueToWrite);
  }
  else {
  if (newValue !== current) {
- target.notifySubscribers(valueToWrite.toString());
+ target.notifySubscribers(valueToWrite);
  }
  }
  }

diff --git a/grails-app/taglib/au/org/ala/ecodata/forms/ModelJSTagLib.groovy b/grails-app/taglib/au/org/ala/ecodata/forms/ModelJSTagLib.groovy
@@ -624,7 +624,11 @@ class ModelJSTagLib {
 
  def numberViewModel(JSModelRenderContext ctx) {
  int decimalPlaces = ctx.dataModel.decimalPlaces ?: 2
- observable(ctx, ["{numericString:${decimalPlaces}}"])
+
+ Map options = new HashMap(ctx.viewModel()?.displayOptions ?: [:])
+ options.decimalPlaces = decimalPlaces
+ String optionString = (options as JSON).toString()
+ observable(ctx, ["{numericString:${optionString}}"])
  }
 
  def dateViewModel(JSModelRenderContext ctx) {

diff --git a/src/test/groovy/au/org/ala/ecodata/forms/ModelJSTagLibSpec.groovy b/src/test/groovy/au/org/ala/ecodata/forms/ModelJSTagLibSpec.groovy
@@ -44,7 +44,7 @@ class ModelJSTagLibSpec extends Specification implements TagLibUnitTest<ModelJST
  tagLib.renderDataModelItem(ctx)
 
  then:
- actualOut.toString().trim() == 'data.myField = ko.observable().extend({numericString:2}).extend({metadata:{metadata:self.dataModel[\'myField\'], context:self.\$context, config:config}});'
+ actualOut.toString().trim() == 'data.myField = ko.observable().extend({numericString:{"decimalPlaces":2}}).extend({metadata:{metadata:self.dataModel[\'myField\'], context:self.\$context, config:config}});'
  }
 
  void "the feature data type doesn't need any special initialisation behaviour"() {
@@ -84,7 +84,7 @@ class ModelJSTagLibSpec extends Specification implements TagLibUnitTest<ModelJST
  tagLib.numberViewModel(ctx)
 
  then: "the default is 2"
- actualOut.toString().trim() == "data.item1 = ko.observable().extend({numericString:2});"
+ actualOut.toString().trim() == "data.item1 = ko.observable().extend({numericString:{\"decimalPlaces\":2}});"
 
  when: "a number of decimal places is specified"
  ctx.dataModel.decimalPlaces = 3
@@ -93,7 +93,7 @@ class ModelJSTagLibSpec extends Specification implements TagLibUnitTest<ModelJST
  tagLib.numberViewModel(ctx)
 
  then:
- actualOut.toString().trim() == "data.item1 = ko.observable().extend({numericString:3});"
+ actualOut.toString().trim() == "data.item1 = ko.observable().extend({numericString:{\"decimalPlaces\":3}});"
 
  }