Merge branch 'master' into fix/1432

finos · Nov 13, 2019 · 1e4cb3e · 1e4cb3e
2 parents 96d0939 + d12be61
commit 1e4cb3e
Show file tree

Hide file tree

Showing 182 changed files with 1,235 additions and 171 deletions.
diff --git a/common/src/main/java/com/scottlogic/deg/common/profile/FieldType.java b/common/src/main/java/com/scottlogic/deg/common/profile/FieldType.java
@@ -20,5 +20,6 @@ public enum FieldType
 {
     NUMERIC,
     STRING,
-    DATETIME
+    DATETIME,
+    BOOLEAN
 }
diff --git a/common/src/main/java/com/scottlogic/deg/common/profile/SpecificFieldType.java b/common/src/main/java/com/scottlogic/deg/common/profile/SpecificFieldType.java
@@ -33,7 +33,8 @@ public enum SpecificFieldType
     FULL_NAME("fullname", FieldType.STRING),
     STRING("string", FieldType.STRING),
     DATETIME("datetime", FieldType.DATETIME),
-    DATE("date",FieldType.DATETIME);
+    DATE("date",FieldType.DATETIME),
+    BOOLEAN("boolean", FieldType.BOOLEAN);
 
     @JsonValue
     private final String type;
@@ -69,6 +70,7 @@ public static SpecificFieldType from(String type){
             case "string": return STRING;
             case "datetime": return DATETIME;
             case "date": return DATE;
+            case "boolean": return BOOLEAN;
             default:
                 throw new IllegalStateException("No data types with type " + type);
         }

diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md
@@ -40,7 +40,7 @@ We'll start by generating data for a trivial schema. Using your favourite text e
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [{ "name": "firstName", "type": "string" }],
     "rules": []
 }
