Add Coveralls for code coverage tracking. Badge and updates to README

OpenDataFormats · Apr 5, 2020 · 68ce1bf · 68ce1bf
1 parent b80dbf3
commit 68ce1bf
Show file tree

Hide file tree

Showing 18 changed files with 82 additions and 28 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,6 +21,9 @@ lib-cov
 # nyc test coverage
 .nyc_output
 
+# Coveralls config
+.coveralls.yml
+
 # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 

diff --git a/bin/run.tests.sh b/bin/run.tests.sh
@@ -3,10 +3,10 @@ source $(dirname ${0})/base.sh
 
 info "Running all tests"
 
+cd $SRC_JS_OPENTIMESTAMP
 
 info "Checking code lint"
 
-cd $SRC_JS_OPENTIMESTAMP
 npm run lint
 
 

diff --git a/docs/coverage/clover.xml b/docs/coverage/clover.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1585584114059" clover="3.2.0">
-  <project timestamp="1585584114060" name="All files">
+<coverage generated="1586091106317" clover="3.2.0">
+  <project timestamp="1586091106317" name="All files">
     <metrics statements="259" coveredstatements="259" conditionals="77" coveredconditionals="77" methods="47" coveredmethods="47" elements="383" coveredelements="383" complexity="0" loc="259" ncloc="259" packages="1" files="4" classes="4"/>
     <file name="calendar.js" path="/Users/david/src/opendataformats/opentimestamp/src/javascript/opentimestamp/lib/calendar.js">
       <metrics statements="34" coveredstatements="34" conditionals="4" coveredconditionals="4" methods="9" coveredmethods="9"/>

diff --git a/docs/coverage/lcov-report/calendar.js.html b/docs/coverage/lcov-report/calendar.js.html
@@ -616,7 +616,7 @@ <h1><a href="index.html">All files</a> calendar.js</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Mar 30 2020 18:01:54 GMT+0200 (Central European Summer Time)
+                at Sun Apr 05 2020 14:51:46 GMT+0200 (Central European Summer Time)
             </div>
         </div>
         <script src="prettify.js"></script>

diff --git a/docs/coverage/lcov-report/execution.js.html b/docs/coverage/lcov-report/execution.js.html
@@ -505,7 +505,7 @@ <h1><a href="index.html">All files</a> execution.js</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Mar 30 2020 18:01:54 GMT+0200 (Central European Summer Time)
+                at Sun Apr 05 2020 14:51:46 GMT+0200 (Central European Summer Time)
             </div>
         </div>
         <script src="prettify.js"></script>

diff --git a/docs/coverage/lcov-report/index.html b/docs/coverage/lcov-report/index.html
@@ -140,7 +140,7 @@ <h1>All files</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Mar 30 2020 18:01:54 GMT+0200 (Central European Summer Time)
+                at Sun Apr 05 2020 14:51:46 GMT+0200 (Central European Summer Time)
             </div>
         </div>
         <script src="prettify.js"></script>

diff --git a/docs/coverage/lcov-report/parser.js.html b/docs/coverage/lcov-report/parser.js.html
@@ -550,7 +550,7 @@ <h1><a href="index.html">All files</a> parser.js</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Mar 30 2020 18:01:54 GMT+0200 (Central European Summer Time)
+                at Sun Apr 05 2020 14:51:46 GMT+0200 (Central European Summer Time)
             </div>
         </div>
         <script src="prettify.js"></script>

diff --git a/docs/coverage/lcov-report/timestamp.js.html b/docs/coverage/lcov-report/timestamp.js.html
@@ -1462,7 +1462,7 @@ <h1><a href="index.html">All files</a> timestamp.js</h1>
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Mon Mar 30 2020 18:01:54 GMT+0200 (Central European Summer Time)
+                at Sun Apr 05 2020 14:51:46 GMT+0200 (Central European Summer Time)
             </div>
         </div>
         <script src="prettify.js"></script>

