pyDiffTools 0.1.42__tar.gz → 0.1.43__tar.gz

{pydifftools-0.1.42/pyDiffTools.egg-info → pydifftools-0.1.43}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.42
+Version: 0.1.43
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck

{pydifftools-0.1.42 → pydifftools-0.1.43/pyDiffTools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyDiffTools
-Version: 0.1.42
+Version: 0.1.43
 Summary: Diff tools
 Author: J M Franck
 License: Copyright (c) 2015, jmfranck

{pydifftools-0.1.42 → pydifftools-0.1.43}/pydifftools/continuous.py

@@ -132,7 +132,7 @@ def show_markdown_fix_dialog(report):
     from html import escape
 
     from PySide6.QtCore import Qt
-    from PySide6.QtGui import QFontDatabase
+    from PySide6.QtGui import QFontDatabase, QFontMetrics
     from PySide6.QtWidgets import (
         QApplication,
         QDialog,
@@ -145,14 +145,7 @@ def show_markdown_fix_dialog(report):
 
     fixes = report["fixes"]
     warnings = report["warnings"]
-    records = [
-        {"record_type": "fix", **fix}
-        for fix in fixes
-    ] + [
-        {"record_type": "warning", **warning}
-        for warning in warnings
-    ]
-    if not records:
+    if not fixes and not warnings:
         return
 
     dialog = QDialog()
@@ -160,7 +153,53 @@ def show_markdown_fix_dialog(report):
         QApplication.instance() or QApplication([])
     )
     dialog.setWindowTitle("Markdown source fixes")
-    dialog.resize(760, 480)
+    fixed_font = QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont)
+    # {{{ group fixes of one kind onto pages that fill the screen
+    screen_height = dialog.screen().availableGeometry().height()
+    dialog.resize(900, int(screen_height * 0.85))
+    # leave room for the heading, explanation, button and margins
+    page_rows = max(
+        3,
+        int(
+            (screen_height * 0.85 - 120)
+            / QFontMetrics(fixed_font).lineSpacing()
+        ),
+    )
+    groups = {}
+    for fix in fixes:
+        groups.setdefault(fix["reason"], []).append(fix)
+    records = []
+    for reason, group in groups.items():
+        page = []
+        rows = 0
+        for fix in sorted(group, key=lambda fix: fix["line"]):
+            # a blank line separates each fix from the one before it, and a
+            # fix that only drops trailing spaces shows just its old line
+            fix_rows = (
+                len(fix["before"].splitlines() or [""])
+                + (
+                    0
+                    if fix["after"] == fix["before"].rstrip()
+                    else len(fix["after"].splitlines() or [""])
+                )
+                + (1 if page else 0)
+            )
+            if page and rows + fix_rows > page_rows:
+                records.append(
+                    {"record_type": "fix", "reason": reason, "fixes": page}
+                )
+                page = []
+                rows = 0
+                fix_rows -= 1
+            page.append(fix)
+            rows += fix_rows
+        records.append(
+            {"record_type": "fix", "reason": reason, "fixes": page}
+        )
+    records += [
+        {"record_type": "warning", **warning} for warning in warnings
+    ]
+    # }}}
     layout = QVBoxLayout(dialog)
     heading = QLabel()
     heading.setWordWrap(True)
@@ -175,14 +214,10 @@ def show_markdown_fix_dialog(report):
         Qt.AlignmentFlag.AlignTop | Qt.AlignmentFlag.AlignRight
     )
     line_numbers.setStyleSheet("color: #666; padding-right: 8px;")
-    line_numbers.setFont(
-        QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont)
-    )
+    line_numbers.setFont(fixed_font)
     preview = QTextEdit()
     preview.setReadOnly(True)
-    preview.setFont(
-        QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont)
-    )
+    preview.setFont(fixed_font)
     preview_row.addWidget(line_numbers)
     preview_row.addWidget(preview, 1)
     layout.addLayout(preview_row, 1)
@@ -194,37 +229,60 @@ def show_markdown_fix_dialog(report):
 
     def show_record():
         record = records[index]
