Merge pull request #5712 from openstreetmap/preset-field-inheritance

Preset field inheritance
openstreetmap · Jan 15, 2019 · 03f3dd5 · 03f3dd5
2 parents a9b8cfd + 4252c5c
commit 03f3dd5
Show file tree

Hide file tree

Showing 149 changed files with 1,323 additions and 2,233 deletions.
diff --git a/build_data.js b/build_data.js
@@ -2,7 +2,6 @@
 const requireESM = require('esm')(module);
 const _cloneDeep = requireESM('lodash-es/cloneDeep').default;
 const _forEach = requireESM('lodash-es/forEach').default;
-const _intersection = requireESM('lodash-es/intersection').default;
 const _isEmpty = requireESM('lodash-es/isEmpty').default;
 const _merge = requireESM('lodash-es/merge').default;
 const _toPairs = requireESM('lodash-es/toPairs').default;
@@ -459,28 +458,29 @@ function validateCategoryPresets(categories, presets) {
 }
 
 function validatePresetFields(presets, fields) {
+    var betweenBracketsRegex = /([^{]*?)(?=\})/;
     _forEach(presets, function(preset) {
-        if (preset.fields) {
-            preset.fields.forEach(function(field) {
-                if (fields[field] === undefined) {
-                    console.error('Unknown preset field "' + field + '" in "fields" array of preset ' + preset.name);
-                    process.exit(1);
-                }
-            });
-        }
-        if (preset.moreFields) {
-            preset.moreFields.forEach(function(field) {
-                if (fields[field] === undefined) {
-                    console.error('Unknown preset field "' + field + '" in "moreFields" array of preset ' + preset.name);
-                    process.exit(1);
-                }
-            });
-        }
-        var fieldsIntersection = _intersection(preset.fields, preset.moreFields);
-        if (fieldsIntersection.length > 0) {
-            console.error('Preset field "' + fieldsIntersection[0] + '" in both "fields" and "moreFields" arrays of preset ' + preset.name);
-            process.exit(1);
-        }
+        // the keys for properties that contain arrays of field ids
+        var fieldKeys = ['fields', 'moreFields'];
+        fieldKeys.forEach(function(fieldsKey) {
+            if (preset[fieldsKey]) {
+                preset[fieldsKey].forEach(function(field) {
+                    if (fields[field] === undefined) {
+                        var regexResult = betweenBracketsRegex.exec(field);
+                        if (regexResult) {
+                            var foreignPresetID = regexResult[0];
+                            if (presets[foreignPresetID] === undefined) {
+                                console.error('Unknown preset "' + foreignPresetID + '" referenced in "' + fieldsKey + '" array of preset ' + preset.name);
+                                process.exit(1);
+                            }
+                        } else {
+                            console.error('Unknown preset field "' + field + '" in "' + fieldsKey + '" array of preset ' + preset.name);
+                            process.exit(1);
+                        }
+                    }
+                });
+            }
+        });
     });
 }
 

diff --git a/data/presets.yaml b/data/presets.yaml
@@ -226,7 +226,7 @@ en:
           onsen: Japanese Onsen
       beauty:
         # beauty=*
-        label: Shop Type
+        label: Beauty Specialty
       bench:
         # bench=*
         label: Bench

diff --git a/data/presets/README.md b/data/presets/README.md
@@ -58,7 +58,40 @@ The complete JSON schema for presets can be found in [`data/presets/schema/prese
 
 #### Preset Properties
 
-##### searchable
+##### `fields`/`moreFields`
+
+Both these properties are arrays of field paths (e.g. `description` or `generator/type`).
+`fields` are shown by default and `moreFields` are shown if manually added by the
+user or if a matching tag is present. Note that some fields have a `prerequisiteTag`
+property that limits when they will be shown.
+
+A preset can reference the fields of another by using that preset's name contained in
+brackets, like `{preset}`. For example, `shop/books` references and extends the fields
+of `shop`:
+
+```javascript
+"fields": [
+    "{shop}",
+    "internet_access"
+],
+"moreFields": [
+    "{shop}",
+    "internet_access/fee",
+    "internet_access/ssid"
+],
+"tags": {
+    "shop": "books"
+}
+```
+
+If `fields` or `moreFields` are not defined, the values of the preset's "parent"
+preset are used. For example, `shop/convenience` automatically uses the same
+fields as `shop`.
+
+In both explicit and implicit inheritance, fields for keys that define the
+preset are not inherited. E.g. the `shop` field is not inherited by `shop/…` presets.  
+
+##### `searchable`
 
 Deprecated or generic presets can include the property `"searchable": false`.
 This means that they will be recognized by iD when editing existing data,

diff --git a/data/presets/fields.json b/data/presets/fields.json
@@ -28,7 +28,7 @@
     "bath/open_air": {"key": "bath:open_air", "label": "Open Air", "type": "check"},
     "bath/sand_bath": {"key": "bath:sand_bath", "label": "Sand Bath", "type": "check"},
     "bath/type": {"key": "bath:type", "type": "combo", "label": "Specialty", "strings": {"options": {"onsen": "Japanese Onsen", "foot_bath": "Foot Bath", "hot_spring": "Hot Spring"}}},
-    "beauty": {"key": "beauty", "type": "combo", "label": "Shop Type"},
+    "beauty": {"key": "beauty", "type": "combo", "label": "Beauty Specialty"},
     "bench": {"key": "bench", "type": "check", "label": "Bench"},
     "bicycle_parking": {"key": "bicycle_parking", "type": "combo", "label": "Type"},
     "bin": {"key": "bin", "type": "check", "label": "Waste Bin"},

diff --git a/data/presets/fields/beauty.json b/data/presets/fields/beauty.json
@@ -1,5 +1,5 @@
 {
     "key": "beauty",
     "type": "combo",
-    "label": "Shop Type"
+    "label": "Beauty Specialty"
 }
diff --git a/data/presets/fields/shop.json b/data/presets/fields/shop.json
@@ -2,4 +2,4 @@
     "key": "shop",
     "type": "typeCombo",
     "label": "Type"
-}
+}