- added Coffee-Script support closes jhnns#8 (jashkenas/coffeescript#2707)

jhnns · jhnns · commit 6040974a2f0b · 2013-02-23T14:52:22.000+01:00
- renamed internalRewire.js to simply rewire.js
- moved all the stuff related to manipulating the module environment to moduleEnv.js
diff --git a/lib/index.js b/lib/index.js
@@ -1,4 +1,4 @@
-var rewireModule = require("./internalRewire.js");
+var rewireModule = require("./rewire.js");
 
 /**
  * Adds a special setter and getter to the module located at filename. After the module has been rewired, you can
diff --git a/lib/internalRewire.js b/lib/internalRewire.js
diff --git a/lib/moduleEnv.js b/lib/moduleEnv.js
@@ -0,0 +1,82 @@
+"use strict";
+
+var Module = require("module"),
+    fs = require("fs");
+
+    // caching original wrapper
+var moduleWrapper0 = Module.wrapper[0],
+    moduleWrapper1 = Module.wrapper[1],
+    originalExtensions = {},
+    nodeRequire,
+    currentModule;
+
+function load(targetModule) {
+    nodeRequire = targetModule.require;
+    targetModule.require = requireProxy;
+    currentModule = targetModule;
+
+    registerExtensions();
+    targetModule.load(targetModule.id);
+
+    // This is only necessary if nothing has been required within the module
+    reset();
+}
+
+function reset() {
+    Module.wrapper[0] = moduleWrapper0;
+    Module.wrapper[1] = moduleWrapper1;
+    restoreExtensions();
+}
+
+function inject(prelude, appendix) {
+    Module.wrapper[0] = moduleWrapper0 + prelude;
+    Module.wrapper[1] = appendix + moduleWrapper1;
+}
+
+/**
+ * Proxies the first require call in order to draw back all changes to the Module.wrapper.
+ * Thus our changes don't influence other modules
+ *
+ * @param {!String} path
+ */
+function requireProxy(path) {
+    reset();
+    currentModule.require = nodeRequire;
+    return nodeRequire.call(currentModule, path);  // node's require only works when "this" points to the module
+}
+
+function registerExtensions() {
+    originalExtensions.coffee = require.extensions[".coffee"];
+    require.extensions[".coffee"] = coffeeExtension;
+}
+
+function restoreExtensions() {
+    require.extensions[".coffee"] = originalExtensions.coffee;
+}
+
+function coffeeExtension(module, filename) {
+    var coffee = require("coffee-script"),
+        content = stripBOM(fs.readFileSync(filename, "utf8"));
+
+    content = coffee.compile(content, {
+        filename: filename,
+        bare: true
+    });
+    module._compile(content, filename);
+}
+
+/**
+ * @see https://github.com/joyent/node/blob/master/lib/module.js
+ */
+function stripBOM(content) {
+    // Remove byte order marker. This catches EF BB BF (the UTF-8 BOM)
+    // because the buffer-to-string conversion in `fs.readFileSync()`
+    // translates it to FEFF, the UTF-16 BOM.
+    if (content.charCodeAt(0) === 0xFEFF) {
+        content = content.slice(1);
+    }
+    return content;
+}
+
+exports.load = load;
+exports.inject = inject;
diff --git a/lib/rewire.js b/lib/rewire.js
@@ -0,0 +1,56 @@
+var Module = require("module"),
+    fs = require("fs"),
+    __get__ = require("./__get__.js"),
+    __set__ = require("./__set__.js"),
+    getImportGlobalsSrc = require("./getImportGlobalsSrc.js"),
+    detectStrictMode = require("./detectStrictMode.js"),
+    moduleEnv = require("./moduleEnv.js");
+
+/**
+ * Does actual rewiring the module. For further documentation @see index.js
+ */
+function internalRewire(parentModulePath, targetPath) {
+    var targetModule,
+        prelude,
+        appendix,
+        src;
+
+    // Checking params
+    if (typeof targetPath !== "string") {
+        throw new TypeError("Filename must be a string");
+    }
+
+    // Resolve full filename relative to the parent module
+    targetPath = Module._resolveFilename(targetPath, parentModulePath);
+
+    // Special support for older node versions that returned an array on Module._resolveFilename
+    // @see https://github.com/joyent/node/blob/865b077819a9271a29f982faaef99dc635b57fbc/lib/module.js#L319
+    // TODO Remove this switch on the next major release
+    if (Array.isArray(targetPath)) {
+        targetPath = targetPath[1];
+    }
+
+    // Create testModule as it would be created by require()
+    targetModule = new Module(targetPath, parentModulePath);
+
+    // We prepend a list of all globals declared with var so they can be overridden (without changing original globals)
+    prelude = getImportGlobalsSrc();
+
+    // We append our special setter and getter.
+    appendix = "module.exports.__set__ = " + __set__.toString() + "; ";
+    appendix += "module.exports.__get__ = " + __get__.toString() + "; ";
+
+    // Check if the module uses the strict mode.
+    // If so we must ensure that "use strict"; stays at the beginning of the module.
+    src = fs.readFileSync(targetPath, "utf8");
+    if (detectStrictMode(src) === true) {
+        prelude = ' "use strict"; ' + prelude;
+    }
+
+    moduleEnv.inject(prelude, appendix);
+    moduleEnv.load(targetModule);
+
+    return targetModule.exports;
+}
+
+module.exports = internalRewire;
diff --git a/test/rewire.test.js b/test/rewire.test.js
@@ -2,10 +2,26 @@
 // In case this module was in strict mode, all other modules called by this would also be strict.
 // But when testing if the strict mode is preserved, we must ensure that this module is NOT strict.
 
-describe("internalRewire", function () {
+var expect = require("expect.js");
+
+var rewire;
+
+describe("rewire", function () {
     before(require("./testHelpers/createFakePackageJSON.js"));
     after(require("./testHelpers/removeFakePackageJSON.js"));
     it("should pass all shared test cases", function () {
         require("./testModules/sharedTestCases.js");
     });
+    it("should also work with CoffeeScript", function () {
+        var coffeeModule;
+
+        rewire = require("rewire");
+        coffeeModule = rewire("./testModules/module.coffee");
+        coffeeModule.__set__("fs", {
+            readFileSync: function () {
+                return "It works!";
+            }
+        });
+        expect(coffeeModule.readFileSync()).to.be("It works!");
+    });
 });
diff --git a/test/testModules/module.coffee b/test/testModules/module.coffee
@@ -0,0 +1,3 @@
+fs = require "fs"
+
+exports.readFileSync = () -> fs.readFileSync()

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-var rewireModule = require("./internalRewire.js");`
	`1`	`+var rewireModule = require("./rewire.js");`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Adds a special setter and getter to the module located at filename. After the module has been rewired, you can`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+fs = require "fs"`
	`2`	`+`
	`3`	`+exports.readFileSync = () -> fs.readFileSync()`