Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/rewire.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes <mail@johannesewald.de>2012-06-04 03:29:39 +0400
committerJohannes <mail@johannesewald.de>2012-06-04 03:29:39 +0400
commitf36825ab2607e9444f9a29f5ed666817583d0aa3 (patch)
tree5da79c9a9ede869fbf2f9d5bd28687dabe899cee /README.md
parentb4b2794f5a5e5977e048ff777ac53263144126e6 (diff)
added documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md85
1 files changed, 80 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8462cc8..11fe36b 100644
--- a/README.md
+++ b/README.md
@@ -7,15 +7,21 @@ rewire allows you to modify the behaviour of modules for better unit testing. Yo
- provide mocks for other modules
- leak private variables
- override variables within the module
-- inject scripts
+- inject your own scripts
-rewire does **not** load the file and eval it to emulate node's require mechanism. In fact it uses node's require to load the module. Thus your module behaves exactly the same in your test environment as under regular circumstances (except your modifications).
+rewire does **not** load the file and eval the contents to emulate node's require mechanism. In fact it uses node's own require to load the module. Thus your module behaves exactly the same in your test environment as under regular circumstances (except your modifications).
+
+**Debugging is fully supported.**
+
+-----------------------------------------------------------------
Installation
------------
```npm install rewire```
+-----------------------------------------------------------------
+
Examples
--------
@@ -28,6 +34,8 @@ var rewire = require("rewire"),
// rewire acts exactly like require when omitting all other params
rewiredModule = rewire("./myModuleA.js");
+
+
// Mocks
////////////////////////////////
var mockedModuleB = {},
@@ -35,10 +43,11 @@ var mockedModuleB = {},
"path/to/moduleB.js": mockedModuleB
};
-// the rewired module will now use your mock instead of moduleB.js.
+// The rewired module will now use your mock instead of moduleB.js.
rewiredModule = rewire("./myModuleA.js", mocks);
+
// Injections
////////////////////////////////
var injections = {
@@ -49,13 +58,79 @@ var injections = {
__filename: "some/other/dir"
};
-// overrides all given variables within the module
+// This will inject
+// var console = {log: function () { /* be quiet */ }};
+// var process = {argv: ["someArgs"] };
+// var __filename = "some/other/dir";
+// at the bottom of the module.
+// This way you can override private variables within the module
rewiredModule = rewire("./myModuleA.js", null, injections);
-// you can also pass a script to inject
+
+// You can also pass a script to inject
rewiredModule = rewire("./myModuleA.js", null, "console.log('hellooo');");
+
// Leaks
////////////////////////////////
+var leaks = ["myPrivateVar1", "myPrivateVar2"];
+
+// rewire exports variables under the special "__"-object.
+rewiredModule = rewire("./myModuleA.js", null, null, leaks);
+console.log(rewiredModule.__.myPrivateVar1);
+console.log(rewiredModule.__.myPrivateVar2);
+
+
+// Cache
+////////////////////////////////
+// By disabling the module cache the rewired module will not be cached.
+// Any later require()-calls within other modules will now return the original
+// module again instead of the rewired. Caching is enabled by default.
+rewiredModule = rewire("./myModuleA.js", null, null, null, false);
```
+
+-----------------------------------------------------------------
+
+##API
+
+**rewire(***filename, mocks\*, injections\*, leaks\*, cache=true*) \* = optional
+
+- *{!String} **filename***: Path to the module that shall be rewired. Use it exactly like require().
+- *{Object} **mocks***: An object with mocks. Keys should be the exactly same like they're required in the target module. So if you write ```require("../../myModules/myModuleA.js")``` you need to pass ```{"../../myModules/myModuleA.js": myModuleAMock}```.
+- *{Object|String} **injections***: If you pass an object, all keys of the object will be ```var```s within the module. You can also eval a string. **Please note**: All scripts are injected at the end of the module. So if there is any code in your module that is executed during ```require()```, your injected variables will be undefined at this point. For example: passing ```{console: {...}}``` will cause all calls of ```console.log()``` to throw an exception if they're executed during ```require()```.
+- *{Array&lt;String&gt;} **leaks***: An array with variable names that should be exported. These variables are accessible via ```myModule.__```
+- *{Boolean=true} **cache***: Indicates whether the rewired module should be cached by node so subsequent calls of ```require()``` will return the rewired module. Subsequent calls of ```rewire()``` will always overwrite the cache.
+
+-----------------------------------------------------------------
+
+## Credits
+
+This module is inspired by the great [injectr](https://github.com/nathanmacinnes/injectr "injectr")-module.
+
+-----------------------------------------------------------------
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2012 Johannes Ewald &lt;mail@johannesewald.de&gt;
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file