Fixed typo: performPostRequst -> performPostRequest

README.md

@@ -19,11 +19,11 @@ The easiest way to get a glimpse of what Ladda can do is checking out our [demos
 
 # Get Started
 
-Check out the [guide](/docs/GettingStarted.md) for getting started. In addition, you can have a look in the [examples folder](https://github.com/petercrona/ladda/tree/master/examples). These are standalone examples where you only need to follow the README.md to setup the project. There is an addtional minimal example, where you can find everything in one file, that you can clone and run: Check out [ladda-example-mini-project](https://github.com/petercrona/ladda-example-mini-project) ([code](https://github.com/petercrona/ladda-example-mini-project/blob/master/script.js)).
+Check out the [guide](/docs/GettingStarted.md) for getting started. In addition, you can have a look in the [examples folder](https://github.com/ladda-js/ladda/tree/master/examples). These are standalone examples where you only need to follow the README.md to setup the project. There is an addtional minimal example, where you can find everything in one file, that you can clone and run: Check out [ladda-example-mini-project](https://github.com/petercrona/ladda-example-mini-project) ([code](https://github.com/petercrona/ladda-example-mini-project/blob/master/script.js)).
 
 # Documentation
 
-The documentation gives you an [exhaustive overview of Ladda](https://petercrona.gitbooks.io/ladda/content/).
+The documentation gives you an [exhaustive overview of Ladda](https://www.ladda.io/).
 
 # Why Use Ladda?
 
@@ -35,7 +35,7 @@ Ladda is a lightweight library and comes with no additional dependencies. The li
 
 ## Quality
 
-Ladda has a high test coverage (**100%** line coverage) with tests constantly being added. And yes, we know that high test coverage is a "feel good" number, our focus is still on meaningful and good tests. It has a reasonably simple architecture and often tries to stay [tacit](https://www.youtube.com/watch?v=seVSlKazsNk&feature=youtu.be) and concise by taking inspiration from [functional programming](https://drboolean.gitbooks.io/mostly-adequate-guide/content/). We urge you to check out the [source code](https://github.com/petercrona/ladda/tree/master/src). You can help us to improve it further or just enjoy reading functional JavaScript.
+Ladda has a high test coverage (**100%** line coverage) with tests constantly being added. And yes, we know that high test coverage is a "feel good" number, our focus is still on meaningful and good tests. It has a reasonably simple architecture and often tries to stay [tacit](https://www.youtube.com/watch?v=seVSlKazsNk&feature=youtu.be) and concise by taking inspiration from [functional programming](https://drboolean.gitbooks.io/mostly-adequate-guide/content/). We urge you to check out the [source code](https://github.com/ladda-js/ladda/tree/master/src). You can help us to improve it further or just enjoy reading functional JavaScript.
 
 ## Standalone
 

docs/advanced/Plugins.md

@@ -126,17 +126,20 @@ following shape:
 
 ```javascript
 {
-  type: 'UPDATE' | 'REMOVE',
+  operation: 'CREATE' | 'READ' | 'UPDATE' | 'DELETE' | 'NO_OPERATION',
   entity: EntityName,
-  entities: EntityValue[]
+  apiFn: ApiFunctionName,
+  args: Any[] | null
+  values: EntityValue[],
 }
 ```
 
-At this point in time there is no difference made between adding new
-EntityValues and updating already present ones: Both events lead to a
-change of the type `UPDATE`.
-The `entities` field is guaranteed to be a list of EntityValues, even if
-a change only affects a single entity.
+It provides all information about which call triggered a change,
+including the arguments array.
+
+The `values` field is guaranteed to be a list of EntityValues, even if
+a change only affects a single entity. The only expection are
+`NO_OPERATION` operations, which will always return `null` here.
 
 `addChangeListener` returns a deregistration function. Call it to stop
 listening for changes.
@@ -209,7 +212,8 @@ with two fields:
   applied and an additional `name` property is present to identify it.
 - `fn` is the original __ApiFunction__ we want to act on. It has all
   meta data attached, that was defined in the build configuration,
-including defaults.
+including defaults. In addition Ladda's `build` function also added the
+property `fnName`, so that we can easily identify it.
 
 With this comprehensive information we can easily add additional
 behavior to an ApiFunction.
@@ -228,14 +232,14 @@ export const logger = (pluginConfig = {}) => {
 
     return ({ entity, fn }) => {
       return (...args) => {
-        console.log(`Ladda: Calling ${entity.name}.${fn.name} with args`, args);
+        console.log(`Ladda: Calling ${entity.name}.${fn.fnName} with args`, args);
         return fn(...args).then(
           (res) => {
-            console.log(`Ladda: Resolved ${entity.name}.${fn.name} with`, res);
+            console.log(`Ladda: Resolved ${entity.name}.${fn.fnName} with`, res);
             return res;
           },
           (err) => {
-            console.log(`Ladda: Rejected ${entity.name}.${fn.name} with`, err)
+            console.log(`Ladda: Rejected ${entity.name}.${fn.fnName} with`, err)
             return Promise.reject(err);
           }
         );
@@ -249,7 +253,7 @@ We issue a first log statement immediately when the function is invoked
 and print out the arguments we received. By using the entity
 configuration we got passed in and the meta data of the ApiFunction we
 can produce a nice string to reveal which function just got called:
-`${entity.name}.${fn.name}`. This could for example produce
+`${entity.name}.${fn.fnName}`. This could for example produce
 something like `user.getAll`.
 
 We then use Promise chaining to intercept the result of our original
@@ -282,14 +286,14 @@ export const logger = (pluginConfig = {}) => {
 
     return ({ entity, fn }) => {
       return (...args) => {
-        console.log(`Ladda: Calling ${entity.name}.${fn.name} with args`, args);
+        console.log(`Ladda: Calling ${entity.name}.${fn.fnName} with args`, args);
         return fn(...args).then(
           (res) => {
-            console.log(`Ladda: Resolved ${entity.name}.${fn.name} with`, res);
+            console.log(`Ladda: Resolved ${entity.name}.${fn.fnName} with`, res);
             return res;
           },
           (err) => {
-            console.log(`Ladda: Rejected ${entity.name}.${fn.name} with`, err)
+            console.log(`Ladda: Rejected ${entity.name}.${fn.fnName} with`, err)
             return Promise.reject(err);
           }
         );

docs/basics/Operations.md

@@ -17,7 +17,7 @@ An example of how a function of operation CREATE might look is:
 ```javascript
 createUser.operation = 'CREATE';
 function createUser(user) {
-    return performPostRequst('/api/user', user);
+    return performPostRequest('/api/user', user);
 }
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ladda-cache",
-  "version": "0.2.1",
+  "version": "0.2.7",
   "description": "Data fetching layer with support for caching",
   "main": "dist/bundle.js",
   "dependencies": {
@@ -43,5 +43,5 @@
     "type": "git",
     "url": "https://github.com/ladda-js/ladda.git"
   },
-  "homepage": "https://github.com/ladda-js/ladda"
+  "homepage": "https://www.ladda.io/"
 }

src/builder.js

@@ -1,5 +1,5 @@
-import {mapObject, mapValues, compose, toObject, reduce, toPairs,
-        prop, filterObject, isEqual, not, curry, copyFunction
+import {map, mapObject, mapValues, compose, toObject, reduce, fromPairs,
+        toPairs, prop, filterObject, isEqual, not, curry, copyFunction
       } from 'ladda-fp';
 
 import {cachePlugin} from './plugins/cache';
@@ -22,13 +22,6 @@ const KNOWN_STATICS = {
   arity: true
 };
 
-const setFnName = curry((name, fn) => {
-  Object.defineProperty(fn, 'name', { writable: true });
-  fn.name = name;
-  Object.defineProperty(fn, 'name', { writable: false });
-  return fn;
-});
-
 const hoistMetaData = (a, b) => {
   const keys = Object.getOwnPropertyNames(a);
   for (let i = keys.length - 1; i >= 0; i--) {
@@ -37,7 +30,6 @@ const hoistMetaData = (a, b) => {
       b[k] = a[k];
     }
   }
-  setFnName(a.name, b);
   return b;
 };
 
@@ -52,9 +44,7 @@ export const mapApiFunctions = (fn, entityConfigs) => {
         // containing a "bound" prefix.
         (apiM, [apiFnName, apiFn]) => {
           const getFn = compose(prop(apiFnName), prop('api'));
-          const nextFn = hoistMetaData(getFn(entity), fn({ entity, fn: apiFn }));
-          setFnName(apiFnName, nextFn);
-          apiM[apiFnName] = nextFn;
+          apiM[apiFnName] = hoistMetaData(getFn(entity), fn({ entity, fn: apiFn }));
           return apiM;
         },
         {},
@@ -100,9 +90,21 @@ const setApiConfigDefaults = ec => {
     return copy;
   };
 
+  const setFnName = ([name, apiFn]) => {
+    apiFn.fnName = name;
+    return [name, apiFn];
+  };
+
+  const mapApi = compose(
+    fromPairs,
+    map(setFnName),
+    toPairs,
+    mapValues(setDefaults)
+  );
+
   return {
     ...ec,
-    api: ec.api ? mapValues(setDefaults, ec.api) : ec.api
+    api: ec.api ? mapApi(ec.api) : ec.api
   };
 };
 
@@ -127,6 +129,12 @@ const applyPlugin = curry((addChangeListener, config, entityConfigs, plugin) =>
   return mapApiFunctions(pluginDecorator, entityConfigs);
 });
 
+const createPluginList = (core, plugins) => {
+  return plugins.length ?
+    [core, dedupPlugin, ...plugins, dedupPlugin] :
+    [core, dedupPlugin];
+};
+
 // Config -> Api
 export const build = (c, ps = []) => {
   const config = getGlobalConfig(c);
@@ -136,5 +144,5 @@ export const build = (c, ps = []) => {
   const applyPlugin_ = applyPlugin(listenerStore.addChangeListener, config);
   const applyPlugins = reduce(applyPlugin_, entityConfigs);
   const createApi = compose(toApi, applyPlugins);
-  return createApi([cachePlugin(listenerStore.onChange), ...ps, dedupPlugin]);
+  return createApi(createPluginList(cachePlugin(listenerStore.onChange), ps));
 };

src/builder.spec.js

@@ -11,12 +11,16 @@ getUsers.operation = 'READ';
 const deleteUser = () => Promise.resolve();
 deleteUser.operation = 'DELETE';
 
+const noopUser = () => Promise.resolve(['a', 'b']);
+noopUser.operation = 'NO_OPERATION';
+
 const config = () => ({
   user: {
     ttl: 300,
     api: {
       getUsers,
-      deleteUser
+      deleteUser,
+      noopUser
     },
     invalidates: ['alles']
   },
@@ -139,7 +143,7 @@ describe('builder', () => {
       const pName = pConfig.name;
       pluginTracker[pName] = {};
       return curry(({ config: c, entityConfigs }, { fn }) => {
-        pluginTracker[pName][fn.name] = true;
+        pluginTracker[pName][fn.fnName] = true;
         return fn;
       });
     };
@@ -152,6 +156,23 @@ describe('builder', () => {
       .then(() => done());
   });
 
+  it('applies dedup before and after the plugins, if there are any', () => {
+    const getAll = sinon.stub().returns(Promise.resolve([]));
+    getAll.operation = 'READ';
+    const conf = { test: { api: { getAll } } };
+    const plugin = () => ({ fn }) => () => {
+      fn();
+      fn();
+      return fn();
+    };
+    const api = build(conf, [plugin]);
+    api.test.getAll();
+    api.test.getAll();
+    return api.test.getAll().then(() => {
+      expect(getAll).to.have.been.calledOnce;
+    });
+  });
+
   describe('change listener', () => {
     it('exposes Ladda\'s listener/onChange interface to plugins', () => {
       const plugin = ({ addChangeListener }) => {
@@ -162,22 +183,81 @@ describe('builder', () => {
       build(config(), [plugin]);
     });
 
-    it('allows plugins to add a listener, which gets notified on all cache changes', () => {
+    it('returns a deregistration fn', () => {
       const spy = sinon.spy();
 
       const plugin = ({ addChangeListener }) => {
-        addChangeListener(spy);
+        const deregister = addChangeListener(spy);
+        deregister();
         return ({ fn }) => fn;
       };
 
       const api = build(config(), [plugin]);
 
       return api.user.getUsers().then(() => {
-        expect(spy).to.have.been.calledOnce;
-        const changeObject = spy.args[0][0];
-        expect(changeObject.entity).to.equal('user');
-        expect(changeObject.type).to.equal('UPDATE');
-        expect(changeObject.entities).to.deep.equal(users);
+        expect(spy).not.to.have.been.called;
+      });
+    });
+
+    it('can call deregistration fn several times without harm', () => {
+      const spy = sinon.spy();
+
+      const plugin = ({ addChangeListener }) => {
+        const deregister = addChangeListener(spy);
+        deregister();
+        deregister();
+        deregister();
+        return ({ fn }) => fn;
+      };
+
+      const api = build(config(), [plugin]);
+
+      return api.user.getUsers().then(() => {
+        expect(spy).not.to.have.been.called;
+      });
+    });
+
+    describe('allows plugins to add a listener, which gets notified on all cache changes', () => {
+      it('on READ operations', () => {
+        const spy = sinon.spy();
+
+        const plugin = ({ addChangeListener }) => {
+          addChangeListener(spy);
+          return ({ fn }) => fn;
+        };
+
+        const api = build(config(), [plugin]);
+
+        return api.user.getUsers().then(() => {
+          expect(spy).to.have.been.calledOnce;
+          const changeObject = spy.args[0][0];
+          expect(changeObject.entity).to.equal('user');
+          expect(changeObject.apiFn).to.equal('getUsers');
+          expect(changeObject.operation).to.equal('READ');
+          expect(changeObject.values).to.deep.equal(users);
+          expect(changeObject.args).to.deep.equal([]);
+        });
+      });
+
+      it('on NO_OPERATION operations', () => {
+        const spy = sinon.spy();
+
+        const plugin = ({ addChangeListener }) => {
+          addChangeListener(spy);
+          return ({ fn }) => fn;
+        };
+
+        const api = build(config(), [plugin]);
+
+        return api.user.noopUser('x').then(() => {
+          expect(spy).to.have.been.calledOnce;
+          const changeObject = spy.args[0][0];
+          expect(changeObject.entity).to.equal('user');
+          expect(changeObject.apiFn).to.equal('noopUser');
+          expect(changeObject.operation).to.equal('NO_OPERATION');
+          expect(changeObject.values).to.deep.equal(null);
+          expect(changeObject.args).to.deep.equal(['x']);
+        });
       });
     });