[TASK] bump version to 0.9.0

`precision` expresses precision within the provided value and won't expand it if the max expression of the value is smaller
`min_precision` will expand the value if the max expression of the value is smaller

HISTORY.md

@@ -2,17 +2,26 @@
 
 + Add routes to the vault client for KYC attestations ([ed2da574](https://github.com/ripple/ripple-lib/commit/ed2da57475acf5e9d2cf3373858f4274832bd83f))
 
++ Currency: add `show_interest` flag to show or hide interest in `Currency.to_human()` and `Currency.to_json()` [Example use in tests](https://github.com/ripple/ripple-lib/blob/947ec3edc2e7c8f1ef097e496bf552c74366e749/test/currency-test.js#L123)
+
 + Configurable maxAttempts for transaction submission ([d107092](https://github.com/ripple/ripple-lib/commit/d10709254061e9e4416d2cb78b5cac1ec0d7ffa5))
 
++ Binformat: added missing TransactionResult options ([6abed8d](https://github.com/ripple/ripple-lib/commit/6abed8dd5311765b2eb70505dadbdf5121439ca8))
+
++ **Breaking change:** make maxLoops in seed.get_key optional. [Example use in tests](https://github.com/ripple/ripple-lib/blob/23e473b6886c457781949c825b3ff48b3984e51f/test/seed-test.js) ([23e473b](https://github.com/ripple/ripple-lib/commit/23e473b6886c457781949c825b3ff48b3984e51f))
+
++ Shrinkwrap packages for dependency locking ([2dcd5f9](2dcd5f94fbc71200eb08a5044c76ef94f7971913))
+
++ Fix: Amount.to_human() precision bugs ([4be209e](https://github.com/ripple/ripple-lib/commit/4be209e286b5b209bec7bcd1212098985e15ff2f) and [7708c64](https://github.com/ripple/ripple-lib/commit/7708c64576e70ce3ac190442daceb30e4446aab7))
+
 + Fix: change handling of requestLedger options ([57b7030](https://github.com/ripple/ripple-lib/commit/57b70300f5f0c7534ede118ddbb5d8762668a4f8))
 
-+ **Breaking change:** make maxLoops in seed.get_key optional. [Example use in tests](https://github.com/ripple/ripple-lib/blob/develop/test/seed-test.js) ([23e473b](https://github.com/ripple/ripple-lib/commit/23e473b6886c457781949c825b3ff48b3984e51f)) 
 
 ##0.8.2
 
 + Currency: Allow mixed letters and numbers in currencies
 
-+ Deprecate account_tx map/reduce/filter
++ Deprecate account_tx map/reduce/filterg
 
 + Fix: correct requestLedger arguments
 

npm-shrinkwrap.json

@@ -0,0 +1,142 @@
+{
+  "name": "ripple-lib",
+  "version": "0.9.0-rc5",
+  "dependencies": {
+    "async": {
+      "version": "0.8.0",
+      "from": "async@>=0.8.0 <0.9.0"
+    },
+    "extend": {
+      "version": "1.2.1",
+      "from": "extend@>=1.2.1 <1.3.0"
+    },
+    "lru-cache": {
+      "version": "2.5.0",
+      "from": "lru-cache@>=2.5.0 <2.6.0"
+    },
+    "ripple-wallet-generator": {
+      "version": "1.0.1",
+      "from": "ripple-wallet-generator@1.0.1",
+      "resolved": "https://registry.npmjs.org/ripple-wallet-generator/-/ripple-wallet-generator-1.0.1.tgz"
+    },
+    "superagent": {
+      "version": "0.18.2",
+      "from": "superagent@>=0.18.0 <0.19.0",
+      "dependencies": {
+        "qs": {
+          "version": "0.6.6",
+          "from": "qs@0.6.6",
+          "resolved": "https://registry.npmjs.org/qs/-/qs-0.6.6.tgz"
+        },
+        "formidable": {
+          "version": "1.0.14",
+          "from": "formidable@1.0.14",
+          "resolved": "https://registry.npmjs.org/formidable/-/formidable-1.0.14.tgz"
+        },
+        "mime": {
+          "version": "1.2.11",
+          "from": "mime@1.2.11",
+          "resolved": "https://registry.npmjs.org/mime/-/mime-1.2.11.tgz"
+        },
+        "component-emitter": {
+          "version": "1.1.2",
+          "from": "component-emitter@1.1.2",
+          "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.1.2.tgz"
+        },
+        "methods": {
+          "version": "1.0.1",
+          "from": "methods@1.0.1",
+          "resolved": "https://registry.npmjs.org/methods/-/methods-1.0.1.tgz"
+        },
+        "cookiejar": {
+          "version": "2.0.1",
+          "from": "cookiejar@2.0.1",
+          "resolved": "https://registry.npmjs.org/cookiejar/-/cookiejar-2.0.1.tgz"
+        },
+        "debug": {
+          "version": "1.0.4",
+          "from": "debug@>=1.0.1 <1.1.0",
+          "dependencies": {
+            "ms": {
+              "version": "0.6.2",
+              "from": "ms@0.6.2",
+              "resolved": "https://registry.npmjs.org/ms/-/ms-0.6.2.tgz"
+            }
+          }
+        },
+        "reduce-component": {
+          "version": "1.0.1",
+          "from": "reduce-component@1.0.1",
+          "resolved": "https://registry.npmjs.org/reduce-component/-/reduce-component-1.0.1.tgz"
+        },
+        "form-data": {
+          "version": "0.1.3",
+          "from": "form-data@0.1.3",
+          "resolved": "https://registry.npmjs.org/form-data/-/form-data-0.1.3.tgz",
+          "dependencies": {
+            "combined-stream": {
+              "version": "0.0.5",
+              "from": "combined-stream@>=0.0.4 <0.1.0",
+              "dependencies": {
+                "delayed-stream": {
+                  "version": "0.0.5",
+                  "from": "delayed-stream@0.0.5",
+                  "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-0.0.5.tgz"
+                }
+              }
+            },
+            "async": {
+              "version": "0.9.0",
+              "from": "async@>=0.9.0 <0.10.0"
+            }
+          }
+        },
+        "readable-stream": {
+          "version": "1.0.27-1",
+          "from": "readable-stream@1.0.27-1",
+          "dependencies": {
+            "core-util-is": {
+              "version": "1.0.1",
+              "from": "core-util-is@>=1.0.0 <1.1.0"
+            },
+            "isarray": {
+              "version": "0.0.1",
+              "from": "isarray@0.0.1",
+              "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz"
+            },
+            "string_decoder": {
+              "version": "0.10.31",
+              "from": "string_decoder@>=0.10.0 <0.11.0"
+            },
+            "inherits": {
+              "version": "2.0.1",
+              "from": "inherits@>=2.0.1 <2.1.0"
+            }
+          }
+        }
+      }
+    },
+    "ws": {
+      "version": "0.4.32",
+      "from": "ws@>=0.4.31 <0.5.0",
+      "dependencies": {
+        "commander": {
+          "version": "2.1.0",
+          "from": "commander@>=2.1.0 <2.2.0"
+        },
+        "nan": {
+          "version": "1.0.0",
+          "from": "nan@>=1.0.0 <1.1.0"
+        },
+        "tinycolor": {
+          "version": "0.0.1",
+          "from": "tinycolor@>=0.0.0 <1.0.0"
+        },
+        "options": {
+          "version": "0.0.6",
+          "from": "options@>=0.0.5"
+        }
+      }
+    }
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ripple-lib",
-  "version": "0.9.0-rc1",
+  "version": "0.9.0",
   "description": "Ripple JavaScript client library",
   "files": [
     "src/js/*",
@@ -20,7 +20,6 @@
     "extend": "~1.2.1",
     "lru-cache": "~2.5.0",
     "superagent": "^0.18.0",
-    "gulp-bump": "~0.1.10",
     "ripple-wallet-generator": "1.0.1"
   },
   "devDependencies": {
@@ -30,6 +29,7 @@
     "gulp-jshint": "~1.5.5",
     "gulp-uglify": "~0.3.0",
     "gulp-rename": "~1.2.0",
+    "gulp-bump": "~0.1.10",
     "webpack": "~1.1.11",
     "map-stream": "~0.1.0",
     "istanbul": "~0.2.10",
@@ -40,7 +40,7 @@
   "scripts": {
     "build": "node_modules/.bin/gulp",
     "pretest": "node_modules/.bin/gulp concat-sjcl",
-    "test": "./node_modules/.bin/istanbul test -x build/sjcl.js -x src/js/jsbn/* ./node_modules/mocha/bin/mocha -- --reporter spec test/*-test.js",
+    "test": "./node_modules/.bin/istanbul test -x build/sjcl.js -x src/js/jsbn/* ./node_modules/mocha/bin/_mocha -- --reporter spec test/*-test.js",
     "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls"
   },
   "repository": {

src/js/ripple/amount.js

@@ -1109,12 +1109,26 @@ Amount.prototype.to_human = function(opts) {
   fraction_part = fraction_part.replace(/0*$/, '');
 
   if (fraction_part.length || !opts.skip_empty_fraction) {
+
     // Enforce the maximum number of decimal digits (precision)
     if (typeof opts.precision === 'number') {
-      if (opts.precision === 0 && fraction_part.charCodeAt(0) >= 53) {
-        int_part = (Number(int_part) + 1).toString();
+      if (opts.precision <= 0) {
+
+        // increment the int_part if the first decimal is 5 or higher
+        if (fraction_part.charCodeAt(0) >= 53) {
+          int_part = (Number(int_part) + 1).toString();
+        }
+        fraction_part = '';
+      } else {
+        var precision = Math.min(opts.precision, fraction_part.length);
+        fraction_part = Math.round(fraction_part / Math.pow(10, fraction_part.length - precision)).toString();
+
+        // because the division above will cut off the leading 0's we have to add them back again
+        // XXX look for a more elegant alternative
+        while (fraction_part.length < precision) {
+          fraction_part = '0' + fraction_part;
+        }
       }
-      fraction_part = fraction_part.slice(0, opts.precision);
     }
 
     // Limit the number of significant digits (max_sig_digits)

src/js/ripple/binformat.js

@@ -382,23 +382,32 @@ exports.metadata = [
 ];
 
 exports.ter = {
-  tesSUCCESS: 0,
-  tecCLAIM: 100,
-  tecPATH_PARTIAL: 101,
-  tecUNFUNDED_ADD: 102,
-  tecUNFUNDED_OFFER: 103,
-  tecUNFUNDED_PAYMENT: 104,
-  tecFAILED_PROCESSING: 105,
-  tecDIR_FULL: 121,
-  tecINSUF_RESERVE_LINE: 122,
-  tecINSUF_RESERVE_OFFER: 123,
-  tecNO_DST: 124,
-  tecNO_DST_INSUF_XRP: 125,
-  tecNO_LINE_INSUF_RESERVE: 126,
-  tecNO_LINE_REDUNDANT: 127,
-  tecPATH_DRY: 128,
-  tecUNFUNDED: 129,
-  tecMASTER_DISABLED: 130,
-  tecNO_REGULAR_KEY: 131,
-  tecOWNERS: 132
+  tesSUCCESS               : 0,
+  tecCLAIM                 : 100,
+  tecPATH_PARTIAL          : 101,
+  tecUNFUNDED_ADD          : 102,
+  tecUNFUNDED_OFFER        : 103,
+  tecUNFUNDED_PAYMENT      : 104,
+  tecFAILED_PROCESSING     : 105,
+  tecDIR_FULL              : 121,
+  tecINSUF_RESERVE_LINE    : 122,
+  tecINSUF_RESERVE_OFFER   : 123,
+  tecNO_DST                : 124,
+  tecNO_DST_INSUF_XRP      : 125,
+  tecNO_LINE_INSUF_RESERVE : 126,
+  tecNO_LINE_REDUNDANT     : 127,
+  tecPATH_DRY              : 128,
+  tecUNFUNDED              : 129,  // Deprecated, old ambiguous unfunded.
+  tecMASTER_DISABLED       : 130,
+  tecNO_REGULAR_KEY        : 131,
+  tecOWNERS                : 132,
+  tecNO_ISSUER             : 133,
+  tecNO_AUTH               : 134,
+  tecNO_LINE               : 135,
+  tecINSUFF_FEE            : 136,
+  tecFROZEN                : 137,
+  tecNO_TARGET             : 138,
+  tecNO_PERMISSION         : 139,
+  tecNO_ENTRY              : 140,
+  tecINSUFFICIENT_RESERVE  : 141
 };

src/js/ripple/currency.js

@@ -316,17 +316,17 @@ Currency.prototype.to_json = function(opts) {
   var opts = opts || {};
 
   var currency;
-  var fullName = opts && opts.full_name ? " - " + opts.full_name : "";
+  var fullName = opts && opts.full_name ? ' - ' + opts.full_name : '';
+  opts.show_interest = opts.show_interest !== void(0) ? opts.show_interest : this.has_interest();
 
-  // Any currency with standard properties and a valid code can be abbreviated
-  // in the JSON wire format as the three character code.
-  if (!opts.force_hex && /^[A-Z0-9]{3}$/.test(this._iso_code) && !this.has_interest()) {
+  if (!opts.force_hex && /^[A-Z0-9]{3}$/.test(this._iso_code)) {
     currency = this._iso_code + fullName;
+    if (opts.show_interest) {
+      var decimals = !isNaN(opts.decimals) ? opts.decimals : void(0);
+      var interestPercentage = this.has_interest() ? this.get_interest_percentage_at(this._interest_start + 3600 * 24 * 365, decimals) : 0;
+      currency += ' (' + interestPercentage + '%pa)';
+    }
 
-  // If there is interest, append the annual interest to the full currency name
-  } else if (!opts.force_hex && this.has_interest()) {
-    var decimals = opts ? opts.decimals : undefined;
-    currency = this._iso_code + fullName + " (" + this.get_interest_percentage_at(this._interest_start + 3600 * 24 * 365, decimals) + "%pa)";
   } else {
 
     // Fallback to returning the raw currency hex

test/amount-test.js

@@ -16,6 +16,92 @@ describe('Amount', function() {
       assert(Amount.from_json('1').is_positive());
     });
   });
+  describe('Positives', function() {
+    it('Number 1', function() {
+      assert(Amount.from_json('1').is_positive());
+    });
+  });
+  // also tested extensively in other cases
+  describe('to_human', function() {
+    it('12345.6789 XAU', function() {
+      assert.strictEqual(Amount.from_human("12345.6789 XAU").to_human(), '12,345.6789');
+    });
+    it('12345.678901234 XAU', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human(), '12,345.678901234');
+    });
+    it('to human, precision -1, should be ignored, precision needs to be >= 0', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:-1}), '12,346');
+    });
+    it('to human, precision 0', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:0}), '12,346');
+    });
+    it('to human, precision 1', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:1}), '12,345.7');
+    });
+    it('to human, precision 2', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:2}), '12,345.68');
+    });
+    it('to human, precision 3', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:3}), '12,345.679');
+    });
+    it('to human, precision 4', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:4}), '12,345.6789');
+    });
+    it('to human, precision 5', function() {
+      assert.strictEqual(Amount.from_human("12345.678901234 XAU").to_human({precision:5}), '12,345.67890');
+    });
+    it('to human, precision -1, should be ignored, precision needs to be >= 0', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:-1}), '0');
+    });
+    it('to human, precision 0', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:0}), '0');
+    });
+    it('to human, precision 1', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:1}), '0.0');
+    });
+    it('to human, precision 2', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:2}), '0.00');
+    });
+    it('to human, precision 5', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:5}), '0.00012');
+    });
+    it('to human, precision 6', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:6}), '0.000123');
+    });
+    it('to human, precision 16', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:16}), '0.00012345');
+    });
+    it('to human, precision 16, min_precision 16', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:16, min_precision:16}), '0.0001234500000000');
+    });
+    it('to human, precision 16, min_precision 12', function() {
+      assert.strictEqual(Amount.from_human("0.00012345 XAU").to_human({precision:16, min_precision:12}), '0.000123450000');
+    });
+    it('to human, precision 0, first decimal 4', function() {
+      assert.strictEqual(Amount.from_human("0.4 XAU").to_human({precision:0}), '0');
+    });
+    it('to human, precision 0, first decimal 5', function() {
+      assert.strictEqual(Amount.from_human("0.5 XAU").to_human({precision:0}), '1');
+    });
+    it('to human, precision 0, first decimal 8', function() {
+      assert.strictEqual(Amount.from_human("0.8 XAU").to_human({precision:0}), '1');
+    });
+    it('to human, precision 0, precision 16', function() {
+      assert.strictEqual(Amount.from_human("0.0 XAU").to_human({precision:16}), '0.0');
+    });
+    it('to human, precision 0, precision 8, min_precision 16', function() {
+      assert.strictEqual(Amount.from_human("0.0 XAU").to_human({precision:8, min_precision:16}), '0.0000000000000000');
+    });
+    it('to human, precision 0, first decimal 8', function() {
+      assert.strictEqual(Amount.from_human("0.8 XAU").to_human({precision:0}), '1');
+    });
+    it('to human, precision 6, min_precision 6, max_sig_digits 20', function() {
+      assert.strictEqual(Amount.from_human("0.0 XAU").to_human({precision: 6, min_precision: 6, max_sig_digits: 20}), '0.000000');
+    });
+    it('to human, precision 16, min_precision 6, max_sig_digits 20', function() {
+      assert.strictEqual(Amount.from_human("0.0 XAU").to_human({precision: 16, min_precision: 6, max_sig_digits: 20}), '0.000000');
+    });
+  });
   describe('from_human', function() {
     it('1 XRP', function() {
       assert.strictEqual(Amount.from_human("1 XRP").to_text_full(), '1/XRP');

test/currency-test.js

@@ -82,6 +82,9 @@ describe('Currency', function() {
       var cur = currency.from_human('EUR (0.5361%pa)');
       assert.strictEqual(cur.to_json(), 'EUR (0.54%pa)');
       assert.strictEqual(cur.to_json({decimals:4, full_name:'Euro'}), 'EUR - Euro (0.5361%pa)');
+      assert.strictEqual(cur.to_json({decimals:void(0), full_name:'Euro'}), 'EUR - Euro (0.54%pa)');
+      assert.strictEqual(cur.to_json({decimals:undefined, full_name:'Euro'}), 'EUR - Euro (0.54%pa)');
+      assert.strictEqual(cur.to_json({decimals:'henk', full_name:'Euro'}), 'EUR - Euro (0.54%pa)');
       assert.strictEqual(cur.get_interest_percentage_at(undefined, 4), 0.5361);
     });
     it('From human "TYX - 30-Year Treasuries (1.5%pa)"', function() {
@@ -111,8 +114,28 @@ describe('Currency', function() {
       assert.strictEqual('XRP', currency.from_json(NaN).to_human());
     });
     it('"015841551A748AD2C1F76FF6ECB0CCCD00000000") == "015841551A748AD2C1F76FF6ECB0CCCD00000000"', function() {
-      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human(),
-                         'XAU (-0.5%pa)');
+      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human(), 'XAU (-0.5%pa)');
+    });
+    it('"015841551A748AD2C1F76FF6ECB0CCCD00000000") == "015841551A748AD2C1F76FF6ECB0CCCD00000000"', function() {
+      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human({full_name:'Gold'}), 'XAU - Gold (-0.5%pa)');
+    });
+    it('to_human interest XAU with full name, do not show interest', function() {
+      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human({full_name:'Gold', show_interest:false}), 'XAU - Gold');
+    });
+    it('to_human interest XAU with full name, show interest', function() {
+      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human({full_name:'Gold', show_interest:true}), 'XAU - Gold (-0.5%pa)');
+    });
+    it('to_human interest XAU, do show interest', function() {
+      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human({show_interest:true}), 'XAU (-0.5%pa)');
+    });
+    it('to_human interest XAU, do not show interest', function() {
+      assert.strictEqual(currency.from_json("015841551A748AD2C1F76FF6ECB0CCCD00000000").to_human({show_interest:false}), 'XAU');
+    });
+    it('to_human with full_name "USD - US Dollar show interest"', function() {
+      assert.strictEqual(currency.from_json('USD').to_human({full_name:'US Dollar', show_interest:true}), 'USD - US Dollar (0%pa)');
+    });
+    it('to_human with full_name "USD - US Dollar do not show interest"', function() {
+      assert.strictEqual(currency.from_json('USD').to_human({full_name:'US Dollar', show_interest:false}), 'USD - US Dollar');
     });
     it('to_human with full_name "USD - US Dollar"', function() {
       assert.strictEqual('USD - US Dollar', currency.from_json('USD').to_human({full_name:'US Dollar'}));
@@ -128,6 +151,7 @@ describe('Currency', function() {
       var cur = currency.from_json("TIM");
       assert.strictEqual(cur.to_human({full_name: null}), "TIM");
     });
+
   });
 
   describe('from_hex', function() {