Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/techjacker/mitsubishi

Mixin utilities for extending prototypes
https://github.com/techjacker/mitsubishi

Last synced: 15 days ago
JSON representation

Mixin utilities for extending prototypes

Awesome Lists containing this project

README 

        
# mitsubishi



Mixin utilities for extending prototypes



[![Build Status](https://secure.travis-ci.org/techjacker/mitsubishi.png)](http://travis-ci.org/techjacker/mitsubishi)



[![Sauce Labs Browser Test Status](https://saucelabs.com/buildstatus/mitsubishi)](https://saucelabs.com/u/mitsubishi)

[![Sauce Labs Browser Test Status](https://saucelabs.com/browser-matrix/mitsubishi.svg)](https://saucelabs.com/u/mitsubishi)



### Install



#### Node



```Shell

npm install mitsubishi

```



#### Browser



```Shell

component install mitsubishi

```



```Shell

bower install mitsubishi

```



## Usage



#### mitsubishi.props(class, [classes])



Mixin JUST instance props (not proto props) from Obj literals + Classes.



```JavaScript

var myStaticClass = {};



/* .mixinInstanceProps() */

mitsubishi.props(myStaticClass, [{hello:true}, {world:true}]);



console.log('myStaticClass', myStaticClass);

// outputs: {{hello:true, world:true}

```



#### mitsubishi.proto(class, [classes])



Mixin proto props of UNinstantiated Classes (and Obj literals) NOT instance props



```JavaScript

var myDynamicClass = function () {};

var parentDynamicClass = function () {};



parentDynamicClass.prototype.awesome = blah;



mitsubishi.proto(myDynamicClass, [parentDynamicClass, {world:true}]);



console.log('myDynamicClass', myDynamicClass);

// outputs: {{awesome:"blah", world:true}

```



#### mitsubishi.protoInstantiated(class, [classes])



Mixin proto props of INSTANTIATED Classes (and Obj literals) NOT instance props



```JavaScript

var myDynamicClass = function () {};

var parentDynamicClass = function () {};



parentDynamicClass.prototype.awesome = blah;

myDynamicClass.hello = true;



mitsubishi.protoInstance(myDynamicClass, [(new parentDynamicClass), {world:true}]);



console.log('myDynamicClass', myDynamicClass);

// outputs: {{awesome:"blah", world:true, hello:true}

```



### Docs

[Yuidocs documentation here](docs/index.html)

- fire up the connect server ```$ grunt docs```

- navigate your browser to the [docs](http://localhost:9001)



### API

   - [mitsubishi](#mitsubishi)



 



### mitsubishi

should export all needed API methods.



```js

expect(mitsubishi).to.only.have.keys('proto', 'protoInstantiated', 'props', 'instancePropsFromInstantiated', 'protoPropsFromInstantiated', 'protoPropsFromUninstantiated');

done();

```



##### mitsubishi.instancePropsFromInstantiated() - copy instance properties from instantiated dynamic classes as well as object literals.



```js

expect(mitsubishi.instancePropsFromInstantiated({}, [fixtures.A, fixtures.C])).to.only.have.keys('foo', 'bar', 'marbel');

expect(mitsubishi.instancePropsFromInstantiated({}, [fixtures.A, fixtures.B])).to.only.have.keys('foo', 'bar');

expect(mitsubishi.instancePropsFromInstantiated({}, fixtures.A)).to.only.have.keys('foo', 'bar');

expect(mitsubishi.instancePropsFromInstantiated({}, [fixtures.A, (new fixtures.B)])).to.only.have.keys('foo', 'bar', 'blah');

expect(mitsubishi.instancePropsFromInstantiated({}, [(new fixtures.B), fixtures.C])).to.only.have.keys('blah', 'marbel');



// doesn't mix in proto props

expect(mitsubishi.instancePropsFromInstantiated({}, (new fixtures.B()))).to.not.have.key('protoproperty');



done();

```



##### mitsubishi.protoPropsFromInstantiated() - copy poto properties from dynamic classes (if instantiated) as well as object literals.



```js

expect(mitsubishi.protoPropsFromInstantiated({}, [fixtures.A, fixtures.C])).to.have.key('foo', 'bar', 'marbel');

expect(mitsubishi.protoPropsFromInstantiated({}, [(new fixtures.B()), fixtures.C])).to.have.key('marbel');

expect(mitsubishi.protoPropsFromInstantiated({}, (new fixtures.B()))).to.have.key('protoproperty');



///////////////////////////////////////////////////////////////////////////////////////////

// MUST BE AN INSTANCE OF A DYNAMIC CLASS

// to add a prototype of an uninstantiated dynamic class then....

// use instancePropsFromInstantiated and....

// directly reference its prototype

/////////////////////////////////////////////////////////////////////////////////////////////

expect(mitsubishi.protoPropsFromInstantiated({}, fixtures.B)).to.not.have.key('protoproperty');

expect(mitsubishi.instancePropsFromInstantiated({}, fixtures.B.prototype)).to.have.key('protoproperty');

// better to use .protoPropsFromUninstantiated()

expect(mitsubishi.protoPropsFromUninstantiated({}, fixtures.B)).to.have.key('protoproperty');

done();

```



##### mitsubishi.protoPropsFromUninstantiated() - copy poto properties from dynamic classes (if UNinstantiated) as well as object literals.



```js

// dynamic classes

		var res = function () {};

		 mitsubishi.protoPropsFromUninstantiated(res.prototype, fixtures.B);

		expect(res.prototype).to.have.key('protoproperty');

// works with object literals too

		expect(mitsubishi.protoPropsFromUninstantiated({}, fixtures.B)).to.have.key('protoproperty');

		done();

```



should not copy instance props when using proto methods.



```js

fixtures.B.bull = true;

BInst = new fixtures.B;

BInst.cow = true;

// expect(mitsubishi.protoPropsFromUninstantiated({}, BI)).to.not.have.key('bull');

expect(mitsubishi.protoPropsFromUninstantiated({}, fixtures.B)).to.not.have.key('bull');

expect(mitsubishi.instancePropsFromInstantiated({}, fixtures.B)).to.have.key('bull');

expect(mitsubishi.protoPropsFromInstantiated({}, fixtures.B)).to.not.have.key('bull');

expect(mitsubishi.instancePropsFromInstantiated({}, BInst)).to.have.key('cow');

expect(mitsubishi.protoPropsFromInstantiated({}, BInst)).to.not.have.key('cow');

```



## License

Copyright (c) 2013 Andrew Griffiths 



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.