RxProps: Uses "get" interface instead of "getFieldProp"

Author: kettanaito

examples/reactive-props/DelegatedSubscription.jsx

@@ -14,8 +14,8 @@ export default class RxPropsDelegatedSubscription extends React.Component {
             name="firstName"
             label="Fisrt name"
             hint="Required when `lastName` has value"
-            required={({ getFieldProp }) => {
-              return !!getFieldProp(['lastName', 'value']);
+            required={({ get }) => {
+              return !!get(['lastName', 'value']);
             }} />
           <Input
             name="lastName"

examples/reactive-props/DynamicRequired.jsx

@@ -18,8 +18,8 @@ export default class RxPropsDynamicRequired extends React.Component {
             name="lastName"
             label="Last name"
             hint="Required when `firstName` has value"
-            required={({ getFieldProp }) => {
-              return !!getFieldProp(['firstName', 'value']);
+            required={({ get }) => {
+              return !!get(['firstName', 'value']);
             }} />
 
           <Button>Submit</Button>

examples/reactive-props/Interdependent.jsx

@@ -14,15 +14,15 @@ export default class RxPropsInterdependent extends React.Component {
             name="firstName"
             label="First name"
             hint="Required when `lastName` has value"
-            required={({ getFieldProp }) => {
-              return !!getFieldProp(['lastName', 'value']);
+            required={({ get }) => {
+              return !!get(['lastName', 'value']);
             }} />
           <Input
             name="lastName"
             label="Last name"
             hint="Required when `firstName` has value"
-            required={({ getFieldProp }) => {
-              return !!getFieldProp(['firstName', 'value']);
+            required={({ get }) => {
+              return !!get(['firstName', 'value']);
             }} />
 
           <Button>Submit</Button>

examples/reactive-props/SingleTarget.jsx

@@ -14,8 +14,8 @@ export default class RxPropsSingleTarget extends React.Component {
             name="firstName"
             label="First name"
             hint="Required when `lastName` has value"
-            required={({ getFieldProp }) => {
-              return !!getFieldProp(['lastName', 'value']);
+            required={({ get }) => {
+              return !!get(['lastName', 'value']);
             }} />
           <Input
             name="lastName"
@@ -24,8 +24,8 @@ export default class RxPropsSingleTarget extends React.Component {
             name="fieldThree"
             label="Some field three"
             hint="Required when `lastName` has value"
-            required={({ getFieldProp }) => {
-              return !!getFieldProp(['lastName', 'value'])
+            required={({ get }) => {
+              return !!get(['lastName', 'value'])
             }} />
           <Button>Submit</Button>
         </Form>

examples/validation/SyncValidation/Form.props.rules.jsx

@@ -13,8 +13,8 @@ const rules = {
       const { ref: { props } } = fieldProps;
       return (value !== 'foo');
     },
-    fieldTwo: ({ value, getFieldProp }) => {
-      return (value === getFieldProp(['fieldOne', 'value']));
+    fieldTwo: ({ value, get }) => {
+      return (value === get(['fieldOne', 'value']));
     }
   }
 };

src/utils/fieldUtils/createPropGetter.js

@@ -1,12 +1,17 @@
 /**
- * Generates a field prop getter function.
+ * A thunk to generate a field prop getter function.
  * The latter is used for reactive props implementation and allows to flush
  * field prop references into a single source using a callback function.
  * @param {Map} fields
  * @param {Function} callback
+ * @returns {Function} A field prop getter function.
  */
 export default function createPropGetter(fields, callback) {
   return (propPath) => {
+    /**
+     * Getting the value is an internal procedure operating with Immutable fields.
+     * This logic is not affected by the "withImmutable" option.
+     */
     const propValue = fields.getIn(propPath);
 
     if (callback) {

src/utils/fieldUtils/validateSync.js

@@ -90,7 +90,7 @@ export default function validateSync({ fieldProps, fields, form }) {
   const resolverArgs = {
     [valuePropName]: value,
     fieldProps,
-    getFieldProp: createPropGetter(fields),
+    get: createPropGetter(fields),
     fields,
     form
   };

src/utils/flushFieldRefs.js

@@ -10,11 +10,11 @@ import createPropGetter from './fieldUtils/createPropGetter';
 export default function flushFieldRefs(method, methodArgs) {
   const { fields, form } = methodArgs;
   const refs = [];
-  const getFieldProp = createPropGetter(fields, propPath => refs.push(propPath));
+  const fieldPropGetter = createPropGetter(fields, propRefPath => refs.push(propRefPath));
 
   const initialValue = dispatch(method, {
     ...methodArgs,
-    getFieldProp
+    get: fieldPropGetter
   }, form.context);
 
   return { refs, initialValue };

src/utils/rxUtils/createRulesSubscriptions.js

@@ -2,11 +2,12 @@ import makeObservable from './makeObservable';
 import flushFieldRefs from '../flushFieldRefs';
 import getFieldRules from '../formUtils/getFieldRules';
 
-//
-// TODO
-// Change rule subscriptions according to new "getFieldProp" API
-//
-
+/**
+ * Creates an observable for each validation rule which referenced other fields' props.
+ * @param {Map} fieldProps
+ * @param {Map} fields
+ * @param {Object} form
+ */
 export default function createRulesSubscriptions({ fieldProps, fields, form }) {
   const { rxRules } = form.state;
   const value = fieldProps.get(fieldProps.get('valuePropName'));

src/utils/rxUtils/createSubscriptions.js

@@ -23,7 +23,7 @@ export default function createSubscriptions({ fieldProps, fields, form }) {
         const nextPropValue = resolver({
           fieldProps: fieldProps.toJS(),
           fields: nextFields.toJS(),
-          getFieldProp: createPropGetter(nextFields),
+          get: createPropGetter(nextFields),
           form
         }, form.context);