rolfedh-doc-utils 0.1.3__tar.gz → 0.1.4__tar.gz

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.3
+Version: 0.1.4
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/doc_utils/topic_map_parser.py

@@ -22,8 +22,16 @@ def detect_repo_type(base_path='.'):
         if yml_files:
             return 'topic_map'
     
-    # Check for master.adoc files
-    master_files = glob.glob(os.path.join(base_path, '**/master.adoc'), recursive=True)
+    # Check for master.adoc files using os.walk to avoid symlink issues
+    master_files = []
+    for root, dirs, files in os.walk(base_path):
+        # Skip symbolic link directories to prevent infinite recursion
+        dirs[:] = [d for d in dirs if not os.path.islink(os.path.join(root, d))]
+        
+        # Check for master.adoc in this directory
+        if 'master.adoc' in files:
+            master_files.append(os.path.join(root, 'master.adoc'))
+            
     if master_files:
         return 'master_adoc'
     

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/doc_utils/unused_adoc.py

@@ -6,6 +6,9 @@ from .file_utils import collect_files, write_manifest_and_archive
 from .topic_map_parser import detect_repo_type, get_all_topic_map_references
 
 def find_unused_adoc(scan_dirs, archive_dir, archive=False, exclude_dirs=None, exclude_files=None):
+    # Print safety warning
+    print("\n⚠️  SAFETY: Work in a git branch! Run without --archive first to preview.\n")
+    
     # Detect repository type
     repo_type = detect_repo_type()
     print(f"Detected repository type: {repo_type}")

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/doc_utils/unused_images.py

@@ -7,6 +7,9 @@ from .file_utils import collect_files, write_manifest_and_archive
 IMAGE_EXTENSIONS = {'.png', '.jpg', '.jpeg', '.gif', '.svg'}
 
 def find_unused_images(scan_dirs, archive_dir, archive=False, exclude_dirs=None, exclude_files=None):
+    # Print safety warning
+    print("\n⚠️  SAFETY: Work in a git branch! Run without --archive first to preview.\n")
+    
     image_files = collect_files(scan_dirs, IMAGE_EXTENSIONS, exclude_dirs, exclude_files)
     adoc_files = collect_files(['.'], {'.adoc'}, exclude_dirs, exclude_files)
     referenced_images = set()

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rolfedh-doc-utils"
-version = "0.1.3"
+version = "0.1.4"
 description = "CLI tools for AsciiDoc documentation projects"
 readme = "README.md"
 requires-python = ">=3.8"

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/rolfedh_doc_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.3
+Version: 0.1.4
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License

{rolfedh_doc_utils-0.1.3 → rolfedh_doc_utils-0.1.4}/rolfedh_doc_utils.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ archive_unused_images.py
 check_scannability.py
 find_unused_attributes.py
 pyproject.toml
+setup.py
 doc_utils/__init__.py
 doc_utils/file_utils.py
 doc_utils/scannability.py
@@ -27,5 +28,6 @@ tests/test_fixture_archive_unused_files.py
 tests/test_fixture_archive_unused_images.py
 tests/test_fixture_check_scannability.py
 tests/test_parse_exclude_list.py
+tests/test_symlink_handling.py
 tests/test_topic_map_parser.py
 tests/test_unused_attributes.py

rolfedh_doc_utils-0.1.4/setup.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+"""
+Setup script for doc-utils package.
+This file is only needed if we want to customize the installation process.
+"""
+
+from setuptools import setup
+from setuptools.command.install import install
+from setuptools.command.develop import develop
+from setuptools.command.egg_info import egg_info
+
+def custom_post_install():
+    """Display safety message after installation."""
+    print("\n" + "="*60)
+    print("✅ doc-utils installed successfully!")
+    print("\n⚠️  IMPORTANT: Safety First")
+    print("   • Work in a git branch (never main/master)")
+    print("   • Run without --archive first to preview") 
+    print("   • Review changes with git diff")
+    print("="*60 + "\n")
+
+class CustomInstallCommand(install):
+    """Customized setuptools install command."""
+    def run(self):
+        install.run(self)
+        custom_post_install()
+
+class CustomDevelopCommand(develop):
+    """Customized setuptools develop command."""
+    def run(self):
+        develop.run(self)
+        custom_post_install()
+
+class CustomEggInfoCommand(egg_info):
+    """Customized setuptools egg_info command."""
+    def run(self):
+        egg_info.run(self)
+
+setup(
+    cmdclass={
+        'install': CustomInstallCommand,
+        'develop': CustomDevelopCommand,
+        'egg_info': CustomEggInfoCommand,
+    },
+)

