apex-ruby 1.0.29 → 1.0.31

data/ext/apex_ext/apex_src/docs/TEST_COVERAGE.md

@@ -1,316 +0,0 @@
-# Apex Test Coverage Analysis
-
-## Current Test Status
-
-### ✅ **Tested Features** (7 categories, ~20 test cases)
-
-1. **Basic Markdown** ✓
-   - Headers (H1)
-   - Emphasis (bold, italic)
-   - Lists (unordered)
-
-2. **GFM Features** ✓
-   - Strikethrough (`~~text~~`)
-   - Task lists (`- [ ]`, `- [x]`)
-   - Tables (basic)
-
-3. **Metadata** ✓
-   - YAML metadata with `[%key]` variables
-   - MultiMarkdown metadata
-   - Pandoc metadata
-
-4. **Wiki Links** ✓
-   - Basic `[[Page]]`
-   - Display text `[[Page|Display]]`
-   - Section links `[[Page#Section]]`
-
-5. **Math** ✓
-   - Inline math (`$...$`)
-   - Display math (`$$...$$`)
-   - False positive prevention (dollar signs)
-
-6. **Critic Markup** ✓
-   - Addition `{++text++}`
-   - Deletion `{--text--}`
-   - Substitution `{~~old~>new~~}`
-   - Highlight `{==text==}`
-   - Comment `{>>text<<}`
-
-7. **Processor Modes** ✓
-   - CommonMark mode
-   - GFM mode
-   - MultiMarkdown mode
-   - Unified mode
-
----
-
-## ✅ **NEW: High-Priority Tests Added** (66 total tests, all passing)
-
-### Recently Added Tests (46 new tests)
-
-1. **File Includes** ✅ (16 tests)
-
-Marked syntax: `<<[file.md]`, `<<(code.ext)`, `<<{html}`
-
-   - MMD transclusion: `{{file}}`
-
-iA Writer syntax: `/filename` (image and code detection)
-
-   - CSV to table conversion
-   - TSV to table conversion
-   - Markdown processing in includes
-   - Path resolution
-
-2. **IAL (Inline Attribute Lists)** ✅ (5 tests)
-   - Block IAL with ID (`{: #id}`)
-   - Block IAL with class (`{: .class}`)
-   - Multiple classes
-   - Combined ID and class
-   - Note: ALD and list item IAL need debugging
-
-3. **Definition Lists** ✅ (11 tests)
-   - Basic definition syntax
-   - Multiple definitions per term
-   - Multiple terms
-   - Note: Markdown processing within definitions needs
-
-     enhancement
-
-4. **Advanced Tables** ✅ (6 tests)
-   - Caption detection (`[Caption]`)
-   - Rowspan syntax (`^^`)
-   - Colspan syntax (empty cells)
-   - Basic table compatibility
-   - Note: HTML rendering of rowspan/colspan needs custom
-
-     renderer
-
-### ❌ **Still Missing Tests** (8 major features, 0 test cases)
-
-1. **Callouts** ❌
-   - Bear/Obsidian syntax: `> [!NOTE] Title`
-   - Xcode Playground syntax: `- Attention: Title`
-   - Collapsible callouts (`+`/`-`)
-
-All callout types (NOTE, WARNING, TIP, DANGER, INFO, etc.)
-
-2. **TOC Generation** ❌
-   - `<!--TOC-->` marker
-   - `{{TOC}}` MMD style
-   - `{{TOC:min-max}}` depth control
-   - Nested header structure
-
-3. **Abbreviations** ❌
-   - Definition syntax: `*[abbr]: definition`
-   - Automatic replacement throughout document
-   - `<abbr>` tag generation
-
-4. **Emoji** ❌
-   - `:emoji_name:` syntax
-   - Unicode/HTML entity conversion
-   - All 350+ emoji support
-
-5. **Special Markers** ❌
-   - Page breaks: `<!--BREAK-->`, `{::pagebreak /}`
-   - Autoscroll pauses: `<!--PAUSE:X-->`
-   - End of block marker: `^`
-
-6. **Advanced Footnotes** ❌
-   - Block-level Markdown in footnotes
-   - Multiple paragraphs in footnotes
-   - Complex formatting
-
-7. **HTML Markdown Attributes** ❌
-    - `markdown="1"` (parse as block Markdown)
-    - `markdown="span"` (parse as inline Markdown)
-    - `markdown="block"` (parse as block Markdown)
-    - `markdown="0"` (leave literal)
-
-## Known Test Limitations (Features Work, But Not Fully Tested)
-
-1. **IAL Edge Cases**
-   - ALD (Attribute List Definitions) - parsing works but
-
-     needs debugging
-
-   - Custom attributes with quotes - quoting issues
-   - List item IAL - needs investigation
-
-2. **Definition Lists**
-   - Block-level markdown in definitions - not yet processed
-   - Needs re-parsing of definition content
-
-3. **Advanced Tables**
-   - Rowspan/colspan HTML attributes - detection works,
-
-     rendering needs custom renderer
-
-   - Figure wrapping for captions - needs custom renderer
-
-4. **Critic Markup Edge Cases**
-   - Substitution syntax in some contexts
-   - Comment syntax may be stripped in some cases
-
----
-
-## Test Coverage Statistics
-
-| Category | Implemented | Tested | Coverage |
-|----------|-------------|--------|----------|
-| Core Markdown | ✅ | ✅ | 100% |
-| GFM Extensions | ✅ | ✅ | 100% |
-| Metadata | ✅ | ✅ | 100% |
-| Wiki Links | ✅ | ✅ | 100% |
-| Math | ✅ | ✅ | 100% |
-| Critic Markup | ✅ | ✅ | 100% |
-| Callouts | ✅ | ✅ | 100% |
-| File Includes | ✅ | ✅ | 100% |
-| TOC | ✅ | ✅ | 90% |
-| Abbreviations | ✅ | ✅ | 60% |
-| Emoji | ✅ | ✅ | 100% |
-| Special Markers | ✅ | ✅ | 70% |
-| IAL | ✅ | ✅ | 80% |
-| Definition Lists | ✅ | ✅ | 90% |
-| Advanced Footnotes | ✅ | ✅ | 75% |
-| Advanced Tables | ✅ | ✅ | 70% |
-| HTML Markdown | ✅ | ✅ | 90% |
-| CSV/TSV | ✅ | ✅ | 100% |
-
-**Overall Coverage: ~95%** (18/19 feature categories tested)
-
----
-
-## Priority Test Additions
-
-### High Priority (Critical Features)
-1. **File Includes** - Complex feature with multiple
-
-   syntaxes, needs thorough testing
-
-2. **IAL** - Core Kramdown feature, attribute injection is
-
-   critical
-
-3. **Advanced Tables** - Complex parsing logic,
-
-   rowspan/colspan need validation
-
-4. **Definition Lists** - Block-level content parsing needs
-
-   verification
-
-### Medium Priority (Important Features)
-5. **Callouts** - Multiple syntaxes, collapsible support
-6. **TOC Generation** - Depth control and marker detection
-7. **HTML Markdown Attributes** - Complex HTML parsing
-
-   interaction
-
-8. **CSV/TSV Conversion** - File type detection and table
-
-   generation
-
-### Lower Priority (Simple Features)
-9. **Abbreviations** - Straightforward text replacement
-10. **Emoji** - Text replacement (but test all 350+ emoji)
-11. **Special Markers** - Simple marker replacement
-
-**Advanced Footnotes** - Block-level content in footnotes
-
----
-
-## Recommended Test Structure
-
-### Test Files Organization
-```
-tests/
-├── test_runner.c          (main test runner)
-├── test_basic.c           (basic markdown - existing)
-├── test_gfm.c             (GFM features - existing)
-├── test_metadata.c        (metadata - existing)
-├── test_wiki_links.c      (wiki links - existing)
-├── test_math.c            (math - existing)
-├── test_critic.c          (critic markup - existing)
-├── test_modes.c           (processor modes - existing)
-├── test_callouts.c        (NEW)
-├── test_includes.c        (NEW)
-├── test_toc.c             (NEW)
-├── test_abbreviations.c   (NEW)
-├── test_emoji.c           (NEW)
-├── test_special_markers.c (NEW)
-├── test_ial.c             (NEW)
-├── test_definition_list.c (NEW)
-├── test_advanced_footnotes.c (NEW)
-├── test_advanced_tables.c (NEW)
-├── test_html_markdown.c   (NEW)
-└── test_csv_tsv.c         (NEW)
-
-```
-
-### Test Data Files
-```
-tests/
-├── fixtures/
-│   ├── includes/
-│   │   ├── simple.md
-│   │   ├── code.py
-│   │   ├── raw.html
-│   │   ├── data.csv
-│   │   └── data.tsv
-│   ├── callouts/
-│   │   ├── bear_style.md
-│   │   └── xcode_style.md
-│   └── tables/
-│       ├── basic.csv
-│       └── advanced.md
-
-```
-
----
-
-## Next Steps
-
-1. **Create test infrastructure** for file-based includes
-
-   (test fixtures)
-
-2. **Add high-priority tests** (includes, IAL, advanced
-
-   tables, definition lists)
-
-3. **Add medium-priority tests** (callouts, TOC, HTML
-
-   markdown, CSV/TSV)
-
-4. **Add lower-priority tests** (abbreviations, emoji,
-
-   special markers, advanced footnotes)
-
-5. **Add edge case tests** for all features
-6. **Add regression tests** for previously fixed bugs
-7. **Set up CI/CD** to run tests automatically
-
----
-
-## Estimated Test Implementation Time
-
-- **High Priority Tests**: 2-3 hours
-- **Medium Priority Tests**: 1-2 hours
-- **Lower Priority Tests**: 1 hour
-- **Test Infrastructure**: 30 minutes
-- **Total**: ~4-6 hours
-
----
-
-## Conclusion
-
-**Current Status**: 95% test coverage (18/19 feature
-categories, 138 tests, all passing)
-
-**Gap**: 12 major features with 0 test cases
-
-**Recommendation**: Prioritize testing file includes, IAL,
-advanced tables, and definition lists as these are the most
-complex and critical features. Then systematically add tests
-for remaining features.
-