@@ -111,7 +111,7 @@ Update the JSON profile as follows:
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [{ "name": "firstName", "type": "string" }],
     "rules": [
         {
@@ -181,7 +181,7 @@ We'll expand the example profile to add a new `age` field, a not-null integer in
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [
         { "name": "firstName", "type": "string" }, 
         { "name": "age", "type": "integer"  }
@@ -228,7 +228,7 @@ Finally, we'll add a field for National Insurance number. In this case, the cons
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [
         { "name": "firstName", "type": "string" }, 
         { "name": "age", "type": "integer"  },

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -56,6 +56,7 @@
 7. [Custom Generators](#custom-generator)
     1. [adding](#adding-custom-generator)
     2. [using](#using-custom-generator)
+    3. [using as constraint](#using-custom-generator-as-constraint)
 
 8. [Running a Profile](#Running-a-Profile)
     1. [Command Line Arguments](#Command-Line-Arguments)
@@ -87,9 +88,9 @@ This section will walk you through creating basic profiles with which you can ge
 Profiles are JSON documents consisting of three sections, the schema version, the list of fields and the rules.
 
 - **Schema Version** - Dictates the method of serialisation of the profile in order for the generator to
-interpret the profile fields and rules. The latest version is 0.7.
+interpret the profile fields and rules. The latest version is 
 ```
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
 ```
 - **List of Fields** - An array of column headings is defined with unique "name" keys.
 ```
@@ -140,7 +141,7 @@ These three sections are combined to form the [complete profile](#Example-Profil
 ## Example Profile
 
     {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [
         {
             "name": "Column 1",
@@ -209,6 +210,7 @@ The data type of the field. See [Data types](#Data-Types) for more on how types
 *  `firstname`
 *  `lastname`
 *  `fullname`
+*  `boolean`
 
  This is a required property.
 
@@ -250,6 +252,12 @@ Sets the field as unique. Unique fields can not be used within [grammatical cons
 
 # Data Types
 
+## Boolean
+
+Users can specify boolean data types which will take the values `true` and `false`.
+
+Currently these types are only supported with the `equalTo` and `equalToField` constraints, for example:
+
 ## Integer/Decimal
 
 Within a profile, users can specify two numeric data types: integer and decimal. Under the hood both of these data types are considered numeric from a point of generation but the integer type enforces a granularity of 1, see below for more information on granularity.
@@ -333,6 +341,8 @@ OR
 { "field": "type", "equalTo": 23 }
 OR
 { "field": "type", "equalTo": "2001-02-03T04:05:06.007" }
+OR
+{ "field": "type", "equalTo": true }
 ```
 
 Is satisfied if `field`'s value is equal to `value`
@@ -668,7 +678,6 @@ While it's not prohibited, wrapping conditional constraints in any other kind of
 
 
 
-
 # Custom Generators
 <div id="custom-generator"></div>
 
@@ -704,6 +713,22 @@ This will use the "lorem ipsum" example custom generator.
 
 To use your own, put the name of your generator instead of "lorem ipsum"
 
+## using Custom Generators as Constraint
+<div id="using-custom-generator-as-constraint"></div>
+
+You can also use custom generators as constraints 
+
+
+```javascript
+{ "field": "field1", "generator": "lorem ipsum" }
+```
+
+Custom generators can be used in "anyOf" grammatical constraints, as well as in the "then" and "else" parts of conditional constraints
+
+To combine generators with sets and equalTo, you will need to create a 'matchingFunction' when building the custom generator. Which should be a function that returns true if a value is one the custom generator could produce. 
+
+To be able negate the custom generator, or use in the 'if' section of an if then statement, you must define the 'negated Generator' when building the custom generator. Which should return values that the custom generator should not produce. 
+
 # Running a Profile
 <div id="Running-a-Profile"></div>
 

diff --git a/docs/user/Schema.md b/docs/user/Schema.md
@@ -3,7 +3,7 @@
 ## Sample file
 ```javascript
 {
-	"schemaVersion": "0.7",
+	"schemaVersion": "0.16",
 	"description": "A dataset about financial products",
 	"fields":
 	[

diff --git a/examples/a-valid-isin/profile.json b/examples/a-valid-isin/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "isin",

diff --git a/examples/actor-names/profile.json b/examples/actor-names/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "forename",

diff --git a/examples/anyOf/profile.json b/examples/anyOf/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "rules": [
     {
       "rule": "rule 1",

diff --git a/examples/boolean/README.md b/examples/boolean/README.md
@@ -0,0 +1 @@
+A profile that generates booleans.
diff --git a/examples/boolean/profile.json b/examples/boolean/profile.json
@@ -0,0 +1,31 @@
+{
+  "schemaVersion": "0.14",
+  "fields": [
+    {
+      "name": "alwaysTrue",
+      "type": "boolean",
+      "nullable": false
+    },
+    {
+      "name": "alwaysFalseOrNull",
+      "type": "boolean",
+      "nullable": true
+    }
+  ],
+  "rules": [
+    {
+      "constraints": [
+        {
+          "field": "alwaysTrue",
+          "equalTo": true
+        },
+        {
+          "not": {
+            "field": "alwaysFalseOrNull",
+            "equalToField": "alwaysTrue"
+          }
+        }
+      ]
+    }
+  ]
+}
diff --git a/examples/date-after/profile.json b/examples/date-after/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "date",

diff --git a/examples/datetime-after-dynamic/profile.json b/examples/datetime-after-dynamic/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "field1",

diff --git a/examples/datetime-after/profile.json b/examples/datetime-after/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "date",

diff --git a/examples/datetime-equal-to-dynamic-offset/profile.json b/examples/datetime-equal-to-dynamic-offset/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first",

diff --git a/examples/datetime-equal-to-dynamic/profile.json b/examples/datetime-equal-to-dynamic/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first",

diff --git a/examples/datetime-equal-to/profile.json b/examples/datetime-equal-to/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "date",

diff --git a/examples/datetime-offset-working-days/profile.json b/examples/datetime-offset-working-days/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "foo",

diff --git a/examples/demo-trades-smaller/profile.json b/examples/demo-trades-smaller/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "tradeId",

diff --git a/examples/demo-trades/profile.json b/examples/demo-trades/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "tradeId",

diff --git a/examples/duplicates/profile.json b/examples/duplicates/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "a",

diff --git a/examples/formatting/profile.json b/examples/formatting/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "decimal",

diff --git a/examples/from-file-weighted/profile.json b/examples/from-file-weighted/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "name",

diff --git a/examples/from-file/profile.json b/examples/from-file/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "name",

diff --git a/examples/hard-contradiction-null-validation/profile.json b/examples/hard-contradiction-null-validation/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "Column 1",

diff --git a/examples/hard-contradiction-range-and-granular/profile.json b/examples/hard-contradiction-range-and-granular/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "Column 1",

diff --git a/examples/integer-range-with-blacklist/profile.json b/examples/integer-range-with-blacklist/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "an_integer",

diff --git a/examples/integer-range/profile.json b/examples/integer-range/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "an_integer",

diff --git a/examples/multiple-fields/profile.json b/examples/multiple-fields/profile.json
@@ -1,5 +1,5 @@
 {
-    "schemaVersion": "0.15",
+    "schemaVersion": "0.16",
     "fields": [
         {
             "name": "field1",

diff --git a/examples/names/profile.json b/examples/names/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "forename",

diff --git a/examples/partial-contradictions/profile.json b/examples/partial-contradictions/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "Column 1",

diff --git a/examples/partitioning/profile.json b/examples/partitioning/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "p1f1",

diff --git a/examples/real-number-range/profile.json b/examples/real-number-range/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "a_number",

diff --git a/examples/regex-contains/profile.json b/examples/regex-contains/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

diff --git a/examples/regex-intersect-with-blacklist/profile.json b/examples/regex-intersect-with-blacklist/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

diff --git a/examples/regex-intersect/profile.json b/examples/regex-intersect/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

diff --git a/examples/regex/profile.json b/examples/regex/profile.json
@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",