Merge pull request #162 from data-provider/release

Release v2.8.2

Author: javierbrea

.github/workflows/build.yml

@@ -0,0 +1,79 @@
+name: build
+on:
+  push:
+    branches:
+      - master
+      - release
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ["10.23.0", "12.19.0", "14.15.0", "15.2.0"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF##*/})"
+        id: extract-branch
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Cache node modules
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-node-modules
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint
+        run: npm run lint
+      - name: Test unit
+        run: npm run test:unit
+      - name: Test E2E
+        run: npm run test:e2e:ci
+        id: test-e2e
+      - name: Upload E2E tests screenshots
+        if: ${{ always() && steps.test-e2e.outcome == 'failure' }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: e2e-screenshots-${{ matrix.node }}
+          path: test-e2e/browser/cypress/screenshots
+          retention-days: 7
+      - name: Upload test results
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-${{ matrix.node }}
+          path: coverage
+          retention-days: 1
+  quality:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Download test results
+        uses: actions/download-artifact@v2
+        with:
+          name: coverage-15.2.0
+          path: coverage
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: SonarCloud Scan
+        if: env.SONAR_TOKEN != ''
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

…workflows/publish-to-github-registry.yml .github/workflows/publish-to-github.yml.github/workflows/publish-to-github-registry.yml renamed to .github/workflows/publish-to-github.yml .github/workflows/publish-to-github-registry.yml renamed to .github/workflows/publish-to-github.yml

@@ -1,4 +1,4 @@
-name: publish-to-github-registry
+name: publish-to-github
 on:
   release:
     types: [created]

.github/workflows/publish-to-npm.yml

@@ -0,0 +1,18 @@
+name: publish-to-npm
+on:
+  release:
+    types: [created]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '12.x'
+        registry-url: 'https://registry.npmjs.org/'
+    - run: npm ci
+    - run: npm run build
+    - run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.travis.yml

@@ -10,6 +10,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 ### Removed
 
+## [2.8.2] - 2020-12-12
+### Added
+- chore(ci): Migrate from Travis CI to github actions
+- chore(deps): Support all Node.js releases that have not passed their end date
+
+### Changed
+- test(mutation): Set branch name in stryker dashboard based on environment variable
+- docs(readme): Update docs
+
+### Fixed
+- fix(events): Pass force option also to children when cleaning caches
+- fix(selector): Force cleaning of cache when a selector dependency is cleaned (#156)
+- fix(providers): Allow options in providers.cleanCache method
+- test: Fix Sonar smell in tests
+
 ## [2.8.1] - 2020-11-27
 
 ### Fixed

CHANGELOG.md

@@ -1,4 +1,4 @@
-[![Build status][travisci-image]][travisci-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Quality Gate][quality-gate-image]][quality-gate-url] [![Mutation testing badge][stryker-image]][stryker-url]
+[![Build status][build-image]][build-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Quality Gate][quality-gate-image]][quality-gate-url] [![Mutation testing badge][stryker-image]][stryker-url]
 
 [![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) [![Last commit][last-commit-image]][last-commit-url] [![Last release][release-image]][release-url] 
 
@@ -15,11 +15,11 @@ The main target of the library are front-end applications, but it could be used
 It helps you __providing async data__ to your components informing them about __loading and error states__.
 It also provides a __cache layer__, so you don´t have to worry about when to read the data, and allows you to __combine the results of different data providers__ using a syntax very similar to the known [Reselect][reselect], recalculating them only when one of the dependencies cache is cleaned.
 
-As its states are managed with [Redux][redux], you can take advantage of his large ecosystem of addons, which will improve the developer experience. _(You don't need to use Redux directly in your application if you don't want, the library includes its own internal store for that purpose, which [can be migrated to your own store][api-store-manager])._
+As its states are managed with [Redux][redux], you can take advantage of his large ecosystem of addons, which will improve the developer experience. _(You don't need to use Redux directly in your application if you don't want, the library includes its own internal store for that purpose, which [can be migrated to your own store easily][api-store-manager] for debugging purposes, for example)._
 
-You can use Data Provider with [React][react], or with any other view library. Separated addons are available for that purpose, as [@data-provider/react][data-provider-react].
+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 plugins 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.
 
@@ -32,16 +32,17 @@ We have a website available to help you to learn to use Data Provider. There are
 * [Motivation][motivation]
 * [Installation][installation]
 * [Basic tutorial][basic-tutorial]
+* [Addons][addons]
 * [Recipes][recipes]
 * [API reference][api-reference]
 
 ## Main features
 
 ### 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__.
+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 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".
+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".
 
 Sharing the same interface for all origins, and being able to build Selectors combining all of them implies that your logic will be __completely isolated about WHERE the data is being retrieved.__
 
@@ -119,7 +120,7 @@ Providers and selectors instances can be queried, which returns a new child inst
 
 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)
+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)
 
 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")_
 
@@ -147,26 +148,30 @@ 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 HOCs to connect providers to your components__, creating a wrapper component handling all the logic for you.
+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__, 
 
