Changeset 17620 in josm

Timestamp:

2021-03-21T13:56:23+01:00 (4 years ago)

Author:

simon04

Message:

see #4626 - Extract interface MapCSSTagCheckerFixCommand

Location:

trunk/src/org/openstreetmap/josm/data/validation/tests

Files:

• MapCSSTagChecker.java (modified) (3 diffs)
• MapCSSTagCheckerFixCommand.java (added)
• MapCSSTagCheckerRule.java (modified) (3 diffs)

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

@@ -23 +23 @@
 import java.util.stream.Stream;
 
-import org.openstreetmap.josm.command.ChangePropertyCommand;
-import org.openstreetmap.josm.command.ChangePropertyKeyCommand;
-import org.openstreetmap.josm.command.Command;
 import org.openstreetmap.josm.data.osm.IPrimitive;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
-import org.openstreetmap.josm.data.osm.Tag;
 import org.openstreetmap.josm.data.preferences.sources.SourceEntry;
 import org.openstreetmap.josm.data.preferences.sources.ValidatorPrefHelper;
@@ -37 +33 @@
 import org.openstreetmap.josm.gui.mappaint.Environment;
 import org.openstreetmap.josm.gui.mappaint.MultiCascade;
-import org.openstreetmap.josm.gui.mappaint.mapcss.Expression;
 import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSRule;
 import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSStyleIndex;
@@ -77 +72 @@
     public MapCSSTagChecker() {
         super(tr("Tag checker (MapCSS based)"), tr("This test checks for errors in tag keys and values."));
-    }
-
-    /**
-     * Represents a fix to a validation test. The fixing {@link Command} can be obtained by {@link #createCommand(OsmPrimitive, Selector)}.
-     */
-    @FunctionalInterface
-    interface FixCommand {
-        /**
-         * Creates the fixing {@link Command} for the given primitive. The {@code matchingSelector} is used to evaluate placeholders
-         * (cf. {@link MapCSSTagCheckerRule#insertArguments(Selector, String, OsmPrimitive)}).
-         * @param p OSM primitive
-         * @param matchingSelector  matching selector
-         * @return fix command, or {@code null} if if cannot be created
-         */
-        Command createCommand(OsmPrimitive p, Selector matchingSelector);
-
-        /**
-         * Checks that object is either an {@link Expression} or a {@link String}.
-         * @param obj object to check
-         * @throws IllegalArgumentException if object is not an {@code Expression} or a {@code String}
-         */
-        static void checkObject(final Object obj) {
-            CheckParameterUtil.ensureThat(obj instanceof Expression || obj instanceof String,
-                    () -> "instance of Exception or String expected, but got " + obj);
-        }
-
-        /**
-         * Evaluates given object as {@link Expression} or {@link String} on the matched {@link OsmPrimitive} and {@code matchingSelector}.
-         * @param obj object to evaluate ({@link Expression} or {@link String})
-         * @param p OSM primitive
-         * @param matchingSelector matching selector
-         * @return result string
-         */
-        static String evaluateObject(final Object obj, final OsmPrimitive p, final Selector matchingSelector) {
-            final String s;
-            if (obj instanceof Expression) {
-                s = (String) ((Expression) obj).evaluate(new Environment(p));
-            } else if (obj instanceof String) {
-                s = (String) obj;
-            } else {
-                return null;
-            }
-            return MapCSSTagCheckerRule.insertArguments(matchingSelector, s, p);
-        }
-
-        /**
-         * Creates a fixing command which executes a {@link ChangePropertyCommand} on the specified tag.
-         * @param obj object to evaluate ({@link Expression} or {@link String})
-         * @return created fix command
-         */
-        static FixCommand fixAdd(final Object obj) {
-            checkObject(obj);
-            return new FixCommand() {
-                @Override
-                public Command createCommand(OsmPrimitive p, Selector matchingSelector) {
-                    final Tag tag = Tag.ofString(FixCommand.evaluateObject(obj, p, matchingSelector));
-                    return new ChangePropertyCommand(p, tag.getKey(), tag.getValue());
-                }
-
-                @Override
-                public String toString() {
-                    return "fixAdd: " + obj;
-                }
-            };
-        }
-
-        /**
-         * Creates a fixing command which executes a {@link ChangePropertyCommand} to delete the specified key.
-         * @param obj object to evaluate ({@link Expression} or {@link String})
-         * @return created fix command
-         */
-        static FixCommand fixRemove(final Object obj) {
-            checkObject(obj);
-            return new FixCommand() {
-                @Override
-                public Command createCommand(OsmPrimitive p, Selector matchingSelector) {
-                    final String key = FixCommand.evaluateObject(obj, p, matchingSelector);
-                    return new ChangePropertyCommand(p, key, "");
-                }
-
-                @Override
-                public String toString() {
-                    return "fixRemove: " + obj;
-                }
-            };
-        }
-
-        /**
-         * Creates a fixing command which executes a {@link ChangePropertyKeyCommand} on the specified keys
-         * @param oldKey old key
-         * @param newKey new key
-         * @return created fix command
-         */
-        static FixCommand fixChangeKey(final String oldKey, final String newKey) {
-            return new FixCommand() {
-                @Override
-                public Command createCommand(OsmPrimitive p, Selector matchingSelector) {
-                    return new ChangePropertyKeyCommand(p,
-                            MapCSSTagCheckerRule.insertArguments(matchingSelector, oldKey, p),
-                            MapCSSTagCheckerRule.insertArguments(matchingSelector, newKey, p));
-                }
-
-                @Override
-                public String toString() {
-                    return "fixChangeKey: " + oldKey + " => " + newKey;
-                }
-            };
-        }
     }
 

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

@@ -59 +59 @@
      * Commands to apply in order to fix a matching primitive
      */
-    protected final List<MapCSSTagChecker.FixCommand> fixCommands;
+    protected final List<MapCSSTagCheckerFixCommand> fixCommands;
     /**
      * Tags (or arbitrary strings) of alternatives to be presented to the user
@@ -135 +135 @@
                                 "Unsupported " + ai.key + " instruction. Allowed instructions are " + POSSIBLE_THROWS + '.', null);
                     } else if ("fixAdd".equals(ai.key)) {
-                        check.fixCommands.add(MapCSSTagChecker.FixCommand.fixAdd(ai.val));
+                        check.fixCommands.add(MapCSSTagCheckerFixCommand.fixAdd(ai.val));
                     } else if ("fixRemove".equals(ai.key)) {
                         CheckParameterUtil.ensureThat(!(ai.val instanceof String) || !(val != null && val.contains("=")),
                                 "Unexpected '='. Please only specify the key to remove in: " + ai);
-                        check.fixCommands.add(MapCSSTagChecker.FixCommand.fixRemove(ai.val));
+                        check.fixCommands.add(MapCSSTagCheckerFixCommand.fixRemove(ai.val));
                     } else if (val != null && "fixChangeKey".equals(ai.key)) {
                         CheckParameterUtil.ensureThat(val.contains("=>"), "Separate old from new key by '=>'!");
@@ -145 +145 @@
                         final String oldKey = Utils.removeWhiteSpaces(x[0]);
                         final String newKey = Utils.removeWhiteSpaces(x[1]);
-                        check.fixCommands.add(MapCSSTagChecker.FixCommand.fixChangeKey(oldKey, newKey));
+                        check.fixCommands.add(MapCSSTagCheckerFixCommand.fixChangeKey(oldKey, newKey));
                     } else if (val != null && "fixDeleteObject".equals(ai.key)) {
                         CheckParameterUtil.ensureThat("this".equals(val), "fixDeleteObject must be followed by 'this'");