offshore/lib/offshore/collection/index.js

An ORM for Node.js

/**
 * Dependencies
 */

var _ = require('lodash');
var extend = require('../utils/extend');
var inherits = require('util').inherits;

// Various Pieces
var Core = require('../core');
var Query = require('../query');

/**
 * Collection
 *
 * A prototype for managing a collection of database
 * records.
 *
 * This file is the prototype for collections defined using Offshore.
 * It contains the entry point for all ORM methods (e.g. User.find())
 *
 * Methods in this file defer to the adapter for their true implementation:
 * the implementation here just validates and normalizes the parameters.
 *
 * @param {Object} offshore, reference to parent
 * @param {Object} options
 * @param {Function} callback
 */

var Collection = module.exports = function(offshore, connections) {
  // Set the connections
  this.connections = connections || {};

  // Cache reference to the parent
  this.offshore = offshore;

  // Default Attributes
  this.attributes = this.attributes || {};

  // Instantiate Base Collection
  Core.call(this);

  // Instantiate Query Language
  Query.call(this);

  return this;
};

inherits(Collection, Core);
inherits(Collection, Query);

Collection.prototype._loadQuery = function(query) {
  if (!query) {
    return this;
  }

  var obj = Object.create(this);
  obj._query = _.merge(this._query, query);
  obj.adapter = this.adapter._loadQuery(query);
  return obj;
};

// Make Extendable
Collection.extend = extend;