Implemented the jpaMetamodelFiltering option

Closes: jhipster/generator-jhipster#6286
jhipster · Aug 28, 2017 · fd8f712 · fd8f712 · DanielFran · Sep 23, 2017
1 parent e7699e1
commit fd8f712
Show file tree

Hide file tree

Showing 16 changed files with 1,494 additions and 1,216 deletions.
diff --git a/lib/core/jhipster/unary_options.js b/lib/core/jhipster/unary_options.js
@@ -2,7 +2,8 @@ const UNARY_OPTIONS = {
   SKIP_CLIENT: 'skipClient',
   SKIP_SERVER: 'skipServer',
   SKIP_USER_MANAGEMENT: 'skipUserManagement',
-  NO_FLUENT_METHOD: 'noFluentMethod'
+  NO_FLUENT_METHOD: 'noFluentMethod',
+  FILTER: 'filter',
 };
 
 function exists(option) {

diff --git a/lib/dsl/grammar.txt b/lib/dsl/grammar.txt
@@ -57,6 +57,7 @@
     searchEngine: {},
     noClient: { list: [], excluded: [] },
     noServer: { list: [], excluded: [] },
+    filter: { list: [], excluded: [] },
     angularSuffix: {},
     noFluentMethod: { list: [], excluded: [] }
   };
@@ -125,6 +126,10 @@ prog
     parsed.noFluentMethod = noFluentMethod;
     return parsed;
   }
+  / SPACE* filter:filterDecl SPACE* p:prog {
+    parsed.filter = filter;
+    return parsed;
+  }
   / '' { return parsed; }
 
 // Application Declaration
@@ -451,6 +456,22 @@ subNoServerDecl
   / ALL { return ['*']; }
   / e:ENTITY_NAME { return [e]; }
 
+// JPA Metamodel filter option
+filterDecl
+  = FILTER SPACE decl:subFilterDecl SPACE* ex:exclusion? SPACE*  {
+    addUniqueElements(parsed.filter.list, decl);
+    if (ex) {
+      addUniqueElements(parsed.filter.excluded, ex);
+    }
+    return parsed.filter;
+  }
+
+subFilterDecl
+  = e:ENTITY_NAME SPACE* ',' SPACE* sub:subFilterDecl { return addUniqueElements([e], sub); }
+  / STAR { return ['*']; }
+  / ALL { return ['*']; }
+  / e:ENTITY_NAME { return [e]; }
+
 
 // angularSuffix option
 angularSuffixDecl
@@ -567,6 +588,7 @@ SEARCH = 'search'
 SKIP_CLIENT = 'skipClient'
 SKIP_SERVER = 'skipServer'
 ANGULAR_SUFFIX = 'angularSuffix'
+FILTER = 'filter'
 // validations
 REQUIRED = 'required'
 MINLENGTH = 'minlength'

diff --git a/lib/dsl/pegjs_parser.js b/lib/dsl/pegjs_parser.js
diff --git a/lib/parser/entity_parser.js b/lib/parser/entity_parser.js
@@ -97,6 +97,7 @@ function initializeEntities() {
         dto: 'no',
         pagination: 'no',
         service: 'no',
+        jpaMetamodelFiltering: false
       };
     }
   }
@@ -133,6 +134,9 @@ function setEntityNamesOptions(option) {
     case BinaryOptions.ANGULAR_SUFFIX:
       entities[entityName].angularJSSuffix = option.value;
       break;
+    case UnaryOptions.FILTER:
+      entities[entityName].jpaMetamodelFiltering = true;
+      break;
     default:
       entities[entityName][option.name] = option.value;
     }

diff --git a/lib/parser/jdl_parser.js b/lib/parser/jdl_parser.js
@@ -223,6 +223,13 @@ function fillUnaryOptions() {
       excludedNames: document.noFluentMethod.excluded
     }));
   }
+  if (document.filter.list.length !== 0) {
+    jdlObject.addOption(new JDLUnaryOption({
+      name: UnaryOptions.UNARY_OPTIONS.FILTER,
+      entityNames: document.filter.list,
+      excludedNames: document.filter.excluded
+    }));
+  }
 }
 
 function addOption(key, value) {

diff --git a/test/spec/parser/entity_parser_test.js b/test/spec/parser/entity_parser_test.js
@@ -247,5 +247,16 @@ describe('::convert', () => {
         );
       });
     });
+    describe('when converting a JDL with filtering', () => {
+      const input = parseFromFiles(['./test/test_files/filtering.jdl']);
+      const content = EntityParser.parse({
+        jdlObject: JDLParser.parse(input, 'sql'),
+        databaseType: 'sql'
+      });
+      it('converts it', () => {
+        expect(content.A.jpaMetamodelFiltering).to.be.true;
+        expect(content.B.jpaMetamodelFiltering).to.be.false;
+      });
+    });
   });
 });
diff --git a/test/spec/parser/jdl_parser_test.js b/test/spec/parser/jdl_parser_test.js
@@ -622,6 +622,14 @@ describe('JDLParser', () => {
           expect(application.skipServer).to.be.false;
         });
       });
