rolfedh-doc-utils 0.1.8__py3-none-any.whl → 0.1.10__py3-none-any.whl

replace_link_attributes.py

@@ -0,0 +1,186 @@
+#!/usr/bin/env python3
+"""
+replace-link-attributes - Replace AsciiDoc attributes within link URLs with their actual values.
+
+This script finds and replaces attribute references (like {attribute-name}) that appear
+in the URL portion of AsciiDoc link macros (link: and xref:) with their resolved values
+from attributes.adoc. Link text is preserved unchanged.
+"""
+
+import argparse
+import sys
+from pathlib import Path
+from typing import Optional
+
+from doc_utils.replace_link_attributes import (
+    find_attributes_files,
+    load_attributes,
+    resolve_nested_attributes,
+    replace_link_attributes_in_file,
+    find_adoc_files
+)
+
+
+def prompt_for_attributes_file(attributes_files: list[Path]) -> Optional[Path]:
+    """Prompt user to select or specify attributes file."""
+    if not attributes_files:
+        print("No attributes.adoc files found in the repository.")
+        response = input("Enter the path to your attributes.adoc file (or 'q' to quit): ").strip()
+        if response.lower() == 'q':
+            return None
+        path = Path(response)
+        if path.exists() and path.is_file():
+            return path
+        else:
+            print(f"Error: File not found: {response}")
+            return None
+
+    if len(attributes_files) == 1:
+        file_path = attributes_files[0]
+        response = input(f"Found attributes file: {file_path}\nUse this file? (y/n/q): ").strip().lower()
+        if response == 'y':
+            return file_path
+        elif response == 'q':
+            return None
+        else:
+            response = input("Enter the path to your attributes.adoc file (or 'q' to quit): ").strip()
+            if response.lower() == 'q':
+                return None
+            path = Path(response)
+            if path.exists() and path.is_file():
+                return path
+            else:
+                print(f"Error: File not found: {response}")
+                return None
+
+    # Multiple files found
+    print("\nFound multiple attributes.adoc files:")
+    for i, file_path in enumerate(attributes_files, 1):
+        print(f"  {i}. {file_path}")
+    print(f"  {len(attributes_files) + 1}. Enter custom path")
+
+    while True:
+        response = input(f"\nSelect option (1-{len(attributes_files) + 1}) or 'q' to quit: ").strip()
+        if response.lower() == 'q':
+            return None
+
+        try:
+            choice = int(response)
+            if 1 <= choice <= len(attributes_files):
+                return attributes_files[choice - 1]
+            elif choice == len(attributes_files) + 1:
+                response = input("Enter the path to your attributes.adoc file: ").strip()
+                path = Path(response)
+                if path.exists() and path.is_file():
+                    return path
+                else:
+                    print(f"Error: File not found: {response}")
+            else:
+                print(f"Invalid choice. Please enter a number between 1 and {len(attributes_files) + 1}")
+        except ValueError:
+            print("Invalid input. Please enter a number.")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description='Replace AsciiDoc attributes within link macros with their actual values.'
+    )
+    parser.add_argument(
+        '--dry-run', '-n',
+        action='store_true',
+        help='Show what would be changed without making actual modifications'
+    )
+    parser.add_argument(
+        '--path', '-p',
+        type=str,
+        default='.',
+        help='Repository path to search (default: current directory)'
+    )
+    parser.add_argument(
+        '--attributes-file', '-a',
+        type=str,
+        help='Path to attributes.adoc file (skips interactive selection)'
+    )
+
+    args = parser.parse_args()
+
+    # Determine repository root
+    repo_root = Path(args.path).resolve()
+
+    if not repo_root.exists() or not repo_root.is_dir():
+        print(f"Error: Directory not found: {repo_root}")
+        sys.exit(1)
+
+    print(f"{'DRY RUN MODE - ' if args.dry_run else ''}Searching in: {repo_root}")
+
+    # Find or get attributes file
+    if args.attributes_file:
+        attributes_file = Path(args.attributes_file)
+        if not attributes_file.exists():
+            print(f"Error: Specified attributes file not found: {attributes_file}")
+            sys.exit(1)
+    else:
+        print("\nSearching for attributes.adoc files...")
+        attributes_files = find_attributes_files(repo_root)
+        attributes_file = prompt_for_attributes_file(attributes_files)
+
+        if not attributes_file:
+            print("Operation cancelled.")
+            sys.exit(0)
+
+    print(f"\nLoading attributes from: {attributes_file}")
+    attributes = load_attributes(attributes_file)
+
+    if not attributes:
+        print("No attributes found in the file.")
+        sys.exit(1)
+
+    print(f"Found {len(attributes)} attributes")
+
+    # Resolve nested references
+    print("Resolving nested attribute references...")
+    attributes = resolve_nested_attributes(attributes)
+
+    # Find all AsciiDoc files
+    print(f"\nSearching for *.adoc files in {repo_root}")
+    adoc_files = find_adoc_files(repo_root)
+
+    # Exclude the attributes file itself
+    adoc_files = [f for f in adoc_files if f != attributes_file]
+
+    print(f"Found {len(adoc_files)} AsciiDoc files to process")
+
+    if args.dry_run:
+        print("\n*** DRY RUN MODE - No files will be modified ***\n")
+
+    # Process each file
+    total_replacements = 0
+    files_modified = 0
+
+    for file_path in adoc_files:
+        replacements = replace_link_attributes_in_file(file_path, attributes, args.dry_run)
+        if replacements > 0:
+            rel_path = file_path.relative_to(repo_root)
+            prefix = "[DRY RUN] " if args.dry_run else ""
+            print(f"  {prefix}Modified {rel_path}: {replacements} replacements")
+            total_replacements += replacements
+            files_modified += 1
+
+    # Summary
+    print(f"\nSummary:")
+    if args.dry_run:
+        print(f"  Would modify {files_modified} files")
+        print(f"  Would make {total_replacements} replacements")
+        print("\nRun without --dry-run to apply changes.")
+    else:
+        print(f"  Total files modified: {files_modified}")
+        print(f"  Total replacements: {total_replacements}")
+
+        if total_replacements == 0:
+            print("\nNo attribute references found within link macros.")
+        else:
+            print("\nReplacement complete!")
+
+
+if __name__ == '__main__':
+    main()