-        line = record["line"]
+        page = (
+            f" (page {index + 1} of {len(records)})"
+            if len(records) > 1
+            else ""
+        )
         if record["record_type"] == "fix":
-            heading.setText("I fixed this source line automatically.")
+            count = len(record["fixes"])
+            heading.setText(
+                "I fixed this source line automatically." + page
+                if count == 1
+                else f"I fixed these {count} source lines automatically."
+                + page
+            )
             details.setText(record["reason"])
-            before_lines = record["before"].splitlines() or [""]
-            after_lines = record["after"].splitlines() or [""]
-            source_html = ""
-            numbers = []
-            if "\n" in record["after"]:
-                after_html = "<br>↳ ".join(
-                    escape(value)
-                    for value in record["after"].split("\n")
-                )
-                source_html = (
-                    "<pre style='font-family:monospace; margin:0'>"
-                    + "Before:<br>"
-                    + "<br>".join(escape(value) for value in before_lines)
-                    + "<br><br>After:<br>"
-                    + after_html
-                    + "</pre>"
-                )
-                numbers = [""] + list(
-                    range(line, line + len(before_lines))
-                )
-                numbers += ["", ""]
-                numbers += list(range(line, line + len(after_lines)))
-            line_numbers.setText("<br>".join(str(value) for value in numbers))
-            preview.setHtml(source_html)
+            line_numbers.setVisible(False)
+            # {{{ show each fix as numbered before (−) and after (+) lines
+            entries = []
+            for fix in record["fixes"]:
+                rows = []
+                for offset, value in enumerate(
+                    fix["before"].splitlines() or [""]
+                ):
+                    stripped = value.rstrip(" ")
+                    rows.append(
+                        f"<span style='color:#666'>{fix['line'] + offset:>6}"
+                        "</span> − "
+                        + escape(stripped)
+                        # make stray trailing spaces visible
+                        + "<span style='background:#fbb'>·</span>"
+                        * (len(value) - len(stripped))
+                    )
+                for offset, value in enumerate(
+                    []
+                    if fix["after"] == fix["before"].rstrip()
+                    else fix["after"].split("\n")
+                ):
+                    rows.append(
+                        f"<span style='color:#666'>{fix['line'] + offset:>6}"
+                        "</span> "
+                        + ("+ " if offset == 0 else "↳ ")
+                        + escape(value)
+                    )
+                entries.append("<br>".join(rows))
+            preview.setHtml(
+                "<pre style='font-family:monospace; margin:0'>"
+                + "<br><br>".join(entries)
+                + "</pre>"
+            )
+            # }}}
             button.setText("Next" if index + 1 < len(records) else "Done")
         else:
