Merge pull request #159 from kuzzleio/factory-method-refactor

Factory method refactor

Author: Gilles Ballini

index.js

@@ -1,6 +1,6 @@
 var
   bluebird = require('bluebird'),
-  Kuzzle = require('./src/kuzzle');
+  Kuzzle = require('./src/Kuzzle');
 
 // Adds on the fly methods promisification
 Kuzzle.prototype.bluebird = bluebird;

src/kuzzleDataCollection.js renamed to src/Collection.js

@@ -13,26 +13,26 @@
  *  (currently handled by ElasticSearch), and your searches may suffer from below-average performances, depending on
  *  the amount of data you stored in a collection and the complexity of your database.
  *
- *  The KuzzleDataMapping object allow to get the current mapping of a data collection and to modify it if needed.
+ *  The CollectionMapping object allow to get the current mapping of a data collection and to modify it if needed.
  *
- * @param {object} kuzzleDataCollection - Instance of the inherited KuzzleDataCollection object
+ * @param {object} collection - Instance of the inherited Collection object
  * @param {object} [mapping] - mappings
  * @constructor
  */
-function KuzzleDataMapping(kuzzleDataCollection, mapping) {
+function CollectionMapping(collection, mapping) {
   Object.defineProperties(this, {
     //read-only properties
     collection: {
-      value: kuzzleDataCollection,
+      value: collection,
       enumerable: true
     },
     kuzzle: {
-      value: kuzzleDataCollection.kuzzle,
+      value: collection.kuzzle,
       enumerable: true
     },
     // writable properties
     headers: {
-      value: JSON.parse(JSON.stringify(kuzzleDataCollection.headers)),
+      value: JSON.parse(JSON.stringify(collection.headers)),
       enumerable: true,
       writable: true
     },
@@ -63,7 +63,7 @@ function KuzzleDataMapping(kuzzleDataCollection, mapping) {
  * @param {object} [options] - Optional parameters
  * @param {responseCallback} [cb] - Handles the query response
  */
-KuzzleDataMapping.prototype.apply = function (options, cb) {
+CollectionMapping.prototype.apply = function (options, cb) {
   var
     self = this,
     data = this.kuzzle.addHeaders({body: {properties: this.mapping}}, this.headers);
@@ -93,7 +93,7 @@ KuzzleDataMapping.prototype.apply = function (options, cb) {
  * @param {responseCallback} [cb] - Handles the query response
  * @returns {*} this
  */
-KuzzleDataMapping.prototype.refresh = function (options, cb) {
+CollectionMapping.prototype.refresh = function (options, cb) {
   var
     self = this,
     data = this.kuzzle.addHeaders({}, this.headers);
@@ -139,9 +139,9 @@ KuzzleDataMapping.prototype.refresh = function (options, cb) {
  *
  * @param {string} field - Name of the field from which the mapping is to be added or updated
  * @param {object} mapping - corresponding field mapping
- * @returns {KuzzleDataMapping}
+ * @returns {CollectionMapping}
  */
-KuzzleDataMapping.prototype.set = function (field, mapping) {
+CollectionMapping.prototype.set = function (field, mapping) {
   this.mapping[field] = mapping;
 
   return this;
@@ -156,9 +156,9 @@ KuzzleDataMapping.prototype.set = function (field, mapping) {
  * @param content - new headers content
  * @param [replace] - default: false = append the content. If true: replace the current headers with tj
  */
-KuzzleDataMapping.prototype.setHeaders = function (content, replace) {
+CollectionMapping.prototype.setHeaders = function (content, replace) {
   this.kuzzle.setHeaders.call(this, content, replace);
   return this;
 };
 
-module.exports = KuzzleDataMapping;
+module.exports = CollectionMapping;

src/kuzzleDataMapping.js renamed to src/CollectionMapping.js

@@ -8,19 +8,19 @@
 
 /**
  * Kuzzle handles documents either as realtime messages or as stored documents.
- * KuzzleDocument is the object representation of one of these documents.
+ * Document is the object representation of one of these documents.
  *
  * Notes:
  *   - this constructor may be called either with a documentId, a content, neither or both.
  *   - providing a documentID to the constructor will automatically call refresh, unless a content is also provided
  *
  *
- * @param {object} kuzzleDataCollection - an instanciated KuzzleDataCollection object
+ * @param {object} kuzzleDataCollection - an instanciated Collection object
  * @param {string} [documentId] - ID of an existing document
  * @param {object} [content] - Initializes this document with the provided content
  * @constructor
  */
-function KuzzleDocument(kuzzleDataCollection, documentId, content) {
+function Document(kuzzleDataCollection, documentId, content) {
   Object.defineProperties(this, {
     // read-only properties
     collection: {
@@ -99,7 +99,7 @@ function KuzzleDocument(kuzzleDataCollection, documentId, content) {
  *
  * @return {object} JSON object representing this document
  */
-KuzzleDocument.prototype.serialize = function () {
+Document.prototype.serialize = function () {
   var
     data = {};
 
@@ -119,7 +119,7 @@ KuzzleDocument.prototype.serialize = function () {
  *
  * @return {string} serialized version of this object
  */
-KuzzleDocument.prototype.toString = function () {
+Document.prototype.toString = function () {
   return JSON.stringify(this.serialize());
 };
 
@@ -134,7 +134,7 @@ KuzzleDocument.prototype.toString = function () {
  * @param {responseCallback} [cb] - Handles the query response
  * @returns {*} this
  */
-KuzzleDocument.prototype.delete = function (options, cb) {
+Document.prototype.delete = function (options, cb) {
   var self = this;
 
   if (!cb && typeof options === 'function') {
@@ -143,7 +143,7 @@ KuzzleDocument.prototype.delete = function (options, cb) {
   }
 
   if (!self.id) {
-    throw new Error('KuzzleDocument.delete: cannot delete a document without a document ID');
+    throw new Error('Document.delete: cannot delete a document without a document ID');
   }
 
   this.kuzzle.query(this.dataCollection.buildQueryArgs('document', 'delete'), this.serialize(), options, cb && function (err) {
@@ -158,7 +158,7 @@ KuzzleDocument.prototype.delete = function (options, cb) {
  * @param {responseCallback} [cb] - Handles the query response
  * @returns {*} this
  */
-KuzzleDocument.prototype.refresh = function (options, cb) {
+Document.prototype.refresh = function (options, cb) {
   var self = this;
 
   if (!cb && typeof options === 'function') {
@@ -167,10 +167,10 @@ KuzzleDocument.prototype.refresh = function (options, cb) {
   }
 
   if (!self.id) {
-    throw new Error('KuzzleDocument.refresh: cannot retrieve a document if no ID has been provided');
+    throw new Error('Document.refresh: cannot retrieve a document if no ID has been provided');
   }
 
-  this.kuzzle.callbackRequired('KuzzleDocument.refresh', cb);
+  this.kuzzle.callbackRequired('Document.refresh', cb);
 
   self.kuzzle.query(self.dataCollection.buildQueryArgs('document', 'get'), {_id: self.id}, options, function (error, res) {
     var newDocument;
@@ -179,7 +179,7 @@ KuzzleDocument.prototype.refresh = function (options, cb) {
       return cb(error);
     }
 
-    newDocument = new KuzzleDocument(self.dataCollection, self.id, res.result._source);
+    newDocument = new Document(self.dataCollection, self.id, res.result._source);
     newDocument.version = res.result._version;
 
     cb(null, newDocument);
@@ -201,7 +201,7 @@ KuzzleDocument.prototype.refresh = function (options, cb) {
  * @param {responseCallback} [cb] - Handles the query response
  * @returns {*} this
  */
-KuzzleDocument.prototype.save = function (options, cb) {
+Document.prototype.save = function (options, cb) {
   var
     data = this.serialize(),
     self = this;
@@ -237,7 +237,7 @@ KuzzleDocument.prototype.save = function (options, cb) {
  * @param {object} [options] - Optional parameters
  * @returns {*} this
  */
-KuzzleDocument.prototype.publish = function (options) {
+Document.prototype.publish = function (options) {
   var data = this.serialize();
 
   this.kuzzle.query(this.dataCollection.buildQueryArgs('realtime', 'publish'), data, options);
@@ -252,7 +252,7 @@ KuzzleDocument.prototype.publish = function (options) {
  * @param {object} data - New content
  * @param {boolean} replace - if true: replace this document content with the provided data
  */
-KuzzleDocument.prototype.setContent = function (data, replace) {
+Document.prototype.setContent = function (data, replace) {
   var self = this;
 
   if (replace) {
@@ -274,18 +274,18 @@ KuzzleDocument.prototype.setContent = function (data, replace) {
  * @param {object} [options] - subscription options
  * @param {responseCallback} cb - callback that will be called each time a change has been detected on this document
  */
-KuzzleDocument.prototype.subscribe = function (options, cb) {
+Document.prototype.subscribe = function (options, cb) {
   var filters;
 
   if (options && !cb && typeof options === 'function') {
     cb = options;
     options = null;
   }
 
-  this.kuzzle.callbackRequired('KuzzleDocument.subscribe', cb);
+  this.kuzzle.callbackRequired('Document.subscribe', cb);
 
   if (!this.id) {
-    throw new Error('KuzzleDocument.subscribe: cannot subscribe to a document if no ID has been provided');
+    throw new Error('Document.subscribe: cannot subscribe to a document if no ID has been provided');
   }
 
   filters = { ids: { values: [this.id] } };
@@ -302,10 +302,10 @@ KuzzleDocument.prototype.subscribe = function (options, cb) {
  * @param content - new headers content
  * @param [replace] - default: false = append the content. If true: replace the current headers with tj
  */
-KuzzleDocument.prototype.setHeaders = function (content, replace) {
+Document.prototype.setHeaders = function (content, replace) {
   this.kuzzle.setHeaders.call(this, content, replace);
   return this;
 };
 
 
-module.exports = KuzzleDocument;
+module.exports = Document;

src/kuzzleDocument.js renamed to src/Document.js

@@ -1,9 +1,9 @@
 var
   uuid = require('uuid'),
-  KuzzleDataCollection = require('./kuzzleDataCollection'),
-  KuzzleSecurity = require('./security/kuzzleSecurity'),
-  KuzzleMemoryStorage = require('./kuzzleMemoryStorage'),
-  KuzzleUser = require('./security/kuzzleUser'),
+  Collection = require('./Collection.js'),
+  Security = require('./security/Security'),
+  MemoryStorage = require('./MemoryStorage'),
+  User = require('./security/User'),
   networkWrapper = require('./networkWrapper');
 
 /**
@@ -249,7 +249,7 @@ function Kuzzle (host, options, cb) {
    * Create an attribute security that embed all methods to manage Role, Profile and User
    */
   Object.defineProperty(this, 'security', {
-    value: new KuzzleSecurity(this),
+    value: new Security(this),
     enumerable: true
   });
 
@@ -282,7 +282,7 @@ function Kuzzle (host, options, cb) {
   });
 
   Object.defineProperty(this, 'memoryStorage', {
-    value: new KuzzleMemoryStorage(this),
+    value: new MemoryStorage(this),
     enumerable: true
   });
 
@@ -610,7 +610,7 @@ Kuzzle.prototype.whoAmI = function (callback) {
       return callback(err);
     }
 
-    callback(null, new KuzzleUser(self.security, response.result._id, response.result._source));
+    callback(null, new User(self.security, response.result._id, response.result._source));
   });
 };
 
@@ -754,7 +754,7 @@ function emitRequest (request, cb) {
 
   this.network.send(request);
 
-  // Track requests made to allow KuzzleRoom.subscribeToSelf to work
+  // Track requests made to allow Room.subscribeToSelf to work
   self.requestHistory[request.requestId] = Date.now();
 }
 
@@ -934,14 +934,14 @@ Kuzzle.prototype.getStatistics = function (timestamp, options, cb) {
 };
 
 /**
- * Create a new instance of a KuzzleDataCollection object.
+ * Create a new instance of a Collection object.
  * If no index is specified, takes the default index.
  *
  * @param {string} collection - The name of the data collection you want to manipulate
  * @param {string} [index] - The name of the data index containing the data collection
- * @returns {KuzzleDataCollection} A KuzzleDataCollection instance
+ * @returns {Collection} A Collection instance
  */
-Kuzzle.prototype.dataCollectionFactory = function(collection, index) {
+Kuzzle.prototype.collection = function(collection, index) {
   this.isValid();
 
   if (!index) {
@@ -961,7 +961,7 @@ Kuzzle.prototype.dataCollectionFactory = function(collection, index) {
   }
 
   if (!this.collections[index][collection]) {
-    this.collections[index][collection] = new KuzzleDataCollection(this, collection, index);
+    this.collections[index][collection] = new Collection(this, collection, index);
   }
 
   return this.collections[index][collection];
@@ -1486,4 +1486,4 @@ Kuzzle.prototype.stopQueuing = function () {
   return this;
 };
 
-module.exports = Kuzzle;
+module.exports = Kuzzle;

src/kuzzle.js renamed to src/Kuzzle.js

@@ -28,7 +28,7 @@
  * @param {object} kuzzle - Kuzzle instance to inherit from
  * @constructor
  */
-function KuzzleMemoryStorage(kuzzle) {
+function MemoryStorage(kuzzle) {
   Object.defineProperties(this, {
     // read-only properties
     kuzzle: {
@@ -173,7 +173,7 @@ function KuzzleMemoryStorage(kuzzle) {
   commands.zscore = commands.zrevrank;
 
   Object.keys(commands).forEach(function (command) {
-    KuzzleMemoryStorage.prototype[command] = function () {
+    MemoryStorage.prototype[command] = function () {
       var
         args = Array.prototype.slice.call(arguments),
         options = null,
@@ -231,4 +231,4 @@ function KuzzleMemoryStorage(kuzzle) {
 
 })();
 
-module.exports = KuzzleMemoryStorage;
+module.exports = MemoryStorage;