Changeset 12719 in josm

Timestamp:

2017-09-04T02:10:29+02:00 (7 years ago)

Author:

Don-vip

Message:

fix #15232 - Allow user to request feedback when uploading by adding the review_requested=yes changeset tag.
Inspired by:

• ​https://github.com/openstreetmap/iD/issues/4133
• ​https://github.com/openstreetmap/iD/pull/4223
• ​http://neis-one.org/2017/09/review-requests-osm/

Location:

trunk

Files:

• src/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanel.java (modified) (6 diffs)
• src/org/openstreetmap/josm/gui/io/ChangesetReviewModel.java (added)
• src/org/openstreetmap/josm/gui/io/TagSettingsPanel.java (modified) (5 diffs)
• src/org/openstreetmap/josm/gui/io/UploadDialog.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanelTest.java (modified) (1 diff)
• test/unit/org/openstreetmap/josm/gui/io/TagSettingsPanelTest.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanel.java

@@ -10 +10 @@
 import java.awt.event.FocusAdapter;
 import java.awt.event.FocusEvent;
+import java.awt.event.ItemEvent;
 import java.awt.event.KeyAdapter;
 import java.awt.event.KeyEvent;
@@ -20 +21 @@
 import javax.swing.Action;
 import javax.swing.BorderFactory;
+import javax.swing.JCheckBox;
 import javax.swing.JEditorPane;
 import javax.swing.JPanel;
@@ -62 +64 @@
     /** the panel with a summary of the upload parameters */
     private final UploadParameterSummaryPanel pnlUploadParameterSummary = new UploadParameterSummaryPanel();
+    /** the checkbox to request feedback from other users */
+    private final JCheckBox cbRequestReview = new JCheckBox(tr("I would like someone to review my edits."));
     /** the changeset comment model */
     private final transient ChangesetCommentModel changesetCommentModel;
     private final transient ChangesetCommentModel changesetSourceModel;
+    private final transient ChangesetReviewModel changesetReviewModel;
 
     protected JPanel buildUploadCommentPanel() {
@@ -118 +123 @@
         add(buildUploadCommentPanel(), BorderLayout.NORTH);
         add(pnlUploadParameterSummary, BorderLayout.CENTER);
+        add(cbRequestReview, BorderLayout.SOUTH);
+        cbRequestReview.addItemListener(e -> changesetReviewModel.setReviewRequested(e.getStateChange() == ItemEvent.SELECTED));
     }
 
@@ -125 +132 @@
      * @param changesetCommentModel the model for the changeset comment. Must not be null
      * @param changesetSourceModel the model for the changeset source. Must not be null.
+     * @param changesetReviewModel the model for the changeset review. Must not be null.
      * @throws IllegalArgumentException if {@code changesetCommentModel} is null
-     */
-    public BasicUploadSettingsPanel(ChangesetCommentModel changesetCommentModel, ChangesetCommentModel changesetSourceModel) {
+     * @since 12719 (signature)
+     */
+    public BasicUploadSettingsPanel(ChangesetCommentModel changesetCommentModel, ChangesetCommentModel changesetSourceModel,
+            ChangesetReviewModel changesetReviewModel) {
         CheckParameterUtil.ensureParameterNotNull(changesetCommentModel, "changesetCommentModel");
         CheckParameterUtil.ensureParameterNotNull(changesetSourceModel, "changesetSourceModel");
+        CheckParameterUtil.ensureParameterNotNull(changesetReviewModel, "changesetReviewModel");
         this.changesetCommentModel = changesetCommentModel;
         this.changesetSourceModel = changesetSourceModel;
+        this.changesetReviewModel = changesetReviewModel;
         changesetCommentModel.addChangeListener(new ChangesetCommentChangeListener(hcbUploadComment));
         changesetSourceModel.addChangeListener(new ChangesetCommentChangeListener(hcbUploadSource));
+        changesetReviewModel.addChangeListener(new ChangesetReviewChangeListener());
         build();
     }
@@ -250 +263 @@
         }
     }
+
+    /**
+     * Observes the changeset review model and keeps the review checkbox
+     * in sync with the current changeset review request
+     */
+    class ChangesetReviewChangeListener implements ChangeListener {
+        @Override
+        public void stateChanged(ChangeEvent e) {
+            if (!(e.getSource() instanceof ChangesetReviewModel)) return;
+            boolean newState = ((ChangesetReviewModel) e.getSource()).isReviewRequested();
+            if (cbRequestReview.isSelected() != newState) {
+                cbRequestReview.setSelected(newState);
+            }
+        }
+    }
 }

trunk/src/org/openstreetmap/josm/gui/io/TagSettingsPanel.java

@@ -29 +29 @@
     private final transient ChangesetCommentModel changesetCommentModel;
     private final transient ChangesetCommentModel changesetSourceModel;
+    private final transient ChangesetReviewModel changesetReviewModel;
 
     /**
@@ -35 +36 @@
      * @param changesetCommentModel the changeset comment model. Must not be null.
      * @param changesetSourceModel the changeset source model. Must not be null.
+     * @param changesetReviewModel the model for the changeset review. Must not be null.
      * @throws IllegalArgumentException if {@code changesetCommentModel} is null
+     * @since 12719 (signature)
      */
