Feat/flat xml editor

CLAUDE.md

@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 ## Project Overview
 
-The **dbUnit Eclipse Plugin** adds a spreadsheet-like editor for [dbUnit](https://github.com/dbunit/dbunit-extension) dataset files to the Eclipse IDE. Version 1 supports the flat XML format (`FlatXmlDataSet`). It is built with Maven and Eclipse Tycho and published as a PGP-signed p2 repository (Eclipse update site) on GitHub Pages.
+The **dbUnit Eclipse Plugin** adds a spreadsheet-like editor for [dbUnit](https://github.com/dbunit/dbunit-extension) dataset files to the Eclipse IDE. The plugin currently supports the dbUnit flat XML format (`FlatXmlDataSet`); other dataset formats are planned. It is built with Maven and Eclipse Tycho and published as a PGP-signed p2 repository (Eclipse update site) on GitHub Pages.
 
 ## Build Commands
 
@@ -14,6 +14,11 @@ The project uses a Maven wrapper. Always use `./mvnw` instead of `mvn`. Tycho 5
 # Build, run all tests, and assemble the update site (default goal is verify)
 ./mvnw clean verify
 
+# The same build with the current UTC time as the version qualifier, to install it into Eclipse: the pom pins
+# project.build.outputTimestamp, so a plain build always has the same version, which Eclipse does not offer as an update.
+# Arguments go to ./mvnw (none runs clean install); build-local.cmd is the Windows script.
+./build-local.sh clean verify
+
 # Build and test against the newest Eclipse release instead of the baseline (oldest supported)
 ./mvnw clean verify -Platest-target
 
@@ -28,6 +33,9 @@ The project uses a Maven wrapper. Always use `./mvnw` instead of `mvn`. Tycho 5
 
 # Skip tests
 ./mvnw clean verify -DskipTests
+
+# Skip SpotBugs, the Error Prone pass, and PMD, which verify runs on the core and UI bundles, failing the build on any finding
+./mvnw clean verify -Dspotbugs.skip -Dmaven.main.skip -Dpmd.skip=true
 ```
 
 UI tests (`bundles/org.dbunit.eclipse.dataset.ui/src/test/java`) run inside an Eclipse workbench via `tycho-surefire-plugin:plugin-test`; on Linux without a display, prefix the command with `xvfb-run -a`.
@@ -93,7 +101,9 @@ The IDocument (text) is the single source of truth: grid edits become minimal te
   - Use Eclipse code cleanup settings file `code-cleanup-eclipse.xml` when modifying or creating files (e.g., `final` parameters, locals, and private fields).
   - Start every Java file with the dbUnit LGPL license header used by the existing sources.
   - Place the Logger variable first in the class; log through Eclipse's `org.eclipse.core.runtime.ILog` (`private static final ILog LOG = ILog.of(ClassName.class);`), not a logging framework.
+    - The core bundle's unit tests run without OSGi, where `ILog.of` throws, so core classes never call it: they take a `Consumer<IStatus>` log sink through their constructor, as `FlatXmlDatasetDocument` does, and the UI bundle passes `LOG::log`.
   - Write JavaDoc comments on all public classes and methods in src/main.
+    - A method that overrides or implements another one inherits the JavaDoc of that method, so it needs its own only when it says something that the inherited one does not.
   - In JavaDoc, use complete sentences for all descriptions, start with a capital letter and end with a period, for everything - the topic body, parameters, and return, including all annotations such as @param and @throws.
   - Tests:
     - Prefer assertJ.
@@ -119,6 +129,11 @@ The IDocument (text) is the single source of truth: grid edits become minimal te
   - Monitor a branch's CI build result at <https://github.com/dbunit/dbunit-eclipse-plugin/actions/workflows/build-any-branch.yml> for issues to correct.
   - Keep `org.dbunit.eclipse.dataset.core` free of UI dependencies (no `org.eclipse.ui*`, `org.eclipse.swt`, `org.eclipse.jface` other than `org.eclipse.jface.text` types from the `org.eclipse.text` bundle).
   - All SWT access happens on the UI thread; dispose every Color, Font, Image, and Cursor you create (prefer `JFaceResources`/`LocalResourceManager`).
+  - Fix static analysis findings instead of suppressing them.
+    - Exclude a SpotBugs finding that is by design only in `src/code-audit-rules/spotbugs-exclude.xml`, naming the class, the field, and the pattern, with the reason.
+    - Suppress an Error Prone finding that is by design with `@SuppressWarnings("CheckName")` on the smallest element, with a comment that gives the reason.
+    - Suppress a PMD finding that is by design with `@SuppressWarnings("PMD.RuleName")` on the smallest element, with a comment that gives the reason.
+  - Tycho compiles with the Eclipse compiler, which cannot run Error Prone, so Error Prone runs as a second, analysis-only javac pass (the `error-prone` execution of `maven-compiler-plugin` in the root `pom.xml`); the shipped classes still come from the Eclipse compiler.
 
 ## Troubleshooting
 

README.adoc

@@ -7,12 +7,20 @@ image:https://img.shields.io/github/issues/dbunit/dbunit-eclipse-plugin["Open Is
 
 Edit link:https://dbunit.github.io/dbunit-extension/[dbUnit] dataset files like a spreadsheet, inside the Eclipse IDE.
 
-The *dbUnit Dataset Editor* opens dbUnit flat XML dataset files as a grid:
+The *dbUnit Dataset Editor* opens dbUnit dataset files as a grid:
 each table is a sheet, each row element is a spreadsheet row, and each attribute is a cell.
-Edits are written back into the XML text with minimal changes,
-so comments, formatting, and the DOCTYPE are preserved and diffs stay small.
 
-Version 1 supports the dbUnit flat XML format; other dataset formats are planned.
+The plugin currently supports the dbUnit flat XML format; other dataset formats are planned.
+
+== Features
+
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#tables-page[One sheet per table], with rows in file order
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#editing[Spreadsheet editing], with link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#null-values[NULL and empty strings kept apart]
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#rows-columns-tables[Row, column, and table commands]
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#clipboard[Copy and paste] to and from spreadsheet applications
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#undo[Undo and redo] shared with the link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#source-page[Source page]
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#problems[Warnings about content dbUnit ignores or rejects]
+* link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#dtd[DTD support] and a link:https://dbunit.github.io/dbunit-eclipse-plugin/usage.html#opening[new dataset wizard]
 
 == Documentation
 

build-local.cmd

@@ -0,0 +1,33 @@
+@echo off
+rem Builds the plugin with the current UTC time as the version qualifier, to install the build into
+rem Eclipse during development. build-local.sh does the same in bash.
+rem
+rem A plain mvnw build takes the qualifier from project.build.outputTimestamp in the root pom.xml,
+rem which changes only per release, so every local build has the same version, and Eclipse does not
+rem offer a rebuilt plugin as an update to the installed one. A build from this script is newer than
+rem the one before it. The qualifier has the format of the pom's 'v'yyyyMMdd-HHmm, as in the CI build.
+rem
+rem Usage: build-local.cmd [Maven arguments]
+rem   Without arguments it runs: clean install
+rem   Arguments replace those goals, so give the goals too: build-local.cmd clean verify -DskipTests
+
+setlocal
+pushd "%~dp0"
+
+set "BUILD_QUALIFIER="
+for /f "usebackq delims=" %%q in (`powershell -NoProfile -NonInteractive -Command "'v' + [DateTime]::UtcNow.ToString('yyyyMMdd-HHmm')"`) do set "BUILD_QUALIFIER=%%q"
+if not defined BUILD_QUALIFIER (
+  echo Cannot get the current UTC time from powershell for the version qualifier.>&2
+  popd
+  exit /b 1
+)
+
+set "DEFAULT_GOALS="
+if "%~1"=="" set "DEFAULT_GOALS=clean install"
+
+echo Building with the version qualifier %BUILD_QUALIFIER%
+call "%~dp0mvnw.cmd" -DforceContextQualifier=%BUILD_QUALIFIER% %DEFAULT_GOALS% %*
+set "MAVEN_EXIT_CODE=%ERRORLEVEL%"
+
+popd
+exit /b %MAVEN_EXIT_CODE%

build-local.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+#
+# Builds the plugin with the current UTC time as the version qualifier, to install the build into
+# Eclipse during development. build-local.cmd does the same on Windows.
+#
+# A plain mvnw build takes the qualifier from project.build.outputTimestamp in the root pom.xml,
+# which changes only per release, so every local build has the same version, and Eclipse does not
+# offer a rebuilt plugin as an update to the installed one. A build from this script is newer than
+# the one before it. The qualifier has the format of the pom's 'v'yyyyMMdd-HHmm, as in the CI build.
+#
+# Usage: build-local.sh [<Maven arguments>]
+#   Without arguments it runs: clean install
+#   Arguments replace those goals, so give the goals too: build-local.sh clean verify -DskipTests
+
+set -euo pipefail
+
+cd "$(dirname "$0")"
+
+if [ "$#" -eq 0 ]; then
+  set -- clean install
+fi
+
+qualifier="v$(date -u +%Y%m%d-%H%M)"
+echo "Building with the version qualifier ${qualifier}"
+
+exec ./mvnw -DforceContextQualifier="${qualifier}" "$@"

bundles/org.dbunit.eclipse.dataset.core/META-INF/MANIFEST.MF

@@ -10,5 +10,15 @@ Bundle-ActivationPolicy: lazy
 Automatic-Module-Name: org.dbunit.eclipse.dataset.core
 Require-Bundle: org.eclipse.equinox.common;bundle-version="3.19.0",
  org.eclipse.core.contenttype;bundle-version="3.9.0",
- org.eclipse.text;bundle-version="3.14.0"
-Export-Package: org.dbunit.eclipse.dataset.core
+ org.eclipse.text;bundle-version="3.14.0",
+ org.eclipse.core.commands;bundle-version="3.12.0"
+Import-Package: javax.xml.parsers,
+ org.eclipse.osgi.util;version="1.1.0",
+ org.xml.sax,
+ org.xml.sax.helpers
+Export-Package: org.dbunit.eclipse.dataset.core,
+ org.dbunit.eclipse.dataset.core.model,
+ org.dbunit.eclipse.dataset.core.dtd;x-friends:="org.dbunit.eclipse.dataset.ui",
+ org.dbunit.eclipse.dataset.core.edit;x-friends:="org.dbunit.eclipse.dataset.ui",
+ org.dbunit.eclipse.dataset.core.flatxml;x-friends:="org.dbunit.eclipse.dataset.ui",
+ org.dbunit.eclipse.dataset.core.tsv;x-friends:="org.dbunit.eclipse.dataset.ui"

bundles/org.dbunit.eclipse.dataset.core/build.properties

@@ -2,4 +2,5 @@ source.. = src/main/java/
 output.. = target/classes/
 bin.includes = META-INF/,\
                .,\
-               plugin.properties
+               plugin.properties,\
+               plugin.xml

bundles/org.dbunit.eclipse.dataset.core/plugin.properties

@@ -1,2 +1,3 @@
 Bundle-Name = dbUnit Dataset Core
 Bundle-Vendor = dbUnit
+contentType.flatXml.name = dbUnit Flat XML Dataset

bundles/org.dbunit.eclipse.dataset.core/plugin.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+   <extension point="org.eclipse.core.contenttype.contentTypes">
+      <content-type
+            id="org.dbunit.eclipse.dataset.flatxml"
+            base-type="org.eclipse.core.runtime.xml"
+            name="%contentType.flatXml.name"
+            file-extensions="xml"
+            priority="normal">
+         <describer class="org.dbunit.eclipse.dataset.core.flatxml.FlatXmlContentDescriber"/>
+      </content-type>
+   </extension>
+</plugin>

bundles/org.dbunit.eclipse.dataset.core/pom.xml

@@ -78,6 +78,18 @@
           <failIfNoTests>true</failIfNoTests>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>com.github.spotbugs</groupId>
+        <artifactId>spotbugs-maven-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-pmd-plugin</artifactId>
+      </plugin>
     </plugins>
   </build>
 </project>