diff --git a/docs/jsdocs/Timestamp.html b/docs/jsdocs/Timestamp.html
@@ -3183,7 +3183,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/jsdocs/index.html b/docs/jsdocs/index.html
@@ -580,7 +580,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/jsdocs/index.js.html b/docs/jsdocs/index.js.html
@@ -53,7 +53,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/jsdocs/lib_calendar.js.html b/docs/jsdocs/lib_calendar.js.html
@@ -226,7 +226,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/jsdocs/lib_execution.js.html b/docs/jsdocs/lib_execution.js.html
@@ -189,7 +189,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/jsdocs/lib_parser.js.html b/docs/jsdocs/lib_parser.js.html
@@ -204,7 +204,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/jsdocs/lib_timestamp.js.html b/docs/jsdocs/lib_timestamp.js.html
@@ -508,7 +508,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Timestamp
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Mar 30 2020 18:01:56 GMT+0200 (Central European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sun Apr 05 2020 14:51:51 GMT+0200 (Central European Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/src/javascript/opentimestamp/README.md b/src/javascript/opentimestamp/README.md
@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.com/OpenDataFormats/opentimestamp.svg?branch=master)](https://travis-ci.com/OpenDataFormats/opentimestamp)
 
+[![Coverage Status](https://coveralls.io/repos/github/OpenDataFormats/opentimestamp/badge.svg?branch=master)](https://coveralls.io/github/OpenDataFormats/opentimestamp?branch=master)
+
 # OpenTimestamp
 
 ECMAScript/JS 6 Node library for creating compact, portable [Open Timestamps](https://en.wikipedia.org/wiki/OpenTimestamps) attestations.
@@ -115,14 +117,14 @@ This can be set during creation by calling `.setIdentity()`.
 
 ```javascript
 timestamp.setIdentity(
-  'US',
-  'NY',
-  'New York',
-  'My Company',
-  'Engineering',
-  'Corp Eng',
-  'eng@example.com',
-  'John Smith',
+  'US',               // Country Code
+  'NY',               // State/Province
+  'New York',         // City
+  'My Company',       // Organization
+  'Engineering',      // Section/Division
+  'Corp Eng',         // Common Name
+  'eng@example.com',  // Email Address
+  'John Smith',       // Full Name
 );
 ```
 
@@ -138,8 +140,12 @@ This can be set during creation by calling `.setLocation()`.
 
 ```javascript
 timestamp.setLocation(
-  40.73111,
-  -73.99689,
+  40.73111,   // Latitude
+  -73.99689,  // Longitude
+  120,        // Altitude, meters
+  10,         // Accuracy, meters
+  217.39,     // Direction, degrees
+  42,         // Velocity
 );
 ```
 
@@ -195,6 +201,25 @@ After some time has passed, the calendar server will submit a transaction to the
 timestamp.update();
 ```
 
+### Saving a Timestamp
+
+Serialize the internal Timestamp protocol buffer to portable binary and save the data to a storage layer of choice; filesystem, database, etc.
+
+```javascript
+const /** @type {Buffer} */ data = timestamp.toBinary();
+fs.writeFileSync('./myfile.timestamp', data);
+```
+
+### Loading a Timestamp
+
+Loading the binary representation into the wrapped `OpenTimestamp` class is done by the static `.fromBinary` class method.
+
+```javascript
+const OpenTimestamp = require('opentimestamp');
+
+const data = fs.readFileSync('./myfile.timestamp');
+const timestamp = OpenTimestamp.fromBinary(data);
+```
 
 ## Testing
 

diff --git a/src/javascript/opentimestamp/package-lock.json b/src/javascript/opentimestamp/package-lock.json
diff --git a/src/javascript/opentimestamp/package.json b/src/javascript/opentimestamp/package.json
@@ -1,6 +1,6 @@
 {
   "name": "opentimestamp",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "ECMAScript/JS 6 Node library for creating compact, portable Open Timestamps attestations.",
   "keywords": [
     "opentimestamps",
@@ -16,7 +16,7 @@
     "lint": "eslint .",
     "lint-fix": "eslint . --fix",
     "start": "node frontend.js",
-    "test": "jest",
+    "test": "jest && coveralls < ../../../docs/coverage/lcov.info",
     "test:watch": "jest --watchAll"
   },
   "repository": {
@@ -36,6 +36,7 @@
     "google-protobuf": "^3.9.1"
   },
   "devDependencies": {
+    "coveralls": "^3.0.11",
     "eslint": "^5.6.0",
     "eslint-config-airbnb": "^17.1.0",
     "eslint-plugin-import": "^2.14.0",