-            heading.setText("This source span is not closed.")
+            line = record["line"]
+            heading.setText("This source span is not closed." + page)
+            line_numbers.setVisible(True)
             if record["kind"] == "math":
                 delimiter = record["delimiter"]
                 details.setText(

{pydifftools-0.1.42 → pydifftools-0.1.43}/pydifftools/wrap_sentences.py

@@ -1190,10 +1190,15 @@ def apply_markdown_issue_fix(content, line_number, message):
         else:
             span = found.span("gap")
             joined = ""
-        before = content[found.start() : found.end()]
         updated = content[: span[0]] + joined + content[span[1] :]
+        # report the whole source lines around the join
+        line_start = content.rfind("\n", 0, found.start()) + 1
+        line_end = content.find("\n", max(found.end(), span[1]))
+        if line_end == -1:
+            line_end = len(content)
+        before = content[line_start:line_end]
         after = updated[
-            found.start() : span[0] + len(joined) + found.end() - span[1]
+            line_start : line_end - (span[1] - span[0]) + len(joined)
         ]
         return (
             updated,

{pydifftools-0.1.42 → pydifftools-0.1.43}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyDiffTools"
-version = "0.1.42"
+version = "0.1.43"
 authors = [{ name = "J M Franck" }]
 description = "Diff tools"
 readme = "README.rst"

{pydifftools-0.1.42 → pydifftools-0.1.43}/tests/test_wrap_check.py

@@ -423,11 +423,6 @@ def test_qt_fix_and_reload_windows_show_source_changes(tmp_path):
         )
         seen["preview"] = dialog.findChild(QTextEdit).toPlainText()
         seen["button"] = dialog.findChild(QPushButton).text()
-        seen["line_gutter"] = next(
-            label
-            for label in dialog.findChildren(QLabel)
-            if "#666" in label.styleSheet()
-        ).text()
         seen["heading"] = dialog.findChildren(QLabel)[0].text()
         dialog.findChild(QPushButton).click()
 
@@ -435,7 +430,7 @@ def test_qt_fix_and_reload_windows_show_source_changes(tmp_path):
     show_markdown_fix_dialog(report)
     assert "↳ collection of words" in seen["preview"]
     assert seen["button"] == "Done"
-    assert "1" in seen["line_gutter"]
+    assert re.search(r"^ +1 − This deliberately", seen["preview"], re.M)
     assert "line 1" not in seen["heading"].lower()
 
     def inspect_reload_window():
@@ -454,6 +449,70 @@ def test_qt_fix_and_reload_windows_show_source_changes(tmp_path):
     assert seen["reload_button"] == "I've reloaded"
 
 
+def test_qt_fix_window_groups_fixes_of_one_kind_onto_full_pages(tmp_path):
+    pytest.importorskip("PySide6")
+    from PySide6.QtCore import QTimer
+    from PySide6.QtWidgets import QApplication, QDialog, QPushButton
+    from PySide6.QtWidgets import QLabel, QTextEdit
+
+    from pydifftools.continuous import show_markdown_fix_dialog
+
+    app = QApplication.instance() or QApplication([])
+    # from RM_ESR: many stray trailing spaces plus one other kind of fix
+    source_path = tmp_path / "content.md"
+    source_path.write_text(
+        "".join(f"Sentence number {j} ends here. \n" for j in range(60))
+        + "\n$$\nx = y\n$$ {#eq:tauFromLinewidth}\n"
+    )
+    report = autofix_markdown_file(source_path)
+    assert len(report["fixes"]) == 61
+    pages = []
+
+    def inspect_page():
+        dialog = next(
+            widget
+            for widget in app.topLevelWidgets()
+            if isinstance(widget, QDialog)
+            and widget.isVisible()
+            and widget.windowTitle() == "Markdown source fixes"
+        )
+        preview = dialog.findChild(QTextEdit).toPlainText()
+        pages.append(
+            {
+                "heading": dialog.findChildren(QLabel)[0].text(),
+                "details": dialog.findChildren(QLabel)[1].text(),
+                "entries": preview.split("\n\n"),
+            }
+        )
+        button = dialog.findChild(QPushButton)
+        if button.text() == "Next":
+            QTimer.singleShot(0, inspect_page)
+        button.click()
+
+    QTimer.singleShot(0, inspect_page)
+    show_markdown_fix_dialog(report)
+
+    trailing = [page for page in pages if "stray space" in page["details"]]
+    crossref = [page for page in pages if "crossref" in page["details"]]
+    # one kind per page, many fixes per page, and every fix shown once
+    assert len(trailing) + len(crossref) == len(pages)
+    assert len(crossref) == 1
+    assert 1 < len(trailing) < 60
+    assert all(len(page["entries"]) > 5 for page in trailing[:-1])
+    assert sum(len(page["entries"]) for page in trailing) == 60
+    assert f"(page 1 of {len(pages)})" in pages[0]["heading"]
+    # a trailing-space entry is just the numbered line with its stray space
+    # made visible, while other fixes also show the line after the fix
+    assert re.fullmatch(
+        r" +1 − Sentence number 0 ends here\.·", trailing[0]["entries"][0]
+    )
+    assert re.fullmatch(
+        r" +64 − \$\$ \{#eq:tauFromLinewidth\}\n +64 \+ "
+        r"\$\$\{#eq:tauFromLinewidth\}",
+        crossref[0]["entries"][0],
+    )
+
+
 def test_qt_unclosed_math_window_bolds_source_and_requests_confirmation():
     from PySide6.QtCore import QTimer
     from PySide6.QtWidgets import (