Merge pull request #7 from nblum/feature/NonSingletonPluginManager

dropdevcoding · dropdevcoding · commit 15645352388f · 2016-05-05T19:00:06.000+02:00
Changed PluginManager Module to return a constructor instead of a singleton so multiple instances may be created on one page (e.g. when writing CMS Modules)
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -13,7 +13,7 @@ module.exports = function (grunt) {
             mnty: {
                 options: {
                     baseUrl: 'src',
-                    name: 'AutoLoader',
+                    name: 'AutoLoader',git
                     out: 'dist/mnty.js',
                     optimize: 'uglify2',
                     preserveLicenseComments: true,
diff --git a/README.md b/README.md
@@ -338,51 +338,7 @@ Building means all js files will be packed together to one minified file.
 This reduces the page load time of your web page.
 
 ### Building your project with grunt
-The easiest way is to use the [grunt-mntyjs](https://www.npmjs.com/package/grunt-mntyjs) package.
-
- - install grunt-cli ```npm install -g grunt-cli```
- - install grunt-mntyjs ```npm install bitexpert/mntyjs --save-dev```
- 
-Create a basic grunt file
-```js
-    module.exports = function (grunt) {
-        'use strict';
-        
-        grunt.loadNpmTasks('grunt-mntyjs');
-    
-        grunt.initConfig({
-            mntyjs: {
-                files: ['path/to/html/files/**/*.html'],
-                options: {
-                    baseUrl: './',
-                    deps: ['bower_components/mntyjs/dist/mnty.js'],
-                    loadFrom: 'relative/path/to/plugin/folder/',
-                    mountPoint: 'mount',
-                    out: 'path/to/production/file/main.js'
-                }
-            }
-        });
-        grunt.registerTask('build', [
-            'mntyjs'
-        ]);
-    };
-```
-
-Run ```grunt build``` to build the production file.
-The grunt task will find all used plugins (in the file urls) and it's dependencies.
-
-If paths cannot be resolved due the usage of a config file. It is possible to add
-the path and shim config directly to the options.
-
-```js
-    options: {
-        paths: {
-            #the path has to be relative from the grunt file
-            'bar': 'bower_components/foo/bar'
-        }
-    }
-```
-
+The easiest way is to use the [grunt-mntyjs](https://github.com/bitExpert/grunt-mntyjs) [package](https://www.npmjs.com/package/grunt-mntyjs).
 
 
 
diff --git a/dist/mnty.dev.js b/dist/mnty.dev.js
diff --git a/dist/mnty.dev.js.map b/dist/mnty.dev.js.map
diff --git a/dist/mnty.js b/dist/mnty.js
diff --git a/doc/Base.html b/doc/Base.html
@@ -28,9 +28,7 @@ <h1 class="page-title">Class: Base</h1>
 
 <header>
     
-        <h2>
-        Base
-        </h2>
+        <h2>Base</h2>
         
     
 </header>
@@ -454,7 +452,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Base.js.html b/doc/Base.js.html
@@ -198,7 +198,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/FnUtils.js.html b/doc/FnUtils.js.html
@@ -89,7 +89,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Logging.js.html b/doc/Logging.js.html
@@ -61,7 +61,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Observable.html b/doc/Observable.html
@@ -28,9 +28,7 @@ <h1 class="page-title">Class: Observable</h1>
 
 <header>
     
-        <h2>
-        Observable
-        </h2>
+        <h2>Observable</h2>
         
     
 </header>
@@ -1711,7 +1709,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Observable.js.html b/doc/Observable.js.html
@@ -214,7 +214,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/OptionParser.js.html b/doc/OptionParser.js.html
@@ -81,7 +81,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Plugin.html b/doc/Plugin.html
@@ -28,9 +28,7 @@ <h1 class="page-title">Class: Plugin</h1>
 
 <header>
     
-        <h2>
-        Plugin
-        </h2>
+        <h2>Plugin</h2>
         
     
 </header>
@@ -4052,7 +4050,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Plugin.js.html b/doc/Plugin.js.html
@@ -421,7 +421,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/PluginManager.js.html b/doc/PluginManager.js.html
@@ -585,7 +585,7 @@ <h1 class="page-title">Source: PluginManager.js</h1>
         }
     });
 
-    return new PluginManager();
+    return PluginManager;
 });
 </code></pre>
         </article>
