pyDiffTools 0.1.48__tar.gz → 0.1.49__tar.gz

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

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

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

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

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

@@ -78,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
@@ -88,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
@@ -106,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.48 → 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.48 → 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.48 → 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.48 → 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
@@ -802,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(
@@ -867,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)
 
@@ -939,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
@@ -968,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)
@@ -1113,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(
@@ -1155,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)
                             )
@@ -1167,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
+    );
+  });
+})();

{pydifftools-0.1.48 → pydifftools-0.1.49}/pydifftools/flowchart/watch_graph.py

@@ -1,5 +1,6 @@
 import subprocess
 import html
+import json
 import sys
 import time
 import shutil
@@ -26,7 +27,9 @@ from pydifftools.command_registry import register_command
 from pydifftools.browser_lifecycle import (
     browser_window_is_alive,
     close_browser_window,
+    launch_chrome,
 )
+from pydifftools.source_jump import SourceJumpServer
 from .comparison import PlanComparison
 from .graph import EmptyGraphYamlError, endpoint_projects, write_dot_from_yaml
 
@@ -58,7 +61,7 @@ def _reload_svg(driver, svg_src) -> None:
 
 def start_chrome(webdriver, options, preview_url):
     # Launch Chrome and display the local SVG preview page from the server.
-    driver = webdriver.Chrome(options=options)
+    driver = launch_chrome(webdriver, options=options)
     driver.get(preview_url)
     return driver
 
@@ -117,6 +120,8 @@ def _svg_set_stroke(shape, color, stroke_width=None):
             )
 
 
+# also used by: tests/flowchart/test_watch_reload.py, which verifies
+# query modes
 def _watch_view_state_from_params(params):
     # Treat each GET query as the full requested mode so navigation links can
     # reliably switch back to the overview without depending on prior state.
@@ -138,12 +143,15 @@ def _watch_view_state_from_params(params):
     return order_by_date, target_task, filter_completed
 
 
+# also used by: tests/flowchart/test_watch_reload.py, which verifies
+# preview HTML
 def _watch_html(
     svg_url,
     order_by_date,
     target_task=None,
     filter_completed=False,
     comparison=None,
+    source_jump_url=None,
 ):
     # {{{ Build links for the other preview views
     links = []
@@ -213,7 +221,14 @@ def _watch_html(
         "</p>"
         "<script src='/svg-pan-zoom.min.js'></script>"
         "<script src='/wgrph_view.js'></script>"
-        "</body></html>"
+        + (
+            "<script>window.pydifftSourceJumpEndpoint = "
+            + json.dumps(source_jump_url)
+            + ";</script><script src='/source_jump.js'></script>"
+            if source_jump_url
+            else ""
+        )
+        + "</body></html>"
     )
 
 
@@ -322,6 +337,17 @@ def build_graph(
     ET.register_namespace("xlink", xlink_ns)
     link_marker = "__WGRPH_TASK_LINK__:"
     for group in svg_root.iter(f"{namespace}g"):
+        if group.attrib.get("class") == "node":
+            title = next(
+                (
+                    child.text.strip()
+                    for child in group
+                    if child.tag == f"{namespace}title" and child.text
+                ),
+                None,
+            )
+            if title:
+                group.set("data-source-name", title)
         if "class" not in group.attrib or group.attrib["class"] != "node":
             continue
         for index, child in enumerate(list(group)):
@@ -712,6 +738,7 @@ class FlowchartPreviewServer:
         self.host = host
         self.httpd = None
         self.server_thread = None
+        self.source_jump_server = None
         self.base_url = None
         self.svg_url = None
 
@@ -736,6 +763,13 @@ class FlowchartPreviewServer:
                         "text/javascript; charset=utf-8",
                     )
                     return
+                if parsed.path == "/source_jump.js":
+                    _send_preview_response(
+                        self,
+                        (Path(__file__).parent / parsed.path[1:]).read_bytes(),
+                        "text/javascript; charset=utf-8",
+                    )
+                    return
 
                 if parsed.path != "/" and parsed.path != "/index.html":
                     self.send_error(404)
@@ -786,6 +820,7 @@ class FlowchartPreviewServer:
                     event_handler.state["target_task"],
                     event_handler.state["filter_completed"],
                     event_handler.comparison,
+                    self_outer.source_jump_server.url,
                 )
                 body_bytes = body.encode("utf-8")
                 _send_preview_response(
@@ -797,7 +832,17 @@ class FlowchartPreviewServer:
             def log_message(self, format, *args):
                 return
 
-        self.httpd = http.server.ThreadingHTTPServer((self.host, 0), Handler)
+        self.source_jump_server = SourceJumpServer(event_handler.yaml_file)
+        self.source_jump_server.start()
+        self_outer = self
+        try:
+            self.httpd = http.server.ThreadingHTTPServer(
+                (self.host, 0), Handler
+            )
+        except Exception:
+            self.source_jump_server.stop()
+            self.source_jump_server = None
+            raise
         self.httpd.daemon_threads = True
         port = self.httpd.server_address[1]
         self.base_url = f"http://{self.host}:{port}/"
@@ -825,8 +870,13 @@ class FlowchartPreviewServer:
             self.httpd.server_close()
         if self.server_thread is not None:
             self.server_thread.join(timeout=1.0)
+        if self.source_jump_server is not None:
+            self.source_jump_server.stop()
+            self.source_jump_server = None
 
 
+# also used by: pydifftools.command_registry, which dispatches registered
+# commands
 @register_command(
     "Watch a flowchart YAML file, rebuild DOT/SVG output, and open the"
     " preview",

{pydifftools-0.1.48 → pydifftools-0.1.49}/pydifftools/flowchart/wgrph_view.js

@@ -120,6 +120,29 @@
       },
       true
     );
