Changeset 14897 in josm for trunk

Timestamp:

2019-03-18T09:10:55+01:00 (5 years ago)

Author:

GerdP

Message:

fix #17468: Validator produces wrong warning for misspelled tag key

TODO: further improve words.cfg

Location:

trunk

Files:

• data/validator/ignoretags.cfg (modified) (1 diff)
• data/validator/words.cfg (modified) (9 diffs)
• src/org/openstreetmap/josm/data/validation/tests/TagChecker.java (modified) (5 diffs)
• test/unit/org/openstreetmap/josm/data/validation/tests/TagCheckerTest.java (modified) (1 diff)

trunk/data/validator/ignoretags.cfg

@@ -2 +2 @@
 ; This is used for checks "key/tag not in presets"
 ; K:  the given tag will not produce a "tag not in presets" error, but it is 
-;     used as dictionary entry for spell checking the given key.
-; E:  ignore tags with this key
-; S:  ignore tag if key starts with this string
-; F:  ignore tag if key ends with this string
+;     used as dictionary entry for spell checking the given key and also 
+;     for the key/value combination.
+; E:  ignore tags with this key and add the key to the spell check dictionary.
+; S:  ignore tag if key starts with this string.
+; F:  ignore tag if key ends with this string.
 ;
 ;

trunk/data/validator/words.cfg

@@ -8 +8 @@
 # There must not be any white space before or after words, unless they are to be included in
 # the bad spelling.
-# There is no need to add bad spelling with different upper/lower case.
+# There is no need to add bad spelling with different upper/lower case for keys 
+#   which appear in the presets or the ignoreTags.cfg (prefixes E: and K:)
 # There is no need to add bad spelling with leading or trailing blanks.
 
@@ -40 +41 @@
 -maenity
 -emenity
++barrier
+-barier
 +bicycle
 -bycycle
@@ -50 +53 @@
 +commercial
 -comercial
-+created_by
--cretaed_by
--crated_by
--creared_by
--creayed_by
--{created_by
--creeated_by
--created_bu
 +denomination
 -denonimation
@@ -161 +156 @@
 -oeway
 -eway
-+osmarender:nameDirection
--name_direction
--osmarender:name_direction
 +railway
 -raillway
@@ -178 +170 @@
 -waterwy
 -wateway
-+unknown
--unknwon
 #
 # Not sorted.
@@ -208 +198 @@
 -bulding
 -buildinq
-+city
--citya
 +complete
 -complite
@@ -221 +209 @@
 -desription
 -decription
-+feature
--featuer
 +freight
 -frieght
 +full_name:fa
 -full_name:Fa
-+highway_border
--highway_boarder
--highway_boreder
 +int_name
 -iint_name
@@ -290 +273 @@
 +old_name
 -oldname
-+osmarender:renderName
--osmarender:rendername
--soamrender:renderName
-+osmarender:renderRef
--osmrender:renderRef
 +postal_code
 -posatl_code
@@ -324 +302 @@
 -tracltype
 -trackype
-+tramline
--tram_line
 +tunnel
 -tunne

trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java

@@ -297 +297 @@
             case "E:":
                 ignoreDataEquals.add(line);
+                addToKeyDictionary(line);
                 break;
             case "F:":
@@ -305 +306 @@
                 ignoreDataTag.add(tag);
                 oftenUsedTags.put(tag.getKey(), tag.getValue());
+                addToKeyDictionary(tag.getKey());
                 break;
             default:
@@ -314 +316 @@
             Logging.error("Invalid line in {0} : {1}", source, e.getMessage());
             Logging.trace(e);
+        }
+    }
+
+    private static void addToKeyDictionary(String key) {
+        if (key != null) {
+            String hk = harmonizeKey(key);
+            if (!key.equals(hk)) {
+                harmonizedKeys.put(hk, key);
+            }
         }
     }
