pyDiffTools 0.1.47__tar.gz → 0.1.49__tar.gz

{pydifftools-0.1.47 → pydifftools-0.1.49}/MANIFEST.in

@@ -4,6 +4,7 @@ include LICENSE.md
 include pydifftools/diff-doc.js
 include pydifftools/xml2xlsx.vbs
 include pydifftools/comments.css
+include pydifftools/comments_author_colors.css
 include pydifftools/comment_tags.lua
 include pydifftools/comment_tags_margin.lua
 include pydifftools/comment_tags_no_comments.lua

{pydifftools-0.1.47/pyDiffTools.egg-info → pydifftools-0.1.49}/PKG-INFO

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

{pydifftools-0.1.47 → pydifftools-0.1.49/pyDiffTools.egg-info}/PKG-INFO

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

{pydifftools-0.1.47 → pydifftools-0.1.49}/pyDiffTools.egg-info/SOURCES.txt

@@ -58,6 +58,7 @@ pydifftools/comment_tags_margin.lua
 pydifftools/comment_tags_no_comments.lua
 pydifftools/comment_toggle.js
 pydifftools/comments.css
+pydifftools/comments_author_colors.css
 pydifftools/continuous.py
 pydifftools/copy_files.py
 pydifftools/diff-doc.js
@@ -77,6 +78,7 @@ pydifftools/outline.py
 pydifftools/rearrange_tex.py
 pydifftools/searchacro.py
 pydifftools/separate_comments.py
+pydifftools/source_jump.py
 pydifftools/split_conflict.py
 pydifftools/unseparate_comments.py
 pydifftools/update_check.py
@@ -87,6 +89,7 @@ pydifftools/flowchart/__init__.py
 pydifftools/flowchart/comparison.py
 pydifftools/flowchart/dot_to_yaml.py
 pydifftools/flowchart/graph.py
+pydifftools/flowchart/source_jump.js
 pydifftools/flowchart/svg-pan-zoom.min.js
 pydifftools/flowchart/watch_graph.py
 pydifftools/flowchart/wgrph_view.js
@@ -105,6 +108,7 @@ tests/test_git_gd_history.py
 tests/test_git_gd_image.py
 tests/test_git_gd_qt.py
 tests/test_rrng.py
+tests/test_source_jump.py
 tests/test_tex_to_qmd.py
 tests/test_update_check.py
 tests/test_wrap_check.py

{pydifftools-0.1.47 → pydifftools-0.1.49}/pydifftools/browser_lifecycle.py

@@ -1,12 +1,43 @@
 import os
+import re
 import shutil
 import subprocess
+import sys
 
 # callbacks that run before any dialog needs the user; cpb registers one
 # that closes its live preview, so issues are dealt with before it reopens
 dialog_callbacks = []
 
 
+def launch_chrome(webdriver, **kwargs):
+    """Start Chrome, retrying version mismatches with a warning."""
+    from selenium.common.exceptions import SessionNotCreatedException
+    from selenium.webdriver.chrome.service import Service
+
+    try:
+        return webdriver.Chrome(**kwargs)
+    except SessionNotCreatedException as exc:
+        # {{{ Retry only ChromeDriver's explicit browser-version rejection
+        details = str(exc)
+        driver_match = re.search(
+            r"ChromeDriver only supports Chrome version (\d+)", details
+        )
+        browser_match = re.search(
+            r"Current browser version is (\d+)", details
+        )
+        if driver_match is None or browser_match is None:
+            raise
+        print(
+            "pydifft: warning: ChromeDriver "
+            f"{driver_match.group(1)} and Chrome {browser_match.group(1)} "
+            "do not match; retrying with the driver version check disabled.",
+            file=sys.stderr,
+        )
+        kwargs["service"] = Service(service_args=["--disable-build-check"])
+        return webdriver.Chrome(**kwargs)
+        # }}}
+
+
 def prepare_for_dialog():
     """Let watch commands close their preview before a dialog appears."""
     for callback in list(dialog_callbacks):

