refs #1783: Fixed spacing in `SplitDocumentSource.js` in `munge`; munge docs

http://source.rd.rcg.local/trac/eagle6/changeset/1447/Eagle6_SVN

lib/pipeline/Pipeline.js

@@ -1,9 +1,15 @@
 var Pipeline = module.exports = (function(){
 	// CONSTRUCTOR
-	var klass = function Pipeline(){
-		
+	// CONSTRUCTOR
+	/**
+	* mongodb "commands" (sent via db.$cmd.findOne(...)) subclass to make a command.  define a singleton object for it.
+	* @class Pipeline
+	* @namespace munge.pipeline
+	* @module munge
+	* @constructor
+	**/
+	var klass = function Pipeline(/*theCtx*/){
 		this.sourceVector = [];//should be provate?
-		
 	}, base = Object, proto = klass.prototype = Object.create(base.prototype, {constructor:{value:klass}});
 	
 	var LimitDocumentSource = require('./documentSources/LimitDocumentSource'),
@@ -13,7 +19,7 @@ var Pipeline = module.exports = (function(){
 		UnwindDocumentSource = require('./documentSources/UnwindDocumentSource'),
 		GroupDocumentSource = require('./documentSources/GroupDocumentSource'),
 		SortDocumentSource = require('./documentSources/SortDocumentSource'),
-    SplitDocumentSource = require('./documentSources/SplitDocumentSource');
+		SplitDocumentSource = require('./documentSources/SplitDocumentSource');
 	
 	klass.StageDesc = {};//attaching this to the class for test cases
 	klass.StageDesc[LimitDocumentSource.limitName] = LimitDocumentSource.createFromJson;
@@ -23,14 +29,16 @@ var Pipeline = module.exports = (function(){
 	klass.StageDesc[UnwindDocumentSource.unwindName] = UnwindDocumentSource.createFromJson;
 	klass.StageDesc[GroupDocumentSource.groupName] = GroupDocumentSource.createFromJson;
 	klass.StageDesc[SortDocumentSource.sortName] = SortDocumentSource.createFromJson;
-  klass.StageDesc[SplitDocumentSource.splitName] = SplitDocumentSource.createFromJson;
+	klass.StageDesc[SplitDocumentSource.splitName] = SplitDocumentSource.createFromJson;
 	
-    /**
-     * Create a pipeline from the command.
+	/**
+	 * Create a pipeline from the command.
 	 *
-     * @param	{Object} cmdObj the command object sent from the client
-     * @returns	{Array}	the pipeline, if created, otherwise a NULL reference
-     **/
+	 * @static
+	 * @method parseCommand
+	 * @param	{Object} cmdObj the command object sent from the client
+	 * @returns	{Array}	the pipeline, if created, otherwise a NULL reference
+	 **/
 	klass.parseCommand = function parseCommand(cmdObj){
 		var pipelineInstance = new Pipeline(),
 			pipeline = cmdObj;//munge: skipping the command parsing since all we care about is the pipeline
@@ -38,19 +46,19 @@ var Pipeline = module.exports = (function(){
 		var sourceVector = pipelineInstance.sourceVector,
 			nSteps = pipeline.length;
 		for( var iStep = 0; iStep<nSteps; ++iStep){
-            /* pull out the pipeline element as an object */
+			/* pull out the pipeline element as an object */
 			var pipeElement = pipeline[iStep];
 			if (!(pipeElement instanceof Object)){
 				throw new Error("pipeline element " + iStep + " is not an object; code 15942" );
 			}
 			
-            // Parse a pipeline stage from 'obj'.
+			// Parse a pipeline stage from 'obj'.
 			var obj = pipeElement;
 			if (Object.keys(obj).length !== 1){
 				throw new Error("A pipeline stage specification object must contain exactly one field; code 16435" );
 			}
-            // Create a DocumentSource pipeline stage from 'stageSpec'.
-            var stageName = Object.keys(obj)[0],
+			// Create a DocumentSource pipeline stage from 'stageSpec'.
+			var stageName = Object.keys(obj)[0],
 				stageSpec = obj[stageName],
 				desc = klass.StageDesc[stageName];
 				
@@ -58,135 +66,118 @@ var Pipeline = module.exports = (function(){
 				throw new Error("Unrecognized pipeline stage name: '" + stageName + "'; code 16435" );
 			}
 			
-            var stage = desc(stageSpec);
-            //verify(stage);
-            stage.setPipelineStep(iStep);
-            sourceVector.push(stage);
+			var stage = desc(stageSpec);
+			//verify(stage);
+			stage.setPipelineStep(iStep);
+			sourceVector.push(stage);
 		}
 		
-        /* if there aren't any pipeline stages, there's nothing more to do */
+		/* if there aren't any pipeline stages, there's nothing more to do */
 		if (!sourceVector.length){
 			return pipelineInstance;
 		}
 		
-		/*
-          Move filters up where possible.
+		/* Move filters up where possible.
+		CW TODO -- move filter past projections where possible, and noting corresponding field renaming.
+		*/
 
-          CW TODO -- move filter past projections where possible, and noting
-          corresponding field renaming.
-        */
-
-        /*
-          Wherever there is a match immediately following a sort, swap them.
-          This means we sort fewer items.  Neither changes the documents in
-          the stream, so this transformation shouldn't affect the result.
-
-          We do this first, because then when we coalesce operators below,
-          any adjacent matches will be combined.
-         */
-        for(var srcn = sourceVector.length, srci = 1; srci < srcn; ++srci) {
-            var source = sourceVector[srci];
-            if (source.constructor === MatchDocumentSource) {
-                var previous = sourceVector[srci - 1];
-                if (previous.constructor === klass.SortDocumentSource) { //TODO: remove 'sort.' once sort is implemented!!!
-                    /* swap this item with the previous */
-                    sourceVector[srci - 1] = source;
-                    sourceVector[srci] = previous;
-                }
-            }
-        }
-        
 		/*
-          Coalesce adjacent filters where possible.  Two adjacent filters
-          are equivalent to one filter whose predicate is the conjunction of
-          the two original filters' predicates.  For now, capture this by
-          giving any DocumentSource the option to absorb it's successor; this
-          will also allow adjacent projections to coalesce when possible.
-
-          Run through the DocumentSources, and give each one the opportunity
-          to coalesce with its successor.  If successful, remove the
-          successor.
-
-          Move all document sources to a temporary list.
-        */
-        var tempVector = sourceVector.slice(0);
-        sourceVector.length = 0;
+		Wherever there is a match immediately following a sort, swap them.
+		This means we sort fewer items.  Neither changes the documents in the stream, so this transformation shouldn't affect the result.
+		We do this first, because then when we coalesce operators below, any adjacent matches will be combined.
+		*/
+		for(var srcn = sourceVector.length, srci = 1; srci < srcn; ++srci) {
+			var source = sourceVector[srci];
+			if (source.constructor === MatchDocumentSource) {
+				var previous = sourceVector[srci - 1];
+				if (previous.constructor === klass.SortDocumentSource) { //TODO: remove 'sort.' once sort is implemented!!!
+					/* swap this item with the previous */
+					sourceVector[srci - 1] = source;
+					sourceVector[srci] = previous;
+				}
+			}
+		}
+		
+		/*
+		Coalesce adjacent filters where possible.  Two adjacent filters are equivalent to one filter whose predicate is the conjunction of the two original filters' predicates.
+		For now, capture this by giving any DocumentSource the option to absorb it's successor; this will also allow adjacent projections to coalesce when possible.
+		Run through the DocumentSources, and give each one the opportunity to coalesce with its successor.  If successful, remove the successor.
+		Move all document sources to a temporary list.
+		*/
+		var tempVector = sourceVector.slice(0);
+		sourceVector.length = 0;
 
-        /* move the first one to the final list */
-        sourceVector.push(tempVector[0]);
+		/* move the first one to the final list */
+		sourceVector.push(tempVector[0]);
 
-        /* run through the sources, coalescing them or keeping them */
-        for(var tempn = tempVector.length, tempi = 1; tempi < tempn; ++tempi) {
-            /*
-              If we can't coalesce the source with the last, then move it
-              to the final list, and make it the new last.  (If we succeeded,
-              then we're still on the same last, and there's no need to move
-              or do anything with the source -- the destruction of tempVector
-              will take care of the rest.)
-            */
-            var lastSource = sourceVector[sourceVector.length - 1];
-            var temp = tempVector[tempi];
-            if (!temp || !lastSource){
+		/* run through the sources, coalescing them or keeping them */
+		for(var tempn = tempVector.length, tempi = 1; tempi < tempn; ++tempi) {
+			/*
+			If we can't coalesce the source with the last, then move it to the final list, and make it the new last.
+			(If we succeeded, then we're still on the same last, and there's no need to move or do anything with the source -- the destruction of tempVector will take care of the rest.)
+			*/
+			var lastSource = sourceVector[sourceVector.length - 1];
+			var temp = tempVector[tempi];
+			if (!temp || !lastSource){
 				throw new Error("null document sources found");
-            }
-            if (!lastSource.coalesce(temp)){
-                sourceVector.push(temp);
-            }
-        }
+			}
+			if (!lastSource.coalesce(temp)){
+				sourceVector.push(temp);
+			}
+		}
 
-        /* optimize the elements in the pipeline */
-        for(var i = 0, l = sourceVector.length; i<l; i++) {
+		/* optimize the elements in the pipeline */
+		for(var i = 0, l = sourceVector.length; i<l; i++) {
 			var iter = sourceVector[i];
-            if (!iter) {
-                throw new Error("Pipeline received empty document as argument");
-            }
+			if (!iter) {
+				throw new Error("Pipeline received empty document as argument");
+			}
 
-            iter.optimize();
-        }
+			iter.optimize();
+		}
 
-        return pipelineInstance;
+		return pipelineInstance;
 	};
 	/**
 	 * Run the pipeline
-	 * 
+	 *
+	 * @method run 
 	 * @param	{Object}	result	the results of running the pipeline will be stored on this object
 	 * @param	{CursorDocumentSource}	source	the primary document source of the data
 	**/
 	proto.run = function run(result, source){
-        for(var i = 0, l = this.sourceVector.length; i<l; i++) {
+		for(var i = 0, l = this.sourceVector.length; i<l; i++) {
 			var temp = this.sourceVector[i];
-            temp.setSource(source);
-            source = temp;
-        }
-        /* source is left pointing at the last source in the chain */
+			temp.setSource(source);
+			source = temp;
+		}
+		/* source is left pointing at the last source in the chain */
 
-        /*
-          Iterate through the resulting documents, and add them to the result.
-          We do this even if we're doing an explain, in order to capture
-          the document counts and other stats.  However, we don't capture
-          the result documents for explain.
-          */
-        // the array in which the aggregation results reside
-        // cant use subArrayStart() due to error handling
-        var resultArray = [];
-        for(var hasDoc = !source.eof(); hasDoc; hasDoc = source.advance()) {
-            var document = source.getCurrent();
-            /* add the document to the result set */
-            resultArray.push(document);
-            
-            //Commenting out this assertion for munge.  MUHAHAHA!!!
-            
-            // object will be too large, assert. the extra 1KB is for headers
-//            uassert(16389,
-//                    str::stream() << "aggregation result exceeds maximum document size ("
-//                                  << BSONObjMaxUserSize / (1024 * 1024) << "MB)",
-//                    resultArray.len() < BSONObjMaxUserSize - 1024);
-        }
+		/*
+		Iterate through the resulting documents, and add them to the result.
+		We do this even if we're doing an explain, in order to capture the document counts and other stats.
+		However, we don't capture the result documents for explain.
+		*/
+		// the array in which the aggregation results reside
+		// cant use subArrayStart() due to error handling
+		var resultArray = [];
+		for(var hasDoc = !source.eof(); hasDoc; hasDoc = source.advance()) {
+			var document = source.getCurrent();
+			/* add the document to the result set */
+			resultArray.push(document);
+			
+			//Commenting out this assertion for munge.  MUHAHAHA!!!
+			
+			// object will be too large, assert. the extra 1KB is for headers
+//			uassert(16389,
+//					str::stream() << "aggregation result exceeds maximum document size (" << BSONObjMaxUserSize / (1024 * 1024) << "MB)",
+//					resultArray.len() < BSONObjMaxUserSize - 1024);
+		}
 
-        result.result = resultArray;
-        
+		result.result = resultArray;
+		
 		return true;
 	};
 	
 	return klass;
-})();
+})();

lib/pipeline/documentSources/SplitDocumentSource.js

@@ -1,12 +1,10 @@
 var SplitDocumentSource = module.exports = (function(){
 	// CONSTRUCTOR
 	/**
-	 * A document source sorter
-	 *
-	 * Since we don't have shards, this inherits from DocumentSource, instead of SplittableDocumentSource
+	 * A document stream splitter
 	 * 
 	 * @class SortDocumentSource
-	 * @namespace munge.pipeline.documentsource
+	 * @namespace munge.pipeline.documentSources
 	 * @module munge
 	 * @constructor
 	**/

test/lib/pipeline/documentSources/SplitDocumentSource.js

@@ -3,6 +3,7 @@ var assert = require("assert"),
 	CursorDocumentSource = require("../../../../lib/pipeline/documentSources/CursorDocumentSource"),
 	Cursor = require("../../../../lib/Cursor");
 
+
 module.exports = {
 
 	"SplitDocumentSource": {
@@ -25,14 +26,14 @@ module.exports = {
 
 		"#getSourceName()": {
 
-            "should return the correct source name; $split": function testSourceName(){
-                var pds = new SplitDocumentSource();
-                assert.strictEqual(pds.getSourceName(), SplitDocumentSource.splitName);
-            }
+			"should return the correct source name; $split": function testSourceName(){
+				var pds = new SplitDocumentSource();
+				assert.strictEqual(pds.getSourceName(), SplitDocumentSource.splitName);
+			}
 
-        },
+		},
 
-        "#eof()": {
+		"#eof()": {
 
 			"shouldn't be eof after init": function testEOF(){
 				var cwc = new CursorDocumentSource.CursorWithContext();
@@ -43,31 +44,31 @@ module.exports = {
 				assert.ok(!split.eof());
 			},
 
-            "should be eof after one call to get current": function testAdvanceFirst() {
-                var cwc = new CursorDocumentSource.CursorWithContext();
-                var input = [{_id: 0, a: 1}, {_id: 1, a: 2}];
-                cwc._cursor = new Cursor( input );
-                var cds = new CursorDocumentSource(cwc);
-                var split = new SplitDocumentSource();
-                split.setSource(cds);
-                assert.ok(split.getCurrent()); 
-                assert.ok(split.eof);
-            }
-
-        },
-
-        "#advance()": {
-
-            "can't advance after one call to getCurrent": function testAdvanceFirst() {
-                var cwc = new CursorDocumentSource.CursorWithContext();
-                var input = [{_id: 0, a: 1}, {_id: 1, a: 2}];
-                cwc._cursor = new Cursor( input );
-                var cds = new CursorDocumentSource(cwc);
-                var split = new SplitDocumentSource();
-                split.setSource(cds);
-                assert.ok(split.getCurrent()); 
-                assert.ok(!split.advance());
-            },
+			"should be eof after one call to get current": function testAdvanceFirst() {
+				var cwc = new CursorDocumentSource.CursorWithContext();
+				var input = [{_id: 0, a: 1}, {_id: 1, a: 2}];
+				cwc._cursor = new Cursor( input );
+				var cds = new CursorDocumentSource(cwc);
+				var split = new SplitDocumentSource();
+				split.setSource(cds);
+				assert.ok(split.getCurrent()); 
+				assert.ok(split.eof);
+			}
+
+		},
+
+		"#advance()": {
+
+			"can't advance after one call to getCurrent": function testAdvanceFirst() {
+				var cwc = new CursorDocumentSource.CursorWithContext();
+				var input = [{_id: 0, a: 1}, {_id: 1, a: 2}];
+				cwc._cursor = new Cursor( input );
+				var cds = new CursorDocumentSource(cwc);
+				var split = new SplitDocumentSource();
+				split.setSource(cds);
+				assert.ok(split.getCurrent()); 
+				assert.ok(!split.advance());
+			},
 
 			"throws exception if advanced beyond eof": function throwsBeyondEof() {
 				assert.throws(function() {
@@ -112,42 +113,41 @@ module.exports = {
 
 		"#createFromJson()": {
 
-            "should error if called with non-object": function testNonObjectPassed() {
-                //String as arg
-                assert.throws(function() {
-                    var split = SplitDocumentSource.createFromJson("not an object");
-                });
-                //Date as arg
-                assert.throws(function() {
+			"should error if called with non-object": function testNonObjectPassed() {
+				//String as arg
+				assert.throws(function() {
+					var split = SplitDocumentSource.createFromJson("not an object");
+				});
+				//Date as arg
+				assert.throws(function() {
 					var split = SplitDocumentSource.createFromJson(new Date());
-                });
-                //Array as arg
-                assert.throws(function() {
+				});
+				//Array as arg
+				assert.throws(function() {
 					var split = SplitDocumentSource.createFromJson([]);
-                });
-                //Empty args
-                assert.throws(function() {
+				});
+				//Empty args
+				assert.throws(function() {
 					var split = SplitDocumentSource.createFromJson();
-                });
-            },
+				});
+			},
 
-            "should error if spec has no keys": function testNoKeys() {
+			"should error if spec has no keys": function testNoKeys() {
 				assert.throws(function() {
 					var split = SplitDocumentSource.createFromJson({});
-                });
-            },
+				});
+			},
 
-            "should error if value of a key in top level is not an array": function testNoKeys() {
-                assert.throws(function() {
-                    var split = SplitDocumentSource.createFromJson({a: "not an array"});
-                });
-            }
+			"should error if value of a key in top level is not an array": function testNoKeys() {
+				assert.throws(function() {
+					var split = SplitDocumentSource.createFromJson({a: "not an array"});
+				});
+			}
 
-        },
+		},
 
 	}
 
 };
 
 if (!module.parent)(new(require("mocha"))()).ui("exports").reporter("spec").addFile(__filename).run(process.exit);
-