rolfedh_doc_utils-0.1.4/tests/test_symlink_handling.py

@@ -0,0 +1,91 @@
+"""Test that topic_map_parser handles symbolic links correctly without freezing."""
+
+import os
+import tempfile
+import pytest
+from doc_utils.topic_map_parser import detect_repo_type
+
+
+def test_detect_repo_type_with_circular_symlinks(tmp_path):
+    """Test that detect_repo_type doesn't freeze with circular symbolic links."""
+    
+    # Create a directory structure with circular symlinks
+    modules_dir = tmp_path / "modules"
+    modules_dir.mkdir()
+    
+    # Create a master.adoc file in modules
+    (modules_dir / "master.adoc").write_text("= Test Doc\n")
+    
+    # Create a circular symlink: modules/modules -> ../modules
+    circular_link = modules_dir / "modules"
+    try:
+        os.symlink("../../modules", str(circular_link))
+    except OSError:
+        pytest.skip("Cannot create symbolic links on this system")
+    
+    # This should not freeze - it should skip the symlink
+    repo_type = detect_repo_type(str(tmp_path))
+    assert repo_type == "master_adoc"
+
+
+def test_detect_repo_type_with_nested_circular_symlinks(tmp_path):
+    """Test detection with nested directories containing circular symlinks."""
+    
+    # Create nested structure
+    (tmp_path / "assemblies").mkdir()
+    modules_dir = tmp_path / "modules"
+    modules_dir.mkdir()
+    
+    # Create master.adoc
+    (tmp_path / "master.adoc").write_text("= Main Doc\n")
+    
+    # Create archive directory with circular symlinks (similar to real case)
+    archive_dir = tmp_path / ".archive" / "archived-content" / "modules"
+    archive_dir.mkdir(parents=True)
+    
+    try:
+        # Create circular symlink in archive
+        os.symlink("../../modules", str(archive_dir / "modules"))
+    except OSError:
+        pytest.skip("Cannot create symbolic links on this system")
+    
+    # Should detect master_adoc without freezing
+    repo_type = detect_repo_type(str(tmp_path))
+    assert repo_type == "master_adoc"
+
+
+def test_detect_repo_type_skips_symlink_directories(tmp_path):
+    """Test that symlinked directories are skipped during traversal."""
+    
+    # Create main directories
+    real_dir = tmp_path / "real_modules"
+    real_dir.mkdir()
+    (real_dir / "master.adoc").write_text("= Real Master\n")
+    
+    # Create a symlink to real_dir
+    linked_dir = tmp_path / "linked_modules"
+    try:
+        os.symlink(str(real_dir), str(linked_dir))
+    except OSError:
+        pytest.skip("Cannot create symbolic links on this system")
+    
+    # The function should find the master.adoc in real_dir but not traverse linked_dir
+    repo_type = detect_repo_type(str(tmp_path))
+    assert repo_type == "master_adoc"
+    
+    # Test that symlinked directories are not traversed
+    only_symlink_path = tmp_path / "only_symlink_test"
+    only_symlink_path.mkdir()
+    
+    # Create a directory outside that contains master.adoc
+    external_dir = tmp_path / "external"
+    external_dir.mkdir()
+    (external_dir / "master.adoc").write_text("= External Master\n")
+    
+    # Create only a symlink to it inside our test directory
+    symlinked_dir = only_symlink_path / "linked_dir"
+    os.symlink(str(external_dir), str(symlinked_dir))
+    
+    # Should not find master.adoc since it's only accessible via symlink
+    repo_type = detect_repo_type(str(only_symlink_path))
+    assert repo_type == "unknown"