-It also provides __hooks like "useData", "useLoading", etc.__
+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 your desired props have changed.
+__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.
 
 ```jsx
-import { withDataProvider } from "@data-provider/react";
+import { useData, useLoading, useError } from "@data-provider/react";
 
 import { booksProvider } from "data/books";
 import ErrorComponent from "components/error";
 
-const Books = ({ data, loading, error }) => {
+const Books = () => {
+  const error = useError(booksProvider);
+  const data = useData(booksProvider);
+  const loading = useLoading(booksProvider);
+
   if (error) {
     return <ErrorComponent error={error}/>
   }
   return <BooksList data={data} loading={loading} />;
 };
 
-export default withDataProvider(booksProvider)(Books);
+export default Books;
 ```
 
 ## Contributing
@@ -190,15 +195,16 @@ Please read the [contributing guidelines](.github/CONTRIBUTING.md) and [code of
 [motivation]: https://www.data-provider.org/docs/motivation
 [installation]: https://www.data-provider.org/docs/installation
 [basic-tutorial]: https://www.data-provider.org/docs/basics-intro
+[addons]: https://www.data-provider.org/docs/addons-intro
 [recipes]: https://www.data-provider.org/docs/recipes-index
 [api-reference]: https://www.data-provider.org/docs/api-reference
 [api-selector]: https://www.data-provider.org/docs/api-selector
 [api-store-manager]: https://www.data-provider.org/docs/api-store-manager
 
 [coveralls-image]: https://coveralls.io/repos/github/data-provider/core/badge.svg
 [coveralls-url]: https://coveralls.io/github/data-provider/core
-[travisci-image]: https://travis-ci.com/data-provider/core.svg?branch=master
-[travisci-url]: https://travis-ci.com/data-provider/core
+[build-image]: https://github.com/data-provider/core/workflows/build/badge.svg?branch=master
+[build-url]: https://github.com/data-provider/core/actions?query=workflow%3Abuild+branch%3Amaster
 [last-commit-image]: https://img.shields.io/github/last-commit/data-provider/core.svg
 [last-commit-url]: https://github.com/data-provider/core/commits
 [license-image]: https://img.shields.io/npm/l/@data-provider/core.svg

README.md

@@ -1,6 +1,6 @@
 {
   "name": "@data-provider/core",
-  "version": "2.8.1",
+  "version": "2.8.2",
   "description": "Async Data Provider agnostic about data origins",
   "keywords": [
     "data",
@@ -10,7 +10,9 @@
     "cache",
     "reactive",
     "state",
-    "agnostic"
+    "modular",
+    "front-end",
+    "nodejs"
   ],
   "author": "Javier Brea",
   "license": "Apache-2.0",
@@ -31,19 +33,17 @@
   "scripts": {
     "build": "rollup --config",
     "test": "jest",
-    "test:coverage": "npm run test",
+    "test:unit": "npm run test",
     "test:e2e:browser:install": "cd test-e2e/browser && npm i && cd vanilla-app && npm i && cd ../react-app && npm i",
     "test:e2e:browser": "cd test-e2e/browser && npm run test:vanilla-app && npm run test:react-app",
     "test:e2e:node:install": "cd test-e2e/nodejs/esm && npm i",
     "test:e2e:node": "cd test-e2e/nodejs/cjs && npm run test && cd ../esm && npm run test",
     "test:e2e": "npm run test:e2e:browser && npm run test:e2e:node",
-    "test:e2e:ci": "npm run test:e2e:browser:install && npm run test:e2e:node:install && npm run test:e2e",
-    "test:ci": "npm run build && npm run test:coverage && npm run test:e2e:ci",
+    "test:e2e:ci": "npm run build && npm run test:e2e:browser:install && npm run test:e2e:node:install && npm run test:e2e",
+    "test:ci": "npm run test:unit && npm run test:e2e:ci",
     "test:mutation": "stryker run",
-    "test:mutation:dev": "stryker run stryker.conf.local.js",
     "lint": "eslint src test test-e2e/browser/vanilla-app/public/main.js test-e2e/browser/react-app/src test-e2e/browser/cypress test-e2e/nodejs/cjs test-e2e/nodejs/esm/src *.js",
-    "lint-staged": "lint-staged",
-    "coveralls": "cat ./coverage/lcov.info | coveralls"
+    "lint-staged": "lint-staged"
   },
   "peerDependencies": {
     "redux": "4.x"
@@ -64,7 +64,6 @@
     "babel-core": "7.0.0-bridge.0",
     "babel-eslint": "10.1.0",
     "babel-polyfill": "6.26.0",
-    "coveralls": "3.0.9",
     "eslint": "7.12.1",
     "eslint-config-prettier": "6.15.0",
     "eslint-plugin-prettier": "3.1.4",
@@ -95,6 +94,6 @@
     }
   },
   "engines": {
-    "node": "12.x || 14.x || 15.x"
+    "node": "10.x || 12.x || 14.x || 15.x"
   }
 }

package-lock.json

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