coulomb/markitect-main
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
markitect-main/markitect/schema_naming.py

36 lines
953 B
Python
Raw Normal View History

feat: implement schema filename validation (Phase 1 complete) Implements filename convention enforcement for schema files as part of the schema-of-schemas implementation. All schemas must now follow the naming pattern: {domain}-schema-v{major}.{minor}.md ## Phase 1 Deliverables ### Schema Naming Module **File:** `markitect/schema_naming.py` (380 lines) **Functions:** - `validate_schema_filename()` - Validate filename against pattern - `suggest_schema_filename()` - Generate valid filename from domain/version - `extract_schema_metadata()` - Extract domain and version from filename - `get_validation_errors()` - Detailed error messages for invalid filenames - `is_valid_schema_filename()` - Simple boolean validation - `format_validation_message()` - User-friendly error formatting **Features:** - Regex-based pattern matching - Automatic normalization (spaces → hyphens, lowercase) - Detailed error reporting - Domain validation (must start with letter) - Version validation (major.minor format) ### Comprehensive Test Suite **File:** `tests/test_schema_naming.py` (500+ lines, 50 tests) **Test Coverage:** - ✅ Valid filename variations (simple, hyphenated, with numbers) - ✅ Invalid filenames (wrong extension, missing components, wrong case) - ✅ Filename suggestion with normalization - ✅ Metadata extraction - ✅ Error message generation - ✅ Edge cases (long names, many hyphens, large versions) - ✅ Pattern regex validation **Results:** 50/50 tests passing (100%) ### Specification Document **File:** `roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md` **Contents:** - Formal specification of naming convention - Regular expression pattern with explanation - Valid and invalid examples - Version numbering guidelines - Domain naming best practices - Normalization rules - Migration strategy from legacy naming - Implementation guide ## Naming Convention ### Format ``` {domain}-schema-v{major}.{minor}.md ``` ### Examples ``` ✓ manpage-schema-v1.0.md ✓ api-documentation-schema-v1.0.md ✓ terminology-schema-v1.0.md ✓ arc42-schema-v2.1.md ✗ manpage.json (wrong extension) ✗ ManPage-schema-v1.0.md (uppercase) ✗ manpage-v1.0.md (missing 'schema') ✗ manpage-schema-v1.md (missing minor version) ``` ### Components - **domain**: Lowercase, hyphen-separated, starts with letter - **schema**: Literal keyword - **version**: v{major}.{minor} (SemVer simplified) - **extension**: .md (markdown) ## Implementation Highlights ### Automatic Normalization ```python suggest_schema_filename("API Documentation", "2.1") # → "api-documentation-schema-v2.1.md" suggest_schema_filename("My_Custom Type", "1.0") # → "my-custom-type-schema-v1.0.md" ``` ### Detailed Error Reporting ```python format_validation_message("invalid.json") # → Detailed error list + suggested fix ``` ### Metadata Extraction ```python extract_schema_metadata("manpage-schema-v1.0.md") # → {'domain': 'manpage', 'version': '1.0', 'major': 1, 'minor': 0} ``` ## Migration Plan Current schemas will be renamed: ``` Old → New ──────────────────────────────────────────────────────── terminology-schema.json → terminology-schema-v1.0.md api-documentation → api-documentation-schema-v1.0.md enhanced-manpage → manpage-schema-v2.0.md markdown-manpage → DELETE (duplicate) markdown-manpage-schema.json → DELETE (duplicate) ``` ## Phase 1 Status: ✅ COMPLETE ### Completed - [x] Schema naming module implementation - [x] Comprehensive test suite (50 tests, 100% passing) - [x] Specification document - [x] TODO.md updated ### Next: Phase 2 - [ ] Update CLI schema-ingest with validation - [ ] Implement markdown schema loader - [ ] Parse frontmatter and JSON code blocks - [ ] Update SchemaValidator for .md support ## Testing ```bash # Run tests pytest tests/test_schema_naming.py -v # → 50 passed in 0.48s # Test interactively python -c " from markitect.schema_naming import validate_schema_filename print(validate_schema_filename('manpage-schema-v1.0.md')) " # → (True, {'domain': 'manpage', 'version': '1.0', ...}) ``` ## Files Changed - markitect/schema_naming.py (NEW, 380 lines) - tests/test_schema_naming.py (NEW, 500+ lines) - roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md (NEW) - TODO.md (updated progress tracking) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 23:51:29 +01:00
"""
feat(spaces): implement Phase 0-1 of Information Space Service Phase 0 - Project Organization: - Create docs/PROJECT_STRUCTURE.md documenting codebase layout - Create markitect/core/ with parser, serializer, document_manager, workspace - Create markitect/schema/ consolidating 6 schema_*.py modules - Create markitect/storage/ with database module - Maintain backward compatibility via re-exports from original locations - Add docs/roadmap/information-space-service/ with README and WORKPLAN Phase 1 - Foundation (Weeks 1-3): - Week 1: Core domain models (InformationSpace, SpaceDocument, SpaceConfig, SpaceMetadata, SpaceVariable, TransclusionReference, SpaceStatus) - Week 2: Repository layer with interfaces (ISpaceRepository, IDocumentAssociationRepository, IVariableRepository, IReferenceRepository) and SQLite implementations with foreign key cascade deletes - Week 3: SpaceService orchestration layer with full CRUD, document, variable, and reference tracking operations Test coverage: 124 tests (25 model + 63 repository + 36 integration) Capabilities delivered: - CAP-001: InformationSpace entity with lifecycle management - CAP-002: SpaceRepository CRUD with SQLite backing - CAP-003: Document-Space associations with path-based organization - CAP-004: Space metadata and configuration schemas - CAP-005: Database schema with migrations Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-08 02:02:46 +01:00
Schema Naming - Backward Compatibility Module.
feat: implement schema filename validation (Phase 1 complete) Implements filename convention enforcement for schema files as part of the schema-of-schemas implementation. All schemas must now follow the naming pattern: {domain}-schema-v{major}.{minor}.md ## Phase 1 Deliverables ### Schema Naming Module **File:** `markitect/schema_naming.py` (380 lines) **Functions:** - `validate_schema_filename()` - Validate filename against pattern - `suggest_schema_filename()` - Generate valid filename from domain/version - `extract_schema_metadata()` - Extract domain and version from filename - `get_validation_errors()` - Detailed error messages for invalid filenames - `is_valid_schema_filename()` - Simple boolean validation - `format_validation_message()` - User-friendly error formatting **Features:** - Regex-based pattern matching - Automatic normalization (spaces → hyphens, lowercase) - Detailed error reporting - Domain validation (must start with letter) - Version validation (major.minor format) ### Comprehensive Test Suite **File:** `tests/test_schema_naming.py` (500+ lines, 50 tests) **Test Coverage:** - ✅ Valid filename variations (simple, hyphenated, with numbers) - ✅ Invalid filenames (wrong extension, missing components, wrong case) - ✅ Filename suggestion with normalization - ✅ Metadata extraction - ✅ Error message generation - ✅ Edge cases (long names, many hyphens, large versions) - ✅ Pattern regex validation **Results:** 50/50 tests passing (100%) ### Specification Document **File:** `roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md` **Contents:** - Formal specification of naming convention - Regular expression pattern with explanation - Valid and invalid examples - Version numbering guidelines - Domain naming best practices - Normalization rules - Migration strategy from legacy naming - Implementation guide ## Naming Convention ### Format ``` {domain}-schema-v{major}.{minor}.md ``` ### Examples ``` ✓ manpage-schema-v1.0.md ✓ api-documentation-schema-v1.0.md ✓ terminology-schema-v1.0.md ✓ arc42-schema-v2.1.md ✗ manpage.json (wrong extension) ✗ ManPage-schema-v1.0.md (uppercase) ✗ manpage-v1.0.md (missing 'schema') ✗ manpage-schema-v1.md (missing minor version) ``` ### Components - **domain**: Lowercase, hyphen-separated, starts with letter - **schema**: Literal keyword - **version**: v{major}.{minor} (SemVer simplified) - **extension**: .md (markdown) ## Implementation Highlights ### Automatic Normalization ```python suggest_schema_filename("API Documentation", "2.1") # → "api-documentation-schema-v2.1.md" suggest_schema_filename("My_Custom Type", "1.0") # → "my-custom-type-schema-v1.0.md" ``` ### Detailed Error Reporting ```python format_validation_message("invalid.json") # → Detailed error list + suggested fix ``` ### Metadata Extraction ```python extract_schema_metadata("manpage-schema-v1.0.md") # → {'domain': 'manpage', 'version': '1.0', 'major': 1, 'minor': 0} ``` ## Migration Plan Current schemas will be renamed: ``` Old → New ──────────────────────────────────────────────────────── terminology-schema.json → terminology-schema-v1.0.md api-documentation → api-documentation-schema-v1.0.md enhanced-manpage → manpage-schema-v2.0.md markdown-manpage → DELETE (duplicate) markdown-manpage-schema.json → DELETE (duplicate) ``` ## Phase 1 Status: ✅ COMPLETE ### Completed - [x] Schema naming module implementation - [x] Comprehensive test suite (50 tests, 100% passing) - [x] Specification document - [x] TODO.md updated ### Next: Phase 2 - [ ] Update CLI schema-ingest with validation - [ ] Implement markdown schema loader - [ ] Parse frontmatter and JSON code blocks - [ ] Update SchemaValidator for .md support ## Testing ```bash # Run tests pytest tests/test_schema_naming.py -v # → 50 passed in 0.48s # Test interactively python -c " from markitect.schema_naming import validate_schema_filename print(validate_schema_filename('manpage-schema-v1.0.md')) " # → (True, {'domain': 'manpage', 'version': '1.0', ...}) ``` ## Files Changed - markitect/schema_naming.py (NEW, 380 lines) - tests/test_schema_naming.py (NEW, 500+ lines) - roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md (NEW) - TODO.md (updated progress tracking) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 23:51:29 +01:00
feat(spaces): implement Phase 0-1 of Information Space Service Phase 0 - Project Organization: - Create docs/PROJECT_STRUCTURE.md documenting codebase layout - Create markitect/core/ with parser, serializer, document_manager, workspace - Create markitect/schema/ consolidating 6 schema_*.py modules - Create markitect/storage/ with database module - Maintain backward compatibility via re-exports from original locations - Add docs/roadmap/information-space-service/ with README and WORKPLAN Phase 1 - Foundation (Weeks 1-3): - Week 1: Core domain models (InformationSpace, SpaceDocument, SpaceConfig, SpaceMetadata, SpaceVariable, TransclusionReference, SpaceStatus) - Week 2: Repository layer with interfaces (ISpaceRepository, IDocumentAssociationRepository, IVariableRepository, IReferenceRepository) and SQLite implementations with foreign key cascade deletes - Week 3: SpaceService orchestration layer with full CRUD, document, variable, and reference tracking operations Test coverage: 124 tests (25 model + 63 repository + 36 integration) Capabilities delivered: - CAP-001: InformationSpace entity with lifecycle management - CAP-002: SpaceRepository CRUD with SQLite backing - CAP-003: Document-Space associations with path-based organization - CAP-004: Space metadata and configuration schemas - CAP-005: Database schema with migrations Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-08 02:02:46 +01:00
This module re-exports from markitect.schema.naming for backward compatibility.
New code should import from markitect.schema.naming directly.
feat: implement schema filename validation (Phase 1 complete) Implements filename convention enforcement for schema files as part of the schema-of-schemas implementation. All schemas must now follow the naming pattern: {domain}-schema-v{major}.{minor}.md ## Phase 1 Deliverables ### Schema Naming Module **File:** `markitect/schema_naming.py` (380 lines) **Functions:** - `validate_schema_filename()` - Validate filename against pattern - `suggest_schema_filename()` - Generate valid filename from domain/version - `extract_schema_metadata()` - Extract domain and version from filename - `get_validation_errors()` - Detailed error messages for invalid filenames - `is_valid_schema_filename()` - Simple boolean validation - `format_validation_message()` - User-friendly error formatting **Features:** - Regex-based pattern matching - Automatic normalization (spaces → hyphens, lowercase) - Detailed error reporting - Domain validation (must start with letter) - Version validation (major.minor format) ### Comprehensive Test Suite **File:** `tests/test_schema_naming.py` (500+ lines, 50 tests) **Test Coverage:** - ✅ Valid filename variations (simple, hyphenated, with numbers) - ✅ Invalid filenames (wrong extension, missing components, wrong case) - ✅ Filename suggestion with normalization - ✅ Metadata extraction - ✅ Error message generation - ✅ Edge cases (long names, many hyphens, large versions) - ✅ Pattern regex validation **Results:** 50/50 tests passing (100%) ### Specification Document **File:** `roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md` **Contents:** - Formal specification of naming convention - Regular expression pattern with explanation - Valid and invalid examples - Version numbering guidelines - Domain naming best practices - Normalization rules - Migration strategy from legacy naming - Implementation guide ## Naming Convention ### Format ``` {domain}-schema-v{major}.{minor}.md ``` ### Examples ``` ✓ manpage-schema-v1.0.md ✓ api-documentation-schema-v1.0.md ✓ terminology-schema-v1.0.md ✓ arc42-schema-v2.1.md ✗ manpage.json (wrong extension) ✗ ManPage-schema-v1.0.md (uppercase) ✗ manpage-v1.0.md (missing 'schema') ✗ manpage-schema-v1.md (missing minor version) ``` ### Components - **domain**: Lowercase, hyphen-separated, starts with letter - **schema**: Literal keyword - **version**: v{major}.{minor} (SemVer simplified) - **extension**: .md (markdown) ## Implementation Highlights ### Automatic Normalization ```python suggest_schema_filename("API Documentation", "2.1") # → "api-documentation-schema-v2.1.md" suggest_schema_filename("My_Custom Type", "1.0") # → "my-custom-type-schema-v1.0.md" ``` ### Detailed Error Reporting ```python format_validation_message("invalid.json") # → Detailed error list + suggested fix ``` ### Metadata Extraction ```python extract_schema_metadata("manpage-schema-v1.0.md") # → {'domain': 'manpage', 'version': '1.0', 'major': 1, 'minor': 0} ``` ## Migration Plan Current schemas will be renamed: ``` Old → New ──────────────────────────────────────────────────────── terminology-schema.json → terminology-schema-v1.0.md api-documentation → api-documentation-schema-v1.0.md enhanced-manpage → manpage-schema-v2.0.md markdown-manpage → DELETE (duplicate) markdown-manpage-schema.json → DELETE (duplicate) ``` ## Phase 1 Status: ✅ COMPLETE ### Completed - [x] Schema naming module implementation - [x] Comprehensive test suite (50 tests, 100% passing) - [x] Specification document - [x] TODO.md updated ### Next: Phase 2 - [ ] Update CLI schema-ingest with validation - [ ] Implement markdown schema loader - [ ] Parse frontmatter and JSON code blocks - [ ] Update SchemaValidator for .md support ## Testing ```bash # Run tests pytest tests/test_schema_naming.py -v # → 50 passed in 0.48s # Test interactively python -c " from markitect.schema_naming import validate_schema_filename print(validate_schema_filename('manpage-schema-v1.0.md')) " # → (True, {'domain': 'manpage', 'version': '1.0', ...}) ``` ## Files Changed - markitect/schema_naming.py (NEW, 380 lines) - tests/test_schema_naming.py (NEW, 500+ lines) - roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md (NEW) - TODO.md (updated progress tracking) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 23:51:29 +01:00
"""
feat(spaces): implement Phase 0-1 of Information Space Service Phase 0 - Project Organization: - Create docs/PROJECT_STRUCTURE.md documenting codebase layout - Create markitect/core/ with parser, serializer, document_manager, workspace - Create markitect/schema/ consolidating 6 schema_*.py modules - Create markitect/storage/ with database module - Maintain backward compatibility via re-exports from original locations - Add docs/roadmap/information-space-service/ with README and WORKPLAN Phase 1 - Foundation (Weeks 1-3): - Week 1: Core domain models (InformationSpace, SpaceDocument, SpaceConfig, SpaceMetadata, SpaceVariable, TransclusionReference, SpaceStatus) - Week 2: Repository layer with interfaces (ISpaceRepository, IDocumentAssociationRepository, IVariableRepository, IReferenceRepository) and SQLite implementations with foreign key cascade deletes - Week 3: SpaceService orchestration layer with full CRUD, document, variable, and reference tracking operations Test coverage: 124 tests (25 model + 63 repository + 36 integration) Capabilities delivered: - CAP-001: InformationSpace entity with lifecycle management - CAP-002: SpaceRepository CRUD with SQLite backing - CAP-003: Document-Space associations with path-based organization - CAP-004: Space metadata and configuration schemas - CAP-005: Database schema with migrations Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-08 02:02:46 +01:00
# Re-export from schema package for backward compatibility
from markitect.schema.naming import (
validate_schema_filename,
suggest_valid_filename,
suggest_schema_filename,
extract_schema_domain,
get_schema_version,
extract_schema_metadata,
get_validation_errors,
is_valid_schema_filename,
format_validation_message,
SchemaFilenameError,
SCHEMA_FILENAME_PATTERN,
feat: implement schema filename validation (Phase 1 complete) Implements filename convention enforcement for schema files as part of the schema-of-schemas implementation. All schemas must now follow the naming pattern: {domain}-schema-v{major}.{minor}.md ## Phase 1 Deliverables ### Schema Naming Module **File:** `markitect/schema_naming.py` (380 lines) **Functions:** - `validate_schema_filename()` - Validate filename against pattern - `suggest_schema_filename()` - Generate valid filename from domain/version - `extract_schema_metadata()` - Extract domain and version from filename - `get_validation_errors()` - Detailed error messages for invalid filenames - `is_valid_schema_filename()` - Simple boolean validation - `format_validation_message()` - User-friendly error formatting **Features:** - Regex-based pattern matching - Automatic normalization (spaces → hyphens, lowercase) - Detailed error reporting - Domain validation (must start with letter) - Version validation (major.minor format) ### Comprehensive Test Suite **File:** `tests/test_schema_naming.py` (500+ lines, 50 tests) **Test Coverage:** - ✅ Valid filename variations (simple, hyphenated, with numbers) - ✅ Invalid filenames (wrong extension, missing components, wrong case) - ✅ Filename suggestion with normalization - ✅ Metadata extraction - ✅ Error message generation - ✅ Edge cases (long names, many hyphens, large versions) - ✅ Pattern regex validation **Results:** 50/50 tests passing (100%) ### Specification Document **File:** `roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md` **Contents:** - Formal specification of naming convention - Regular expression pattern with explanation - Valid and invalid examples - Version numbering guidelines - Domain naming best practices - Normalization rules - Migration strategy from legacy naming - Implementation guide ## Naming Convention ### Format ``` {domain}-schema-v{major}.{minor}.md ``` ### Examples ``` ✓ manpage-schema-v1.0.md ✓ api-documentation-schema-v1.0.md ✓ terminology-schema-v1.0.md ✓ arc42-schema-v2.1.md ✗ manpage.json (wrong extension) ✗ ManPage-schema-v1.0.md (uppercase) ✗ manpage-v1.0.md (missing 'schema') ✗ manpage-schema-v1.md (missing minor version) ``` ### Components - **domain**: Lowercase, hyphen-separated, starts with letter - **schema**: Literal keyword - **version**: v{major}.{minor} (SemVer simplified) - **extension**: .md (markdown) ## Implementation Highlights ### Automatic Normalization ```python suggest_schema_filename("API Documentation", "2.1") # → "api-documentation-schema-v2.1.md" suggest_schema_filename("My_Custom Type", "1.0") # → "my-custom-type-schema-v1.0.md" ``` ### Detailed Error Reporting ```python format_validation_message("invalid.json") # → Detailed error list + suggested fix ``` ### Metadata Extraction ```python extract_schema_metadata("manpage-schema-v1.0.md") # → {'domain': 'manpage', 'version': '1.0', 'major': 1, 'minor': 0} ``` ## Migration Plan Current schemas will be renamed: ``` Old → New ──────────────────────────────────────────────────────── terminology-schema.json → terminology-schema-v1.0.md api-documentation → api-documentation-schema-v1.0.md enhanced-manpage → manpage-schema-v2.0.md markdown-manpage → DELETE (duplicate) markdown-manpage-schema.json → DELETE (duplicate) ``` ## Phase 1 Status: ✅ COMPLETE ### Completed - [x] Schema naming module implementation - [x] Comprehensive test suite (50 tests, 100% passing) - [x] Specification document - [x] TODO.md updated ### Next: Phase 2 - [ ] Update CLI schema-ingest with validation - [ ] Implement markdown schema loader - [ ] Parse frontmatter and JSON code blocks - [ ] Update SchemaValidator for .md support ## Testing ```bash # Run tests pytest tests/test_schema_naming.py -v # → 50 passed in 0.48s # Test interactively python -c " from markitect.schema_naming import validate_schema_filename print(validate_schema_filename('manpage-schema-v1.0.md')) " # → (True, {'domain': 'manpage', 'version': '1.0', ...}) ``` ## Files Changed - markitect/schema_naming.py (NEW, 380 lines) - tests/test_schema_naming.py (NEW, 500+ lines) - roadmap/schema-of-schemas/SCHEMA_NAMING_SPEC.md (NEW) - TODO.md (updated progress tracking) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-04 23:51:29 +01:00
)
feat(spaces): implement Phase 0-1 of Information Space Service Phase 0 - Project Organization: - Create docs/PROJECT_STRUCTURE.md documenting codebase layout - Create markitect/core/ with parser, serializer, document_manager, workspace - Create markitect/schema/ consolidating 6 schema_*.py modules - Create markitect/storage/ with database module - Maintain backward compatibility via re-exports from original locations - Add docs/roadmap/information-space-service/ with README and WORKPLAN Phase 1 - Foundation (Weeks 1-3): - Week 1: Core domain models (InformationSpace, SpaceDocument, SpaceConfig, SpaceMetadata, SpaceVariable, TransclusionReference, SpaceStatus) - Week 2: Repository layer with interfaces (ISpaceRepository, IDocumentAssociationRepository, IVariableRepository, IReferenceRepository) and SQLite implementations with foreign key cascade deletes - Week 3: SpaceService orchestration layer with full CRUD, document, variable, and reference tracking operations Test coverage: 124 tests (25 model + 63 repository + 36 integration) Capabilities delivered: - CAP-001: InformationSpace entity with lifecycle management - CAP-002: SpaceRepository CRUD with SQLite backing - CAP-003: Document-Space associations with path-based organization - CAP-004: Space metadata and configuration schemas - CAP-005: Database schema with migrations Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-08 02:02:46 +01:00
__all__ = [
'validate_schema_filename',
'suggest_valid_filename',
'suggest_schema_filename',
'extract_schema_domain',
'get_schema_version',
'extract_schema_metadata',
'get_validation_errors',
'is_valid_schema_filename',
'format_validation_message',
'SchemaFilenameError',
'SCHEMA_FILENAME_PATTERN',
]
Reference in a new issue Copy permalink