Merge pull request #9 from davidlandais/feat-component-overriding

feat(ui-component-overriding): add possibility to override ui default…

Author: FGRibreau

.gitignore

@@ -1,5 +1,13 @@
+lib
 .cache
+.vscode
+.idea
+coverage
+node_modules
+lerna-debug.log
+npm-debug.log
+.DS_Store
+docs
 old
-dist/
-coverage/
-.env
+dist
+.env

packages/ui-predicate-core/.gitignore

@@ -1,4 +1,11 @@
 lib
 .cache
+.vscode
+.idea
 coverage
 node_modules
+lerna-debug.log
+npm-debug.log
+.DS_Store
+docs
+dist

packages/ui-predicate-core/src/PredicateCore.js

@@ -1,7 +1,7 @@
 /* eslint no-unused-vars: "off" */
 
 /**
- * Rules
+ * PredicateCore
  * @module core
  * @namespace core
  * @since 1.0.0
@@ -27,7 +27,7 @@ function head(list) {
   return option.fromNullable(list[0]).value();
 }
 
-module.exports = function({ dataclasses, invariants, errors, rules }) {
+module.exports = function({ dataclasses, invariants, errors, rules, UITypes }) {
   const { CompoundPredicate, ComparisonPredicate, Predicate } = dataclasses;
   /**
    * Get a type by its type_id
@@ -278,7 +278,7 @@ module.exports = function({ dataclasses, invariants, errors, rules }) {
    * @memberof core
    */
   function PredicateCore(args) {
-    const { columns, data, options } = args;
+    const { data, columns, ui, options } = args;
 
     return new Promise((resolve, reject) => {
       try {
@@ -572,6 +572,17 @@ module.exports = function({ dataclasses, invariants, errors, rules }) {
             );
         }
 
+        /**
+         * Get default or overrided ui component
+         * @param {ui} name the UIType key to get the right component
+         * @return {any} component
+         * @since 1.0.0
+         * @memberof core.api
+         */
+        function getUIComponent(name) {
+          return ui[name];
+        }
+
         /**
          * Compute the JSON pointer path the element
          * @param  {Object} element (http://jsonpatch.com/)
@@ -683,6 +694,20 @@ module.exports = function({ dataclasses, invariants, errors, rules }) {
                 setArgumentValue: _afterPromise(setArgumentValue, _afterWrite),
 
                 getArgumentTypeComponentById,
+
+                /**
+                 * Enumeration of overridable core ui-predicate component
+                 * @enum {String}
+                 */
+                UITypes,
+
+                /**
+                 * Get core UI component (e.g. target selector)
+                 * @param {core.ui} ui component name
+                 * @return {Object} component
+                 * @memberof core.api
+                 */
+                getUIComponent,
                 toJSON,
 
                 /**

packages/ui-predicate-core/src/PredicateCore.test.js

@@ -11,6 +11,7 @@ const {
     ComparisonPredicate,
     LogicalType,
   },
+  UITypes,
   errors,
 } = require('./index');
 
@@ -591,6 +592,18 @@ describe('UIPredicateCore', () => {
     });
   });
 
+  describe('ctrl.getUIComponent', () => {
+    it('return a default UI component', () => {
+      expect.assertions(1);
+      return PredicateCore({
+        columns: _defaultConfig(),
+        ui: UITypes
+      }).then(ctrl => {
+        expect(ctrl.getUIComponent(UITypes.TARGETS)).toBe('TARGETS');
+      });
+    });
+  });
+
   describe('ctrl.options', () => {
     it('expose computed options', () => {
       expect.assertions(1);

packages/ui-predicate-core/src/UITypes.js

@@ -0,0 +1,15 @@
+/**
+ * UITypes
+ * @module ui
+ * @namespace core
+ * @since 1.0.0
+ * @note default (and overridable) base ui components of ui-predicate (e.g. target select, operator select, add button, remove button, ...)
+*/
+module.exports = {
+    TARGETS: 'TARGETS',
+    LOGICAL_TYPES: 'LOGICAL_TYPES',
+    OPERATORS: 'OPERATORS',
+    PREDICATE_ADD: 'PREDICATE_ADD',
+    PREDICATE_REMOVE: 'PREDICATE_REMOVE',
+    ARGUMENT_DEFAULT: 'ARGUMENT_DEFAULT',
+}

packages/ui-predicate-core/src/__snapshots__/PredicateCore.test.js.snap

@@ -30,6 +30,8 @@ Array [
   "setPredicateLogicalType_id",
   "setArgumentValue",
   "getArgumentTypeComponentById",
+  "UITypes",
+  "getUIComponent",
   "toJSON",
   "root",
   "columns",

packages/ui-predicate-core/src/index.js

@@ -1,4 +1,5 @@
 const errors = require('./errors');
+const UITypes = require('./UITypes');
 const rules = require('./rules');
 const invariants = require('./invariants')({ errors, rules });
 const dataclasses = require('./dataclasses')({ invariants, errors });
@@ -7,5 +8,7 @@ const PredicateCore = require('./PredicateCore')({
   invariants,
   errors,
   rules,
+  UITypes,
 });
-module.exports = { PredicateCore, errors, invariants, dataclasses };
+
+module.exports = { PredicateCore, errors, invariants, UITypes, dataclasses };

packages/ui-predicate-vue/.gitignore

@@ -0,0 +1,11 @@
+lib
+.cache
+.vscode
+.idea
+coverage
+node_modules
+lerna-debug.log
+npm-debug.log
+.DS_Store
+docs
+dist

packages/ui-predicate-vue/getting-started/simple.vue

@@ -1,7 +1,12 @@
 <template>
     <div class="columns">
       <div class="column">
-        <ui-predicate :config="config" @changed="onChange" @initialized="onChange"></ui-predicate>
+        <ui-predicate
+          v-model="predicate"
+          :columns="columns"
+          @changed="onChange"
+          @initialized="onChange"
+        />
       </div>
 
       <div class="column">
@@ -38,8 +43,20 @@ export default {
   name: 'app',
   data() {
     return {
-      ast: {},
-      config: {
+      ast: {
+        
+      },
+      predicate: {
+        logicalType_id: 'all',
+        predicates: [
+          {
+            "target_id": "article.videoCount",
+            "operator_id": "isEqualTo",
+            "argument": 42
+          },
+        ],
+      },
+      columns: {
         targets: [
           {
             target_id: 'article.title',

packages/ui-predicate-vue/jest.config.js

@@ -23,4 +23,6 @@ module.exports = {
   collectCoverage: true,
   coverageReporters: ['html', 'text-summary'],
   collectCoverageFrom: ['**/*.{js,vue}', '!**/node_modules/**'],
+  verbose: true,
+  testURL: 'http://localhost/',
 };