Define namespaces as constructor functions (or any object).
Clone or download
Latest commit c310be8 Apr 7, 2015
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test Change code style. Apr 7, 2015
.gitignore Ignore node modules. Apr 7, 2015
README.md Updated README with Module.wrapper usage. Jul 22, 2013
bower.json Set description. Apr 7, 2015
module.js Change code style. Apr 7, 2015
module.min.js Bump up version. Apr 7, 2015

README.md

Module.js

Define namespaces as constructor functions (or any object).

Usage

Create a new module.

Module("Todo.Application", function(Application){
  Application.fn.initialize = function() {
    // execute something when initializing the object.
  };
});

var app = new Todo.Application();
    app = Todo.Application(); // the new keyword is optional.

Define namespace with custom objects.

Module("Todo.config", function(config){
  config.assets = "/assets";
}, {});

Define namespace without a callback.

Module("Todo.config", {});

You can fetch a namespace using Module.fetch, which returns the module or null.

var action = Module.fetch("MyApp.SignupController.New");

If you want to execute a module you can use the Module.run function, which will execute the module (when defined) and return the instance.

var actionInstance = Module.run("MyApp.SignupController.New");

You may want to provide your own wrapper, with default initialization. You can use Module.wrapper for this.

Module.wrapper("Model", function(namespace, callback){
  Module(namespace, function(Model){
    Model.fn.initialize = function(attributes) {
      this.assign(attributes);
    };

    Model.fn.assign = function(attributes) {
      for (var name in attributes) {
        this[name] = attributes[name];
      }
    };

    callback(Model);
  });
});

Now you can just call Model and brand new model function will be defined.

Model("Todo.Task", function(Task){
  Task.fn.isPending = function() {
    return this.status === "pending";
  };
});

var task = Todo.Task({status: "pending"});
console.log(task.isPending()); // true

Maintainer

Contributing

Once you've made your great commits:

  1. Fork Module.js
  2. Create a topic branch - git checkout -b my_branch
  3. Push to your branch - git push origin my_branch
  4. Create an Issue with a link to your branch
  5. That's it!

Please respect the indentation rules and code style. And use 2 spaces, not tabs. And don't touch the versioning thing.

Running tests

Just open the file test/tests.html in your target browser.

License

(The MIT License)

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.