Merge 7571aaf into f39492d

README.md

@@ -11,11 +11,17 @@ Selectors with parameters and dynamic dependencies.
 
 ## Packages
 
-**[@dynamic-selectors/core](./packages/core/)**
+#### [@dynamic-selectors/core](./packages/core/)
 
 [![npm version](https://img.shields.io/npm/v/@dynamic-selectors/core/latest.svg)](https://www.npmjs.com/package/@dynamic-selectors/core)
 [![gzip size](https://img.shields.io/bundlephobia/minzip/@dynamic-selectors/core)](https://bundlephobia.com/result?p=@dynamic-selectors/core@latest)
 
+Core functionality for dynamic selectors, independent of any other libraries.
+
+#### @dynamic-selectors/with-reselect
+
+![not found](https://img.shields.io/badge/npm-package%20not%20found-red.svg)
+
 (In progress, not published)
 
 ## What is this?

package.json

@@ -58,8 +58,7 @@
   "dependencies": {},
   "devDependencies": {
     "@testing-library/jest-dom": "5.11.4",
-    "@testing-library/react": "11.0.4",
-    "@types/react": "16.9.51",
+    "@testing-library/react": "11.1.0",
     "@types/react-dom": "16.9.8",
     "coveralls": "3.1.0",
     "cross-env": "7.0.2",
@@ -70,7 +69,7 @@
     "lint-staged": "10.4.0",
     "prettier": "2.1.2",
     "standard-version": "9.0.0",
-    "tsdx": "0.14.0",
+    "tsdx": "0.14.1",
     "typescript": "3.9.7",
     "yarn-or-npm": "3.0.1"
   },

packages/core/README.md

@@ -9,10 +9,10 @@
 
 Selectors with parameters and dynamic dependencies.
 
-Selectors can access state and call each other dynamically, even conditionally or within loops, without needing to
-register dependencies up-front. As with Reselect and Re-reselect, functions are only re-run when necessary.
+Dynamic selectors can access state and call each other dynamically, even conditionally or within loops, without needing
+to register dependencies up-front. As with Reselect and Re-reselect, functions are only re-run when necessary.
 
-This is the core functionality for [Dynamic Selectors](https://github.com/spautz/dynamic-selectors)
+For more information or related packages, see the [Dynamic Selectors workspace](https://github.com/spautz/dynamic-selectors).
 
 ## Example
 
@@ -42,66 +42,16 @@ getUsersByLibrary(state, 'vue');
 getUsersByLibrary(state, 'react'); // this hits the cache
 ```
 
-`getUsersByLibrary(state, 'react')` will rerun only when its dependencies change: `state.users` or
-`getLibraryId('react')`. This could also be built without using `getLibraryId`: the `getUsersByLibrary` selector
-could just access both locations in `state` directly.
+`getUsersByLibrary(state, 'react')` will rerun only when its dependencies change: `state.users` or `getLibraryId('react')`.
+
+This could also be built without using `getLibraryId`: the `getUsersByLibrary` selector could just use `getState`
+to read from `` `libraries[${libraryName}].id` ``, and it would work the same.
 
 ## Features
 
 - Dynamic, automatically-registered dependencies. Instead of listing your selector's dependencies up-front, just call
   them within your function.
 - Provide arguments/parameters to selectors. Each set of arguments gets its own cache, like in re-reselect.
 - Cache controls: "freeze" a selector's output even if it returned a new object.
-- Call selectors recursively, if you want.
-
-## Comparison with Reselect
-
-(This is based on [Reselect's example selector](https://github.com/reduxjs/reselect#example).)
-
-#### Plain, unmemoized function
-
-State values are passed to a normal function. This is straightforward but will repeat the work every single time
-your state updates.
-
-```javascript
-const getVisibleTodos = (todos, filter) => {
-  // Snipped for brevity: filter `todos` by `filter`
-};
-
-const mapStateToProps = (state) => {
-  return {
-    todos: getVisibleTodos(state.todos, state.visibilityFilter),
-  };
-};
-```
-
-#### Using Reselect
-
-Each value in state is wrapped in a function, and `getVisibleTodos` is set to depend on those functions. It will
-rerun only when one of the functions returns a new value. The selector's dependencies must be listed ahead of time.
-
-```javascript
-const getVisibilityFilter = (state) => state.visibilityFilter;
-const getTodos = (state) => state.todos;
-
-const getVisibleTodos = createSelector(
-  [getVisibilityFilter, getTodos],
-  (visibilityFilter, todos) => {
-    // Snipped for brevity: filter `todos` by `filter`
-  },
-);
-```
-
-#### Using Dynamic Selectors
-
-`getVisibleTodos` can retrieve values directly from the state, or from other dynamic selectors. It will rerun only when
-one of the functions returns a new value. You can retrieve values dynamically: it works with if/else, loops, etc.
-
-```javascript
-const getVisibleTodos = createDynamicSelector((getState) => {
-  const visibilityFilter = getState('visibilityFilter');
-  const todos = getState('todos');
-
-  // Snipped for brevity: filter `todos` by `filter`
-});
-```
+- Access state directly from within a selector. This automatically registers a dependency against that location in your `state`.
+- A selector can call other selectors from `if` blocks, loops, or any other controls -- or even recursively.

packages/core/docs/comparison-with-reselect.md

@@ -0,0 +1,52 @@
+# Comparison with Reselect
+
+This shows several different ways to write [Reselect's example selector](https://github.com/reduxjs/reselect#example),
+which -- assuming Redux -- filters `state.todos` based on a value in `state.visibilityFilter`.
+
+#### Plain, unmemoized function
+
+State values are passed to a normal function. This is straightforward to write, but it will repeat the work every
+single time your state updates, with potentially bad performance.
+
+```javascript
+const getVisibleTodos = (todos, filter) => {
+  // Snipped for brevity: filter `todos` by `filter`
+};
+
+const mapStateToProps = (state) => {
+  return {
+    todos: getVisibleTodos(state.todos, state.visibilityFilter),
+  };
+};
+```
+
+#### Using Reselect
+
+Each value in state is wrapped in a function, and `getVisibleTodos` is set to depend on those functions. It will
+rerun only when one of the functions returns a new value. The selector's dependencies must be listed ahead of time.
+
+```javascript
+const getVisibilityFilter = (state) => state.visibilityFilter;
+const getTodos = (state) => state.todos;
+
+const getVisibleTodos = createSelector(
+  [getVisibilityFilter, getTodos],
+  (visibilityFilter, todos) => {
+    // Snipped for brevity: filter `todos` by `filter`
+  },
+);
+```
+
+#### Using Dynamic Selectors
+
+`getVisibleTodos` can retrieve values directly from the state, or from other dynamic selectors. It will rerun only when
+one of the functions returns a new value. You can retrieve values dynamically: it works with if/else, loops, etc.
+
+```javascript
+const getVisibleTodos = createDynamicSelector((getState) => {
+  const visibilityFilter = getState('visibilityFilter');
+  const todos = getState('todos');
+
+  // Snipped for brevity: filter `todos` by `filter`
+});
+```

packages/core/package.json

@@ -60,7 +60,7 @@
     "shallowequal": "^1.1.0"
   },
   "devDependencies": {
-    "@types/lodash": "4.14.161",
+    "@types/lodash": "4.14.162",
     "@types/shallowequal": "1.1.1"
   }
 }

packages/core/src/dynamicSelectorForState.ts

@@ -334,12 +334,11 @@ const dynamicSelectorForState = <StateType = any>(
       const argsWithState = addStateToArguments(args);
       const rootResult = createResultEntry(stateOptions, argsWithState[0], false, false);
 
-      // const paramKey = getKeyForParams(argsWithState[1]);
-      // const previousResult = resultCache.get(paramKey);
-      // if (!previousResult) {
-      //   // Don't even bother checking if there's _nothing_ to check
-      //   return rootResult;
-      // }
+      const paramKey = getKeyForParams(argsWithState[1]);
+      if (!resultCache.get(paramKey)) {
+        // Don't even bother checking if there's _nothing_ to check
+        return rootResult;
+      }
 
       pushCallStackEntry(rootResult);
       const result = evaluateSelector(...argsWithState);

packages/core/src/internals/resultCache.ts

@@ -48,9 +48,6 @@ export const RESULT_ENTRY__DEBUG_INFO = 9 as const;
 export type DynamicSelectorResultCache = {
   get: (paramKey: string) => DynamicSelectorResultEntry | undefined;
   set: (paramKey: string, newEntry: DynamicSelectorResultEntry) => void;
-  // getAll?: () => Record<string, DynamicSelectorResultEntry>;
-  // has?: (paramKey: string) => boolean;
-  // reset?: () => void;
   [propName: string]: any;
 };
 

packages/with-reselect/.prettierignore

@@ -0,0 +1,23 @@
+# Unless https://github.com/prettier/prettier/issues/4081 gets resolved,
+# this MUST be copied into each package dir for local runs to work.
+
+# Whitelist supported files only
+**/*.*
+!**/*.css
+!**/*.html
+!**/*.js
+!**/*.jsx
+!**/*.json
+!**/*.less
+!**/*.md
+!**/*.scss
+!**/*.ts
+!**/*.tsx
+
+# Unless they're somewhere we can ignore
+build/
+dist/
+coverage/
+coverage-local/
+node_modules/
+storybook-static/

packages/with-reselect/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

packages/with-reselect/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at spautz@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

packages/with-reselect/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Steven Pautz
+
+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.

packages/with-reselect/README.md

@@ -0,0 +1,11 @@
+# @dynamic-selectors/with-reselect
+
+**This package is in active development. Things will change rapidly, and it is not yet production-ready. Feedback is welcome.**
+
+**Release `0.1.0` will be the first stable, production-ready version.**
+
+[![npm version](https://img.shields.io/npm/v/@dynamic-selectors/with-reselect/latest.svg)](https://www.npmjs.com/package/@dynamic-selectors/with-reselect)
+[![gzip size](https://img.shields.io/bundlephobia/minzip/@dynamic-selectors/with-reselect)](https://bundlephobia.com/result?p=@dynamic-selectors/with-reselect@latest)
+
+Helper functions to make it easy to use [Dynamic Selectors](https://github.com/spautz/dynamic-selectors) and
+[Reselect](https://github.com/reduxjs/reselect) together.

packages/with-reselect/jest.config.js

@@ -0,0 +1,4 @@
+/* eslint-env node */
+const baseConfig = require('../../jest-packages.config');
+
+module.exports = baseConfig;