{rolfedh_doc_utils-0.1.8.dist-info → rolfedh_doc_utils-0.1.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.8
+Version: 0.1.10
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License
@@ -79,6 +79,8 @@ pip install -e .
 
 | Tool | Description | Usage |
 |------|-------------|-------|
+| **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
+| **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
 | **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
 | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
 | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |

rolfedh_doc_utils-0.1.10.dist-info/RECORD

@@ -0,0 +1,23 @@
+archive_unused_files.py,sha256=KMC5a1WL3rZ5owoVnncvfpT1YeMKbVXq9giHvadDgbM,1936
+archive_unused_images.py,sha256=PG2o3haovYckgfhoPhl6KRG_a9czyZuqlLkzkupKTCY,1526
+check_scannability.py,sha256=gcM-vFXKHGP_yFBz7-V5xbXWhIMmtMzBYIGwP9CFbzI,5140
+extract_link_attributes.py,sha256=utDM1FE-VEr649HhIH5BreXvxDNLnnAJO9dB5rs5f9Q,2535
+find_unused_attributes.py,sha256=fk-K32eoCVHxoj7RiBNgSmX1arBLuwYfdSAOMc-wIx0,1677
+format_asciidoc_spacing.py,sha256=ROp-cdMs2_hk8H4z5ljT0iDgGtsiECZ8TVjjcN_oOWE,3874
+replace_link_attributes.py,sha256=vg_aufw7dKXvh_epCKRNq_hEBMU_9crZ_JyJPpxSMNk,6454
+doc_utils/__init__.py,sha256=qqZR3lohzkP63soymrEZPBGzzk6-nFzi4_tSffjmu_0,74
+doc_utils/extract_link_attributes.py,sha256=qBpJuTXNrhy15klpqC0iELZzcSLztEzMSmhEnKyQZT0,15574
+doc_utils/file_utils.py,sha256=fpTh3xx759sF8sNocdn_arsP3KAv8XA6cTQTAVIZiZg,4247
+doc_utils/format_asciidoc_spacing.py,sha256=XnVJekaj39aDzjV3xFKl58flM41AaJzejxNYJIIAMz0,10139
+doc_utils/replace_link_attributes.py,sha256=kBiePbxjQn3O2rzqmYY8Mqy_mJgZ6yw048vSZ5SSB5E,6587
+doc_utils/scannability.py,sha256=XwlmHqDs69p_V36X7DLjPTy0DUoLszSGqYjJ9wE-3hg,982
+doc_utils/topic_map_parser.py,sha256=tKcIO1m9r2K6dvPRGue58zqMr0O2zKU1gnZMzEE3U6o,4571
+doc_utils/unused_adoc.py,sha256=2cbqcYr1os2EhETUU928BlPRlsZVSdI00qaMhqjSIqQ,5263
+doc_utils/unused_attributes.py,sha256=HBgmHelqearfWl3TTC2bZGiJytjLADIgiGQUNKqXXPg,1847
+doc_utils/unused_images.py,sha256=nqn36Bbrmon2KlGlcaruNjJJvTQ8_9H0WU9GvCW7rW8,1456
+rolfedh_doc_utils-0.1.10.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
+rolfedh_doc_utils-0.1.10.dist-info/METADATA,sha256=Kk1Ur-SbE2XIP55NJ7Y5oVB-KNScnlADwmZyFSthTXo,7180
+rolfedh_doc_utils-0.1.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rolfedh_doc_utils-0.1.10.dist-info/entry_points.txt,sha256=aQtQRDwcdDN-VLBCnQBfmoozzQiaCUZ9dqcLLv8fCkM,381
+rolfedh_doc_utils-0.1.10.dist-info/top_level.txt,sha256=ILTc2mA4sHdDp0GvKC8JXO1I_DBP7vvF5hn-PFkMcL8,167
+rolfedh_doc_utils-0.1.10.dist-info/RECORD,,

{rolfedh_doc_utils-0.1.8.dist-info → rolfedh_doc_utils-0.1.10.dist-info}/entry_points.txt

@@ -2,5 +2,7 @@
 archive-unused-files = archive_unused_files:main
 archive-unused-images = archive_unused_images:main
 check-scannability = check_scannability:main
+extract-link-attributes = extract_link_attributes:main
 find-unused-attributes = find_unused_attributes:main
 format-asciidoc-spacing = format_asciidoc_spacing:main
+replace-link-attributes = replace_link_attributes:main

{rolfedh_doc_utils-0.1.8.dist-info → rolfedh_doc_utils-0.1.10.dist-info}/top_level.txt

@@ -2,5 +2,7 @@ archive_unused_files
 archive_unused_images
 check_scannability
 doc_utils
+extract_link_attributes
 find_unused_attributes
 format_asciidoc_spacing
+replace_link_attributes

rolfedh_doc_utils-0.1.8.dist-info/RECORD

@@ -1,18 +0,0 @@
-archive_unused_files.py,sha256=KMC5a1WL3rZ5owoVnncvfpT1YeMKbVXq9giHvadDgbM,1936
-archive_unused_images.py,sha256=PG2o3haovYckgfhoPhl6KRG_a9czyZuqlLkzkupKTCY,1526
-check_scannability.py,sha256=gcM-vFXKHGP_yFBz7-V5xbXWhIMmtMzBYIGwP9CFbzI,5140
-find_unused_attributes.py,sha256=fk-K32eoCVHxoj7RiBNgSmX1arBLuwYfdSAOMc-wIx0,1677
-format_asciidoc_spacing.py,sha256=Jy_V8c03KGRPJxu4uPdDuMsFg-Q-4AGD9BdkGnApUu8,13241
-doc_utils/__init__.py,sha256=qqZR3lohzkP63soymrEZPBGzzk6-nFzi4_tSffjmu_0,74
-doc_utils/file_utils.py,sha256=fpTh3xx759sF8sNocdn_arsP3KAv8XA6cTQTAVIZiZg,4247
-doc_utils/scannability.py,sha256=XwlmHqDs69p_V36X7DLjPTy0DUoLszSGqYjJ9wE-3hg,982
-doc_utils/topic_map_parser.py,sha256=tKcIO1m9r2K6dvPRGue58zqMr0O2zKU1gnZMzEE3U6o,4571
-doc_utils/unused_adoc.py,sha256=2cbqcYr1os2EhETUU928BlPRlsZVSdI00qaMhqjSIqQ,5263
-doc_utils/unused_attributes.py,sha256=HBgmHelqearfWl3TTC2bZGiJytjLADIgiGQUNKqXXPg,1847
-doc_utils/unused_images.py,sha256=nqn36Bbrmon2KlGlcaruNjJJvTQ8_9H0WU9GvCW7rW8,1456
-rolfedh_doc_utils-0.1.8.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
-rolfedh_doc_utils-0.1.8.dist-info/METADATA,sha256=KrjqTRhF_B26ZNt37SZXReMcV4-ztpy1aWHJepYxMDE,6891
-rolfedh_doc_utils-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rolfedh_doc_utils-0.1.8.dist-info/entry_points.txt,sha256=dA-u4qlxKcewUAOFgaeW1NUIrkhsVknuwFuGTn1-84w,271
-rolfedh_doc_utils-0.1.8.dist-info/top_level.txt,sha256=WrYqTa4wbjRPMUl2hgJBfP734XsXLkhbnzUublx8S0s,119
-rolfedh_doc_utils-0.1.8.dist-info/RECORD,,