Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k1r0s/kaop
Advanced OOP Library with createClass, inheritance, providers, injectors, advices which enables handy Inversion of Control techniques
https://github.com/k1r0s/kaop
aop-architecture aop-aspects aspect-oriented-programming composition dependency-injection inheritance object-oriented-programming reflection
Last synced: 10 days ago
JSON representation
Advanced OOP Library with createClass, inheritance, providers, injectors, advices which enables handy Inversion of Control techniques
- Host: GitHub
- URL: https://github.com/k1r0s/kaop
- Owner: k1r0s
- Created: 2016-10-18T20:17:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:36:30.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T02:13:45.296Z (24 days ago)
- Topics: aop-architecture, aop-aspects, aspect-oriented-programming, composition, dependency-injection, inheritance, object-oriented-programming, reflection
- Language: JavaScript
- Homepage:
- Size: 521 KB
- Stars: 39
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/k1r0s/)
[](https://www.npmjs.com/package/kaop/)
[](https://coveralls.io/github/k1r0s/kaop?branch=master)
[](https://david-dm.org/k1r0s/kaop/status.svg)
[](https://www.npmjs.com/package/kaop)
[](https://www.npmjs.com/package/kaop)
[](https://snyk.io/test/npm/kaop)
Lightweight, solid, framework agnostic and **easy to use** library which provides reflection features to deal with *Cross Cutting Concerns* and improve modularity in your code.
### Try it!
Clone the repo:
`git clone https://github.com/k1r0s/kaop.git`
Run showcase:
`node showcase.js`
Run tests:
`npm test`
### Features, from bottom to top.
- ES6 class alternative
- Inheritance
- Composition
- Method Overriding
- Dependency Injection
- AOP Extensions
### Get started
```bash
npm install kaop --save
```
```javascript
import { extend } from 'kaop'
// Array.prototype.includes() polyfill
const MyArray = extend(Array, {
includes(value) {
return this.indexOf(value) > -1;
}
});
const arr = new MyArray(1, 2, 3, 4);
arr.includes(2); // true
arr.includes(5); // false
```
Easy, right? lets try something else.
Say that for calculating John Doe's age we have to waste a lot of resources so we want to apply memoization to one method.
```javascript
// create a spy function
const methodSpy = jest.fn();
const Person = createClass({
constructor(name, yearBorn) {
this.name = name;
this.age = new Date(yearBorn, 1, 1);
},
// note that `sayHello` always calls `veryHeavyCalculation`
veryHeavyCalculation: [Memoize.read, function() {
// call spy function
methodSpy();
const today = new Date();
return today.getFullYear() - this.age.getFullYear();
}, Memoize.write],
sayHello(){
return `hello, I'm ${this.name}, and I'm ${this.veryHeavyCalculation()} years old`;
}
})
// ... test it
it("cache advices should avoid 'veryHeavyCalculation' to be called more than once", () => {
const personInstance = new Person("John Doe", 1990);
personInstance.sayHello();
personInstance.sayHello();
personInstance.sayHello();
expect(methodSpy).toHaveBeenCalledTimes(1);
});
```
```javascript
// we're creating a group of advices which provides memoization
const Memoize = (function() {
const CACHE_KEY = "#CACHE";
return {
read: reflect.advice(meta => {
if(!meta.scope[CACHE_KEY]) meta.scope[CACHE_KEY] = {};
if(meta.scope[CACHE_KEY][meta.key]) {
meta.result = meta.scope[CACHE_KEY][meta.key];
meta.break();
}
}),
write: reflect.advice(meta => {
meta.scope[CACHE_KEY][meta.key] = meta.result;
})
}
})();
```
### O_O what are advices?
Advices are pieces of code that can be plugged in several places within OOP paradigm like 'beforeMethod', 'afterInstance'.. etc. Advices are used to change, extend, modify the behavior of methods and constructors non-invasively.
If you're looking for better experience using advices and vanilla ES6 classes you should check [kaop-ts](https://github.com/k1r0s/kaop-ts) which has a nicer look with ES7 Decorators.
### But this library isn't only about `Advices` right?
This library tries to provide an alternative to ES6 class constructors which can be nicer in some way but do not allow reflection (it seems that ES7 Decorators are the way to go but they're still experimental) compared to `createClass` prototyping shell which provides a nice interface to put pieces of code that allows __declarative Inversion of Control__.
### Once you have reflection...
Building Dependency Injection system is trivial. For example:
```javascript
import { createClass, inject, provider } from 'kaop'
// having the following service
const Storage = createClass({
constructor: function() {
this.store = {};
},
get: function(key){
return this.store[key];
},
set: function(key, val){
return this.store[key] = val;
}
});
// you declare a singleton provider (you can use a factory for multiple instances)
const StorageProvider = provider.singleton(Storage);
// and then you inject it in several classes
const Model1 = createClass({
constructor: [inject.args(StorageProvider), function(_storageInstance) {
this.storage = _storageInstance;
}]
});
const Model2 = createClass({
constructor: [inject.args(StorageProvider), function(_storageInstance) {
this.storage = _storageInstance;
}]
});
const m1 = new Model1;
const m2 = new Model2;
m1.storage instanceof Storage // true
m2.storage instanceof Storage // true
// and they are the same instance coz `StorageProvider` returns a single instance `singleton`
```
### TODO
Way more documentation about Aspect Oriented, Dependency Injection, Composition, Asynchronous Advices, etc.
Tests are the most useful documentation nowadays, that should change soon.
### Similar resources
- [mgechev/aspect.js](https://github.com/mgechev/aspect.js)
- [cujojs/meld](https://github.com/cujojs/meld)
- [kaop-ts](https://github.com/k1r0s/kaop-ts)