{pydifftools-0.1.47 → pydifftools-0.1.49}/pydifftools/comment_tags.lua

@@ -34,6 +34,24 @@ local OPENERS = {
 }
 local AUTHOR_COLORS = {}
 
+local function author_color_style(color)
+  local red = tonumber(color:sub(2, 3), 16)
+  local green = tonumber(color:sub(4, 5), 16)
+  local blue = tonumber(color:sub(6, 7), 16)
+  local function tint(component)
+    return math.floor(component * 0.13 + 255 * 0.87 + 0.5)
+  end
+  local background = string.format(
+    "#%02x%02x%02x", tint(red), tint(green), tint(blue)
+  )
+  return string.format(
+    "--comment-accent-color: %s; "
+      .. "--comment-accent-background-color: %s; "
+      .. "border-color: %s; background-color: %s;",
+    color, background, color, background
+  )
+end
+
 local comment_id = 0
 local function next_id()
   comment_id = comment_id + 1
@@ -43,7 +61,7 @@ end
 local function make_inline_comment(side, content_inlines, spec)
   local attributes = {}
   if spec and spec.color then
-    attributes["style"] = "--comment-accent-color: " .. spec.color .. ";"
+    attributes["style"] = author_color_style(spec.color)
     attributes["data-comment-author"] = spec.author
   end
   local inner = pandoc.Span(
@@ -66,7 +84,7 @@ local function make_block_overlay(side, id, content_blocks, spec)
       ["data-comment-id"] = id,
       ["data-comment-author"] = spec and spec.author or nil,
       ["style"] = spec and spec.color
-        and ("--comment-accent-color: " .. spec.color .. ";") or nil,
+        and author_color_style(spec.color) or nil,
     })
   )
 end
@@ -402,7 +420,7 @@ function Div(el)
       if #style > 0 and not style:match(";%s*$") then
         style = style .. ";"
       end
-      el.attributes.style = style .. "--comment-accent-color: " .. color .. ";"
+      el.attributes.style = style .. author_color_style(color)
       el.attributes["data-comment-author"] = author
     end
   end

{pydifftools-0.1.47 → pydifftools-0.1.49}/pydifftools/comment_tags_margin.lua

@@ -35,6 +35,24 @@ local OPENERS = {
 }
 local AUTHOR_COLORS = {}
 
+local function author_color_style(color)
+  local red = tonumber(color:sub(2, 3), 16)
+  local green = tonumber(color:sub(4, 5), 16)
+  local blue = tonumber(color:sub(6, 7), 16)
+  local function tint(component)
+    return math.floor(component * 0.13 + 255 * 0.87 + 0.5)
+  end
+  local background = string.format(
+    "#%02x%02x%02x", tint(red), tint(green), tint(blue)
+  )
+  return string.format(
+    "--comment-accent-color: %s; "
+      .. "--comment-accent-background-color: %s; "
+      .. "border-color: %s; background-color: %s;",
+    color, background, color, background
+  )
+end
+
 local comment_id = 0
 local function next_id()
   comment_id = comment_id + 1
@@ -69,7 +87,7 @@ local function make_inline_comment(side, content_inlines, spec)
           ["data-comment-author"] = spec and spec.author or nil,
           ["style"] = "font-size: 6pt;"
             .. (spec and spec.color
-              and (" --comment-accent-color: " .. spec.color .. ";") or ""),
+              and (" " .. author_color_style(spec.color)) or ""),
         }
       )
     )
@@ -101,7 +119,7 @@ local function make_block_overlay(side, id, content_blocks, spec)
         ["data-comment-author"] = spec and spec.author or nil,
         ["style"] = "font-size: 6pt;"
           .. (spec and spec.color
-            and (" --comment-accent-color: " .. spec.color .. ";") or ""),
+            and (" " .. author_color_style(spec.color)) or ""),
       }
     )
   )
