Merge branch 'master' of https://github.com/vassalengine/vassal into …

…12670-Essential-Components
vassalengine · Sep 11, 2023 · 42b1f1a · 42b1f1a
2 parents f1ca264 + a7bd573
commit 42b1f1a
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 228 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,9 @@
+3.7.1 - ???
+
+* 12676: IncrementProperty: Corrected bad wrap-around calculation when
+  increment is negative
+* 12661: Translate side names in change sides message
+
 3.7.0 - 7 September 2023
 
 * 12644: Prevent NPE when Editing Deck count expressions

diff --git a/Makefile b/Makefile
@@ -47,13 +47,13 @@ JDKDIR:=$(DISTDIR)/jdks
 JDOCDIR:=jdoc
 
 # numeric part of the version only
-VNUM:=3.7.0
+VNUM:=3.7.1
 # major-minor part of the version
 V_MAJ_MIN:=$(shell echo "$(VNUM)" | cut -f1,2 -d'.')
 
-#MAVEN_VERSION:=$(VNUM)-SNAPSHOT
+MAVEN_VERSION:=$(VNUM)-SNAPSHOT
 #MAVEN_VERSION:=$(VNUM)-beta5
-MAVEN_VERSION:=$(VNUM)
+#MAVEN_VERSION:=$(VNUM)
 
 JARNAME:=vassal-app-$(MAVEN_VERSION)
 

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ VASSAL is a game engine for building and playing online adaptations of board gam
 
 ### Minimum Requirements
 
-VASSAL 3.6 requires Java 11 or later.
+VASSAL 3.7 requires Java 11 or later.
 
 The Windows and Mac packages have an appropriate version of Java bundled with
 them, so there is no need to install Java separately on those operating

