Graph restructure by ilijaljubicic · Pull Request #37 · reqvire-org/reqvire

ilijaljubicic · 2025-09-19T22:20:09Z

Updated to use graph registry to support more advanced functionalities.

Lint deprecated in favor of format which is flushing from graph registry:

it is deterministic and does all in single pass

- Add release-patch, release-minor, release-major commands to Makefile - Automate branch creation, version update, commit, and PR creation - Include GitHub CLI integration for automatic PR creation - Update RELEASE.md to focus on automated workflow - Simplify release process from 5+ commands to 3 commands - Maintain backward compatibility with existing manual commands Streamlines release process while maintaining safety and review workflow.

This commit introduces a comprehensive marker-based system to distinguish auto-generated diagrams from user-created diagrams, enabling reliable content preservation during diagram operations. Key Changes: - Add REQVIRE-AUTOGENERATED-DIAGRAM marker to all auto-generated diagrams - Implement marker-based filtering in parser and utility functions - Update diagram removal logic to preserve user-created diagrams - Fix section content being null instead of empty string in model summaries - Add comprehensive system requirement for diagram marker specification - Update verification tests to validate marker functionality - Enhance test coverage for mixed diagram scenarios Technical Implementation: - diagrams.rs: Embed marker in generated diagrams - utils.rs: Shared utility functions for diagram filtering - parser.rs: Content filtering during parsing with page/section support - reports.rs: Enhanced model summaries with proper content display - Element registry extended with page and section content tracking Verification Updates: - Enhanced diagram generation tests to verify marker presence - Updated diagram removal tests for marker-based identification - Added bidirectional traceability between requirements and verifications - Comprehensive test coverage for auto-generated vs custom diagram handling This ensures reliable diagram management while protecting user content from accidental removal during automated operations.

The diagrams now include the new 'Auto-Generated Diagram Identification' requirement and its verification relationships, providing complete visual traceability for the marker-based diagram management feature.

- Add Pages and Sections tracking in ElementRegistry and GraphRegistry - Include page content (frontmatter) and section content in flushed markdown - Fix duplicate header issue by detecting existing headers in page content - Add comprehensive tests for page/section content inclusion - Enhance model summaries with page and section content display - Improve content filtering to preserve user-created diagrams

Major architectural changes: - Replace ElementRegistry with GraphRegistry as central component - Implement two-pass validation: element collection then relation validation - Move validation logic into GraphRegistry methods - Add ValidationError variant to ReqvireError enum - Make validation automatic for all commands that need model data - Remove redundant validate command from CLI Core improvements: - Move ElementNode and RelationNode types to GraphRegistry - Implement metadata-based circular dependency detection - Fix relation type validation and element type compatibility - Update all modules to use GraphRegistry instead of ElementRegistry - Add proper error handling and validation reporting Test fixes: - Fix all validation errors in test specifications - Create proper implementation files for satisfy relations - Add missing parent relations with correct element types - Fix circular dependencies and incompatible element types - Ensure test-diagram-generation passes with validation enabled File changes: - Delete core/src/element_registry.rs (replaced by GraphRegistry) - Update CLI to handle validation errors for all commands - Fix compilation errors across all modules and tests - Add new test implementation files for satisfy relations

Matrix generation fixes: - Rewrite get_requirements_by_root() to group by actual root requirements instead of file paths - Identify true root elements (without parent relations) - Build hierarchical groups under each root requirement - Use requirement names as section headers instead of file paths - Add recursive descendant collection with proper lifetimes Test fixes: - Fix test-remove-diagrams validation errors by adding user-requirement metadata - Move custom mermaid diagrams to section level to avoid metadata parsing conflicts - Ensure proper element structure in test specifications Results: - test-matrix-generation now passes (shows "## Root Requirement Alpha" sections) - test-remove-diagrams now passes (validation errors resolved)