@@ -356 +367 @@
     private static void addPresetValue(KeyedItem ky) {
         if (ky.key != null && ky.getValues() != null) {
-            String hk = harmonizeKey(ky.key);
-            if (!ky.key.equals(hk)) {
-                harmonizedKeys.put(hk, ky.key);
-            }
+            addToKeyDictionary(ky.key);
         }
     }
@@ -602 +610 @@
     private void spellCheckKey(MultiMap<OsmPrimitive, String> withErrors, OsmPrimitive p, String key) {
         String prettifiedKey = harmonizeKey(key);
-        String fixedKey = isKeyInPresets(prettifiedKey) ? prettifiedKey : harmonizedKeys.get(prettifiedKey);
+        String fixedKey;
+        if (ignoreDataEquals.contains(prettifiedKey)) {
+            fixedKey = prettifiedKey;
+        } else {
+            fixedKey = isKeyInPresets(prettifiedKey) ? prettifiedKey : harmonizedKeys.get(prettifiedKey);
+        }
+        if (fixedKey == null) {
+            for (Tag a : ignoreDataTag) {
+                if (a.getKey().equals(prettifiedKey)) {
+                    fixedKey = prettifiedKey;
+                    break;
+                }
+            }
+        }
+
         if (fixedKey != null && !"".equals(fixedKey) && !fixedKey.equals(key)) {
+            final String proposedKey = fixedKey;
             // misspelled preset key
             final TestError.Builder error = TestError.builder(this, Severity.WARNING, MISSPELLED_KEY)
-                    .message(tr("Misspelled property key"), marktr("Key ''{0}'' looks like ''{1}''."), key, fixedKey)
+                    .message(tr("Misspelled property key"), marktr("Key ''{0}'' looks like ''{1}''."), key, proposedKey)
                     .primitives(p);
             if (p.hasKey(fixedKey)) {
                 errors.add(error.build());
             } else {
-                errors.add(error.fix(() -> new ChangePropertyKeyCommand(p, key, fixedKey)).build());
+                errors.add(error.fix(() -> new ChangePropertyKeyCommand(p, key, proposedKey)).build());
             }
             withErrors.put(p, "WPK");

trunk/test/unit/org/openstreetmap/josm/data/validation/tests/TagCheckerTest.java

@@ -84 +84 @@
 
     /**
+     * Check for misspelled key where the suggested alternative is given with prefix E: in ignoreTags.cfg.
+     * The error should be fixable.
+     * @throws IOException if any I/O error occurs
+     */
+    @Test
+    public void testUpperCaseIgnoredKey() throws IOException {
+        // ticket 17468
+        final List<TestError> errors = test(OsmUtils.createPrimitive("node wheelchair:Description=bla"));
+        assertEquals(1, errors.size());
+        assertEquals("Misspelled property key", errors.get(0).getMessage());
+        assertEquals("Key 'wheelchair:Description' looks like 'wheelchair:description'.", errors.get(0).getDescription());
+        assertEquals(Severity.WARNING, errors.get(0).getSeverity());
+        assertTrue(errors.get(0).isFixable());
+    }
+
+    /**
+     * Check for misspelled key where the suggested alternative is given with prefix K: in ignoreTags.cfg.
+     * The error should be fixable.
+     * @throws IOException if any I/O error occurs
+     */
+    @Test
+    public void testUpperCaseInKeyIgnoredTag() throws IOException {
+        // ticket 17468
+        final List<TestError> errors = test(OsmUtils.createPrimitive("node land_Area=administrative"));
+        assertEquals(1, errors.size());
+        assertEquals("Misspelled property key", errors.get(0).getMessage());
+        assertEquals("Key 'land_Area' looks like 'land_area'.", errors.get(0).getDescription());
+        assertEquals(Severity.WARNING, errors.get(0).getSeverity());
+        assertTrue(errors.get(0).isFixable());
+    }
+
+    /**
      * Check for unknown key.
      * @throws IOException if any I/O error occurs