-    public TagSettingsPanel(ChangesetCommentModel changesetCommentModel, ChangesetCommentModel changesetSourceModel) {
+    public TagSettingsPanel(ChangesetCommentModel changesetCommentModel, ChangesetCommentModel changesetSourceModel,
+            ChangesetReviewModel changesetReviewModel) {
         CheckParameterUtil.ensureParameterNotNull(changesetCommentModel, "changesetCommentModel");
         CheckParameterUtil.ensureParameterNotNull(changesetSourceModel, "changesetSourceModel");
+        CheckParameterUtil.ensureParameterNotNull(changesetReviewModel, "changesetReviewModel");
         this.changesetCommentModel = changesetCommentModel;
         this.changesetSourceModel = changesetSourceModel;
-        this.changesetCommentModel.addChangeListener(new ChangesetCommentChangeListener("comment"));
-        this.changesetSourceModel.addChangeListener(new ChangesetCommentChangeListener("source"));
+        this.changesetReviewModel = changesetReviewModel;
+        changesetCommentModel.addChangeListener(new ChangesetCommentChangeListener("comment"));
+        changesetSourceModel.addChangeListener(new ChangesetCommentChangeListener("source"));
+        changesetReviewModel.addChangeListener(new ChangesetReviewChangeListener());
         build();
         pnlTagEditor.getModel().addTableModelListener(this);
@@ -109 +116 @@
         changesetCommentModel.setComment(getTagEditorValue("comment"));
         changesetSourceModel.setComment(getTagEditorValue("source"));
+        changesetReviewModel.setReviewRequested("yes".equals(getTagEditorValue("review_requested")));
     }
 
@@ -117 +125 @@
         setProperty("comment", changesetCommentModel.getComment());
         setProperty("source", changesetSourceModel.getComment());
+        setProperty("review_requested", changesetReviewModel.isReviewRequested() ? "yes" : null);
     }
 
@@ -142 +151 @@
         }
     }
+
+    /**
+     * Observes the changeset review model and keeps the tag editor in sync
+     * with the current changeset review request
+     */
+    class ChangesetReviewChangeListener implements ChangeListener {
+
+        private final String key = "review_requested";
+
+        @Override
+        public void stateChanged(ChangeEvent e) {
+            if (e.getSource() instanceof ChangesetReviewModel) {
+                boolean newState = ((ChangesetReviewModel) e.getSource()).isReviewRequested();
+                boolean oldState = "yes".equals(Optional.ofNullable(getTagEditorValue(key)).orElse(""));
+                if (oldState != newState) {
+                    setProperty(key, newState ? "yes" : null);
+                }
+            }
+        }
+    }
 }

trunk/src/org/openstreetmap/josm/gui/io/UploadDialog.java

@@ -101 +101 @@
     private final transient ChangesetCommentModel changesetCommentModel = new ChangesetCommentModel();
     private final transient ChangesetCommentModel changesetSourceModel = new ChangesetCommentModel();
+    private final transient ChangesetReviewModel changesetReviewModel = new ChangesetReviewModel();
 
     private transient DataSet dataSet;
@@ -145 +146 @@
         tpConfigPanels = new CompactTabbedPane();
 
-        pnlBasicUploadSettings = new BasicUploadSettingsPanel(changesetCommentModel, changesetSourceModel);
+        pnlBasicUploadSettings = new BasicUploadSettingsPanel(changesetCommentModel, changesetSourceModel, changesetReviewModel);
         tpConfigPanels.add(pnlBasicUploadSettings);
         tpConfigPanels.setTitleAt(0, tr("Settings"));
         tpConfigPanels.setToolTipTextAt(0, tr("Decide how to upload the data and which changeset to use"));
 
-        pnlTagSettings = new TagSettingsPanel(changesetCommentModel, changesetSourceModel);
+        pnlTagSettings = new TagSettingsPanel(changesetCommentModel, changesetSourceModel, changesetReviewModel);
         tpConfigPanels.add(pnlTagSettings);
         tpConfigPanels.setTitleAt(1, tr("Tags of new changeset"));

trunk/test/unit/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanelTest.java

@@ -27 +27 @@
     @Test
     public void testBasicUploadSettingsPanel() {
-        assertNotNull(new BasicUploadSettingsPanel(new ChangesetCommentModel(), new ChangesetCommentModel()));
+        assertNotNull(new BasicUploadSettingsPanel(new ChangesetCommentModel(), new ChangesetCommentModel(), new ChangesetReviewModel()));
     }
 }

trunk/test/unit/org/openstreetmap/josm/gui/io/TagSettingsPanelTest.java

@@ -27 +27 @@
     @Test
     public void testTagSettingsPanel() {
-        assertNotNull(new TagSettingsPanel(new ChangesetCommentModel(), new ChangesetCommentModel()));
+        assertNotNull(new TagSettingsPanel(new ChangesetCommentModel(), new ChangesetCommentModel(), new ChangesetReviewModel()));
     }
 }