Update subdirectory processing requirements and tests to properly validate parent directory references: - Update Subdirectory Processing Option requirement to specify that parent directory references should be reported as missing relation target errors - Update Subdirectory Processing Verification to test for missing relation target errors when parent directories are referenced - Enhance test-subdirectory-functionality to validate that model-summary fails with missing relation target error for parent directory references - Test properly handles both validation failure and normal subdirectory functionality by replacing invalid references with local ones for subsequent tests - Add proper metadata to test specification files for validation consistency The existing validation logic already correctly handles parent directory references by reporting them as missing relation targets when referenced files are not found in the subdirectory scope. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>

…itecture Restructure the invalid relations test to properly validate the two-pass validation strategy: **Pass 1 Test (Parsing/Format Errors):** - Create pass1-errors/ test data with duplicate elements, invalid metadata format, invalid relation format, unsupported relation types, and duplicate subsections - These errors prevent Pass 2 from executing, validating the two-pass architecture **Pass 2 Test (Relation Validation Errors):** - Create pass2-errors/ test data with missing relation targets, incompatible element types, and circular dependencies - These errors are only detected when Pass 1 completes successfully **Updated Test Implementation:** - Run two separate test scenarios that independently validate each pass - Remove success echo statements for cleaner output - Verify that Pass 1 errors prevent Pass 2 execution - Verify that Pass 2 catches relation validation issues **Updated Verification Requirements:** - Clarify that Invalid Relations Test verifies the Two-Pass Validation Strategy - Add verification relations for both Two-Pass Validation Strategy and Validation Error Handling requirements - Update acceptance criteria to explicitly separate Pass 1 and Pass 2 validation concerns **Fix test-html-export:** - Add missing user-requirement metadata to elements that were triggering missing parent relation validation errors

- Fix test-diagram-filtering circular dependency by removing trace relation - Create backup file without circular dependency for proper test operation - Fix test-coverage-report by adding missing files (test-satisfied.sh, analysis-test.md) - Add backup directory cleanup to all tests that create backup folders - Remove existing backup directories to clean up test environment All diagram and coverage tests now pass with proper cleanup.

…and ensuring deterministic ordering - Update GraphRegistry::change_impact_with_relation() to include InternalPath targets (like satisfiedBy files) - Replace HashMap with BTreeMap for deterministic alphabetical ordering of relations - Fixes test-change-impact-detection which was failing due to: 1. Missing satisfiedBy relations (InternalPath targets were excluded) 2. Non-deterministic HashMap iteration causing flaky test results The change impact analysis now correctly shows all IMPACT_PROPAGATION_RELATIONS including satisfiedBy relations to implementation files, with consistent output ordering.

…fications - Update CLAUDE.md and README.md to use 'format' command instead of 'lint' - Remove obsolete 'validate' command references (validation is now automatic) - Rename "Lint Command" → "Format Command" in SystemRequirements - Rename "Linting Command" → "Formatting Command" in UserRequirements - Rename "Model Linting" → "Model Formatting" in UserRequirements - Update LintingTests.md to FormattingTests terminology - Update CLI interface structure in requirements The 'format' command better describes the operation: normalizing and standardizing requirements files rather than just checking for issues.

…ture - Update Two-Pass Validation Strategy to include automatic semantic normalization in Pass 1 - Specify that non-link identifiers and absolute paths are normalized during parsing - Remove incorrect reference to graph-based approach from Format Command - Clarify that normalization happens during element collection, not formatting This establishes that semantic normalization (identifiers, paths) occurs during model loading while stylistic formatting remains part of the format command.

BREAKING CHANGE: Semantic normalizations now happen during model loading - Add automatic identifier normalization in parse_target() function: - Convert non-link identifiers to proper markdown links with display text - Normalize absolute paths to relative paths (basic implementation) - Normalization occurs during Pass 1 of two-pass validation architecture - Fix broken references from linting→formatting terminology updates - Update relation parsing to apply normalizations during element collection This implements the semantic normalization requirements specified in the Two-Pass Validation Strategy. Relations are now automatically normalized when the model is loaded, ensuring consistent internal representation. Next: Implement graph-based format command to flush normalized model back to files.