diff --git a/dist/notes/data.json b/dist/notes/data.json
@@ -15,6 +15,18 @@
     { "display_name": "Other", "suffix": "other.zip" }
   ],
   "changes": [
+   {
+      "in": "3.7.1",
+      "since": "3.7.0",
+      "new_features": [
+      ],
+      "bug_fixes": [
+        { "num": 12676, "desc": "IncrementProperty: Corrected bad wrap-around calculation when increment is negative" }
+      ],
+      "other_improvements": [
+        { "num": 12661, "desc": "Translate side names in change sides message" }
+      ]
+   },
    {
       "in": "3.7.0",
       "since": "3.6.19",
@@ -35,7 +47,6 @@
         { "num": 12153, "desc": "Layer traits allow a show-only-if-this-property-true filter" },
         { "num": 12149, "desc": "BorderOutline trait now accepts two fields" },
         { "num": 12129, "desc": "PlaceMarker and ReplaceWithOther can use expression for X/Y offset" },
-        { "num": 12127, "desc": "Toolbar buttons disableable by a property (e.g., GKC, ActionButton, etc.) can be set to hide when disabled" },
         { "num": 12100, "desc": "Text Labels support <img> tags" },
 
         { "num": 12067, "desc": "Import/export of groups of items from Editor as XML files (e.g., to transfer between modules)" },
@@ -59,8 +70,6 @@
         { "num": 10820, "desc": "Make Action Button available on all windows where other similar buttons (e.g., GKC, Multi-Action, etc) are available" },
         { "num": 4454, "desc": "Save chat text to file" },
         { "num": 4446, "desc": "Dynamic button labels (can use expressions and $...$ in certain toolbar buttons)" }
-
-
       ],
       "bug_fixes": [
         { "num": 12644, "desc": "Prevent NPE when Editing Deck count expressions" },
@@ -74,7 +83,6 @@
         { "num": 12529, "desc": "Allow Piece UIDs to be compared properly in expressions" },
         { "num": 12528, "desc": "Close InputStreams opened for reading SVG" },
         { "num": 12482, "desc": "Map Shader now able to add button to Map Toolbar" },
-        { "num": 12478, "desc": "Revert 12077 - Do not return a default value for ObscuredToOthers" },
         { "num": 12470, "desc": "Place Marker X Offset should default to 0, not null" },
         { "num": 12439, "desc": "Uniformly handle addition of standard and imported Configurables" },
         { "num": 12434, "desc": "FastMatch by Location now respects Deck limits" },
@@ -97,7 +105,6 @@
         { "num": 12261, "desc": "Report error if more than one grid added to a Zone" },
         { "num": 12220, "desc": "Add BorderOutline's property names to the searchable target list" },
         { "num": 12215, "desc": "New MarkMoved commands shouldn't default to being displayed if no key commands entered" },
-        { "num": 12208, "desc": "Hiding disabled toolbar buttons feature removed (reverts 12127)" },
         { "num": 12205, "desc": "Area of Effect trait was eating other traits' visibility info in some cases" },
         { "num": 12203, "desc": "Properly extract outlines from SVG for NonRectangular" },
         { "num": 12175, "desc": "Fix stretchy images in chat" },
@@ -136,7 +143,6 @@
         { "num": 12133, "desc": "Rollovers automatically shrink scale if the pieces are too wide to fit the screen width" },
         { "num": 12084, "desc": "Help menu shows module-specific help items before generic Vassal ones" },
         { "num": 12080, "desc": "Zooming in and out no longer loses track of player's preferred center point for map" },
-        { "num": 12077, "desc": "ObscuredToOthers can be counted on to be 'false' for pieces that don't even have a Mask property" },
         { "num": 11919, "desc": "Allow DEL/BACKSPACE to be mapped as a hotkey" },
         { "num": 11506, "desc": "Predefined Setup \"menus\" with blank names will not be shown" },
         { "num": 11104, "desc": "Refresh Can Rotate trait by Rotator Name match option for Game Refreshers" }

diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>org.vassalengine</groupId>
     <artifactId>vassal-parent</artifactId>
-    <version>3.7.0</version>
+    <version>3.7.1-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>Vassal Engine</name>

diff --git a/release-prepare/pom.xml b/release-prepare/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.vassalengine</groupId>
         <artifactId>vassal-parent</artifactId>
-        <version>3.7.0</version>
+        <version>3.7.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>release-prepare</artifactId>

diff --git a/vassal-agent/pom.xml b/vassal-agent/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.vassalengine</groupId>
         <artifactId>vassal-parent</artifactId>
-        <version>3.7.0</version>
+        <version>3.7.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>vassal-agent</artifactId>

diff --git a/vassal-app/pom.xml b/vassal-app/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.vassalengine</groupId>
         <artifactId>vassal-parent</artifactId>
-        <version>3.7.0</version>
+        <version>3.7.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>vassal-app</artifactId>
@@ -18,7 +18,7 @@
         <main.basedir>${project.basedir}${file.separator}..</main.basedir>
         <project.reporting.outputEncoding>${project.build.sourceEncoding}</project.reporting.outputEncoding>
         <version.batik>1.17</version.batik>
-        <clirr.nofork.comparison.version>3.6.19</clirr.nofork.comparison.version>
+        <clirr.nofork.comparison.version>3.7.0</clirr.nofork.comparison.version>
     </properties>
 
     <dependencyManagement>

diff --git a/vassal-app/src/main/java/VASSAL/build/module/PlayerRoster.java b/vassal-app/src/main/java/VASSAL/build/module/PlayerRoster.java
@@ -280,7 +280,7 @@ protected void launch() {
       newSide
     );
 
-    Command c = new Chatter.DisplayText(gm.getChatter(), Resources.getString(GlobalOptions.getInstance().chatterHTMLSupport() ? "PlayerRoster.changed_sides_2" : "PlayerRoster.changed_sides", GameModule.getGameModule().getPrefs().getValue(GameModule.REAL_NAME), mySide, newSide));
+    Command c = new Chatter.DisplayText(gm.getChatter(), Resources.getString(GlobalOptions.getInstance().chatterHTMLSupport() ? "PlayerRoster.changed_sides_2" : "PlayerRoster.changed_sides", GameModule.getGameModule().getPrefs().getValue(GameModule.REAL_NAME), translateSide(mySide), translateSide(newSide)));
     c.execute();
 
     final Remove r = new Remove(this, GameModule.getActiveUserId());

diff --git a/vassal-app/src/main/java/VASSAL/build/module/properties/IncrementProperty.java b/vassal-app/src/main/java/VASSAL/build/module/properties/IncrementProperty.java
@@ -82,7 +82,11 @@ public String getNewValue(String oldValue) {
       else if (constraints.isWrap()) {
         final int min = constraints.getMinimumValue();
         final int max = constraints.getMaximumValue();
-        value = min + ((value - min + incr) % (max - min + incr));
+        final int range = max - min + 1;
+        // NB: value - min + incr could be < 0 (but > -range), which is
+        // why we add range and mod a second time to ensure that the
+        // result is in [0,range).
+        value = min + ((value - min + incr) % range + range) % range;
       }
       else {
         value += incr;

diff --git a/vassal-app/src/test/resources/clirr-ignored-differences.xml b/vassal-app/src/test/resources/clirr-ignored-differences.xml
@@ -22,214 +22,6 @@
         <method>*</method>
     </difference>
 
-    <!-- 3.7.0 -->
-
-    <difference>
-        <className>VASSAL/build/module/Chatter</className>
-        <differenceType>6001</differenceType>
-        <field>scroll2</field>
-        <justification>Accidentally added; nothing should use this.</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/build/module/AttachmentManager</className>
-        <differenceType>7002</differenceType>
-        <method>*</method>
-        <justification>New class added in 3.7 beta.</justification>
-    </difference>
-
-    <difference>
-        <!-- Major revamp of Expression Interpreter that will never be over-ridden -->
-        <className>VASSAL/script/ExpressionInterpreter</className>
-        <differenceType>7005</differenceType>
-        <method>*</method>
-        <to>*</to>
-        <justification>No one should be using this externally</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/script/ExpressionInterpreter</className>
-        <differenceType>7004</differenceType>
-        <method>java.lang.Object sumZone(java.lang.String, java.lang.String, VASSAL.build.module.properties.PropertySource)</method>
-        <justification>No one should be using this externally</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/script/ExpressionInterpreter</className>
-        <differenceType>7002</differenceType>
-        <method>*</method>
-        <justification>Only called from Beanshell interface script which has been revamped.</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/script/ExpressionInterpreter</className>
-        <differenceType>7006</differenceType>
-        <method>**</method>
-        <to>**</to>
-        <justification>No one should be using this externally, Internal changes only</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/script/AbstractInterpreter</className>
-        <differenceType>7005</differenceType>
-        <method>*</method>
-        <to>*</to>
-        <justification>No one should be using this externally</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/configure/BeanShellFunctionMenu</className>
-        <differenceType>7005</differenceType>
-        <method>*</method>
-        <to>*</to>
-        <justification>Internal use only</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/configure/BeanShellFunctionMenu</className>
-        <differenceType>7002</differenceType>
-        <method>*</method>
-        <justification>Internal use only.</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/counters/SetAttachmentProperty</className>
-        <differenceType>8001</differenceType>
-        <justification>Class added in beta, then removed</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/counters/SetAttachmentProperty$Ed</className>
-        <differenceType>8001</differenceType>
-        <justification>Class added in beta, then removed</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/counters/SetAttachmentProperty$SetAttachmentPropertySource</className>
-        <differenceType>8001</differenceType>
-        <justification>Class added in beta, then removed</justification>
-    </difference>
-
-    <!-- 3.6.14 -->
-
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>MOVE_CAMERA_MODE</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>ZOOM</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>BOARD_NAME</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>X_POS</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>Y_POS</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>ZONE_NAME</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>GRID_LOCATION</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>REGION_NAME</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>PROPERTY_FILTER</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>X_OFFSET</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/build/module/map/MoveCameraButton</className>
-        <differenceType>6006</differenceType>
-        <field>Y_OFFSET</field>
-        <justification>String constants should be final</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/tools/NamedKeyManager</className>
-        <differenceType>6006</differenceType>
-        <field>instance</field>
-        <justification>Singletons should be final</justification>
-    </difference>
-
-    <!-- 3.6.15 -->
-
-    <difference>
-        <className>VASSAL/launch/TilingHandler</className>
-        <differenceType>7006</differenceType>
-        <method>void runSlicer(java.util.List, int, int)</method>
-        <to>VASSAL.tools.lang.Pair</to>
-        <justification>No one should be using this externally</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/launch/TilingHandler</className>
-        <differenceType>7005</differenceType>
-        <method>void runSlicer(java.util.List, int, int)</method>
-        <to>*</to>
-        <justification>No one should be using this externally</justification>
-    </difference>
-    <difference>
-        <className>VASSAL/tools/image/tilecache/FileArchiveImageTiler</className>
-        <differenceType>7004</differenceType>
-        <method>void run(VASSAL.tools.io.FileArchive, java.lang.String, int, int, java.lang.Iterable, java.util.concurrent.ExecutorService, VASSAL.tools.image.ImageLoader, VASSAL.tools.image.tilecache.TileSlicer, VASSAL.tools.lang.Callback, VASSAL.tools.lang.Callback, VASSAL.tools.lang.Callback)</method>
-        <justification>No one should be using this externally</justification>
-    </difference>
-
-    <!-- 3.6.16 -->
-
-    <difference>
-        <className>VASSAL/launch/DebugClassLoader</className>
-        <differenceType>8001</differenceType>
-        <justification>Never released</justification>
-    </difference>
-
-   <!-- 3.6.17 -->
-
-   <difference>
-      <className>VASSAL/launch/TilingHandler</className>
-      <differenceType>7002</differenceType>
-      <method>TilingHandler(java.lang.String, java.io.File, java.awt.Dimension, int, int)</method>
-      <justification>Kept for VASL 6.6.2 compatibility; no longer needed.</justification>
-    </difference>
-
-    <difference>
-        <className>VASSAL/launch/TilingHandler</className>
-        <differenceType>6011</differenceType>
-        <field>pid</field>
-        <justification>Kept for VASL 6.6.2 compatibility; no longer needed.</justification>
-    </difference>
+    <!-- 3.7.1 -->
 
 </differences>
diff --git a/vassal-deprecation/pom.xml b/vassal-deprecation/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.vassalengine</groupId>
         <artifactId>vassal-parent</artifactId>
-        <version>3.7.0</version>
+        <version>3.7.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>vassal-deprecation</artifactId>

diff --git a/vassal-doc/pom.xml b/vassal-doc/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>org.vassalengine</groupId>
         <artifactId>vassal-parent</artifactId>
-        <version>3.7.0</version>
+        <version>3.7.1-SNAPSHOT</version>
     </parent>
 
     <artifactId>vassal-doc</artifactId>