Changeset 6377 in josm

Timestamp:

2013-11-07T22:14:53+01:00 (11 years ago)

Author:

simon04

Message:

see #9157 - make some errors in opening_hours fixable

Location:

trunk

Files:

• src/org/openstreetmap/josm/data/validation/FixableTestError.java (added)
• src/org/openstreetmap/josm/data/validation/tests/OpeningHourTest.java (modified) (6 diffs)
• test/unit/org/openstreetmap/josm/data/validation/tests/OpeningHourTestTest.java (modified) (4 diffs)

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

@@ -18 +18 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.command.ChangePropertyCommand;
 import org.openstreetmap.josm.data.osm.Node;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Relation;
 import org.openstreetmap.josm.data.osm.Way;
+import org.openstreetmap.josm.data.validation.FixableTestError;
 import org.openstreetmap.josm.data.validation.Severity;
 import org.openstreetmap.josm.data.validation.Test;
@@ -108 +110 @@
     }
 
+    public class OpeningHoursTestError {
+        final Severity severity;
+        final String message, prettifiedValue;
+
+        public OpeningHoursTestError(String message, Severity severity, String prettifiedValue) {
+            this.message = message;
+            this.severity = severity;
+            this.prettifiedValue = prettifiedValue;
+        }
+
+        public OpeningHoursTestError(String message, Severity severity) {
+            this(message, severity, null);
+        }
+
+        public TestError getTestError(final OsmPrimitive p, final String key) {
+            if (prettifiedValue == null) {
+                return new TestError(OpeningHourTest.this, severity, message, 2901, p);
+            } else {
+                return new FixableTestError(OpeningHourTest.this, severity, message, 2901, p,
+                        new ChangePropertyCommand(p, key, prettifiedValue));
+            }
+        }
+
+        public String getMessage() {
+            return message;
+        }
+
+        public String getPrettifiedValue() {
+            return prettifiedValue;
+        }
+
+        public Severity getSeverity() {
+            return severity;
+        }
+    }
+
     /**
      * Checks for a correct usage of the opening hour syntax of the {@code value} given according to
@@ -113 +151 @@
      * validation errors or an empty list. Null values result in an empty list.
      * @param value the opening hour value to be checked.
+     * @param mode whether to validate {@code value} as a time range, or points in time, or both.
      * @return a list of {@link TestError} or an empty list
      */
