pyDiffTools 0.1.22__tar.gz → 0.1.23__tar.gz

{pydifftools-0.1.22/pyDiffTools.egg-info → pydifftools-0.1.23}/PKG-INFO

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

{pydifftools-0.1.22 → pydifftools-0.1.23/pyDiffTools.egg-info}/PKG-INFO

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

{pydifftools-0.1.22 → pydifftools-0.1.23}/pydifftools/comment_toggle.js

@@ -3,9 +3,9 @@
   const SELECTOR_BUBBLE =
     "div.comment-left, div.comment-right, " +
     "span.comment-pin > span.comment-left, span.comment-pin > span.comment-right, " +
-    "div.comment-overlay.comment-left, div.comment-overlay.comment-right";
+    ".comment-overlay.comment-left, .comment-overlay.comment-right";
 
-  const SELECTOR_OVERLAY = "div.comment-overlay[data-comment-id]";
+  const SELECTOR_OVERLAY = ".comment-overlay[data-comment-id]";
   const SELECTOR_ANCHOR = 'span.comment-pin-block[data-comment-id]';
   const SELECTOR_INLINE =
     "span.comment-pin > span.comment-right, span.comment-pin > span.comment-left";
@@ -34,6 +34,7 @@
   }
 
   function positionComments() {
+    const useMobileFlow = window.matchMedia("(max-width: 900px)").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.
@@ -97,6 +98,15 @@
       );
       if (!anchor) return;
 
+      if (useMobileFlow && ov.classList.contains("comment-margin-left")) {
+        // Let CSS place margin-mode comments in-flow in narrow layouts.
+        ov.style.position = "";
+        ov.style.visibility = "";
+        ov.style.left = "";
+        ov.style.top = "";
+        return;
+      }
+
       // Ensure measurable
       ov.style.position = "absolute";
       ov.style.visibility = "hidden";
@@ -115,9 +125,15 @@
       // Anchor point in document coords
       const ax = a.left + window.scrollX;
       const ay = a.top + window.scrollY;
+      const bodyRect = document.body.getBoundingClientRect();
+      const bodyLeft = bodyRect.left + window.scrollX;
 
       let left;
