@fedeghe/pangjs 0.0.1 → 0.0.3

package/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis
+repo_token: s70zTJdyYdnFJD63dVSg9iCovgQ80azIz

package/.travis.yml

@@ -0,0 +1,7 @@
+install: yarn
+language: node_js
+script: yarn test
+after_success:
+- yarn coveralls
+node_js:
+  - "10.12.0"

package/README.md

@@ -1,7 +1,8 @@
-# PANGjs (0.0.1)
+# PANGjs (0.0.3)
 
-![alt text](./pangjs.png "Pang js")
+![alt text](https://github.com/fedeghe/pangjs/blob/main/pangjs.png?raw=true "Pang js")
 
+[![Coverage Status](https://coveralls.io/repos/github/fedeghe/pangjs/badge.svg?branch=main)](https://coveralls.io/github/fedeghe/pangjs?branch=main)
 
 # Simple asynchronous state manager
 
@@ -14,11 +15,10 @@ All we need to do now is to:
 - define an asynchronous reducer as:
     ``` js
     const reducer = async (oldState, action, payload) => {
-        const res = await fetch(targetUrl),
-            newstate = {
-                ...oldState,
-                // your updates
-            }
+        const res = await fetch(targetUrl);
+        //
+        // your updates 
+        // 
         return newState
     }
     ```
@@ -27,22 +27,19 @@ All we need to do now is to:
 now it's time to get a store and use it:
 
 
-``` js
-const store = PANGjs.getStore(
-    reducer,
-    initState
-);
+``` js  
+const store = PANGjs.getStore( reducer, initState );
 
 // commit, change it only internally
 store.commit({
-        type: 'ADD',
-        payload: { number: 4 }
-    })
-    .then(s => console.log(
-        'here we get the unpushed state:', s
-    ));
-
-// to push the changes to be effective we have to push
+    type: 'ADD',
+    payload: { number: 4 }
+})
+.then(s => console.log(
+    'here we get the unpushed state:', s
+));
+
+// for the changes to be effective we have to push
 store.push()
     // here we get the pushed state
     .then(console.log);
@@ -50,12 +47,19 @@ store.push()
 alternatively one single call just adding `true` as second parameter (semantically is 'autocommit'): 
 ``` js
 store.commit({
-        type: 'ADD',
-        payload: { number: 4 }},
-        true // autoCommit changes
-    )
-    // here we get autopushed state
-    .then(console.log);
+    type: 'ADD',
+    payload: { number: 4 }
+}, true /* autocommit */) 
+.then(console.log); // here we get autopushed state
+```
+
+alternatively it is possible to directly push the action:
+``` js
+store.push({
+    type: 'ADD',
+    payload: { number: 4 }},
+)
+.then(console.log); // here we get the state
 ```
 
 ---
@@ -116,27 +120,62 @@ the resulting combined reducer
 
 ### `PANGjs.isStore(toBeChecked)`
 
-Parameters: 
+**Parameters**: 
 - **toBeChecked**:
     what needs to be checked if it is a PANGjs store or not
 
 ---
 
-# store API
+# store
 
-Every store obtained invoking successfully `PANGjs.getStore` exposes the following (more details will come):
+Every store obtained invoking successfully `PANGjs.getStore` exposes the following:
 
-### `storeInstance.getState() -> state (last pushed)`
+### `storeInstance.getState() -> state`
 
-### `storeInstance.commit(action, autoPush) -> Promise resolved with new state (pushed or not)`
+returns the last pushed state
 
-### `storeInstance.push() -> Promise resolved with new pushed state`
-- calls subscribers 
+### `storeInstance.commit(action, autoPush) -> Promise`
+
+commit or commit&push returning a promise resolving with new state (pushed or not); 
+
+**Parameters**: 
+- **action**:
+    ```js
+    {
+        type: <String>,
+        payload: <Object>
+    }
+    ```
+- autoPush `<Boolean>` default `false`
 
-### `storeInstance.suubscribe(fn) -> unsubscribing function`
+
+
+### `storeInstance.push() -> Promise`
+push all the committed but unpushed changes.  
+Only this operations calls subscribers.  
+
+Optionally it can recieve an action and that will be equivalent to commit and push:  
+`s.commit(action).then(() => s.push())`  
+act as
+`s.commit(action, true)`  
+and as
+`s.push(action))`
+
+
+### `storeInstance.subscribe(fn) -> unsubscribing function`
+
+allows to register a subscribing function that will be invoked everytime the state changes (pushed)  
+
+**returns**:  the unsubscribing function
 
 ### `storeInstance.replaceReducer(fn) -> store instance`
 
+replace the store reducer
+
 ### `storeInstance.move(int) -> store instance`
 
-### `storeInstance.reset() -> store instance`
+in case the history is active allows to move in the states
+
+### `storeInstance.reset() -> store instance`
+
+reset the store to its initial state

package/dist/index.js

@@ -1,28 +1,29 @@
 'use strict';
 /*
 PANGjs
-v. 0.0.1
-8:3:34
-Size: ~3.63KB
+v. 0.0.3
+
+Size: ~3.82KB
 */
-var PANGjs=function(){"use strict";function t(t,e){if("function"!=typeof t)throw new Error(e)}function e(t,e){if("Promise"!==t.constructor.name)throw new Error(e)}function s(t,e){
-if("number"!=typeof t)throw new Error(e)}function n(t,e){this.states=[t||{}],this.unpushedStates=[t||{}],this.config=e||{},this.maxElements=this.config.maxElements||!1,
-this.maxElements=Math.max(0,parseInt(this.config.maxElements,0))||!1,this.index=0,this.unpushedIndex=0}function i(e,s,i){this.reducer=e||o,t(this.reducer,r.REDUCERS_FUNCTION),this.initState=s||{},
-this.config=i||{},this.config.check=this.config.check||function(){return!0},t(this.config.check,r.REDUCERS_FUNCTION),this.subscribers=[],this.previousAction="ORIGIN",
-this.HistoryManager=new n(this.initState,this.config)}var r={REDUCERS_FUNCTION:"[ERROR] Reducer must be a function!",REDUCERS_RETURN:"[ERROR] Reducer should return a promise!",
-REDUCERS_ASYNC:"[ERROR] Reducer should be asynchronous!",SUBSCRIBERS_FUNCTION:"[ERROR] Subscribers must be a functions!",ACTION_TYPE:"[ERROR] Actions needs a type",
-UNAUTHORIZED_STATECHANGE:"[ERROR] State transition not allowed",MOVE_TO_NUMBER:"[ERROR] Move requires a number"};n.prototype.top=function(t){
-return this[t?"unpushedStates":"states"][this[t?"unpushedIndex":"index"]]},n.prototype.commit=function(t,e){var s=this.unpushedStates.slice(0,this.unpushedIndex+1);return s.push(t),
-this.maxElements&&s.length>this.maxElements?s.shift():this.unpushedIndex++,this.unpushedStates=s,e&&this.push(),this},n.prototype.push=function(){this.states=this.unpushedStates,
-this.index=this.unpushedIndex},n.prototype.reset=function(){this.index=0,this.states=this.states.slice(0,1),this.unpushedIndex=0,this.unpushedStates=this.unpushedStates.slice(0,1)};var o=function(){
-return Promise.resolve({})};return i.prototype.getState=function(t){return this.HistoryManager.top(t)},i.prototype.uncommit=function(){this.HistoryManager.unpushedIndex=this.HistoryManager.index,
-this.HistoryManager.unpuhedStates=this.HistoryManager.states},i.prototype.commit=function(t,s){if(!("type"in t))return Promise.reject(r.ACTION_TYPE)
-;var n=this,i=t.type,o=t.payload||{},u=this.getState(!0);if(!n.config.check(u,n.previousAction,i,o))return Promise.reject(r.UNAUTHORIZED_STATECHANGE);var h=this.reducer(u,i,o)
-;return e(h,r.REDUCERS_RETURN),this.previousAction=i,h.then(function(t){return n.HistoryManager.commit(t,s),t})},i.prototype.push=function(){this.HistoryManager.push();var t=this.HistoryManager.top()
-;return this.subscribers.filter(function(t){return Boolean(t)}).forEach(function(e){e(t)}),Promise.resolve(t)},i.prototype.subscribe=function(e){t(e,r.SUBSCRIBERS_FUNCTION);var s,n=this
-;return this.subscribers.push(e),s=this.subscribers.length-1,function(){n.subscribers[s]=null}},i.prototype.move=function(t){if(s(t,r.MOVE_TO_NUMBER),
-this.HistoryManager.index!==this.HistoryManager.unpushedIndex||void 0===t||0===t)return this;var e=this.HistoryManager.index+t,n=e>-1&&e<this.HistoryManager.states.length,i=n?e:this.currentIndex
-;return this.HistoryManager.index=i,this.HistoryManager.unpushedIndex=i,this},i.prototype.replaceReducer=function(t){this.reducer=t||o},i.prototype.reset=function(){this.HistoryManager.reset(),
-this.subscribers=[]},{ERRORS:r,getStore:function(t,e,s){return new i(t,e,s)},isStore:function(t){return t instanceof i},combine:function(e){return e.forEach(function(e){t(e,r.REDUCERS_FUNCTION)}),
-function(t,s,n){t=t||initState;var i=Object.assign({},t),r=e.length;return new Promise(function(t){return e.reduce(function(e,i,o){return e.then(function(e){return r-1===o?t(i(e,s,n)):i(e,s,n)})
-},Promise.resolve(i))})}}}}();"object"==typeof exports&&(module.exports=PANGjs);
+var PANGjs=function(){"use strict";function t(t,e){if("function"!=typeof t)throw new Error(e)}function e(t,e){if("Promise"!==t.constructor.name)throw new Error(e)}function n(t,e){
+if("number"!=typeof t)throw new Error(e)}function i(t,e){this.initState=t,this.states=[t],this.unpushedStates=[t],this.config=e,this.maxElements=Math.max(1,parseInt(this.config.maxElements,10))||1,
+this.index=0,this.unpushedIndex=0}function s(e,n,s){this.reducer=e||o,t(this.reducer,r.REDUCERS_FUNCTION),this.initState=n||{},this.config=s||{},this.config.check=this.config.check||function(){
+return!0},t(this.config.check,r.REDUCERS_FUNCTION),this.subscribers=[],this.previousAction="ORIGIN",this.HistoryManager=new i(this.initState,this.config)}var r={
+REDUCERS_FUNCTION:"[ERROR] Reducer must be a function!",REDUCERS_RETURN:"[ERROR] Reducer should return a promise!",REDUCERS_ASYNC:"[ERROR] Reducer should be asynchronous!",
+SUBSCRIBERS_FUNCTION:"[ERROR] Subscribers must be a functions!",ACTION_TYPE:"[ERROR] Actions needs a type!",UNAUTHORIZED_STATECHANGE:"[ERROR] State transition not allowed!",
+MOVE_TO_NUMBER:"[ERROR] Move requires a number!"};i.prototype.top=function(t){return this[t?"unpushedStates":"states"][this[t?"unpushedIndex":"index"]]},i.prototype.commit=function(t,e){
+var n=this.unpushedStates.slice(0,this.unpushedIndex+1);return n.push(t),this.maxElements&&n.length>this.maxElements?n.shift():this.unpushedIndex++,this.unpushedStates=n,e&&this.push(),this},
+i.prototype.push=function(){this.states=this.unpushedStates,this.index=this.unpushedIndex},i.prototype.reset=function(){this.index=0,this.states=[this.initState],this.unpushedIndex=0,
+this.unpushedStates=this.unpushedStates.slice(0,1)};var o=function(){return Promise.resolve({})};return s.prototype.getState=function(t){return this.HistoryManager.top(t)},
+s.prototype.uncommit=function(){if(1===this.HistoryManager.maxElements)return this;this.HistoryManager.unpushedIndex=this.HistoryManager.index,
+this.HistoryManager.unpuhedStates=this.HistoryManager.states},s.prototype.commit=function(t,n){if(!("type"in t))return Promise.reject(new Error(r.ACTION_TYPE))
+;var i=this,s=t.type,o=t.payload||{},u=this.getState(!0);if(!i.config.check(u,i.previousAction,s,o))return Promise.reject(new Error(r.UNAUTHORIZED_STATECHANGE));var h=this.reducer(u,s,o)
+;return e(h,r.REDUCERS_RETURN),this.previousAction=s,h.then(function(t){return i.HistoryManager.commit(t,n),n&&i.emit(t),t})},s.prototype.emit=function(t){this.subscribers.filter(function(t){
+return Boolean(t)}).forEach(function(e){e(t)})},s.prototype.push=function(t){if(t)return this.commit(t,!0);this.HistoryManager.push();var e=this.HistoryManager.top();return this.emit(e),
+Promise.resolve(e)},s.prototype.subscribe=function(e){t(e,r.SUBSCRIBERS_FUNCTION);var n,i=this;return this.subscribers.push(e),n=this.subscribers.length-1,function(){i.subscribers[n]=null}},
+s.prototype.move=function(t){if(n(t,r.MOVE_TO_NUMBER),1===this.HistoryManager.maxElements||this.HistoryManager.index!==this.HistoryManager.unpushedIndex||void 0===t||0===t)return this
+;var e=this.HistoryManager.index+t,i=e>-1&&e<this.HistoryManager.states.length,s=i?e:this.HistoryManager.index;return this.HistoryManager.index=s,this.HistoryManager.unpushedIndex=s,this},
+s.prototype.replaceReducer=function(e){return t(e,r.SUBSCRIBERS_FUNCTION),this.reducer=e,this},s.prototype.reset=function(){return this.HistoryManager.reset(),this.subscribers=[],this},{ERRORS:r,
+getStore:function(t,e,n){return new s(t,e,n)},isStore:function(t){return t instanceof s},combine:function(e){return e.forEach(function(e){t(e,r.REDUCERS_FUNCTION)}),function(t,n,i){
+var s=Object.assign({},t),r=e.length;return new Promise(function(t){return e.reduce(function(e,s,o){return e.then(function(e){return r-1===o?t(s(e,n,i)):s(e,n,i)})},Promise.resolve(s))})}}}}()
+;"object"==typeof exports&&(module.exports=PANGjs);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedeghe/pangjs",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "author": "fedeghe <fedeghe@gmail.com>",
   "license": "MIT",
@@ -9,8 +9,8 @@
     "dev": "malta source/buildev.json",
     "test": "jest --coverage --rootDir=test",
     "watch": "jest --watch --coverage --rootDir=test",
-    "cover": "jest --coverage --rootDir=test",
-    "coveralls": "jest --coverage --rootDir=test | coveralls"
+    "cover": "jest --coverage --rootDir=test  --coverageReporters=text",
+    "coveralls": "jest --coverage --rootDir=test --coverageReporters=text && cat ./test/coverage/lcov.info | coveralls"
   },
   "devDependencies": {
     "coveralls": "^3.1.1",
@@ -24,6 +24,15 @@
     "malta": "^4.1.41",
     "malta-header-comment": "^1.0.12",
     "malta-js-uglify": "^1.0.13",
+    "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^17.1.0"
+  },
+  "jest": {
+    "collectCoverage": true,
+    "coverageReporters": [
+      "json",
+      "lcov",
+      "html"
+    ]
   }
 }