-    public List<TestError> checkOpeningHourSyntax(final String value, CheckMode mode) {
+    public List<OpeningHoursTestError> checkOpeningHourSyntax(final String value, CheckMode mode) {
         if (ENGINE == null || value == null || value.trim().isEmpty()) {
             return Collections.emptyList();
@@ -121 +160 @@
         try {
             final Object r = parse(value, mode);
-            final List<TestError> errors = new ArrayList<TestError>();
+            final List<OpeningHoursTestError> errors = new ArrayList<OpeningHoursTestError>();
+            String prettifiedValue = null;
+            try {
+                prettifiedValue = (String) ((Invocable) ENGINE).invokeMethod(r, "prettifyValue");
+            } catch (Exception ignore) {
+            }
             for (final Object i : getList(((Invocable) ENGINE).invokeMethod(r, "getWarnings"))) {
-                errors.add(new TestError(this, Severity.WARNING, i.toString(), 2901, Collections.<OsmPrimitive>emptyList()));
+                errors.add(new OpeningHoursTestError(i.toString(), Severity.WARNING, prettifiedValue));
             }
             return errors;
@@ -131 +175 @@
                     .replaceAll("\\(<Unknown source.*", "")
                     .trim();
-            return Arrays.asList(new TestError(this, Severity.ERROR, message, 2901, Collections.<OsmPrimitive>emptyList()));
+            return Arrays.asList(new OpeningHoursTestError(message, Severity.ERROR));
         } catch (final Exception ex) {
             throw new RuntimeException(ex);
@@ -137 +181 @@
     }
 
-    public List<TestError> checkOpeningHourSyntax(final String value) {
+    public List<OpeningHoursTestError> checkOpeningHourSyntax(final String value) {
         return checkOpeningHourSyntax(value, CheckMode.TIME_RANGE);
     }
 
-    protected void check(final OsmPrimitive p, final String tagValue, CheckMode mode) {
-        for (TestError e : checkOpeningHourSyntax(tagValue, mode)) {
-            e.setPrimitives(Collections.singletonList(p));
-            errors.add(e);
+    protected void check(final OsmPrimitive p, final String key, CheckMode mode) {
+        for (OpeningHoursTestError e : checkOpeningHourSyntax(p.get(key), mode)) {
+            errors.add(e.getTestError(p, key));
         }
     }
 
     protected void check(final OsmPrimitive p) {
-        check(p, p.get("opening_hours"), CheckMode.TIME_RANGE);
-        check(p, p.get("collection_times"), CheckMode.BOTH);
-        check(p, p.get("service_times"), CheckMode.BOTH);
+        check(p, "opening_hours", CheckMode.TIME_RANGE);
+        check(p, "collection_times", CheckMode.BOTH);
+        check(p, "service_times", CheckMode.BOTH);
     }
 

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

@@ -6 +6 @@
 import org.openstreetmap.josm.data.Preferences;
 import org.openstreetmap.josm.data.validation.Severity;
-import org.openstreetmap.josm.data.validation.TestError;
 
 import java.util.List;
@@ -34 +33 @@
     @Test
     public void testCheckOpeningHourSyntax2() throws Exception {
-        final List<TestError> errors = OPENING_HOUR_TEST.checkOpeningHourSyntax("Mo-Tue");
+        final List<OpeningHourTest.OpeningHoursTestError> errors = OPENING_HOUR_TEST.checkOpeningHourSyntax("Mo-Tue");
         assertThat(errors.size(), is(1));
         assertThat(errors.get(0).getMessage(), is("Mo-Tue <--- (Please use the abbreviation \"Tu\" for \"tue\".)"));
@@ -42 +41 @@
     @Test
     public void testCheckOpeningHourSyntax3() throws Exception {
-        final List<TestError> errors = OPENING_HOUR_TEST.checkOpeningHourSyntax("Sa-Su 10.00-20.00");
+        final List<OpeningHourTest.OpeningHoursTestError> errors = OPENING_HOUR_TEST.checkOpeningHourSyntax("Sa-Su 10.00-20.00");
         assertThat(errors.size(), is(2));
         assertThat(errors.get(0).getMessage(), is("Sa-Su 10. <--- (Please use \":\" as hour/minute-separator)"));
         assertThat(errors.get(0).getSeverity(), is(Severity.WARNING));
+        assertThat(errors.get(0).getPrettifiedValue(), is("Sa-Su 10:00-20:00"));
         assertThat(errors.get(1).getMessage(), is("Sa-Su 10.00-20. <--- (Please use \":\" as hour/minute-separator)"));
         assertThat(errors.get(1).getSeverity(), is(Severity.WARNING));
@@ -62 +62 @@
         assertThat(OPENING_HOUR_TEST.checkOpeningHourSyntax("badtext").get(0).getMessage(),
                 is("opening_hours - ba <--- (Unexpected token: \"b\" This means that the syntax is not valid at that point or it is currently not supported.)"));
+        assertThat(OPENING_HOUR_TEST.checkOpeningHourSyntax("5.00 p.m-11.00 p.m").size(), is(1));
+        assertThat(OPENING_HOUR_TEST.checkOpeningHourSyntax("5.00 p.m-11.00 p.m").get(0).getMessage(),
+                is("opening_hours - 5.00 p <--- (hyphen (-) or open end (+) in time range expected. For working with points in time, the mode for opening_hours.js has to be altered. Maybe wrong tag?)"));
     }