Skip to content

Commit

Permalink
Rename storeDefinition to just store
Browse files Browse the repository at this point in the history
  • Loading branch information
youknowriad committed Nov 17, 2020
1 parent 09b2daf commit ff4f4f4
Show file tree
Hide file tree
Showing 48 changed files with 132 additions and 154 deletions.
2 changes: 1 addition & 1 deletion packages/annotations/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
import './format';
import './block';

export { storeDefinition } from './store';
export { store } from './store';
8 changes: 4 additions & 4 deletions packages/annotations/src/store/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { register, createReduxStoreDefinition } from '@wordpress/data';
import { register, createReduxStore } from '@wordpress/data';

/**
* Internal dependencies
Expand All @@ -18,14 +18,14 @@ const STORE_NAME = 'core/annotations';
/**
* Store definition for the annotations namespace.
*
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore
*
* @type {Object}
*/
export const storeDefinition = createReduxStoreDefinition( STORE_NAME, {
export const store = createReduxStore( STORE_NAME, {
reducer,
selectors,
actions,
} );

register( storeDefinition );
register( store );
2 changes: 1 addition & 1 deletion packages/block-directory/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ import '@wordpress/notices';
*/
import './plugins';

export { storeDefinition } from './store';
export { store } from './store';
11 changes: 4 additions & 7 deletions packages/block-directory/src/store/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { createReduxStoreDefinition, register } from '@wordpress/data';
import { createReduxStore, register } from '@wordpress/data';
import { controls as dataControls } from '@wordpress/data-controls';

/**
Expand Down Expand Up @@ -36,13 +36,10 @@ export const storeConfig = {
/**
* Store definition for the block directory namespace.
*
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore
*
* @type {Object}
*/
export const storeDefinition = createReduxStoreDefinition(
STORE_NAME,
storeConfig
);
export const store = createReduxStore( STORE_NAME, storeConfig );

register( storeDefinition );
register( store );
12 changes: 6 additions & 6 deletions packages/block-editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -504,25 +504,25 @@ _Properties_

Undocumented declaration.

<a name="storeConfig" href="#storeConfig">#</a> **storeConfig**
<a name="store" href="#store">#</a> **store**

Block editor data store configuration.
Store definition for the block editor namespace.

_Related_

- <https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#registerStore>
- <https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore>

_Type_

- `Object`

<a name="storeDefinition" href="#storeDefinition">#</a> **storeDefinition**
<a name="storeConfig" href="#storeConfig">#</a> **storeConfig**

Store definition for the block editor namespace.
Block editor data store configuration.

_Related_

- <https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition>
- <https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#registerStore>

_Type_

Expand Down
2 changes: 1 addition & 1 deletion packages/block-editor/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import '@wordpress/notices';
import './hooks';
export * from './components';
export * from './utils';
export { storeConfig, storeDefinition } from './store';
export { storeConfig, store } from './store';
export { SETTINGS_DEFAULTS } from './store/defaults';
10 changes: 5 additions & 5 deletions packages/block-editor/src/store/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { createReduxStoreDefinition, registerStore } from '@wordpress/data';
import { createReduxStore, registerStore } from '@wordpress/data';

/**
* Internal dependencies
Expand Down Expand Up @@ -34,19 +34,19 @@ export const storeConfig = {
/**
* Store definition for the block editor namespace.
*
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore
*
* @type {Object}
*/
export const storeDefinition = createReduxStoreDefinition( STORE_NAME, {
export const store = createReduxStore( STORE_NAME, {
...storeConfig,
persist: [ 'preferences' ],
} );

// Ideally we'd use register instead of register stores.
// We should be able to make the switch once we remove the "effects" middleware.
const store = registerStore( STORE_NAME, {
const instantiatedStore = registerStore( STORE_NAME, {
...storeConfig,
persist: [ 'preferences' ],
} );
applyMiddlewares( store );
applyMiddlewares( instantiatedStore );
4 changes: 2 additions & 2 deletions packages/blocks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -740,13 +740,13 @@ _Parameters_

- _blockName_ `string`: Block name.

<a name="storeDefinition" href="#storeDefinition">#</a> **storeDefinition**
<a name="store" href="#store">#</a> **store**

Store definition for the blocks namespace.

_Related_

- <https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition>
- <https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore>

_Type_

Expand Down
2 changes: 1 addition & 1 deletion packages/blocks/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
// Blocks are inferred from the HTML source of a post through a parsing mechanism
// and then stored as objects in state, from which it is then rendered for editing.

export { storeDefinition } from './store';
export { store } from './store';
export * from './api';
export { withBlockContentContext } from './block-content-provider';
8 changes: 4 additions & 4 deletions packages/blocks/src/store/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { createReduxStoreDefinition, register } from '@wordpress/data';
import { createReduxStore, register } from '@wordpress/data';

/**
* Internal dependencies
Expand All @@ -15,14 +15,14 @@ const STORE_NAME = 'core/blocks';
/**
* Store definition for the blocks namespace.
*
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore
*
* @type {Object}
*/
export const storeDefinition = createReduxStoreDefinition( STORE_NAME, {
export const store = createReduxStore( STORE_NAME, {
reducer,
selectors,
actions,
} );

register( storeDefinition );
register( store );
11 changes: 4 additions & 7 deletions packages/core-data/src/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { createReduxStoreDefinition, register } from '@wordpress/data';
import { createReduxStore, register } from '@wordpress/data';
import { controls } from '@wordpress/data-controls';

/**
Expand Down Expand Up @@ -67,16 +67,13 @@ const storeConfig = {
/**
* Store definition for the code data namespace.
*
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition
* @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore
*
* @type {Object}
*/
export const storeDefinition = createReduxStoreDefinition(
STORE_NAME,
storeConfig
);
export const store = createReduxStore( STORE_NAME, storeConfig );

register( storeDefinition );
register( store );

export { default as EntityProvider } from './entity-provider';
export * from './entity-provider';
6 changes: 3 additions & 3 deletions packages/core-data/src/test/integration.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { createRegistry, controls } from '@wordpress/data';
import * as actions from '../actions';
import * as selectors from '../selectors';
import * as resolvers from '../resolvers';
import { storeDefinition } from '../';
import { store } from '../';

// Mock to prevent calling window.fetch in test environment
jest.mock( '@wordpress/data-controls', () => {
Expand Down Expand Up @@ -52,7 +52,7 @@ describe( 'receiveEntityRecord', () => {
data: {},
},
};
registry.register( storeDefinition );
registry.register( store );
registry.registerStore( 'test/resolution', {
actions: {
receiveEntityRecords: actions.receiveEntityRecords,
Expand Down Expand Up @@ -160,7 +160,7 @@ describe( 'receiveEntityRecord', () => {
describe( 'saveEntityRecord', () => {
function createTestRegistry() {
const registry = createRegistry();
registry.registerStore( storeDefinition );
registry.register( store );
return registry;
}

Expand Down
4 changes: 2 additions & 2 deletions packages/data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ _Returns_

Undocumented declaration.

<a name="createReduxStoreDefinition" href="#createReduxStoreDefinition">#</a> **createReduxStoreDefinition**
<a name="createReduxStore" href="#createReduxStore">#</a> **createReduxStore**

Creates a namespace object with a store derived from the reducer given.

Expand Down Expand Up @@ -489,7 +489,7 @@ Registers a standard `@wordpress/data` store definition.

_Parameters_

- _storeDefinition_ (unknown type): Store definition.
- _store_ (unknown type): Store definition.

<a name="registerGenericStore" href="#registerGenericStore">#</a> **registerGenericStore**

Expand Down
4 changes: 2 additions & 2 deletions packages/data/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export { AsyncModeProvider } from './components/async-mode-provider';
export { createRegistry } from './registry';
export { createRegistrySelector, createRegistryControl } from './factory';
export { controls } from './controls';
export { default as createReduxStoreDefinition } from './redux-store';
export { default as createReduxStore } from './redux-store';

/**
* Object of available plugins to use with a registry.
Expand Down Expand Up @@ -182,6 +182,6 @@ export const use = defaultRegistry.use;
/**
* Registers a standard `@wordpress/data` store definition.
*
* @param {import('./types').WPDataStoreDefinition} storeDefinition Store definition.
* @param {import('./types').WPDataStore} store Store definition.
*/
export const register = defaultRegistry.register;
8 changes: 4 additions & 4 deletions packages/data/src/redux-store/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ function createResolversCache() {
*
* @return {import('../types').WPDataStoreDefinition} Store Object.
*/
export default function createReduxStoreDefinition( key, options ) {
export default function createReduxStore( key, options ) {
return {
name: key,
__internalAttach: ( registry ) => {
instantiate: ( registry ) => {
const reducer = options.reducer;
const store = createReduxStore( key, options, registry );
const store = instantiateReduxStore( key, options, registry );
const resolversCache = createResolversCache();

let resolvers;
Expand Down Expand Up @@ -157,7 +157,7 @@ export default function createReduxStoreDefinition( key, options ) {
*
* @return {Object} Newly created redux store.
*/
function createReduxStore( key, options, registry ) {
function instantiateReduxStore( key, options, registry ) {
const controls = {
...options.controls,
...builtinControls,
Expand Down
18 changes: 7 additions & 11 deletions packages/data/src/registry.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import memize from 'memize';
/**
* Internal dependencies
*/
import createReduxStoreDefinition from './redux-store';
import createReduxStore from './redux-store';
import createCoreDataStore from './store';

/**
Expand Down Expand Up @@ -205,13 +205,10 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
/**
* Registers a new store.
*
* @param {import('./types').WPDataStoreDefinition} storeDefinition Store definition.
* @param {import('./types').WPDataStore} store Store definition.
*/
function register( storeDefinition ) {
registerGenericStore(
storeDefinition.name,
storeDefinition.__internalAttach( registry )
);
function register( store ) {
registerGenericStore( store.name, store.instantiate( registry ) );
}

let registry = {
Expand Down Expand Up @@ -239,10 +236,9 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
throw new TypeError( 'Must specify store reducer' );
}

const store = createReduxStoreDefinition(
storeName,
options
).__internalAttach( registry );
const store = createReduxStore( storeName, options ).instantiate(
registry
);
registerGenericStore( storeName, store );
return store.store;
};
Expand Down
15 changes: 6 additions & 9 deletions packages/data/src/test/registry.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { castArray, mapValues } from 'lodash';
*/
import { createRegistry } from '../registry';
import { createRegistrySelector } from '../factory';
import createReduxStoreDefinition from '../redux-store';
import createReduxStore from '../redux-store';

jest.useFakeTimers();

Expand Down Expand Up @@ -554,18 +554,16 @@ describe( 'createRegistry', () => {

it( 'should work with the store definition as param for select', () => {
const STORE_NAME = 'demo';
const storeDefinition = createReduxStoreDefinition( STORE_NAME, {
const store = createReduxStore( STORE_NAME, {
reducer: ( state = 'OK' ) => state,
selectors: {
getValue: ( state ) => state,
},
resolvers: {},
} );
registry.registry( storeDefinition );
registry.registry( store );

expect( registry.select( storeDefinition ).getValue() ).toBe(
'OK'
);
expect( registry.select( store ).getValue() ).toBe( 'OK' );
} );

it( 'should run the registry selector from a non-registry selector', () => {
Expand Down Expand Up @@ -700,7 +698,7 @@ describe( 'createRegistry', () => {

it( 'should work with the store object as param for dispatch', async () => {
const STORE_NAME = 'demo';
const storeDefinition = createReduxStoreDefinition( STORE_NAME, {
const store = registry.registerStore( STORE_NAME, {
reducer( state = 'OK', action ) {
if ( action.type === 'UPDATE' ) {
return 'UPDATED';
Expand All @@ -713,10 +711,9 @@ describe( 'createRegistry', () => {
},
},
} );
const store = registry.register( storeDefinition );

expect( store.getState() ).toBe( 'OK' );
await registry.dispatch( storeDefinition ).update();
await registry.dispatch( store ).update();
expect( store.getState() ).toBe( 'UPDATED' );
} );
} );
Expand Down
Loading

0 comments on commit ff4f4f4

Please sign in to comment.