Merge pull request #171 from data-provider/release

Release v2.9.0

Author: javierbrea

CHANGELOG.md

@@ -10,6 +10,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 ### Removed
 
+## [2.9.0] - 2020-12-27
+
+### Added
+- feat: Allow defining baseTags property in addons. Will be extended with "tags" option when instantiated for calculating provider tags. (#143)
+- feat: Add tags getter
+- feat: Add "selector" base tag to selectors (#163)
+- feat: Add `cleanDependenciesCache` method to `providers` handler (#164)
+
+### Fixed
+- docs(readme): Fix typos
+
 ## [2.8.2] - 2020-12-12
 ### Added
 - chore(ci): Migrate from Travis CI to github actions

README.md

@@ -6,9 +6,9 @@
 
 # [![Data Provider][logo]][home]
 
-> Async Data Provider. Powered by Redux. Agnostic about data origins. Framework agnostic.
+> Async Data Provider. Powered by Redux. Agnostic about data origins. Agnostic about UI Frameworks.
 
-Data Provider is a data provider _(surprise!)_ with states ands built-in cache for JavaScript apps.
+Data Provider is a data provider _(surprise!)_ with states and built-in cache for JavaScript apps.
 
 The main target of the library are front-end applications, but it could be used also in [Node.js][nodejs].
 
@@ -19,7 +19,7 @@ As its states are managed with [Redux][redux], you can take advantage of his lar
 
 You can use Data Provider with [React][react], or with any other view library. [Separated addons][addons] are available for that purpose, as [@data-provider/react][data-provider-react].
 
-Data Provider is __agnostic about data origins__, so it can be used to read data from a REST API, from localStorage, or from any other origin. Choose one of the [available addons][addons] depending of the type of the origin you want to read from, as [@data-provider/axios][data-provider-axios], or [@data-provider/browser-storage][data-provider-browser-storage].
+Data Provider is __agnostic about data origins__, so it can be used to read data from a REST API, from `localStorage`, or from any other origin. Choose one of the [available addons][addons] depending of the type of the origin you want to read from, as [`@data-provider/axios`][data-provider-axios], or [`@data-provider/browser-storage`][data-provider-browser-storage].
 
 It has a __light weight__, 4.2KB gzipped in UMD format _(you have to add the Redux weight to this)_, and addons usually are even lighter.
 
@@ -40,7 +40,7 @@ We have a website available to help you to learn to use Data Provider. There are
 
 ### Agnostic about data origins
 
-The Provider class provides the cache, state handler, etc., but not the "read" method. The "read" behavior is implemented by __different [Data Provider Origins addons][addons]__.
+The Provider class provides the cache, state handler, etc., but not the `read` method. The `read` behavior is implemented by __different [Data Provider Origins addons][addons]__.
 
 There are different origins addons available, such as __[Axios][data-provider-axios], [LocalStorage][data-provider-browser-storage], [Memory][data-provider-memory], etc.__ and building your own is so easy as extending the Provider class with a custom "readMethod".
 
@@ -116,11 +116,11 @@ export default RenderBooksTwice;
 
 ### Queryable
 
-Providers and selectors instances can be queried, which returns a new child instance with his own "query value".
+Providers and selectors instances can be queried, which returns a new child instance with its own `query value`.
 
 Each different child has a different cache, different state, etc.
 
-Different origins can use the "query" value for different purposes (API origins will normally use it for adding different params or query strings to the provider url, for example)
+Different origins can use the `queryValue` for different purposes (API origins will normally use it for adding different params or query strings to the provider url, for example)
 
 When the parent provider cache is clean, also the children is. _(For example, cleaning the cache of an API origin requesting to "/api/books", will also clean the cache for "/api/books?author=2")_
 
@@ -148,11 +148,11 @@ export default Book;
 
 Data Provider is not concerned about the views, but UI binding addons are available.
 
-For example, the [@data-provider/react][data-provider-react] package __gives you hooks to easily retrieve and provide data and other data-provider states to your components__, 
+For example, the [@data-provider/react][data-provider-react] package __gives you hooks to easily retrieve and provide data__ and other data-provider states to React components.
 
-It also provides __HOCs like "withData", "withLoading", etc., creating a wrapper component handling all the logic for you.__
+It also provides __HOCs__ like "withData", "withLoading", etc. creating a wrapper component handling all the logic for you.
 
-__Optimized__, it takes care of reading the data and re-renders the component only when the provider desired props have changed. It also takes care of reading the data again every time the cache of the provider is invalidated.
+__Optimized__, it takes care of reading the data and re-renders the component only when the provider desired properties have changed. It also takes care of reading the data again every time the cache of the provider is invalidated.
 
 ```jsx
 import { useData, useLoading, useError } from "@data-provider/react";

jest.config.js

@@ -26,7 +26,7 @@ module.exports = {
 
   // The glob patterns Jest uses to detect test files
   testMatch: ["<rootDir>/test/**/*.js"],
-  // testMatch: ["<rootDir>/test/provider/clean-cache-throttle.js"],
+  // testMatch: ["<rootDir>/test/providers/config.js"],
 
   // The test environment that will be used for testing
   testEnvironment: "node",

package-lock.json

@@ -1,10 +1,11 @@
 {
   "name": "@data-provider/core",
-  "version": "2.8.2",
+  "version": "2.9.0",
   "description": "Async Data Provider agnostic about data origins",
   "keywords": [
     "data",
     "provider",
+    "async",
     "redux",
     "selector",
     "cache",

package.json

@@ -1,6 +1,6 @@
 sonar.organization=data-provider
 sonar.projectKey=data-provider-core
-sonar.projectVersion=2.8.2
+sonar.projectVersion=2.9.0
 
 sonar.sources=src,test
 sonar.exclusions=node_modules/**

sonar-project.properties

@@ -13,8 +13,7 @@ import { storeManager } from "./storeManager";
 import {
   childId,
   eventNamespace,
-  removeFalsy,
-  ensureArray,
+  arrayWithoutFalsies,
   isFunction,
   isUndefined,
   ANY,
@@ -34,7 +33,10 @@ class Provider {
     this._emitChild = this._emitChild.bind(this);
     this._options = { ...defaultOptions, ...options };
     this._query = { ...query };
-    this._tags = removeFalsy(ensureArray(this._options.tags));
+    this._tags = [
+      ...arrayWithoutFalsies(this.baseTags),
+      ...arrayWithoutFalsies(this._options.tags),
+    ];
     this._children = new Map();
     this._queryMethods = new Map();
     this._queryMethodsParsers = new Map();
@@ -246,6 +248,10 @@ class Provider {
     return this._options;
   }
 
+  get tags() {
+    return this._tags;
+  }
+
   // Methods to be used for testing
 
   get queryMethods() {

src/Provider.js

@@ -9,7 +9,14 @@ http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */
 
-import { CLEAN_CACHE, isFunction, isArray, isPromise, ensureArray } from "./helpers";
+import {
+  SELECTORS_TAG,
+  CLEAN_CACHE,
+  isFunction,
+  isArray,
+  isPromise,
+  ensureArray,
+} from "./helpers";
 import Provider from "./Provider";
 import CatchDependency from "./CatchDependency";
 
@@ -230,6 +237,12 @@ class SelectorBase extends Provider {
     }
   }
 
+  // Define base tag
+
+  get baseTags() {
+    return SELECTORS_TAG;
+  }
+
   // Methods to be used for testing
 
   get dependencies() {

src/Selector.js

@@ -24,6 +24,7 @@ export const defaultOptions = {
   cleanCacheThrottle: 0,
 };
 
+export const SELECTORS_TAG = "selector";
 export const INIT = "init";
 export const CLEAN_CACHE = "cleanCache";
 export const RESET_STATE = "resetState";
@@ -88,6 +89,10 @@ export function removeFalsy(array) {
   return array.filter((el) => !!el);
 }
 
+export function arrayWithoutFalsies(els) {
+  return removeFalsy(ensureArray(els));
+}
+
 export function message(text) {
   return `@data-provider/core: ${text}`;
 }

src/helpers.js

@@ -55,6 +55,10 @@ export class ProvidersHandler {
     return this._run("cleanCache", options);
   }
 
+  cleanDependenciesCache(options) {
+    return this._run("cleanDependenciesCache", options);
+  }
+
   resetState() {
     return this._run("resetState");
   }
@@ -174,6 +178,10 @@ export class Providers {
     return this._allProviders.cleanCache(options);
   }
 
+  cleanDependenciesCache(options) {
+    return this._allProviders.cleanDependenciesCache(options);
+  }
+
   resetState() {
     return this._allProviders.resetState();
   }