3.0.0-alpha.4

CHANGELOG.md

@@ -1,3 +1,8 @@
+##### 3.0.0-alpha.4 - 26 February 2016
+
+###### Other
+- Finished JSDoc comments
+
 ##### 3.0.0-alpha.3 - 26 February 2016
 
 ###### Backwards compatible API changes

CONTRIBUTORS

@@ -5,5 +5,5 @@
 # Names should be added to this file as:
 #   [commit count] Name <email address>
      1	InternalFX <[email protected]>
-    45	Jason Dobry <[email protected]>
+    48	Jason Dobry <[email protected]>
      2	Ollie Relph <[email protected]>

package.json

@@ -1,7 +1,7 @@
 {
   "name": "js-data-rethinkdb",
   "description": "RethinkDB adapter for js-data.",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.4",
   "homepage": "https://github.com/js-data/js-data-rethinkdb",
   "repository": {
     "type": "git",
@@ -60,7 +60,7 @@
     "coveralls": "2.11.8",
     "ink-docstrap": "1.1.2",
     "istanbul": "0.4.2",
-    "js-data-adapter-tests": "^2.0.0-alpha.8",
+    "js-data-adapter-tests": "^2.0.0-alpha.9",
     "jsdoc": "3.4.0",
     "mocha": "2.4.5",
     "rollup": "0.25.4",

src/index.js

@@ -359,8 +359,8 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
     return this.r.db(isUndefined(opts.db) ? this.db : opts.db)
   },
 
-  selectTable (Resource, opts) {
-    return this.selectDb(opts).table(Resource.table || underscore(Resource.name))
+  selectTable (mapper, opts) {
+    return this.selectDb(opts).table(mapper.table || underscore(mapper.name))
   },
 
   filterSequence (sequence, params) {
@@ -673,7 +673,7 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
   },
 
   /**
-   * TODO
+   * Return the foreignKey from the given record for the provided relationship.
    *
    * There may be reasons why you may want to override this method, like when
    * the id of the parent doesn't exactly match up to the key on the child.
@@ -682,18 +682,18 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
    * @method
    * @return {*}
    */
-  makeHasManyForeignKey (Resource, def, record) {
+  makeHasManyForeignKey (mapper, def, record) {
     return def.getForeignKey(record)
   },
 
   /**
-   * TODO
+   * Load a hasMany relationship.
    *
    * @name RethinkDBAdapter#loadHasMany
    * @method
    * @return {Promise}
    */
-  loadHasMany (Resource, def, records, __opts) {
+  loadHasMany (mapper, def, records, __opts) {
     const self = this
     let singular = false
 
@@ -702,7 +702,7 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
       records = [records]
     }
     const IDs = records.map(function (record) {
-      return self.makeHasManyForeignKey(Resource, def, record)
+      return self.makeHasManyForeignKey(mapper, def, record)
     })
     const query = {}
     const criteria = query[def.foreignKey] = {}
@@ -722,7 +722,7 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
           attached = relatedItems
         } else {
           relatedItems.forEach(function (relatedItem) {
-            if (get(relatedItem, def.foreignKey) === record[Resource.idAttribute]) {
+            if (get(relatedItem, def.foreignKey) === record[mapper.idAttribute]) {
               attached.push(relatedItem)
             }
           })
@@ -733,17 +733,17 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
   },
 
   /**
-   * TODO
+   * Load a hasOne relationship.
    *
    * @name RethinkDBAdapter#loadHasOne
    * @method
    * @return {Promise}
    */
-  loadHasOne (Resource, def, records, __opts) {
+  loadHasOne (mapper, def, records, __opts) {
     if (isObject(records) && !isArray(records)) {
       records = [records]
     }
-    return this.loadHasMany(Resource, def, records, __opts).then(function () {
+    return this.loadHasMany(mapper, def, records, __opts).then(function () {
       records.forEach(function (record) {
         const relatedData = def.getLocalField(record)
         if (isArray(relatedData) && relatedData.length) {
@@ -754,18 +754,18 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
   },
 
   /**
-   * TODO
+   * Return the foreignKey from the given record for the provided relationship.
    *
    * @name RethinkDBAdapter#makeBelongsToForeignKey
    * @method
    * @return {*}
    */
-  makeBelongsToForeignKey (Resource, def, record) {
+  makeBelongsToForeignKey (mapper, def, record) {
     return def.getForeignKey(record)
   },
 
   /**
-   * TODO
+   * Load a belongsTo relationship.
    *
    * @name RethinkDBAdapter#loadBelongsTo
    * @method
@@ -815,7 +815,7 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
    * @param {boolean} [opts.raw=false] Whether to return a more detailed
    * response object.
    * @param {Object} [opts.runOpts] Options to pass to r#run.
-   * @param {string[]} [opts.with=[]] TODO
+   * @param {string[]} [opts.with=[]] Relations to eager load.
    * @return {Promise}
    */
   find (mapper, id, opts) {
@@ -846,9 +846,9 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
       op = opts.op = 'beforeFind'
       return resolve(self[op](mapper, id, opts))
     }).then(function () {
-        op = opts.op = 'find'
-        self.dbg(op, id, opts)
-        return self.selectTable(mapper, opts).get(id).run(self.getOpt('runOpts', opts))
+      op = opts.op = 'find'
+      self.dbg(op, id, opts)
+      return self.selectTable(mapper, opts).get(id).run(self.getOpt('runOpts', opts))
     }).then(function (_record) {
       if (!_record) {
         return
@@ -924,7 +924,7 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
    * @param {boolean} [opts.raw=false] Whether to return a more detailed
    * response object.
    * @param {Object} [opts.runOpts] Options to pass to r#run.
-   * @param {string[]} [opts.with=[]] TODO
+   * @param {string[]} [opts.with=[]] Relations to eager load.
    * @return {Promise}
    */
   findAll (mapper, query, opts) {
@@ -1060,7 +1060,7 @@ addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
   },
 
   /**
-   * TODO
+   * Logging utility method.
    *
    * @name RethinkDBAdapter#log
    * @method