Add documentation generation

- Update README.md
- Add README.md for docs
- Refactor for better structure

Author: oskarhane

.gitignore

@@ -7,4 +7,5 @@ pids
 .lock-wscript
 build
 node_modules
-.idea
+.idea
+docs/build

README.md

@@ -1,10 +1,10 @@
-# Neo4j Bolt Driver for JavaScript
+# Neo4j Bolt Driver for Javascript
 
 An alpha-level database driver for a new Neo4j remoting protocol.
 
 Note: This is in active development, the API is not stable. Please try it out and give us feedback, but expect things to break in the medium term!
 
-## Add module to Nodejs application
+## Add module to Node.js application
 
 ```javascript
 var neo4j = require('build/node/neo4j');
@@ -17,7 +17,7 @@ A global object `neo4j` will be available.
 <script src="build/browser/neo4j-web.min.js"></script>
 ```
 
-## Usage examples (works both in nodejs and browser environments)
+## Usage examples (for both Node.js and browser environments)
 
 ```javascript
 var statement = ['MERGE (alice:Person {name:{name_a},age:{age_a}})',
@@ -83,4 +83,4 @@ See files under `examples/` on how to use.
     ./runTests.sh
 
 This runs the test suite against a fresh download of Neo4j.  
-Or `gulp test` if you already have a running version of a compatible Neo4j server running.
+Or `gulp test` if you already have a running version of a compatible Neo4j server.

docs/README.md

@@ -0,0 +1,14 @@
+# Documentation for Neo4j Bolt Driver for Javascript
+The docs are generated with [esdoc](https://github.com/esdoc/esdoc), which is added 
+as a devDependency to this project.
+
+## Generate docs
+Execute in project root.
+
+```
+npm install
+npm run docs
+```
+
+## Read docs
+Point your web browser to `docs/build/index.html`.

esdoc.json

@@ -0,0 +1,11 @@
+{
+  "source": "./lib",
+  "destination": "./docs/build",
+  "includes": ["\\.js$"],
+  "excludes": ["external"],
+  "package": "./package.json",
+  "title": "Neo4j Bolt  Driver for Javascript",
+  "unexportIdentifier": true,
+  "undocumentIdentifier": false,
+  "access": ["public", "protected"]
+}

lib/driver.js

@@ -1,31 +1,67 @@
+/**
+ * Copyright (c) 2002-2015 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import Session from './session';
 import {connect} from "./internal/connector";
 
+/**
+  * A Driver instance is used for mananging {@link Session}s.
+  * @access public
+  */
 class Driver {
+  /**
+   * @constructor
+   * @param {string} url
+   * @param {string} userAgent
+   */
   constructor(url, userAgent) {
     this._url = url;
-    this.userAgent = userAgent || 'neo4j-javascript/0.0';
+    this._userAgent = userAgent || 'neo4j-javascript/0.0';
     this._openSessions = {};
     this._sessionIdGenerator = 0;
   }
 
+  /**
+   * Create and return new session
+   * @return {Session} new session.
+   */
   session() {
-    var sessionId = this._sessionIdGenerator++,
-        conn = connect(this._url);
-    conn.initialize(this.userAgent);
+    let sessionId = this._sessionIdGenerator++;
+    let conn = connect(this._url);
+    conn.initialize(this._userAgent);
 
-    var driver = this;
-    var session = new Session( conn, () => {
+    let _driver = this;
+    let _session = new Session( conn, () => {
       // On close of session, remove it from the list of open sessions
-      delete driver._openSessions[sessionId]; 
+      delete _driver._openSessions[sessionId]; 
     });
 
-    this._openSessions[sessionId] = session;
-    return session;
+    this._openSessions[sessionId] = _session;
+    return _session;
   }
 
+  /**
+   * Close sessions connections
+   * @return
+   */
   close() {
-    for (var sessionId in this._openSessions) {
+    for (let sessionId in this._openSessions) {
       if (this._openSessions.hasOwnProperty(sessionId)) {
         this._openSessions[sessionId].close();
       }

lib/graph-types.js

@@ -1,5 +1,32 @@
+/**
+ * Copyright (c) 2002-2015 "Neo Technology,"
+ * Network Engine for Objects in Lund AB [http://neotechnology.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
+/**
+ * Class for Node Type.
+ */ 
 class Node {
+  /**
+   * @constructor
+   * @param {string} identity - Unique identity
+   * @param {Array} labels - Array for all labels
+   * @param {Object} properties - Map with node properties
+   */
   constructor(identity, labels, properties) {
     this.identity = identity;
     this.labels = labels;
@@ -25,7 +52,18 @@ class Node {
   }
 }
 
+/**
+ * Class for Relationship Type.
+ */ 
 class Relationship {
+  /**
+   * @constructor
+   * @param {string} identity - Unique identity
+   * @param {string} start - Identity of start Node
+   * @param {string} end - Identity of end Node
+   * @param {string} type - Relationship type
+   * @param {Object} properties - Map with relationship properties
+   */
   constructor(identity, start, end, type, properties) {
     this.identity = identity;
     this.start = start;
@@ -50,15 +88,78 @@ class Relationship {
   }
 }
 
+/**
+ * Class for UnboundRelationship Type.
+ */ 
+class UnboundRelationship {
+  /**
+   * @constructor
+   * @param {string} identity - Unique identity
+   * @param {string} type - Relationship type
+   * @param {Object} properties - Map with relationship properties
+   */
+  constructor(identity, type, properties) {
+    this.identity = identity;
+    this.type = type;
+    this.properties = properties;
+  }
+
+  /**
+   * Bind relationship
+   * @param {string} start - Indentity of start node
+   * @param {string} end - Indentity of end node
+   * @return {Relationship} - Created relationship
+   */
+  bind( start, end ) {
+    return new Relationship(
+      this.identity, 
+      start, 
+      end, 
+      this.type, 
+      this.properties);
+  }
+
+  toString() {
+    let s = "-[:" + this.type;
+    let keys = Object.keys(this.properties);
+    if (keys.length > 0) {
+      s += " {";
+      for(let i = 0; i < keys.length; i++) {
+        if (i > 0) s += ",";
+        s += keys[i] + ":" + JSON.stringify(this.properties[keys[i]]);
+      }
+      s += "}";
+    }
+    s += "]->";
+    return s;
+  }
+}
+
+/**
+ * Class for PathSegment Type.
+ */ 
 class PathSegment {
+  /**
+   * @constructor
+   * @param {string} start - Identity of start Node
+   * @param {Relationship} rel - Relationship segment
+   * @param {string} end - Identity of end Node
+   */
   constructor( start, rel, end ) {
     this.start = start;
     this.relationship = rel;
     this.end = end;
   }
 }
 
+/**
+ * Class for Path Type.
+ */ 
 class Path {
+  /**
+   * @constructor
+   * @param {Array} segments - Array of Segments
+   */
   constructor(segments) {
     this.segments = segments;
     this.start = segments[0].start;
@@ -70,6 +171,7 @@ class Path {
 export default {
   Node,
   Relationship,
+  UnboundRelationship,
   Path,
   PathSegment
 }