Deprecation: createModelReducer -> modelReducer, createFormReducer -> formReducer

Author: davidkpiano

src/enhancers/modeled-enhancer.js

@@ -1,8 +1,8 @@
-import { createModelReducer } from '../reducers/model-reducer';
+import { modelReducer } from '../reducers/model-reducer';
 
 const NULL_ACTION = { type: null };
 
-function createModelReducerEnhancer(modelReducerCreator = createModelReducer) {
+function createModelReducerEnhancer(modelReducerCreator = modelReducer) {
   return function modelReducerEnhancer(reducer, model) {
     let initialState;
     try {
@@ -11,17 +11,17 @@ function createModelReducerEnhancer(modelReducerCreator = createModelReducer) {
       initialState = null;
     }
 
-    const modelReducer = modelReducerCreator(model, initialState);
+    const _modelReducer = modelReducerCreator(model, initialState);
 
     return (state = initialState, action) => {
-      const updatedState = modelReducer(state, action);
+      const updatedState = _modelReducer(state, action);
 
       return reducer(updatedState, action);
     };
   };
 }
 
-const modelReducerEnhancer = createModelReducerEnhancer(createModelReducer);
+const modelReducerEnhancer = createModelReducerEnhancer(modelReducer);
 
 export { createModelReducerEnhancer };
 export default modelReducerEnhancer;

src/immutable/index.js

@@ -19,10 +19,18 @@ function immutableSet(state, path, value) {
   }
 }
 
-const createModelReducer = createModeler(immutableGet, immutableSet);
-const modelReducerEnhancer = createModelReducerEnhancer(createModelReducer);
+const modelReducer = createModeler(immutableGet, immutableSet);
+const modelReducerEnhancer = createModelReducerEnhancer(modelReducer);
+
+function createModelReducer(...args) {
+  console.warn('The createModelReducer() function is deprecated (renamed). '
+    + 'Please use modelReducer().');
+
+  return modelReducer(...args);
+}
 
 export {
   createModelReducer,
+  modelReducer,
   modelReducerEnhancer as modeled,
 };

src/index.js

@@ -6,15 +6,26 @@ import Form from './components/form-component';
 
 import modeled from './enhancers/modeled-enhancer';
 
-import { createFormReducer, initialFieldState, getField } from './reducers/form-reducer';
-import { createModelReducer } from './reducers/model-reducer';
+import {
+  createFormReducer,
+  formReducer,
+  initialFieldState,
+  getField,
+} from './reducers/form-reducer';
+
+import {
+  createModelReducer,
+  modelReducer,
+} from './reducers/model-reducer';
 
 export {
   actions,
   actionTypes,
   controlPropsMap as controls,
   createFieldClass,
+  formReducer,
   createFormReducer,
+  modelReducer,
   createModelReducer,
   Field,
   Form,

src/reducers/form-reducer.js

@@ -100,7 +100,7 @@ function createInitialFormState(model, initialState) {
   return formState;
 }
 
-function createFormReducer(model, initialState) {
+function formReducer(model, initialState) {
   const modelPath = toPath(model);
 
   return (state = createInitialFormState(model, initialState), action) => {
@@ -291,8 +291,16 @@ function createFormReducer(model, initialState) {
   };
 }
 
+function createFormReducer(...args) {
+  console.warn('The createFormReducer() function is deprecated (renamed). '
+    + 'Please use formReducer().');
+
+  return formReducer(...args);
+}
+
 export {
   createFormReducer,
+  formReducer,
   initialFieldState,
   initialFormState,
   getField,

src/reducers/model-reducer.js

@@ -10,7 +10,7 @@ function icepickSet(state, path, value) {
 }
 
 function createModeler(getter = _get, setter = icepickSet, initialModelState = {}) {
-  return function createModelReducer(model, initialState = initialModelState) {
+  return function _createModelReducer(model, initialState = initialModelState) {
     const modelPath = toPath(model);
 
     return (state = initialState, action) => {
@@ -60,9 +60,17 @@ function createModeler(getter = _get, setter = icepickSet, initialModelState = {
   };
 }
 
-const createModelReducer = createModeler();
+const modelReducer = createModeler();
+
+function createModelReducer(...args) {
+  console.warn('The createModelReducer() function is deprecated (renamed). '
+    + 'Please use modelReducer().');
+
+  return modelReducer(...args);
+}
 
 export {
   createModeler,
+  modelReducer,
   createModelReducer,
 };

test/custom-field-component-spec.js

@@ -7,7 +7,7 @@ import { Provider } from 'react-redux';
 import thunk from 'redux-thunk';
 
 import { Field as NativeField } from '../src/native';
-import { controls, createFieldClass, createFormReducer, createModelReducer, Field } from '../src';
+import { controls, createFieldClass, formReducer, modelReducer, Field } from '../src';
 
 describe('controls props mapping', () => {
   it('should exist', () => {
@@ -70,8 +70,8 @@ describe('custom <Field /> components with createFieldClass()', () => {
 
   it('should handle custom prop mappings', () => {
     const store = applyMiddleware(thunk)(createStore)(combineReducers({
-      testForm: createFormReducer('test'),
-      test: createModelReducer('test', { foo: 'bar' }),
+      testForm: formReducer('test'),
+      test: modelReducer('test', { foo: 'bar' }),
     }));
 
     const field = TestUtils.renderIntoDocument(
@@ -95,8 +95,8 @@ describe('custom <Field /> components with createFieldClass()', () => {
 
   it('should handle string prop mappings', () => {
     const store = applyMiddleware(thunk)(createStore)(combineReducers({
-      testForm: createFormReducer('test'),
-      test: createModelReducer('test', { foo: 'bar' }),
+      testForm: formReducer('test'),
+      test: modelReducer('test', { foo: 'bar' }),
     }));
 
     const field = TestUtils.renderIntoDocument(
@@ -120,8 +120,8 @@ describe('custom <Field /> components with createFieldClass()', () => {
 
   it('should continue to recognize native controls', () => {
     const store = applyMiddleware(thunk)(createStore)(combineReducers({
-      testForm: createFormReducer('test'),
-      test: createModelReducer('test', { foo: 'bar' }),
+      testForm: formReducer('test'),
+      test: modelReducer('test', { foo: 'bar' }),
     }));
 
     const field = TestUtils.renderIntoDocument(
@@ -145,8 +145,8 @@ describe('custom <Field /> components with createFieldClass()', () => {
 
   it('should work with mapping appropriate change actions with type="..."', () => {
     const store = applyMiddleware(thunk)(createStore)(combineReducers({
-      testForm: createFormReducer('test'),
-      test: createModelReducer('test', { foo: 'bar' }),
+      testForm: formReducer('test'),
+      test: modelReducer('test', { foo: 'bar' }),
     }));
 
     class InputFoo extends React.Component {