@@ -603,7 +603,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/StringUtils.js.html b/doc/StringUtils.js.html
@@ -94,7 +94,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/Window.js.html b/doc/Window.js.html
@@ -50,7 +50,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/index.html b/doc/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/module-FnUtils.html b/doc/module-FnUtils.html
@@ -522,7 +522,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/module-Logging.html b/doc/module-Logging.html
@@ -152,7 +152,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/module-OptionParser.html b/doc/module-OptionParser.html
@@ -307,7 +307,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/module-PluginManager.html b/doc/module-PluginManager.html
@@ -3858,7 +3858,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/module-StringUtils.html b/doc/module-StringUtils.html
@@ -619,7 +619,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/doc/module-Window.html b/doc/module-Window.html
@@ -150,7 +150,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Fn
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-beta3</a> on Mon Apr 27 2015 14:21:30 GMT+0200 (CEST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Apr 28 2016 11:56:36 GMT+0200 (CEST)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/package.json b/package.json
@@ -1,34 +1,34 @@
 {
-    "name": "mntyjs",
-    "version": "1.1.4",
-    "description": "A lightweight pluginsystem for websites",
-    "main": "Gruntfile.js",
-    "directories": {
-        "doc": "doc"
-    },
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1"
-    },
-    "keywords": [
-        "JavaScript",
-        "Plugins"
-    ],
-    "author": "Peter Hildenbrand",
-    "license": "proprietary",
-    "devDependencies": {
-        "bitexpert-cs-jscs": "^0.1.0",
-        "bitexpert-cs-jshint": "^0.1.0",
-        "grunt": "0.4.x",
-        "grunt-cli": "0.1.x",
-        "grunt-jsdoc": "^0.6.1",
-        "grunt-contrib-requirejs": "^0.4.4",
-        "grunt-contrib-watch": "^0.6.1",
-        "grunt-jscs": "0.7.x",
-        "grunt-contrib-jshint": "^0.9.2",
-        "grunt-jsdoc": "^0.6.1",
-        "grunt-newer": "^0.7.0",
-        "grunt-notify": "^0.3.1",
-        "jshint-jenkins-checkstyle-reporter": "0.1.x",
-        "load-grunt-tasks": "^0.6.0"
-    }
+  "name": "mntyjs",
+  "version": "1.1.4",
+  "description": "A lightweight pluginsystem for websites",
+  "main": "Gruntfile.js",
+  "directories": {
+    "doc": "doc"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "JavaScript",
+    "Plugins"
+  ],
+  "author": "Peter Hildenbrand",
+  "license": "proprietary",
+  "devDependencies": {
+    "bitexpert-cs-jscs": "^0.1.0",
+    "bitexpert-cs-jshint": "^0.1.0",
+    "grunt": "0.4.x",
+    "grunt-cli": "0.1.x",
+    "grunt-contrib-jshint": "^0.9.2",
+    "grunt-contrib-requirejs": "^0.4.4",
+    "grunt-contrib-watch": "^0.6.1",
+    "grunt-jscs": "0.7.x",
+    "grunt-jsdoc": "^0.6.1",
+    "grunt-newer": "^0.7.0",
+    "grunt-notify": "^0.3.1",
+    "jquery": "^2.2.3",
+    "jshint-jenkins-checkstyle-reporter": "0.1.x",
+    "load-grunt-tasks": "^0.6.0"
+  }
 }
diff --git a/src/AutoLoader.js b/src/AutoLoader.js
@@ -5,20 +5,24 @@
  */
 require(['PluginManager', 'OptionParser', 'jquery', 'Window'], function (PluginManager, OptionParser, $, Window) {
 
-    var config = $('script[data-mntyjs]').data('mntyjs');
+    var manager = new PluginManager(),
+        config = $('script[data-mntyjs]').data('mntyjs'),
+        root;
 
     config = OptionParser.parse(config);
 
+    root = config.root ? $(config.root).get(0) : Window.document;
+
     if (config.autoMount !== false) {
         $(Window.document).ready(function () {
-            PluginManager.reconfigure(config);
-            PluginManager.mount(Window.document);
+            manager.reconfigure(config);
+            manager.mount(root);
         });
     }
 
     if (config.autoUnmount !== false) {
         $(Window).on('beforeunload', function () {
-            PluginManager.unmount(Window.document);
+            manager.unmount(root);
         });
     }
 });
diff --git a/src/PluginManager.js b/src/PluginManager.js
@@ -557,5 +557,5 @@ define(['Observable', 'Plugin', 'OptionParser', 'StringUtils', 'Logging', 'jquer
         }
     });
 
-    return new PluginManager();
+    return PluginManager;
 });