- Add test-advanced-format with explicit string matching for 100% expectation coverage - Include reqvire.yaml config to ensure user-requirement metadata handling - Test covers dry-run, actual formatting, idempotent behavior, and diff output validation - Fix user-requirement metadata preservation in format command implementation - Replace old lint test with comprehensive format requirements verification - Update subdirectory test to use format command instead of deprecated lint - Remove obsolete LintingTests.md verification document

…bering - Add context lines (3 before/after changes) for better diff readability - Implement sequential line numbering that reflects final file positions - Add visual separation between file groups in diff output - Support consecutive separator normalization and relation indentation fixes - Add line numbering validation test case to catch regressions - Update requirements and verification docs with new formatting behaviors - Remove unused element_to_markdown function - Add test cases for consecutive separators and relation indentation

ilijaljubicic · 2025-09-19T22:20:20Z

/reqvire impact

github-actions · 2025-09-19T22:21:16Z

Change Impact Report

Removed Elements

New Elements

Formatting Command
- derive -> Format Command (new)
  - satisfiedBy -> cli.rs
Formatting Output
- derive -> Git-Style Diff Output for Linting
  - satisfiedBy -> mod.rs
Integrated Validation
- satisfiedBy -> cli.rs
Model Formatting
- derive -> Parallel Linting Processing
  - satisfiedBy -> mod.rs
- contain -> Format Consistency Enforcement ⚠️
  - derive -> Excess Whitespace Linting Implementation ⚠️
    - satisfiedBy -> whitespace.rs
  - derive -> Incosistent Newlines Linting Implementation
    - satisfiedBy -> newlines.rs
  - derive -> Missing Separators Linting Implementation
    - satisfiedBy -> separators.rs
  - derive -> Reserved Subsections Linting Implementation
    - satisfiedBy -> indentation.rs
  - verifiedBy -> Format Command Requirements Verification (new)
    - satisfiedBy -> test.sh
- contain -> Replace Absolute Links with Relative Links

Changed Elements

File Pattern Exclusion for Linting
- satisfiedBy -> utils.rs
- contain -> Excluded File Relation Validation
  - satisfiedBy -> parser.rs
  - verifiedBy -> Unstructured Documents Test
    - satisfiedBy -> test.sh
Subdirectory Processing Option
- satisfiedBy -> cli.rs
- verifiedBy -> Subdirectory Processing Verification ⚠️
  - satisfiedBy -> test.sh
CLI Interface Structure
- satisfiedBy -> cli.rs
- contain -> CLI Change Impact Report Command
  - derive -> Change Impact Command Line Interface
    - verifiedBy -> Change Impact Detection Test
  - derive -> CLI Git Commit Hash Flag
    - verifiedBy -> CLI Git Commit Hash Flag Test
- contain -> HTML Export
  - refinedBy -> Export Related System Elements
Provide Validation Reports
- derive -> Validation Report Generator ⚠️
  - satisfiedBy -> model.rs
  - derive -> Validation Error Handling (new)
    - satisfiedBy -> error.rs
Model Structure and Summaries
- derive -> Model Summary Report Generator ⚠️
  - satisfiedBy -> reports.rs
  - derive -> CLI Summary Report Command
    - satisfiedBy -> cli.rs
    - derive -> CLI Coverage Report Command
    - derive -> Display Name-Regex Option in Help
      - verifiedBy -> Model Summary Tests ⚠️
        
        satisfiedBy -> test.sh
JSON Output Format Test
Ignoring Unstructured Documents
- satisfiedBy -> config.rs
- derive -> Excluded File Relation Validation
  - verifiedBy -> Unstructured Documents Test
    - satisfiedBy -> test.sh
Invalid Relations Test
- satisfiedBy -> test.sh
Provide Reports
- refinedBy -> Model Reports ⚠️
  - contain -> Change Impact Analysis
    - refinedBy -> Requirements Change Propagation
      - derive -> Change Impact Detection Algorithm
        
        satisfiedBy -> change_impact.rs
        
        verifiedBy -> Change Impact Detection Test
      - derive -> Change Impact Visualization
    - verifiedBy -> Change Impact Analysis Verification
Validate Internal Consistency
- derive -> Internal Consistency Validator
  - satisfiedBy -> model.rs
  - satisfiedBy -> parser.rs
