adds model-form-fields decorator from ui/kubernetes-secrets-engine br…

…anch (#18103)

ui/app/decorators/model-form-fields.js

@@ -0,0 +1,39 @@
+import fieldToAttrs, { expandAttributeMeta } from 'vault/utils/field-to-attrs';
+import Model from '@ember-data/model';
+
+/**
+ * sets formFields and/or formFieldGroups properties on model class based on attr options
+ *
+ * propertyNames must be an array of brace expansion supported strings that represent model attr names
+ * groupPropertyNames must be an array of objects where the keys represent the group names and the values are propertyNames
+ *
+ * reference the field-to-attrs util for more information on expected format for fields and groups
+ */
+
+export function withFormFields(propertyNames, groupPropertyNames) {
+  return function decorator(SuperClass) {
+    if (!Object.prototype.isPrototypeOf.call(Model, SuperClass)) {
+      // eslint-disable-next-line
+      console.error(
+        'withFormFields decorator must be used on instance of ember-data Model class. Decorator not applied to returned class'
+      );
+      return SuperClass;
+    }
+    return class ModelFormFields extends SuperClass {
+      constructor() {
+        super(...arguments);
+        if (!Array.isArray(propertyNames) && !Array.isArray(groupPropertyNames)) {
+          throw new Error(
+            'Array of property names and/or array of field groups are required when using withFormFields model decorator'
+          );
+        }
+        if (propertyNames) {
+          this.formFields = expandAttributeMeta(this, propertyNames);
+        }
+        if (groupPropertyNames) {
+          this.formFieldGroups = fieldToAttrs(this, groupPropertyNames);
+        }
+      }
+    };
+  };
+}

ui/tests/unit/decorators/model-form-fields-test.js

@@ -0,0 +1,75 @@
+import { module, test } from 'qunit';
+import { setupTest } from 'ember-qunit';
+import { withFormFields } from 'vault/decorators/model-form-fields';
+import sinon from 'sinon';
+import Model, { attr } from '@ember-data/model';
+
+// create class using decorator
+const createClass = (propertyNames, groups) => {
+  @withFormFields(propertyNames, groups)
+  class Foo extends Model {
+    @attr('string', {
+      label: 'Foo',
+      subText: 'A form field',
+    })
+    foo;
+    @attr('boolean', {
+      label: 'Bar',
+      subText: 'Maybe a checkbox',
+    })
+    bar;
+  }
+  return new Foo();
+};
+
+module('Unit | Decorators | ModelFormFields', function (hooks) {
+  setupTest(hooks);
+
+  hooks.beforeEach(function () {
+    this.spy = sinon.spy(console, 'error');
+    this.fooField = {
+      name: 'foo',
+      options: { label: 'Foo', subText: 'A form field' },
+      type: 'string',
+    };
+    this.barField = {
+      name: 'bar',
+      options: { label: 'Bar', subText: 'Maybe a checkbox' },
+      type: 'boolean',
+    };
+  });
+  hooks.afterEach(function () {
+    this.spy.restore();
+  });
+
+  test('it should warn when applying decorator to class that does not extend Model', function (assert) {
+    @withFormFields()
+    class Foo {} // eslint-disable-line
+    const message =
+      'withFormFields decorator must be used on instance of ember-data Model class. Decorator not applied to returned class';
+    assert.ok(this.spy.calledWith(message), 'Error is printed to console');
+  });
+
+  test('it should throw error when arguments are not provided', function (assert) {
+    assert.expect(1);
+    try {
+      createClass();
+    } catch (error) {
+      const message =
+        'Array of property names and/or array of field groups are required when using withFormFields model decorator';
+      assert.strictEqual(error.message, message);
+    }
+  });
+
+  test('it should set formFields prop on Model class', function (assert) {
+    const model = createClass(['foo']);
+    assert.deepEqual([this.fooField], model.formFields, 'formFields set on Model class');
+  });
+
+  test('it should set formFieldGroups on Model class', function (assert) {
+    const groups = [{ default: ['foo'] }, { subgroup: ['bar'] }];
+    const model = createClass(null, groups);
+    const fieldGroups = [{ default: [this.fooField] }, { subgroup: [this.barField] }];
+    assert.deepEqual(fieldGroups, model.formFieldGroups, 'formFieldGroups set on Model class');
+  });
+});