-      if (ov.classList.contains("comment-left")) {
+      if (ov.classList.contains("comment-margin-left")) {
+        // Margin-mode comments should live entirely in the left margin like
+        // floated .comment-left bubbles, not just to the left of the anchor.
+        left = bodyLeft - gap - ow;
+      } else if (ov.classList.contains("comment-left")) {
         left = ax - gap - ow;
       } else {
         // default right; add configurable shift so the arrow points back to

{pydifftools-0.1.22 → pydifftools-0.1.23}/pydifftools/comments.css

@@ -189,6 +189,8 @@ div.csl-indent {
 /* Shared visual style */
 div.comment-right,
 div.comment-left,
+.comment-overlay.comment-right,
+.comment-overlay.comment-left,
 span.comment-pin > span.comment-right,
 span.comment-pin > span.comment-left {
   box-sizing: border-box;
@@ -326,14 +328,29 @@ span.comment-pin > span.comment-left::after {
     height: auto;
   }
 
+  .comment-overlay.comment-margin-left {
+    position: static !important;
+    float: none !important;
+    clear: none !important;
+    width: 100% !important;
+    max-width: 100% !important;
+    display: block !important;
+    box-sizing: border-box;
+    margin: 0.4em 0 !important;
+  }
+
+  .comment-inline-break-marker {
+    display: inline !important;
+  }
+
   span.comment-pin > span.comment-right::before,
   span.comment-pin > span.comment-right::after,
   span.comment-pin > span.comment-left::before,
   span.comment-pin > span.comment-left::after,
-  div.comment-overlay.comment-right::before,
-  div.comment-overlay.comment-right::after,
-  div.comment-overlay.comment-left::before,
-  div.comment-overlay.comment-left::after {
+  .comment-overlay.comment-right::before,
+  .comment-overlay.comment-right::after,
+  .comment-overlay.comment-left::before,
+  .comment-overlay.comment-left::after {
     display: none;
   }
 }
@@ -342,7 +359,7 @@ span.comment-pin > span.comment-left::after {
 }
 /* --- Overlay block comments emitted by Lua (contain ul/paras/etc) --- */
 
-div.comment-overlay {
+.comment-overlay {
   position: absolute;
   z-index: 100;          /* above text */
   margin: 0 !important;  /* do not participate in normal layout */
@@ -351,13 +368,23 @@ div.comment-overlay {
 }
 
 /* Ensure overlay uses the same visual bubble styling */
-div.comment-overlay.comment-right,
-div.comment-overlay.comment-left {
+.comment-overlay.comment-right,
+.comment-overlay.comment-left {
   width: 22rem;          /* match your current bubble width */
 }
 
+/* Margin-mode inline comments should use the narrower left-margin bubble size. */
+.comment-overlay.comment-inline-margin,
+.comment-overlay.comment-margin-left {
+  width: 11rem;
+}
+
+.comment-inline-break-marker {
+  display: none;
+}
+
 /* Pointer triangles for overlay block comments */
-div.comment-overlay.comment-right::before {
+.comment-overlay.comment-right::before {
   content: "";
   position: absolute;
   left: calc(-1 * var(--comment-left-arrow-width));
@@ -366,7 +393,7 @@ div.comment-overlay.comment-right::before {
   border-style: solid;
   border-color: transparent #5aa0ff transparent transparent;
 }
-div.comment-overlay.comment-right::after {
+.comment-overlay.comment-right::after {
   content: "";
   position: absolute;
   left: calc(-1 * var(--comment-left-arrow-width) + 1px);
@@ -375,7 +402,7 @@ div.comment-overlay.comment-right::after {
   border-style: solid;
   border-color: transparent #eaf3ff transparent transparent;
 }
-div.comment-overlay.comment-left::before {
+.comment-overlay.comment-left::before {
   content: "";
   position: absolute;
   right: calc(-1 * var(--comment-arrow-width));
@@ -384,7 +411,7 @@ div.comment-overlay.comment-left::before {
   border-style: solid;
   border-color: transparent transparent transparent #5aa0ff;
 }
-div.comment-overlay.comment-left::after {
+.comment-overlay.comment-left::after {
   content: "";
   position: absolute;
   right: calc(-1 * var(--comment-arrow-width) + 1px);

{pydifftools-0.1.22 → pydifftools-0.1.23}/pydifftools/continuous.py

@@ -16,6 +16,7 @@ from .browser_lifecycle import browser_window_is_alive, close_browser_window
 
 FORWARD_SEARCH_HOST = "127.0.0.1"
 FORWARD_SEARCH_PORT = 51235
+MARGIN_COMMENTS_FILTER_MARKER = "-- PYDIFFTOOLS_SPECIAL_MARGIN_COMMENTS_FILTER"
 
 
 def forward_search_listener(stop_event, search_queue):
@@ -44,7 +45,54 @@ def forward_search_listener(stop_event, search_queue):
     server.close()
 
 
-def run_pandoc(filename, html_file):
+def _file_contains_text(path, text):
+    if not os.path.exists(path):
+        return False
+    with open(path, encoding="utf-8") as fp:
+        return text in fp.read()
+
+
+def _is_margin_comments_filter(path):
+    return _file_contains_text(path, MARGIN_COMMENTS_FILTER_MARKER)
+
+
+def _set_comment_filter_mode(source_dir, comments_to_margin):
+    package_dir = os.path.dirname(os.path.abspath(__file__))
+    active_filter = os.path.join(source_dir, "comment_tags.lua")
+    inactive_filter = os.path.join(source_dir, "comment_tags.lua.inactive")
+    packaged_default = os.path.join(package_dir, "comment_tags.lua")
+    packaged_margin = os.path.join(package_dir, "comment_tags_margin.lua")
+
+    active_is_margin = _is_margin_comments_filter(active_filter)
+    inactive_is_margin = _is_margin_comments_filter(inactive_filter)
+
+    if comments_to_margin:
+        if active_is_margin:
+            return
+        if os.path.exists(active_filter):
+            os.replace(active_filter, inactive_filter)
+        shutil.copy2(packaged_margin, active_filter)
+        return
+
+    if active_is_margin:
+        if os.path.exists(inactive_filter) and not inactive_is_margin:
+            temp_filter = active_filter + ".swap_tmp"
+            os.replace(active_filter, temp_filter)
+            os.replace(inactive_filter, active_filter)
+            os.replace(temp_filter, inactive_filter)
+        else:
+            os.replace(active_filter, inactive_filter)
+            shutil.copy2(packaged_default, active_filter)
+        return
+
+    if not os.path.exists(active_filter):
+        if os.path.exists(inactive_filter) and not inactive_is_margin:
+            os.replace(inactive_filter, active_filter)
+        else:
+            shutil.copy2(packaged_default, active_filter)
+
+
+def run_pandoc(filename, html_file, comments_to_margin=False):
     # Pandoc and pandoc-crossref must be installed for HTML rendering.
     if shutil.which("pandoc") is None:
         raise RuntimeError(
@@ -76,17 +124,14 @@ def run_pandoc(filename, html_file):
         markdown_text = fp.read()
     if "<comment>" in markdown_text:
         package_dir = os.path.dirname(os.path.abspath(__file__))
-        for asset_name in [
-            "comments.css",
-            "comment_tags.lua",
-            "comment_toggle.js",
-        ]:
+        for asset_name in ["comments.css", "comment_toggle.js"]:
             target_path = os.path.join(source_dir, asset_name)
             if not os.path.exists(target_path):
                 shutil.copy2(
                     os.path.join(package_dir, asset_name),
                     target_path,
                 )
+        _set_comment_filter_mode(source_dir, comments_to_margin)
     localfiles = {}
     for k in ["csl", "bib"]:
         localfiles[k] = [
@@ -189,9 +234,10 @@ def run_pandoc(filename, html_file):
 
 
 class Handler(FileSystemEventHandler):
-    def __init__(self, filename, observer):
+    def __init__(self, filename, observer, comments_to_margin=False):
         self.observer = observer
         self.filename = filename
+        self.comments_to_margin = comments_to_margin
         self.html_file = filename.rsplit(".", 1)[0] + ".html"
         self.init_firefox()
 
@@ -201,7 +247,11 @@ class Handler(FileSystemEventHandler):
         from selenium import webdriver
 
         self.firefox = webdriver.Chrome()
-        run_pandoc(self.filename, self.html_file)
+        run_pandoc(
+            self.filename,
+            self.html_file,
+            comments_to_margin=self.comments_to_margin,
+        )
         if not os.path.exists(self.html_file):
             print("html doesn't exist")
         self.append_autorefresh()
@@ -213,7 +263,11 @@ class Handler(FileSystemEventHandler):
         if os.path.normpath(
             os.path.abspath(event.src_path)
         ) == os.path.normpath(os.path.abspath(self.filename)):
-            run_pandoc(self.filename, self.html_file)
+            run_pandoc(
+                self.filename,
+                self.html_file,
+                comments_to_margin=self.comments_to_margin,
+            )
             self.append_autorefresh()
             try:
                 self.firefox.refresh()
@@ -238,8 +292,8 @@ class Handler(FileSystemEventHandler):
             "div.comment-left, div.comment-right, " +
             "span.comment-pin > span.comment-left, " +
             "span.comment-pin > span.comment-right, " +
-            "div.comment-overlay.comment-left, " +
-            "div.comment-overlay.comment-right";
+            ".comment-overlay.comment-left, " +
+            ".comment-overlay.comment-right";
 
         // When the page is about to be unloaded, save the current scroll\
 position
@@ -337,11 +391,19 @@ position
 
 @register_command(
     "continuous pandoc build.  Like latexmk, but for markdown!",
-    help={"filename": "Markdown or TeX file to watch for changes"},
+    help={
+        "filename": "Markdown or TeX file to watch for changes",
+        "comments_to_margin": (
+            "Temporarily replace comment_tags.lua with the special margin "
+            "comments filter for printing."
+        ),
+    },
 )
-def cpb(filename):
+def cpb(filename, comments_to_margin=False):
     observer = Observer()
-    event_handler = Handler(filename, observer)
+    event_handler = Handler(
+        filename, observer, comments_to_margin=comments_to_margin
+    )
     search_queue = queue.Queue()
     stop_event = threading.Event()
     socket_thread = threading.Thread(

{pydifftools-0.1.22 → pydifftools-0.1.23}/pyproject.toml

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

{pydifftools-0.1.22 → pydifftools-0.1.23}/tests/test_continuous_shutdown.py

@@ -35,9 +35,10 @@ class FakeThread:
 
 
 class FakeHandler:
-    def __init__(self, filename, observer):
+    def __init__(self, filename, observer, comments_to_margin=False, **kwargs):
         self.filename = filename
         self.observer = observer
+        self.comments_to_margin = comments_to_margin
         self.firefox = object()
 
     def forward_search(self, _search_text):