@@ -441,7 +459,7 @@ function Div(el)
       if #style > 0 and not style:match(";%s*$") then
         style = style .. ";"
       end
-      el.attributes.style = style .. "--comment-accent-color: " .. color .. ";"
+      el.attributes.style = style .. author_color_style(color)
       el.attributes["data-comment-author"] = author
     end
   end

{pydifftools-0.1.47 → pydifftools-0.1.49}/pydifftools/comment_toggle.js

@@ -34,7 +34,7 @@
   }
 
   function positionComments() {
-    const useMobileFlow = window.matchMedia("(max-width: 900px)").matches;
+    const useMobileFlow = window.matchMedia("(max-width: 600px)").matches;
     // Inline comment bubbles are absolutely positioned relative to a zero-width
     // pin. We nudge overlapping bubbles so adjacent <comment> tags visibly
     // separate, and we raise the bubbles so the pointer aims at the source point.

{pydifftools-0.1.47 → pydifftools-0.1.49}/pydifftools/comments.css

@@ -4,9 +4,10 @@ html {
 }
 body {
   margin: 0 auto;
-  max-width: 36em;
-  padding-left: 50px;
-  padding-right: 50px;
+  /* Keep 75% of the previous side margins and give the rest to the text. */
+  max-width: calc(27em + 25%);
+  padding-left: 37.5px;
+  padding-right: 37.5px;
   padding-top: 50px;
   padding-bottom: 50px;
   hyphens: auto;
@@ -311,7 +312,7 @@ span.comment-pin > span.comment-left::after {
 }
 
 /* ---------- Mobile fallback ---------- */
-@media (max-width: 900px) {
+@media (max-width: 600px) {
   div.comment-right,
   div.comment-left,
   span.comment-pin > span.comment-right,

pydifftools-0.1.49/pydifftools/comments_author_colors.css

@@ -0,0 +1,20 @@
+/* Keep comment pointer triangles in sync with per-author bubble colors. */
+span.comment-pin > span.comment-right::before,
+.comment-overlay.comment-right::before {
+  border-color: transparent var(--comment-accent-color, #5aa0ff) transparent transparent;
+}
+
+span.comment-pin > span.comment-right::after,
+.comment-overlay.comment-right::after {
+  border-color: transparent var(--comment-accent-background-color, #eaf3ff) transparent transparent;
+}
+
+span.comment-pin > span.comment-left::before,
+.comment-overlay.comment-left::before {
+  border-color: transparent transparent transparent var(--comment-accent-color, #5aa0ff);
+}
+
+span.comment-pin > span.comment-left::after,
+.comment-overlay.comment-left::after {
+  border-color: transparent transparent transparent var(--comment-accent-background-color, #eaf3ff);
+}

{pydifftools-0.1.47 → pydifftools-0.1.49}/pydifftools/continuous.py

@@ -25,6 +25,7 @@ from .browser_lifecycle import (
     close_browser_window,
     dialog_callbacks,
     forward_search_in_browser,
+    launch_chrome,
     prepare_for_dialog,
 )
 from .forward_search import (
@@ -34,6 +35,7 @@ from .forward_search import (
     drain_forward_search_queue,
     serve_forward_search,
 )
+from .source_jump import SourceJumpServer
 
 FORWARD_SEARCH_PORT = CPB_FORWARD_SEARCH_PORT
 POLL_INTERVAL_SECONDS = 0.1
@@ -75,19 +77,24 @@ def confirm_restore_comment_filter(active_mode):
             "but you ran without the --no-comments flag.\n\n"
             "Note that you have not locally edited the filter relative to "
             "the library default.\n\n"
-            "Do you want to show comments, or continue with no comments?"
+            "Do you want to update the filter and comment styles to the "
+            "library versions and show comments, or keep no comments?"
         )
         default_choice = "restore"
+        update_label = "update filter and styles; show comments"
+        keep_label = "keep no comments"
     elif active_mode == "custom":
         message = (
-            "The current lua filter does not match the pyDiffTools library "
-            "default or the no-comments filter, but you ran without the "
-            "--no-comments flag.\n\n"
-            "Note that this looks like a locally edited filter.\n\n"
-            "Do you want to show comments using the library default, or "
-            "continue with no comments?"
+            "The current lua filter differs from the pyDiffTools library "
+            "filters, but you ran without the --no-comments flag. It may be "
+            "an older distributed filter or a local edit.\n\n"
+            "Do you want to update the filter and comment styles to the "
+            "library versions and show comments, or keep the current "
+            "filter and styles?"
         )
         default_choice = "keep"
+        update_label = "update filter and styles; show comments"
+        keep_label = "keep current filter"
     else:
         raise ValueError(
             "Comment filter restore prompt is only valid for custom or "
@@ -102,12 +109,8 @@ box = QMessageBox()
 box.setWindowTitle("pydifft cpb")
 box.setIcon(QMessageBox.Icon.Question)
 box.setText(sys.argv[1])
-keep_button = box.addButton(
-    "no comments", QMessageBox.ButtonRole.RejectRole
-)
-restore_button = box.addButton(
-    "show comments", QMessageBox.ButtonRole.AcceptRole
-)
+keep_button = box.addButton(sys.argv[3], QMessageBox.ButtonRole.RejectRole)
+restore_button = box.addButton(sys.argv[4], QMessageBox.ButtonRole.AcceptRole)
 if sys.argv[2] == "restore":
     box.setDefaultButton(restore_button)
 else:
@@ -119,7 +122,10 @@ sys.exit(1)
 """
     prepare_for_dialog()
     result = subprocess.run(
-        [sys.executable, "-c", prompt_script, message, default_choice],
+        [
+            sys.executable, "-c", prompt_script, message, default_choice,
+            keep_label, update_label,
+        ],
         capture_output=True,
         text=True,
     )
@@ -530,6 +536,10 @@ def run_pandoc(
                     shutil.copy2(
                         packaged_filters["default"], active_filter
                     )
+                    shutil.copy2(
+                        os.path.join(package_dir, "comments.css"),
+                        os.path.join(source_dir, "comments.css"),
+                    )
                     effective_filter_mode = "default"
                 else:
                     effective_filter_mode = active_mode
@@ -581,7 +591,10 @@ def run_pandoc(
         # }}}
         # Only copy the comment UI assets when comments should be rendered.
         if effective_filter_mode != "none":
-            for asset_name in ["comments.css", "comment_toggle.js"]:
+            for asset_name in [
+                "comments.css", "comments_author_colors.css",
+                "comment_toggle.js",
+            ]:
                 target_path = os.path.join(source_dir, asset_name)
                 if not os.path.exists(target_path):
                     shutil.copy2(
@@ -791,7 +804,7 @@ def run_pandoc(
     return
 
 
-def append_autorefresh(html_file):
+def append_autorefresh(html_file, source_jump_url=None):
     with open(html_file, "r", encoding="utf-8") as fp:
         all_data = fp.read()
     all_data = all_data.replace(
@@ -856,6 +869,29 @@ position
 </head>
     """,
     )
+    if source_jump_url:
+        all_data = re.sub(
+            r'\s*<script id="pydifft-source-jump-config">.*?</script>'
+            r'\s*<script id="pydifft-source-jump">.*?</script>',
+            "",
+            all_data,
+            flags=re.DOTALL,
+        )
+        source_jump_js = (
+            Path(__file__).parent / "flowchart" / "source_jump.js"
+        ).read_text(encoding="utf-8")
+        source_jump_scripts = (
+            '<script id="pydifft-source-jump-config">'
+            "window.pydifftSourceJumpEndpoint = "
+            + json.dumps(source_jump_url)
+            + ";</script>"
+            '<script id="pydifft-source-jump">'
+            + source_jump_js
+            + "</script>"
+        )
+        all_data = all_data.replace(
+            "</head>", source_jump_scripts + "</head>", 1
+        )
     with open(html_file, "w", encoding="utf-8") as fp:
         fp.write(all_data)
 
@@ -928,6 +964,7 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
     observer = None
     observer_started = False
     socket_thread_started = False
+    source_jump_server = None
 
     try:
         # Bind and serve before any build or browser work. This makes the fixed
@@ -957,14 +994,16 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
             comment_filter_session=comment_filter_session,
             wrapnumber=wrapnumber,
         )
-        append_autorefresh(html_file)
+        source_jump_server = SourceJumpServer(source_path)
+        source_jump_server.start()
+        append_autorefresh(html_file, source_jump_server.url)
 
         # Selenium is deliberately initialized once, after the first
         # successful build. Nothing in recovery constructs a browser.
         from selenium import webdriver
         from selenium.common.exceptions import WebDriverException
 
-        chrome = webdriver.Chrome()
+        chrome = launch_chrome(webdriver)
         observer = Observer()
         change_queue = queue.Queue()
         event_handler = Handler(filename, change_queue)
@@ -1102,7 +1141,9 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
                                 comment_filter_session=comment_filter_session,
                                 wrapnumber=wrapnumber,
                             )
-                            append_autorefresh(html_file)
+                            append_autorefresh(
+                                html_file, source_jump_server.url
+                            )
                         except Exception as exc:
                             exception_filename = getattr(exc, "filename", None)
                             missing_source = isinstance(
@@ -1144,7 +1185,7 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
                                     break
                         if chrome is None:
                             # {{{ reopen the preview a dialog closed
-                            chrome = webdriver.Chrome()
+                            chrome = launch_chrome(webdriver)
                             chrome.get(
                                 "file://" + os.path.abspath(html_file)
                             )
@@ -1156,6 +1197,8 @@ def cpb(filename, comments_to_margin=False, no_comments=False, wrapnumber=79):
     finally:
         stop_event.set()
         forward_search_server.close()
+        if source_jump_server is not None:
+            source_jump_server.stop()
         if observer_started:
             observer.stop()
             observer.join()

pydifftools-0.1.49/pydifftools/flowchart/source_jump.js

@@ -0,0 +1,158 @@
+// Add a small local-only source jump action to cpb and flowchart previews.
+(function () {
+  const endpoint = window.pydifftSourceJumpEndpoint;
+  if (!endpoint) {
+    return;
+  }
+  const excludedSourceElements =
+    '.math,.MathJax,mjx-container,.katex,math,' +
+    'script[type^="math/tex"],' +
+    'a[href*="#fig:"],a[href*="#fig-"],a[href*="#fig%3A"]';
+
+  const menu = document.createElement('div');
+  menu.id = 'pydifft-source-jump-menu';
+  menu.style.cssText =
+    'display:none;position:fixed;z-index:2147483647;background:#fff;' +
+    'border:1px solid #777;border-radius:3px;padding:3px;' +
+    'box-shadow:0 2px 6px #555;font:14px sans-serif;';
+  const button = document.createElement('button');
+  button.type = 'button';
+  button.textContent = 'Jump to source';
+  button.style.cssText =
+    'border:0;background:transparent;padding:6px 10px;cursor:pointer;' +
+    'font:inherit;';
+  menu.appendChild(button);
+  document.addEventListener('DOMContentLoaded', function () {
+    document.body.appendChild(menu);
+  });
+
+  let phrase = '';
+
+  function hideMenu() {
+    menu.style.display = 'none';
+  }
+
+  function showMenu(event, text) {
+    phrase = (text || '').replace(/\s+/g, ' ').trim();
+    if (!phrase) {
+      hideMenu();
+      return;
+    }
+    if (menu.parentNode !== document.body && document.body) {
+      document.body.appendChild(menu);
+    }
+    event.preventDefault();
+    menu.style.left = Math.min(event.clientX, window.innerWidth - 170) + 'px';
+    menu.style.top = Math.min(event.clientY, window.innerHeight - 42) + 'px';
+    menu.style.display = 'block';
+  }
+
+  function sentenceAtPoint(event) {
+    let range = null;
+    if (document.caretRangeFromPoint) {
+      range = document.caretRangeFromPoint(event.clientX, event.clientY);
+    } else if (document.caretPositionFromPoint) {
+      const position = document.caretPositionFromPoint(
+        event.clientX,
+        event.clientY
+      );
+      if (position) {
+        range = document.createRange();
+        range.setStart(position.offsetNode, position.offset);
+      }
+    }
+    const target = event.target.nodeType === Node.TEXT_NODE
+      ? event.target.parentElement
+      : event.target;
+    const targetElement = target && target.closest ? target : document.body;
+    if (targetElement.closest(excludedSourceElements)) {
+      return '';
+    }
+    const block = targetElement.closest(
+      'p,li,blockquote,h1,h2,h3,h4,h5,h6,dt,dd,td,th'
+    ) || targetElement;
+    // Drop rendered math and cross-reference links so the phrase resembles
+    // the searchable Markdown source, where mfs removes those constructs.
+    let text = '';
+    let clickedOffset = 0;
+    let found = false;
+    function collectText(node) {
+      if (node.nodeType === Node.TEXT_NODE) {
+        if (range && node === range.startContainer) {
+          clickedOffset = text.length + range.startOffset;
+          found = true;
+        }
+        text += node.textContent;
+        return;
+      }
+      if (
+        node.nodeType === Node.ELEMENT_NODE &&
+        node !== block &&
+        node.matches(excludedSourceElements)
+      ) {
+        text += ' ';
+        return;
+      }
+      node.childNodes.forEach(collectText);
+    }
+    collectText(block);
+    const rawText = text;
+    text = rawText.replace(/\s+/g, ' ').trim();
+    if (!text) {
+      return '';
+    }
+    if (!range || !found) {
+      return text;
+    }
+
+    // The raw DOM offset is used to find sentence bounds before whitespace is
+    // collapsed. Recompute its visible offset after normalization.
+    const normalizedPrefix = rawText
+      .slice(0, clickedOffset)
+      .replace(/\s+/g, ' ')
+      .replace(/^\s+/, '');
+    clickedOffset = normalizedPrefix.length;
+    const before = text.slice(0, clickedOffset);
+    const after = text.slice(clickedOffset);
+    const start = Math.max(
+      before.lastIndexOf('.'),
+      before.lastIndexOf('!'),
+      before.lastIndexOf('?')
+    ) + 1;
+    const endMatch = after.match(/[.!?](?:\s|$)/);
+    const end = endMatch ? clickedOffset + endMatch.index + 1 : text.length;
+    return text.slice(start, end).trim() || text;
+  }
+
+  button.addEventListener('click', function () {
+    hideMenu();
+    fetch(endpoint, {
+      method: 'POST',
+      mode: 'no-cors',
+      body: phrase,
+    }).catch(function () {
+      // The preview may be closing while the local editor request is sent.
+    });
+  });
+  document.addEventListener('click', hideMenu);
+  document.addEventListener('keydown', function (event) {
+    if (event.key === 'Escape') {
+      hideMenu();
+    }
+  });
+  document.addEventListener('contextmenu', function (event) {
+    showMenu(event, sentenceAtPoint(event));
+  });
+  document.addEventListener('pydifft-source-context', function (event) {
+    showMenu(
+      {
+        clientX: event.detail.clientX,
+        clientY: event.detail.clientY,
+        preventDefault: function () {
+          event.preventDefault();
+        },
+      },
+      event.detail.phrase
+    );
+  });
+})();