+    svgDoc.addEventListener(
+      'contextmenu',
+      function (evt) {
+        const node = evt.target.closest
+          ? evt.target.closest('g.node[data-source-name]')
+          : null;
+        if (!node) {
+          return;
+        }
+        evt.preventDefault();
+        const bounds = embed.getBoundingClientRect();
+        window.parent.document.dispatchEvent(
+          new window.parent.CustomEvent('pydifft-source-context', {
+            detail: {
+              phrase: node.getAttribute('data-source-name'),
+              clientX: bounds.left + evt.clientX,
+              clientY: bounds.top + evt.clientY,
+            },
+          })
+        );
+      },
+      true
+    );
     // }}}
 
     // {{{ Zoom-to-rectangle mode

pydifftools-0.1.49/pydifftools/source_jump.py

@@ -0,0 +1,128 @@
+"""Local browser-to-editor requests for source jumps."""
+
+import http.server
+import re
+import secrets
+import subprocess
+import threading
+import urllib.parse
+
+
+MAX_SOURCE_JUMP_BYTES = 8192
+SOURCE_JUMP_WORDS = re.compile(r"[\w]+", re.UNICODE)
+
+
+def _run_gvim_shell_command(*arguments):
+    """Run the user's interactive Bash ``gvim`` alias with safe arguments."""
+
+    subprocess.run(
+        ["bash", "-ic", 'gvim "$@"', "pydifft", *arguments],
+        check=True,
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )
+
+
+# also used by: SourceJumpServer's HTTP request handler and
+# tests/test_source_jump.py
+def jump_to_source(source_path, phrase):
+    """Open *source_path* through the user's gvim alias and run ``SW!``."""
+
+    words = [word.lower() for word in SOURCE_JUMP_WORDS.findall(phrase)]
+    if not words:
+        raise ValueError(
+            "The source-search phrase contains no searchable words"
+        )
+    if len(words) > 120:
+        words = words[:120]
+
+    _run_gvim_shell_command(str(source_path))
+    remote_keys = "<C-\\><C-N>:SW! " + " ".join(words) + "<CR>"
+    _run_gvim_shell_command(
+        "--servername", "GVIM", "--remote-send", remote_keys
+    )
+
+
+class SourceJumpServer:
+    """An ephemeral loopback HTTP endpoint scoped to one preview session."""
+
+    def __init__(self, source_path):
+        self.source_path = str(source_path)
+        self.token = secrets.token_urlsafe(24)
+        self.httpd = None
+        self.thread = None
+        self.url = None
+
+    def start(self):
+        source_path = self.source_path
+        token = self.token
+
+        class Handler(http.server.BaseHTTPRequestHandler):
+            def do_POST(self):
+                parsed = urllib.parse.urlparse(self.path)
+                query = urllib.parse.parse_qs(parsed.query)
+                if (
+                    parsed.path != "/jump"
+                    or query.get("token", [None])[-1] != token
+                ):
+                    self.send_error(404)
+                    return
+                try:
+                    content_length = int(
+                        self.headers.get("Content-Length", "0")
+                    )
+                except ValueError:
+                    self.send_error(400)
+                    return
+                if (
+                    content_length <= 0
+                    or content_length > MAX_SOURCE_JUMP_BYTES
+                ):
+                    self.send_error(413)
+                    return
+                try:
+                    phrase = self.rfile.read(content_length).decode("utf-8")
+                except UnicodeDecodeError:
+                    self.send_error(400)
+                    return
+                try:
+                    jump_to_source(source_path, phrase)
+                except (
+                    OSError,
+                    subprocess.SubprocessError,
+                    ValueError,
+                ) as exc:
+                    print(f"pydifft source jump failed: {exc}", flush=True)
+                    self.send_error(500)
+                    return
+                self.send_response(204)
+                self.send_header("Cache-Control", "no-store")
+                self.end_headers()
+
+            def log_message(self, format, *args):
+                return
+
+        self.httpd = http.server.ThreadingHTTPServer(
+            ("127.0.0.1", 0), Handler
+        )
+        self.httpd.daemon_threads = True
+        host, port = self.httpd.server_address
+        self.url = (
+            f"http://{host}:{port}/jump?token="
+            + urllib.parse.quote(self.token, safe="")
+        )
+        self.thread = threading.Thread(
+            target=self.httpd.serve_forever,
+            daemon=True,
+        )
+        self.thread.start()
+        return self.url
+
+    def stop(self):
+        if self.httpd is not None:
+            self.httpd.shutdown()
+            self.httpd.server_close()
+            self.httpd = None
+        if self.thread is not None:
+            self.thread.join(timeout=1.0)
+            self.thread = None