added comments

Author: Johannes

lib/browserify/appendix.js renamed to lib/browserify/browserInit.js

@@ -6,54 +6,87 @@ var setterSrc = require("../__set__.js").toString(),
     getRewireRequires = require("./getRewireRequires.js"),
     detectStrictMode = require("../detectStrictMode.js"),
 
-    appendix = fs.readFileSync(__dirname + "/appendix.js", "utf8"),
+    browserInit = fs.readFileSync(__dirname + "/browserInit.js", "utf8"),
     importGlobalsSrc = getImportGlobalsSrc(),
     injectionSrc = getInjectionSrc().replace(/\s+/g, " ");   // strip out unnecessary spaces to be unobtrusive in the debug view
 
+/**
+ * Returns a string that gets injected at the beginning of every module. Its purpose is to
+ *
+ * - register the setters and getters according to the module's filename
+ * - override the internal require with a require proxy.
+ *
+ * @return {String}
+ */
 function getInjectionSrc() {
+    // Registers the setters and getters of every module according to their filename. The setters and getters must be
+    // injected as string here to gain access to the private scope of the module.
     return  'require("rewire").register(__filename, ' + setterSrc + ', ' + getterSrc + ');' +
-            'process = require("__browserify_process");' +
+    // Overrides the module internal require with a require proxy. This proxy is necessary to call rewire with the
+    // module's filename at the first parameter to resolve the path. This way rewire() works exactly like require().
             'require = window.browserifyRequire.getProxy(require, __filename);';
 }
 
-function browserifyMiddleware(b) {
-    var strictMode;
+function wrapCodeInDecorativeComments(filename, src) {
+    var topLine = "",
+        bottomLine = "",
+        lineLength = 80;
+
+    while (topLine.length <= lineLength) {
 
-    b.register(".js", function injectRewire(src, filename) {
-        var rewireRequires = getRewireRequires(src),
+    }
+}
+
+function browserifyMiddleware(b) {
+    function injectRewire(src, filename) {
+        var rewireRequires,
             strictMode = "";
 
+        // Search for all rewire() statements an return the required path.
+        rewireRequires = getRewireRequires(src);
+
         // Add all modules that are loaded by rewire() manually to browserify because browserify's
         // require-sniffing doesn't work here.
         rewireRequires.forEach(function forEachRewireRequire(requirePath) {
-
+            // Resolve absolute paths
             if (requirePath.charAt(0) === ".") {
                 requirePath = path.resolve(path.dirname(filename), requirePath);
             }
             b.require(requirePath);
-
         });
 
+        // If the module uses strict mode we must ensure that "use strict" stays at the beginning of the module.
         if (detectStrictMode(src) === true) {
             strictMode = ' "use strict"; ';
         }
 
+        // Convert back slashes to normal slashes.
         filename = filename.replace(/\\/g, "/");
+
+        // We don't want to inject this code at the beginning of a rewire/lib-module. Otherwise
+        // it would cause a black hole that devours our universe.
         if (filename.indexOf("/rewire/lib") === -1) {
             src =
-                strictMode +
-                "var global = window; " +
+                strictMode +    // either '' or ' "use strict"; '
+                "var global = window; " +   // window is our new global object
                 importGlobalsSrc +
-                injectionSrc +
+                injectionSrc + "\n" +
                 // For a better debugging experience we're adding a comment with the filename
-                "\n//// " + filename + " /////////////////////////////////////////////////////////////////////////////////////////////////////////////\n\n" +
-                src +
-                "\n\n////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////\n";
+                "//// " + filename + " /////////////////////////////////////////////////////////////////////////////////////////////////////////////\n" +
+                "\n" +
+                src + "\n" +
+                "\n" +
+                "/////" + filename.replace(/./g, "/") + "//////////////////////////////////////////////////////////////////////////////////////////////////////////////\n" +
+                "//@ sourceURL=" + filename + "\n";
         }
 
         return src;
-    });
-    b.append(appendix);
+    }
+
+    // Register file handler
+    b.register(".js", injectRewire);
+    // Append rewire initialization at the end of the bundle
+    b.append(browserInit);
 
     return b;
 }

lib/browserify/browserifyMiddleware.js

@@ -31,9 +31,6 @@ function checkSomeGlobals() {
     if (typeof global === "undefined") {
         throw new ReferenceError("global is undefined");
     }
-    if (typeof process === "undefined") {
-        throw new ReferenceError("process is undefined");
-    }
     if (typeof console === "undefined") {
         throw new ReferenceError("console is undefined");
     }
@@ -52,10 +49,6 @@ function getConsole() {
     return console;
 }
 
-function getProcess() {
-    return process;
-}
-
 function getFilename() {
     return __filename;
 }
@@ -68,6 +61,5 @@ exports.getMyObj = getMyObj;
 exports.readFileSync = readFileSync;
 exports.checkSomeGlobals = checkSomeGlobals;
 exports.getConsole = getConsole;
-exports.getProcess = getProcess;
 exports.getFilename = getFilename;
 exports.someOtherModule = someOtherModule;

test/testModules/moduleA.js

@@ -31,9 +31,6 @@ function checkSomeGlobals() {
     if (typeof global === "undefined") {
         throw new ReferenceError("global is undefined");
     }
-    if (typeof process === "undefined") {
-        throw new ReferenceError("process is undefined");
-    }
     if (typeof console === "undefined") {
         throw new ReferenceError("console is undefined");
     }
@@ -52,10 +49,6 @@ function getConsole() {
     return console;
 }
 
-function getProcess() {
-    return process;
-}
-
 function getFilename() {
     return __filename;
 }
@@ -68,6 +61,5 @@ exports.getMyObj = getMyObj;
 exports.readFileSync = readFileSync;
 exports.checkSomeGlobals = checkSomeGlobals;
 exports.getConsole = getConsole;
-exports.getProcess = getProcess;
 exports.getFilename = getFilename;
 exports.someOtherModule = someOtherModule;

test/testModules/moduleB.js

@@ -37,7 +37,7 @@ function cleanRequireCache() {
     }
 }
 
-describe("rewire " + (typeof window === "undefined"? "in node.js": "in the browser"), function () {
+describe("rewire " + (typeof window === "undefined"? "(node.js)": "(browser)"), function () {
     beforeEach(cleanRequireCache);  // ensuring a clean test environment
     it("should work like require()", function () {
         expect(rewire("./moduleA.js")).to.be(require("./moduleA.js"));
@@ -109,25 +109,19 @@ describe("rewire " + (typeof window === "undefined"? "in node.js": "in the brows
         var rewiredModuleA = rewire("./moduleA.js"),
             rewiredModuleB = rewire("./moduleB.js"),
             consoleMock = {},
-            processMock = {},
             newFilename = "myFile.js";
 
         rewiredModuleA.__set__({
-            console: consoleMock,
-            process: processMock
+            console: consoleMock
         });
         rewiredModuleA.__set__("__filename", newFilename);
         rewiredModuleB.__set__({
-            console: consoleMock,
-            process: processMock
+            console: consoleMock
         });
         rewiredModuleB.__set__("__filename", newFilename);
         expect(rewiredModuleA.getConsole()).to.be(consoleMock);
         expect(rewiredModuleB.getConsole()).to.be(consoleMock);
         expect(console).not.to.be(consoleMock);
-        expect(rewiredModuleA.getProcess()).to.be(processMock);
-        expect(rewiredModuleB.getProcess()).to.be(processMock);
-        expect(process).not.to.be(processMock);
         expect(rewiredModuleA.getFilename()).to.be(newFilename);
         expect(rewiredModuleB.getFilename()).to.be(newFilename);
     });