Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philmander/inverted
Javascript IOC container
https://github.com/philmander/inverted
Last synced: about 1 month ago
JSON representation
Javascript IOC container
- Host: GitHub
- URL: https://github.com/philmander/inverted
- Owner: philmander
- License: mit
- Created: 2011-05-18T18:52:38.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2015-12-20T11:21:58.000Z (about 9 years ago)
- Last Synced: 2024-11-07T08:46:57.751Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 20.4 MB
- Stars: 57
- Watchers: 8
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
#Inverted: Javascript IOC Container
See [philmander.github.com/inverted](http://philmander.github.com/inverted/) for complete end user documentation.
##Quickstart
Runs in the browser and Node.js
Download source
[Minified (~9.4kb/~3.2kb gzipped)](https://raw.github.com/philmander/inverted/master/lib/inverted-min.js)
[Uncompressed](https://raw.github.com/philmander/inverted/master/lib/inverted.js)
or
```
npm install inverted
```
In the browser, Inverted depends on a module loader being present. Out of the box it will work with
[RequireJS](http://requirejs.org) or [Curl](https://github.com/cujojs/curl). Inverted uses
a module loader to load modules and should be loaded with an AMD module loader itself. For example:
```html
requirejs.config({
baseUrl: "/src",
paths: {
inverted : "/lib/inverted-min"
}
});
require(["inverted", "app-config"], function(inverted, appConfig) {
var appContext = inverted.create(appConfig);
appContext.getProto(["protoId"], function(obj){
obj.doStuff();
});
});
```
##Issues and discussion
Please use the Github [issue tracker](https://github.com/philmander/inverted/issues) for this project to raise bugs, feature requests or just ask a question.
##Project organization
###/src
Core source code is here, split into two sub directories:
* __package__ Files added to the core source code to create a working build
* __inverted__ The main Inverted JS modules, _AppContext_ and _ProtoFactory_ and various support modules
###/lib
Final builds are placed here
###/test
Inverted's unit tests written in QUnit (with support from Q2Junit) are here
###/support
Additional libraries in Javascript and Java for build and testing
##How to build
Inverted is built using Apache Ant. The build performs the following steps:
1. Lints the source code using JSHint.
2. Runs the unit tests in Phantom JS
3. Concatenates the source files to create an unminified build
4. Compresses the unminified build using Google Closure compiler
To perform a build first install [Apache Ant](http://ant.apache.org/bindownload.cgi) on your path and, in the project root directory, run:
```
ant
```
or to run a build that includes a version number in the build's source
```
ant -Dversion=[version]
```
NB. To run on a system other than Windows you will currently need to update the ant test runner config to point
to a platform specific version of Phantom JS
##Versions
The master branch should be considered as a snapshot of the latest code.
Official releases can be found as tags.
##Changelog
###v0.2.*
* __BREAKING CHANGE__ AppContext#getProto interface has changed. More than one proto id must be now specified as an array of strings in the first argument. A single proto id may remain as a string
* Added support for mixin dependecies (issue #6)
* Added support for interfaces (issue #3)
* AppContext#getProto now returns a promise with success and failure callbacks (issue #4)
* Improved error handling
* App config now has the option to inject the app context into a proto (#2)
* Now supports circular dependencies