+      describe('when parsing filtered entities', () => {
+        const input = parseFromFiles(['./test/test_files/filtering.jdl']);
+        const content = JDLParser.parse(input, 'sql');
+        it('works', () => {
+          expect(content.options.options.filter.entityNames.has('*')).to.be.true;
+          expect(content.options.options.filter.excludedNames.has('B')).to.be.true;
+        });
+      });
     });
   });
 });
diff --git a/test/test_files/filtering.jdl b/test/test_files/filtering.jdl
@@ -0,0 +1,4 @@
+entity A
+entity B
+
+filter * except B
diff --git a/test/test_files/jhipster_app/.jhipster/Country.json b/test/test_files/jhipster_app/.jhipster/Country.json
@@ -1,39 +1,40 @@
 {
-    "fluentMethods": true,
-    "relationships": [
-        {
-            "relationshipType": "one-to-one",
-            "relationshipName": "region",
-            "otherEntityName": "region",
-            "otherEntityField": "id",
-            "ownerSide": true,
-            "otherEntityRelationshipName": "country"
-        },
-        {
-            "relationshipType": "one-to-one",
-            "relationshipName": "user",
-            "otherEntityName": "user",
-            "otherEntityField": "id",
-            "ownerSide": true,
-            "otherEntityRelationshipName": "country"
-        }
-    ],
-    "fields": [
-        {
-            "fieldName": "countryId",
-            "fieldType": "Long",
-            "javadoc": "The country Id"
-        },
-        {
-            "fieldName": "countryName",
-            "fieldType": "String"
-        }
-    ],
-    "changelogDate": "20160926101210",
-    "entityTableName": "country",
-    "dto": "no",
-    "pagination": "no",
-    "service": "no",
-    "skipClient": true,
-    "skipServer": true
+  "fluentMethods": true,
+  "relationships": [
+    {
+      "relationshipType": "one-to-one",
+      "relationshipName": "region",
+      "otherEntityName": "region",
+      "otherEntityField": "id",
+      "ownerSide": true,
+      "otherEntityRelationshipName": "country"
+    },
+    {
+      "relationshipType": "one-to-one",
+      "relationshipName": "user",
+      "otherEntityName": "user",
+      "otherEntityField": "id",
+      "ownerSide": true,
+      "otherEntityRelationshipName": "country"
+    }
+  ],
+  "fields": [
+    {
+      "fieldName": "countryId",
+      "fieldType": "Long",
+      "javadoc": "The country Id"
+    },
+    {
+      "fieldName": "countryName",
+      "fieldType": "String"
+    }
+  ],
+  "changelogDate": "20160926101210",
+  "entityTableName": "country",
+  "dto": "no",
+  "pagination": "no",
+  "service": "no",
+  "jpaMetamodelFiltering": false,
+  "skipClient": true,
+  "skipServer": true
 }
diff --git a/test/test_files/jhipster_app/.jhipster/Department.json b/test/test_files/jhipster_app/.jhipster/Department.json
@@ -1,41 +1,42 @@
 {
-    "fluentMethods": true,
-    "relationships": [
-        {
-            "relationshipType": "one-to-one",
-            "relationshipName": "location",
-            "otherEntityName": "location",
-            "otherEntityField": "id",
-            "ownerSide": true,
-            "otherEntityRelationshipName": "department"
-        },
-        {
-            "relationshipType": "one-to-many",
-            "relationshipValidateRules": "required",
-            "relationshipName": "employee",
-            "otherEntityName": "employee",
-            "javadoc": "A relationship",
-            "otherEntityRelationshipName": "department"
-        }
-    ],
-    "fields": [
-        {
-            "fieldName": "departmentId",
-            "fieldType": "Long"
-        },
-        {
-            "fieldName": "departmentName",
-            "fieldType": "String",
-            "fieldValidateRules": [
-                "required"
-            ]
-        }
-    ],
-    "changelogDate": "20160926092246",
-    "entityTableName": "department",
-    "dto": "no",
-    "pagination": "no",
-    "service": "no",
-    "skipClient": true,
-    "skipServer": true
+  "fluentMethods": true,
+  "relationships": [
+    {
+      "relationshipType": "one-to-one",
+      "relationshipName": "location",
+      "otherEntityName": "location",
+      "otherEntityField": "id",
+      "ownerSide": true,
+      "otherEntityRelationshipName": "department"
+    },
+    {
+      "relationshipType": "one-to-many",
+      "relationshipValidateRules": "required",
+      "relationshipName": "employee",
+      "otherEntityName": "employee",
+      "javadoc": "A relationship",
+      "otherEntityRelationshipName": "department"
+    }
+  ],
+  "fields": [
+    {
+      "fieldName": "departmentId",
+      "fieldType": "Long"
+    },
+    {
+      "fieldName": "departmentName",
+      "fieldType": "String",
+      "fieldValidateRules": [
+        "required"
+      ]
+    }
+  ],
+  "changelogDate": "20160926092246",
+  "entityTableName": "department",
+  "dto": "no",
+  "pagination": "no",
+  "service": "no",
+  "jpaMetamodelFiltering": false,
+  "skipClient": true,
+  "skipServer": true
 }