mapexplorer-rails 1.0.0.pre.alpha → 1.0.0.pre.alpha.1

data/vendor/assets/mapexplorer-core/README.md

@@ -0,0 +1,235 @@
+# MapExplorer Core
+
+[![build status](https://travis-ci.org/stratumn/mapexplorer-core.svg?branch=master)](https://travis-ci.org/stratumn/mapexplorer-core.svg?branch=master)
+
+Core library for building Map Explorer components
+
+## Installation
+
+### Browser
+
+```html
+<!-- Polyfill for browser compatibility -->
+<script src="https://libs.stratumn.com/babel-polyfill.min.js"></script>
+<!-- Actual Library -->
+<script src="https://libs.stratumn.com/mapexplorer-core.min.js"></script>
+```
+
+If you want a specific version, include `https://libs.stratumn.com/mapexplorer-core-{version}.min.js` instead (for instance `https://libs.stratumn.com/mapexplorer-core-0.4.1.min.js`).
+
+
+### Node.js
+
+```
+$ npm install mapexplorer-core
+```
+
+```javascript
+var MapexplorerCore = require('mapexplorer-core');
+```
+
+### Bower
+
+```
+$ bower install mapexplorer-core
+```
+
+## Usage
+
+### Display a map explorer
+
+```javascript
+const builder = new MapexplorerCore.ChainTreeBuilder(element);
+
+// with an application and a mapId
+builder.build({
+  id: myMapId,
+  application: myApplication
+}, options);
+
+// with a chainscript (JSON string of array of segment as POJO)
+builder.build({
+  chainscript: myChainscript
+}), options;
+```
+#### Available options
+
+##### withArgs
+```
+Default: false
+```
+
+Display action arguments on the paths between segments.
+
+##### duration
+```
+Default: 750
+```
+
+Transition duration
+
+##### verticalSpacing
+```
+Default: 1.2
+```
+Vertical space factor between segment polygon
+
+##### polygonSize
+```
+Default: 
+    {
+        width: 78,
+        height: 91
+    }
+```
+
+Object with width and height properties that gives the size (in pixels) of the polygon representing 
+a segment.
+
+##### getArrowLength()
+```
+Default: () => this.polygonSize.width
+```
+
+Function that returns the length (in pixels) of the transition arrow.
+
+#### box
+```
+Default: 
+    () => return {
+        width: this.polygonSize.width,
+        height: 25
+    }
+```
+
+Function that return an object with width and height properties that gives the size (in pixels) of the box containing the 
+segment text.
+
+##### getSegmentText(node)
+``` 
+Default:  node => compactHash(node.data.meta.linkHash)
+```
+
+Function that returns the text displayed on a segment.
+
+
+
+##### getLinkText(node)
+``` 
+Default: 
+  function(node) {
+    return node.target.data.link.meta.action +
+        (this.withArgs ? `(${node.target.data.link.meta.arguments.join(', ')})` : '');
+  }
+```      
+
+Function that return the text displayed on a path between segments.
+
+##### onclick(data)
+```
+Default: noop
+```
+
+##### onTag(tag)
+```
+Default: noop
+```
+
+Hook that is called when a segment is tagged
+
+Event handler called when the user clicks on a segment.
+
+### Display a merkle path tree
+
+```javascript
+const merklePathTree = new MapexplorerCore.MerklePathTree(element);
+merklePathTree.display(merklePath);
+```
+
+where `merklePath` looks like:
+
+```
+[
+    {
+      "left": "14b9468d3b8ca51b45e27ecddc5875a48902a74d1182fed9693c1531dfcfd56c",
+      "right": "d15e1460234292852400271530be35cabe822eae5a4ed3376728d5acbbf04f27",
+      "parent": "3bfbc00bfe7aa149e17029e8bb08671636c1c1c16aa5addfc307d6c937134620"
+    },
+    {
+      "left": "3bfbc00bfe7aa149e17029e8bb08671636c1c1c16aa5addfc307d6c937134620",
+      "right": "9fd68d3335eabcad5777b4c717af6de3c51f4aa0af72c26aaf866cde176c96f1",
+      "parent": "8f16bfbe247be6ca881f3d9e462bc154f099298e26cd53662ef7119e1e60a887"
+    },
+    ...
+]
+```
+
+### Validate a chainscript
+
+```javascript
+new MapexplorerCore.ChainValidator(JSON.parse(chainscript)).validate()
+```
+
+Returns a Promise that resolves to an error object such as:
+
+```
+{
+      linkHash: [Promise, ...],
+      stateHash: [Promise, ...],
+      merklePath: [Promise, ...],
+      fossil: [Promise, ...]
+}
+```
+
+Each promise, in each array of each category resolves to an error string if an inconsistency has been detected. It resolves to null otherwise.
+
+Errors can be retrieved with (for instance):
+
+```javascript
+Promise.all(errors.linkHash).
+  then(err => err.filter(Boolean));
+```
+
+## Development
+
+Install dependencies:
+
+```
+$ npm install
+```
+
+Build:
+
+```
+$ npm run build:all
+```
+
+Test:
+
+```
+$ npm test
+```
+
+Lint:
+
+```
+$ npm run lint
+```
+
+Lint and test:
+
+```
+$ npm run check
+```
+
+Bump version:
+
+```
+$ npm version major|minor|patch
+```
+
+Publish:
+
+```
+$ npm publish
+```

data/vendor/assets/mapexplorer-core/assets/stylesheets/map.scss

@@ -0,0 +1,38 @@
+.node {
+    cursor: pointer;
+}
+
+.node polygon {
+    fill: $segment-primary-color;
+}
+
+.node text {
+    font-family: $segment-text-font;
+    font-size: 14px;
+    fill: $segment-text-color;
+}
+
+.node rect {
+    fill: $segment-secondary-color;
+}
+
+.textpath {
+    font-family: $link-text-font;
+    font-size: 14px;
+    fill: $link-text-color;
+}
+
+.link {
+    fill: none;
+    stroke: $link-color;
+    stroke-width: 5px;
+    marker-end: url('#triangle');
+}
+
+.node.selected polygon {
+    fill: $selected-segment-primary-color;
+}
+
+.node.selected rect {
+    fill: $selected-segment-secondary-color;
+}

data/vendor/assets/mapexplorer-core/assets/stylesheets/mapexplorer-core.scss

@@ -0,0 +1,3 @@
+@import "variables";
+@import "map";
+@import "merkle-path";

data/vendor/assets/mapexplorer-core/assets/stylesheets/merkle-path.scss

@@ -0,0 +1,10 @@
+.merkle-path {
+  .node circle {
+    fill: $merkle-path-node-color;
+  }
+
+  .link {
+    stroke: $merkle-path-link-color;
+    stroke-width: 2px;
+  }
+}

data/vendor/assets/mapexplorer-core/assets/stylesheets/variables.scss

@@ -0,0 +1,14 @@
+$segment-primary-color: #7BC0D2 !default;
+$segment-secondary-color: #459FB7 !default;
+$segment-text-color: white !default;
+$segment-text-font: 'RationalTWText-SemiBold', 'Roboto Mono', monospace !default;
+
+$selected-segment-primary-color: #3E3E3E;
+$selected-segment-secondary-color: #2E2E2E;
+
+$link-text-font: 'Gibson-Regular', 'Montserrat', sans-serif !default;
+$link-text-color: #C1C1C1 !default;
+$link-color: #CCC !default;
+
+$merkle-path-node-color: black !default;
+$merkle-path-link-color: black !default;

data/vendor/assets/mapexplorer-core/bower.json

@@ -0,0 +1,32 @@
+{
+  "name": "mapexplorer-core",
+  "description": "Core library for building Map Explorer components",
+  "main": [
+    "dist/mapexplorer-core.js",
+    "assets/stylesheets/mapexplorer-core.scss"
+  ],
+  "authors": [
+    "Stratumn Team"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "stratumn",
+    "lib",
+    "blockchain",
+    "mapexplorer",
+    "chainscript"
+  ],
+  "homepage": "https://github.com/stratumn/mapexplorer-core",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests",
+    "src"
+  ],
+  "dependencies": {
+    "d3": "^4.1.1",
+    "stratumn-sdk": "alpha"
+  }
+}