- derive -> Two-Pass Validation Strategy (new)
Traceability Matrix
- derive -> CLI Traces Command
  - satisfiedBy -> cli.rs
  - derive -> CLI Traces SVG Flag
    - verifiedBy -> SVG Matrix Output Test
      - satisfiedBy -> test.sh
  - verifiedBy -> CLI Traces Flag Test
- derive -> Markdown Matrix Formatter
  - satisfiedBy -> matrix_generator.rs
  - verifiedBy -> JSON Matrix Output Test
- derive -> Traceability Matrix Builder Implementation
  - verifiedBy -> Hierarchical Matrix Format Test
  - verifiedBy -> Traceability Matrix Generation Test
- derive -> Export Traceability Matrix
- refinedBy -> Include Verification Checkboxes
- verifiedBy -> Traceability Matrix Verification
Validating Structures
- refinedBy -> Enhanced Validation Error Reporting
  - derive -> Detailed Error Handling and Logging ⚠️
    - satisfiedBy -> error.rs
    - derive -> Validation Error Handling (new)
      - satisfiedBy -> model.rs
- refinedBy -> Validate Filesystem Structure
Requirements Processing
- satisfiedBy -> model.rs
- satisfiedBy -> parser.rs
- derive -> Structured Markdown Files Search and Detection
  - verifiedBy -> Requirements Files Search and Detection Test
    - satisfiedBy -> test.sh
- derive -> GraphRegistry as Primary Registry (new)
  - satisfiedBy -> graph_registry.rs
Diagram Generation
- satisfiedBy -> diagrams.rs
- refinedBy -> Auto-Generated Diagram Identification (new)
  - satisfiedBy -> parser.rs
  - satisfiedBy -> utils.rs
  - verifiedBy -> Diagram Generation Test ⚠️
  - verifiedBy -> Remove Generated Diagrams Verification ⚠️
    - satisfiedBy -> test.sh
- refinedBy -> Interactive Mermaid Diagram Node Behavior

Invalidated Verifications

- Remove premature leading slash stripping from normalize_link_path function - Add unified path resolution in resolve_path_to_absolute function - Preserve absolute path indicators through parsing pipeline - Fix path resolution for identifiers starting with '/' to be relative to git root - Remove unused normalize_link_path function and simplify parse_target - Fix test expectations for fragment-only identifier normalization - Remove unused old_line_num variable assignments

- Add fallback lookup by fragment identifier when full target_id not found - Display actual element names instead of identifiers in markdown links - Satisfy specification requirement for human-readable relation links - Fix cross-file relation display names in element_to_markdown_with_context

Removed unused variable b_node and associated comment from test function to eliminate compiler warning.

ilijaljubicic and others added 18 commits September 18, 2025 20:57

docs: Update auto-generated diagrams with new requirement traceability

803506d

The diagrams now include the new 'Auto-Generated Diagram Identification' requirement and its verification relationships, providing complete visual traceability for the marker-based diagram management feature.

Fixed test for invalid relations to account for 2 passes flow.

1cfd162

New formating command which replaces old linting.

3e591c4

updated diagrams and index

16ca31c

ilijaljubicic added 4 commits September 21, 2025 23:03

fix: Remove unused variable warning in graph registry tests

969ffb4

Removed unused variable b_node and associated comment from test function to eliminate compiler warning.

Updates diagrams

94df9db

ilijaljubicic merged commit 4887954 into main Sep 21, 2025
3 checks passed

github-actions bot locked and limited conversation to collaborators Sep 21, 2025

ilijaljubicic deleted the graph-restructure branch September 21, 2025 21:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Graph restructure#37

Graph restructure#37
ilijaljubicic merged 22 commits intomainfrom
graph-restructure

ilijaljubicic commented Sep 19, 2025

Uh oh!

ilijaljubicic commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

ilijaljubicic commented Sep 19, 2025

Uh oh!

ilijaljubicic commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Change Impact Report

Removed Elements

New Elements

Changed Elements

Invalidated Verifications

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant