From 0b2dda8caa195986994953c429f395a4f3d5e046 Mon Sep 17 00:00:00 2001 From: Pjandro Date: Fri, 13 Nov 2026 01:24:25 +0300 Subject: [PATCH] =?UTF-8?q?PMD:=20=D1=81=D0=BB=D0=B8=D1=8F=D0=BD=D0=B8?= =?UTF-8?q?=D0=B5=20=D0=BD=D0=BE=D0=B2=D1=8B=D1=85=20=D0=BF=D1=80=D0=B0?= =?UTF-8?q?=D0=B2=D0=B8=D0=BB=20(bestpractices/design/errorprone/multithre?= =?UTF-8?q?ading)=20+=20=D0=BF=D1=80=D0=B0=D0=B2=D0=BA=D0=B0=20=D0=BD?= =?UTF-8?q?=D0=B0=D1=80=D1=83=D1=88=D0=B5=D0=BD=D0=B8=D0=B9=20=D0=B1=D0=B5?= =?UTF-8?q?=D0=B7=20=D0=BF=D0=BE=D0=B4=D0=B0=D0=B2=D0=BB=D0=B5=D0=BD=D0=B8?= =?UTF-8?q?=D0=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 4 +- pmd-ruleset.xml | 56 ++++++++++++------- .../ru/pjandro/wordpdf/WordPdfConverter.java | 3 +- .../wordpdf/internal/DocxRewritePipeline.java | 2 +- .../wordpdf/internal/OleObjectNormalizer.java | 2 +- .../internal/chart/CartesianPainter.java | 10 ++-- .../wordpdf/internal/chart/ChartSpec.java | 10 +++- .../internal/chart/DrawingPreRenderer.java | 18 ++++-- .../wordpdf/ChartTypesDocxGenerator.java | 5 +- .../pjandro/wordpdf/SampleDocxGenerator.java | 7 ++- .../wordpdf/internal/doc/CfbReaderTest.java | 9 +-- .../internal/doc/DocToDocxFormattingTest.java | 28 +++++----- 12 files changed, 97 insertions(+), 57 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 1e4ebee..17bd738 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -97,7 +97,7 @@ python3 docs/standards/docx/validate-fixtures.py wordpdf-core/src/test/resources - Константы UPPER_SNAKE с эталонными значениями (`PIE_DEPTH`, `DECOMPRESS_MB_PER_MAX_MB`); начертания `V_REGULAR/V_BOLD/V_ITALIC/V_BOLD_ITALIC`; модели — `record`; размеры в chart — в пунктах, растр × `DPI/72`. - Логирование: `java.util.logging.Logger` в корневом пакете и `internal/`, SLF4J — в `internal/chart` и `wordpdf-app`. - Тестовые методы: регрессионные — `объект_условие` через underscore (`ruPlain_cyrillicAndStyles`), юниты — camelCase (`pageFieldBecomesFldSimple`); оба стиля разрешает PMD-паттерн `junit5TestPattern` (`^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$`). -- PMD (`pmd-ruleset.xml`, execution `pmd-check` на `verify` в обоих модулях, `includeTests=true`, валится нарушение любой приоритетности): полные исключения категории, кастомное XPath-правило `LiteralFirstInEquals` и настройки — в самом ruleset. +- PMD (`pmd-ruleset.xml`, execution `pmd-check` на `verify` в обоих модулях, `includeTests=true`, валится нарушение любой приоритетности): полные исключения категории и настройки правил — в самом ruleset. Нарушения чинятся кодом; подавление (`@SuppressWarnings("PMD…")`, `// NOPMD`) запрещено. ## Runtime & Tooling @@ -124,6 +124,6 @@ python3 docs/standards/docx/validate-fixtures.py wordpdf-core/src/test/resources - App-тесты: `@SpringBootTest` + `@AutoConfigureMockMvc` (Boot 4: `org.springframework.boot.webmvc.test.autoconfigure`); четыре набора свойств = четыре контекста (отдельные классы, не `@Nested`); `ConversionServiceTest`/`ApiExceptionHandlerTest` — без Spring. Core-юниты Spring **не поднимают**; app-тесты проверяют только HTTP-код/заголовки/текст ошибки. Детали — `docs/agent/testing.md`. - Жизненный цикл: только `@Test`; исключения — два `@BeforeAll` (прогрев шрифтов) и `@AfterEach drainWorker` в `ConversionTimeoutTest`. Ни `@Nested`, ни `@ParameterizedTest`, ни `@Disabled`, ни `assertAll`. - Идиомы загрузки фикстур: **core** — classloader без ведущего слэша, **app** — class-relative со слэшем (core test-jar). Синтетика: docx — `ZipOutputStream`, `.doc` — крафт `POIFSFileSystem`. -- Сообщения ассертов — по-русски и с наблюдаемым значением; сравнение строк литерал-слева (`"%PDF".equals(...)`, PMD `LiteralFirstInEquals`); контракт идентичности — `assertSame`/`assertNotSame`. Общих test-util-классов нет: хелперы (`norm`, `pdfText`, `assertRatio`) намеренно продублированы. +- Сообщения ассертов — по-русски и с наблюдаемым значением; сравнение строк литерал-слева (`"%PDF".equals(...)`, PMD `LiteralsFirstInComparisons`); контракт идентичности — `assertSame`/`assertNotSame`. Общих test-util-классов нет: хелперы (`norm`, `pdfText`, `assertRatio`) намеренно продублированы. - Прод-автотесты: pytest + requests; под маркером `needs_key` без ключа SKIP; конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен). - `mvn test` **не** запускает PMD и JaCoCo-гейты (оба на `verify`) — «зелёное» состояние проверяется `mvn clean verify`. `mvn -pl wordpdf-app` без `-am` падает: app зависит от core test-jar. diff --git a/pmd-ruleset.xml b/pmd-ruleset.xml index 6fc376f..76bc13a 100644 --- a/pmd-ruleset.xml +++ b/pmd-ruleset.xml @@ -2,8 +2,11 @@ - Код-стиль java-word-pdf: codestyle без opinionated-правил + unused-правила + NPE-safe equals + Код-стиль java-word-pdf: codestyle без opinionated-правил, unused-правила, + NPE-safe сравнения, гигиена ошибок/ресурсов/многопоточности. Нарушения чинятся + кодом — подавление @SuppressWarnings("PMD…") и // NOPMD запрещены. + @@ -23,6 +26,8 @@ + + @@ -39,31 +44,35 @@ - - - 3 + + + + - - - + + + + 2 + + + + + + + + + @@ -71,7 +80,16 @@ 2 - - 2 - + + + + + + + + + + + + diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java index 35430e0..ffe36fe 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java @@ -31,6 +31,7 @@ import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import javax.xml.transform.Templates; +import javax.xml.transform.TransformerConfigurationException; import javax.xml.transform.stream.StreamSource; import javax.imageio.ImageIO; import java.io.InputStream; @@ -490,7 +491,7 @@ public final class WordPdfConverter { throw new ConversionException("Ресурс xslt/docx2fo.xslt не найден"); } return XmlUtils.getTransformerFactory().newTemplates(new StreamSource(xslt)); - } catch (Exception e) { + } catch (IOException | TransformerConfigurationException e) { throw new ConversionException("Не удалось скомпилировать xslt/docx2fo.xslt", e); } } diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/DocxRewritePipeline.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/DocxRewritePipeline.java index ec8b8d4..e6c51fe 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/DocxRewritePipeline.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/DocxRewritePipeline.java @@ -137,7 +137,7 @@ public final class DocxRewritePipeline { if (next != null) { cur = next; } - if (cur != xml) { + if (!cur.equals(xml)) { changed = true; rewritten = cur.getBytes(StandardCharsets.UTF_8); } diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/OleObjectNormalizer.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/OleObjectNormalizer.java index c35f11a..7343995 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/OleObjectNormalizer.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/OleObjectNormalizer.java @@ -259,7 +259,7 @@ public final class OleObjectNormalizer { if (fixed != null) { data = fixed.getBytes(StandardCharsets.UTF_8); } - } else if (name.equals(CONTENT_TYPES_ENTRY)) { + } else if (CONTENT_TYPES_ENTRY.equals(name)) { String fixed = stripOverrides( new String(data, StandardCharsets.UTF_8), oleParts); if (fixed != null) { diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/CartesianPainter.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/CartesianPainter.java index bd7c20e..a9b9a98 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/CartesianPainter.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/CartesianPainter.java @@ -70,12 +70,12 @@ final class CartesianPainter { "percentStacked".equalsIgnoreCase(lineGrouping)) : null; - // Разделение серий по осям значений: ссылочное равенство с secondaryValAxis - // (назначается ChartSpec.parse по c:axId, §21.2.2.9). + // Разделение серий по осям значений: та же ось по c:axId + // (назначается ChartSpec.parse, §21.2.2.9; {@link ChartSpec#sameAxis}). List primIdx = new ArrayList<>(); List secIdx = new ArrayList<>(); for (int si = 0; si < spec.series.size(); si++) { - if (secAxis != null && spec.series.get(si).valAxis == secAxis) { + if (ChartSpec.sameAxis(spec.series.get(si).valAxis, secAxis)) { secIdx.add(si); } else { primIdx.add(si); @@ -278,9 +278,9 @@ final class CartesianPainter { return gr != null ? gr : spec.grouping; } - /** Серия на вторичной оси значений (ссылочное равенство с secondaryValAxis). */ + /** Серия на вторичной оси значений (та же ось по c:axId, §21.2.2.9; {@link ChartSpec#sameAxis}). */ private static boolean onSecondary(ChartSpec.Series s, ChartSpec spec) { - return spec.secondaryValAxis != null && s.valAxis == spec.secondaryValAxis; + return ChartSpec.sameAxis(s.valAxis, spec.secondaryValAxis); } private static List intersect(List family, List prim) { diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java index 3f66afe..2a4dcf7 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java @@ -396,7 +396,7 @@ final class ChartSpec { break; } } - if (va == null || va == spec.valAxis) { + if (va == null || sameAxis(va, spec.valAxis)) { continue; } if (spec.secondaryValAxis == null) { @@ -409,6 +409,14 @@ final class ChartSpec { } } + /** Та же ось по c:axId (§21.2.2.9): id уникален в диаграмме, оси с id ≥ 0 лежат + * в {@code axesById} по одному на id — для осей, назначенных из карты при разборе, + * эквивалентно ссылочному равенству. Прямое сравнение осей через == запрещено + * PMD CompareObjectsWithEquals; null и id < 0 — никогда «та же». */ + static boolean sameAxis(AxisSpec a, AxisSpec b) { + return a != null && b != null && a.axId >= 0 && a.axId == b.axId; + } + private static void readChartFrame(CTChartSpace space, ChartSpec spec, DrawMlColor colors) { CTShapeProperties sp = space.getSpPr(); if (sp == null) { diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java index bd5d040..c16f138 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java @@ -46,7 +46,9 @@ import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.lang.reflect.Method; import java.util.ArrayList; +import java.util.Collections; import java.util.HashSet; +import java.util.IdentityHashMap; import java.util.List; import java.util.Set; @@ -134,6 +136,7 @@ public final class DrawingPreRenderer { // ConcurrentModificationException. List parts = new ArrayList<>(pkg.getParts().getParts().values()); Set handled = new HashSet<>(); + Set> visitedContents = Collections.newSetFromMap(new IdentityHashMap<>()); int[] idSeq = {1000}; long[] pngTotal = {0}; for (Part p : parts) { @@ -144,7 +147,7 @@ public final class DrawingPreRenderer { if (content.isEmpty()) { continue; } - walk(p, content, pkg, colors, idSeq, pngTotal, maxPngBytesTotal, options); + walk(p, content, pkg, colors, idSeq, pngTotal, maxPngBytesTotal, options, visitedContents); } } @@ -171,7 +174,14 @@ public final class DrawingPreRenderer { private static void walk(Part part, List content, WordprocessingMLPackage pkg, DrawMlColor colors, int[] idSeq, long[] pngTotal, - long maxPngBytesTotal, ConvertOptions options) { + long maxPngBytesTotal, ConvertOptions options, + Set> visitedContents) { + // Посещённые списки — по идентичности (IdentityHashMap): рефлексивный + // getContent (ребёнок возвращает список родителя) не зацикливает обход. + // Сравнение списков через ==/!= запрещено PMD CompareObjectsWithEquals. + if (!visitedContents.add(content)) { + return; + } for (Object o : content) { Object v = o instanceof JAXBElement ? ((JAXBElement) o).getValue() : o; if (v instanceof Drawing drawing) { @@ -179,8 +189,8 @@ public final class DrawingPreRenderer { continue; } List nested = invokeList(v, "getContent"); - if (!nested.isEmpty() && nested != content) { - walk(part, nested, pkg, colors, idSeq, pngTotal, maxPngBytesTotal, options); + if (!nested.isEmpty()) { + walk(part, nested, pkg, colors, idSeq, pngTotal, maxPngBytesTotal, options, visitedContents); } } } diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/ChartTypesDocxGenerator.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/ChartTypesDocxGenerator.java index 2c2508b..0b81d1c 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/ChartTypesDocxGenerator.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/ChartTypesDocxGenerator.java @@ -7,6 +7,7 @@ import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; import java.util.List; +import java.util.logging.Logger; import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; @@ -34,6 +35,8 @@ public final class ChartTypesDocxGenerator { private static final String A = "http://schemas.openxmlformats.org/drawingml/2006/main"; private static final String R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships"; + private static final Logger LOG = Logger.getLogger(ChartTypesDocxGenerator.class.getName()); + public static void main(String[] args) throws IOException { Path out = Path.of(args[0]); List titles = List.of( @@ -109,7 +112,7 @@ public final class ChartTypesDocxGenerator { } } Files.write(out, out2.toByteArray()); - System.out.println("written " + out + " " + out2.size() + " bytes"); + LOG.info("written " + out + " " + out2.size() + " bytes"); } private static String space(String title, String groupWithAxes) { diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/SampleDocxGenerator.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/SampleDocxGenerator.java index d991eb9..24bf151 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/SampleDocxGenerator.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/SampleDocxGenerator.java @@ -35,6 +35,7 @@ import java.math.BigInteger; import java.nio.file.Path; import java.nio.file.Paths; import java.util.List; +import java.util.logging.Logger; /** * ОДНОРАЗОВАЯ утилита: генерация готовых .docx для тестов (Apache POI). @@ -59,6 +60,8 @@ public final class SampleDocxGenerator { /** Путь основной части документа в zip. */ private static final String DOCUMENT_PART = "word/document.xml"; + private static final Logger LOG = Logger.getLogger(SampleDocxGenerator.class.getName()); + private SampleDocxGenerator() { } @@ -77,7 +80,7 @@ public final class SampleDocxGenerator { tooManyPages(dir.resolve("too-many-pages.docx")); staleCache(dir.resolve("stale-cache.docx")); - System.out.println("Готово: " + dir.toAbsolutePath()); + LOG.info("Готово: " + dir.toAbsolutePath()); } /** Русский текст, Calibri, заголовок + полужирный и курсивный run'ы. */ @@ -498,7 +501,7 @@ public final class SampleDocxGenerator { try (FileOutputStream fos = new FileOutputStream(out.toFile())) { doc.write(fos); } - System.out.println(" создан: " + out.getFileName() + LOG.info(" создан: " + out.getFileName() + " (" + new File(out.toString()).length() + " байт)"); } } diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/CfbReaderTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/CfbReaderTest.java index 962f16a..0861f03 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/CfbReaderTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/CfbReaderTest.java @@ -110,12 +110,9 @@ class CfbReaderTest { for (int i = 0; i < specs.length; i++) { Spec s = specs[i]; boolean smallOne = s.data().length < 4096; - int idx = -1; - for (int k = 0; k < (smallOne ? small : big).size(); k++) { - if ((smallOne ? small : big).get(k) == s) { - idx = k; - } - } + // Spec — record с byte[]: equals сравнивает массив по ссылке, indexOf + // находит ровно тот же экземпляр, что добавлялся в small/big. + int idx = (smallOne ? small : big).indexOf(s); dirEntry(file, 1, 1 + i, s.name(), 2, smallOne ? miniHead[idx] : bigHead[idx], s.data().length); } diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/DocToDocxFormattingTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/DocToDocxFormattingTest.java index 1be7132..f8b449d 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/DocToDocxFormattingTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/doc/DocToDocxFormattingTest.java @@ -377,21 +377,21 @@ class DocToDocxFormattingTest { } private static byte[] cfb(boolean use1Table, boolean withTable) throws IOException { - POIFSFileSystem fs = new POIFSFileSystem(); - byte[] wd = wordDocument(); - if (!use1Table) { - wd[11] &= ~0x02; // fWhichTblStm (бит 9 u16) → 0Table + try (POIFSFileSystem fs = new POIFSFileSystem()) { + byte[] wd = wordDocument(); + if (!use1Table) { + wd[11] &= ~0x02; // fWhichTblStm (бит 9 u16) → 0Table + } + fs.getRoot().createDocument("WordDocument", new ByteArrayInputStream(wd)); + if (withTable) { + fs.getRoot().createDocument(use1Table ? "1Table" : "0Table", + new ByteArrayInputStream(tableStream())); + } + fs.getRoot().createDocument("Data", new ByteArrayInputStream(new byte[64])); + ByteArrayOutputStream out = new ByteArrayOutputStream(); + fs.writeFilesystem(out); + return out.toByteArray(); } - fs.getRoot().createDocument("WordDocument", new ByteArrayInputStream(wd)); - if (withTable) { - fs.getRoot().createDocument(use1Table ? "1Table" : "0Table", - new ByteArrayInputStream(tableStream())); - } - fs.getRoot().createDocument("Data", new ByteArrayInputStream(new byte[64])); - ByteArrayOutputStream out = new ByteArrayOutputStream(); - fs.writeFilesystem(out); - fs.close(); - return out.toByteArray(); } private static String documentXml(byte[] doc) throws IOException { -- 2.56.1