apex-ruby 1.0.30 → 1.0.31

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

@@ -1,73 +0,0 @@
-# Debugging Apex
-
-## Using the debugger in VS Code
-
-To step through apex with the debugger:
-
-1. **Build with debug symbols** (default when using `make` with Debug build type):
-   ```bash
-   cd /path/to/apex
-   make clean && make
-   ```
-   Or with CMake directly: `cmake -DCMAKE_BUILD_TYPE=Debug .. && make`
-
-2. **Install a C/C++ debugger extension** (if not already):
-   - **CodeLLDB** (recommended on macOS): Extension ID `vadimcn.vscode-lldb`
-   - Or **C/C++** (Microsoft): Extension ID `ms-vscode.cpptools`
-
-3. **Use the launch configurations** in `.vscode/launch.json`:
-   - **Run and Debug** (sidebar or `Cmd+Shift+D`), then pick a configuration and press F5 or the green play button.
-   - **Apex CLI (ref-image+IAL fixture)** – runs `build/apex` with `tests/fixtures/debug_ref_image_ial.md` (the ref image + IAL link case).
-   - **Apex CLI (current file as input)** – runs apex with whatever file is currently active in the editor.
-   - **Apex test_runner (multimarkdown_image_attributes)** – runs the image-attributes test suite under the debugger.
-
-4. **Set breakpoints** by clicking in the gutter next to line numbers in:
-   - `src/apex.c` – e.g. in `apex_markdown_to_html` (image_attrs block, IAL block, or after rendering).
-   - `src/extensions/ial.c` – e.g. in `apex_preprocess_image_attributes` (expansion loop, ref-def handling) or in `process_span_ial_in_container` (IAL application to links).
-   - `src/html_renderer.c` – e.g. in `apex_render_html_with_attributes` (attribute injection).
-
-5. **Step through**: F10 (step over), F11 (step into), Shift+F11 (step out). Inspect variables in the **Variables** panel or hover.
-
-## Trace logging (no debugger)
-
-To see how the ref-image + IAL markup moves through the pipeline without stepping:
-
-```bash
-export APEX_DEBUG_PIPELINE=1
-./build/apex tests/fixtures/debug_ref_image_ial.md
-```
-
-Or with piped input (paste your markdown, then Ctrl+D):
-
-```bash
-export APEX_DEBUG_PIPELINE=1
-./build/apex -
-```
-
-Log lines (on stderr) show:
-
-- **preprocess_image_attributes in** – markdown before image-attribute preprocessing.
-- **expand ref [refname]** – when a reference-style image is expanded to inline.
-- **preprocess_image_attributes out** – markdown after image preprocessing (ref def removed, image expanded).
-- **after image_attrs** – markdown after image-attribute step in the main pipeline.
-- **after ial_preprocess** – markdown after IAL preprocessing.
-- **markdown to parse** – exact string fed to the cmark parser.
-- **IAL applied to link** – when span IAL is applied to a link node (with attrs snippet).
-- **rendered html len** – length of HTML after render; if short, the first 500 chars are printed.
-
-Use this to see where content disappears (e.g. empty “markdown to parse” or “rendered html len=0”).
-
-## CLI from terminal with lldb
-
-For a quick run under lldb without the VS Code UI:
-
-```bash
-lldb build/apex
-(lldb) run tests/fixtures/debug_ref_image_ial.md
-# When it hits a breakpoint or you interrupt (Ctrl+C):
-(lldb) bt
-(lldb) frame variable
-(lldb) quit
-```
-
-See also `debug_test.sh` for running the test runner under lldb.

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

@@ -1,391 +0,0 @@
-# Apex - Final Implementation Status
-
-**Date**: December 4, 2025
-**Version**: 0.1.0
-**Completion**: 14 of 17 Major Milestones (82%)
-
-## Executive Summary
-
-Apex is a unified Markdown processor built in C, providing
-comprehensive compatibility with CommonMark, GFM,
-MultiMarkdown, and Kramdown. The project has reached **82%
-completion** with all core features implemented and tested.
-
-## Completed Milestones ✅ (14/17)
-
-1. ✅ **Project Setup** - Complete build system, Git repo,
-
-   directory structure
-
-2. ✅ **cmark-gfm Integration** - Parser fully integrated and
-
-   working
-
-3. ✅ **Metadata Support** - All 3 formats (YAML, MMD,
-
-   Pandoc) + `[%key]` variables
-
-4. ✅ **Wiki Links** - `[[Page]]` syntax with display text
-
-   and sections
-
-5. ✅ **Math Support** - LaTeX math blocks for MathJax/KaTeX
-6. ✅ **Critic Markup** - Full track changes support (5
-
-   markup types)
-
-7. ✅ **macOS Framework** - `Apex.framework` building
-
-   successfully
-
-8. ✅ **CLI Tool** - `apex` binary with full command-line
-
-   interface
-
-✅ **Compatibility Modes** - 5 modes configured and working
-
-10. ✅ **Marked Integration** - Objective-C wrapper created
-
-    with examples
-
-11. ✅ **Test Suite** - 31 automated tests, 90% pass rate
-
-✅ **Documentation** - Complete user guide and API reference
-
-13. ✅ **Build System** - CMake working on macOS
-
-    (cross-platform ready)
-
-14. ✅ **Repository** - Well-organized Git repo with clean
-
-    history
-
-## Remaining Features ⏳ (3/17)
-
-1. **Definition Lists** - Kramdown/PHP Extra style (header
-
-   created, needs impl)
-
-2. **Kramdown Attributes** - `{: #id .class}` syntax (not
-
-   yet started)
-
-3. **Inline Footnotes** - `^[text]` format (not yet started)
-4. **Enhanced Tables** - MMD column spans and captions (not
-
-   yet started)
-
-5. **Release Prep** - Homebrew formula, binaries, website
-
-   (not yet started)
-
-Note: Items 1-4 are nice-to-have features. The core
-processor is fully functional.
-
-## What's Working Right Now
-
-### ✅ Core Markdown
-- Headers (all levels)
-- Emphasis (*italic*, **bold**, ***both***)
-- Lists (ordered, unordered, nested)
-- Links and images
-- Code blocks (fenced and indented)
-- Blockquotes
-- Horizontal rules
-
-### ✅ GFM Features
-- Tables with alignment
-- Strikethrough (~~text~~)
-- Task lists (- [ ] and - [x])
-- Autolinks
-- Tag filtering (security)
-
-### ✅ Extended Syntax
-- **Metadata** (3 formats)
-- **Metadata variables** `[%key]`
-- **Wiki links** `[[Page]]`, `[[Page|Display]]`,
-
-  `[[Page#Section]]`
-
-- **Math** `$inline$` and `$$display$$`
-- **Critic Markup** (all 5 types)
-- **Footnotes** (reference style)
-- **Smart typography** (quotes, dashes, ellipsis)
-
-### ✅ Processor Modes
-- CommonMark (strict spec compliance)
-- GFM (GitHub compatibility)
-- MultiMarkdown (MMD compatibility)
-- Kramdown (partial compatibility)
-- Unified (all features)
-
-## Technical Metrics
-
-**Repository Stats:**
-
-- Total commits: 26
-- Lines of code: ~4,500 C code
-- Source files: 25+
-- Test coverage: ~70% (manual + automated)
-
-**Build Outputs:**
-
-- `apex` - CLI binary (~500KB)
-- `libapex.dylib` - Shared library
-- `libapex.a` - Static library
-- `Apex.framework` - macOS framework
-
-**Performance:**
-
-- Small docs (< 10KB): < 10ms
-- Medium docs (< 100KB): < 100ms
-- Large docs (< 1MB): < 1s
-- Based on highly optimized cmark-gfm
-
-**Code Quality:**
-
-- Clean compilation (only minor warnings)
-- No memory leaks (uses cmark-gfm's arena allocator)
-- Well-documented (inline comments + external docs)
-- Modular architecture (easy to extend)
-
-## Architecture Highlights
-
-**Solid Foundation:**
-
-- Built on GitHub's battle-tested cmark-gfm
-- Extensible architecture with clean separation
-- Preprocessing + parsing + postprocessing pipeline
-
-**Smart Approaches:**
-
-- Metadata: Preprocessing (before parsing)
-- Critic Markup: Preprocessing (avoids typography conflicts)
-- Wiki Links: Postprocessing AST (avoids link syntax
-
-  conflicts)
-
-- Math: Inline extension (character-level matching)
-
-**Clean Abstractions:**
-
-- apex_options for configuration
-- Mode-specific presets
-- Extension system for adding features
-- Consistent C API
-
-## Integration Status
-
-### Ready for Marked
-
-- ✅ Objective-C category created (`NSString+Apex`)
-- ✅ Framework building for macOS
-- ✅ Integration documentation complete
-- ✅ Code examples provided
-- ✅ Symlinks created in Marked directory
-
-**Next steps for Marked integration:**
-
-1. Add apex as git submodule in Marked repo
-2. Add Apex.framework to Xcode project
-3. Add Apex option to processor preferences UI
-4. Wire into processor selection code (examples provided)
-5. Test with real Marked documents
-
-### Ready for Standalone Use
-
-- ✅ CLI tool fully functional
-- ✅ Comprehensive help text
-- ✅ All features accessible via flags
-- ✅ Stdin/stdout support for Unix pipes
-- ✅ User documentation complete
-
-## Testing Status
-
-**Automated Tests:** 31 tests, 28 passing (90%)
-
-**Test Coverage:**
-
-- ✅ Basic Markdown (5/5 passing)
-- ✅ GFM features (5/5 passing)
-- ✅ Metadata (4/4 passing)
-- ✅ Wiki links (3/3 passing)
-- ✅ Math support (4/4 passing)
-- ⚠️ Critic Markup (3/6 passing - edge cases)
-- ✅ Processor modes (4/4 passing)
-
-**Known Test Failures:**
-
-- Critic substitution edge cases (works in real use)
-- Minimal impact on production use
-
-## Feature Comparison
-
-| Feature | CommonMark | GFM | MMD | Kramdown | Apex Unified
-|
-| ---------------- | ---------- | --- | --- | -------- |
------------- |
-| Basic MD | ✅ | ✅ | ✅ | ✅ | ✅ |
-| Tables | ❌ | ✅ | ✅ | ✅ | ✅ |
-| Strikethrough | ❌ | ✅ | ❌ | ❌ | ✅ |
-| Task Lists | ❌ | ✅ | ❌ | ❌ | ✅ |
-| Footnotes | ❌ | ❌ | ✅ | ✅ | ✅ |
-| Metadata | ❌ | ❌ | ✅ | ✅ | ✅ |
-| Meta Vars | ❌ | ❌ | ✅ | ❌ | ✅ |
-| Smart Typography | ❌ | ❌ | ✅ | ✅ | ✅ |
-| Math | ❌ | ❌ | ✅ | ✅ | ✅ |
-| Wiki Links | ❌ | ❌ | ❌ | ❌ | ✅ |
-| Critic Markup | ❌ | ❌ | ❌ | ❌ | ✅ |
-| Def Lists | ❌ | ❌ | ❌ | ✅ | ⏳ |
-| Attributes | ❌ | ❌ | ❌ | ✅ | ⏳ |
-
-**Result**: Apex Unified mode offers a true superset of all
-major Markdown flavors.
-
-## What's Missing
-
-### Low Priority (Nice-to-Have)
-- Definition lists (`:` syntax)
-- Kramdown attributes (`{: .class}`)
-- Inline footnotes (`^[text]`)
-- Enhanced table features (column spans, captions)
-
-### Future Enhancements (Not Planned Yet)
-- Callouts (Bear/Obsidian `> [!NOTE]`)
-- TOC markers (`<!--TOC-->`)
-- File includes (`<<[file]>>`)
-- Page breaks (`<!--BREAK-->`)
-- Leanpub syntax extensions
-
-These Marked-specific features are documented in the plan
-but can be added incrementally as needed.
-
-## Production Readiness
-
-**Overall Assessment: 85% Production Ready**
-
-✅ **Ready:**
-
-- Core parsing and rendering
-- All major Markdown features
-- GFM compatibility
-- MultiMarkdown metadata
-- Extension system
-- CLI tool
-- Documentation
-
-⚠️ **Needs Work:**
-
-- Edge case handling (critic markup)
-- Comprehensive test suite expansion
-- Performance profiling
-- Real-world testing with large documents
-
-❌ **Not Ready:**
-
-- Some Kramdown features incomplete
-- Marked-specific syntax not implemented
-- No official release/packaging
-
-## Recommendations
-
-### For Immediate Use in Marked
-
-**Ready to integrate!** The current implementation covers
-90% of what Marked users need:
-
-1. All basic Markdown
-2. GFM features
-3. Metadata with variables
-4. Wiki links
-5. Math support
-6. Critic Markup
-
-**Integration effort**: ~2-4 hours to wire into Marked's
-Xcode project
-
-### For Standalone CLI Use
-
-**Ready for beta release!** The `apex` binary is functional
-and useful:
-
-- Works on all common documents
-- Fast and reliable
-- Good error handling
-- Comprehensive help
-
-**Release effort**: ~1-2 days to create Homebrew formula and
-package
-
-### For Future Development
-
-**Recommended priority:**
-
-1. **Marked-specific syntax** (callouts, TOC, includes) -
-
-   High user value
-
-2. **Definition lists** - Kramdown compatibility
-3. **Comprehensive tests** - Edge case coverage
-4. **Performance tuning** - Optimize for large documents
-5. **Kramdown attributes** - Full Kramdown compatibility
-
-## Conclusion
-
-Apex has achieved its primary goal: creating a unified
-Markdown processor that works with multiple formats. With
-**14 of 17 milestones complete**, it's ready for integration
-into Marked and can be released as a standalone tool.
-
-**The foundation is solid, the core features work, and the
-architecture is extensible.**
-
-### Success Criteria Met
-
-✅ Parses CommonMark correctly
-✅ Supports GFM extensions
-✅ Handles MultiMarkdown metadata
-✅ Processes Kramdown syntax (mostly)
-✅ Fast and efficient
-✅ Clean C API
-✅ macOS framework built
-✅ Well documented
-
-**Apex is ready to be "One Markdown processor to rule them
-all."**
-
----
-
-## Quick Start for Marked Integration
-
-```bash
-# Add as submodule
-cd /Users/ttscoff/Desktop/Code/marked
-git submodule add ./apex apex
-
-# Build framework
-cd apex
-mkdir -p build && cd build
-cmake -DBUILD_FRAMEWORK=ON ..
-make
-
-# Framework is at: apex/build/Apex.framework
-
-```
-
-Then follow instructions in `docs/MARKED_INTEGRATION.md`.
-
-## Quick Start for Standalone Use
-
-```bash
-cd /Users/ttscoff/Desktop/Code/marked/apex/build
-./apex --help
-echo "# Test" | ./apex
-./apex --mode gfm your-document.md > output.html
-
-```
-
----
-
-**Status**: Ready for integration and real-world use! 🚀
-

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

@@ -1,237 +0,0 @@
-# Apex - Final Status Update
-**Date**: December 4, 2025
-
-## 🎉 Project Milestones Achieved
-
-### Known Limitations Resolution: 5 of 6 Complete (83%)
-
-All critical limitations have been resolved. The project is
-**production-ready**.
-
----
-
-## Resolved Limitations
-
-### 1. ✅ Advanced Tables - Rowspan/Colspan (30 min)
-- Rowspan (`^^`) fully working
-- Colspan (empty cells) fully working
-- HTML postprocessing injects attributes correctly
-- 6 tests passing
-
-### 2. ✅ Definition Lists - Markdown Processing (30 min)
-- Inline Markdown in definitions working
-- Bold, italic, code, links all supported
-- 11 tests passing (added 2)
-
-### 3. ✅ Abbreviations - Expansion (30 min)
-- `*[abbr]: definition` syntax working
-- Multiple abbreviations supported
-- Word boundary detection working
-- 7 tests passing (added 6)
-
-### 4. ✅ Special Markers - HTML Generation (30 min)
-- `<!--BREAK-->` page breaks working
-- `<!--PAUSE:X-->` autoscroll pauses working
-- `{::pagebreak /}` Kramdown syntax working
-- `^` end-of-block separator working
-- 7 tests passing (added 7)
-
-### 5. ✅ TOC Depth Range - Min/Max Syntax (10 min)
-- `{{TOC:2-3}}` range syntax working
-- `<!--TOC max2 min1-->` syntax working
-- All TOC markers with depth control
-- 14 tests passing (added 2)
-
-### 6. ⚠️ IAL - Core Working, Edge Cases Remain
-- **Working**: Headers, paragraphs, blockquotes, code
-
-  blocks, lists (80%)
-
-- **Not Working**: List items between items, ALD references
-
-  (20%)
-
-- **Estimate**: 2-3 hours additional for edge cases
-- 5 tests passing
-
----
-
-## Test Suite Status
-
-### Test Coverage: 95%
-
-| Metric               | Value                  |
-| -------------------- | ---------------------- |
-| **Total Tests**      | 138                    |
-| **Passing**          | 138 (100%)             |
-| **Test File Size**   | 863 lines              |
-| **Feature Coverage** | 18/19 categories (95%) |
-
-### Test Breakdown:
-
-1. Basic Markdown: 5 tests ✓
-2. GFM Features: 5 tests ✓
-3. Metadata: 4 tests ✓
-4. Wiki Links: 3 tests ✓
-5. Math Support: 4 tests ✓
-6. Critic Markup: 3 tests ✓
-7. Processor Modes: 4 tests ✓
-8. **File Includes: 16 tests ✓** (high priority)
-9. **IAL: 5 tests ✓** (high priority)
-10. **Definition Lists: 11 tests ✓** (high priority)
-11. **Advanced Tables: 6 tests ✓** (high priority)
-12. **Callouts: 10 tests ✓** (medium priority)
-13. **TOC Generation: 14 tests ✓** (medium priority)
-14. **HTML Markdown: 9 tests ✓** (medium priority)
-15. **Abbreviations: 7 tests ✓** (lower priority)
-16. **Emoji: 10 tests ✓** (lower priority)
-17. **Special Markers: 7 tests ✓** (lower priority)
-18. **Advanced Footnotes: 3 tests ✓** (lower priority)
-
----
-
-## Codebase Statistics
-
-| Metric            | Count          |
-| ----------------- | -------------- |
-| **Total Commits** | 58             |
-| **Source Files**  | 40 (C/H files) |
-| **Total Lines**   | ~8,571         |
-| **Test Lines**    | 863            |
-| **Extensions**    | 17 modules     |
-
----
-
-## Implementation Sessions
-
-### Session 1: Initial Implementation
-- Core infrastructure
-- Basic extensions (metadata, wiki links, math, critic)
-- ~30 commits
-
-### Session 2: Advanced Features
-- IAL, advanced tables, definition lists
-- MMD transclusion, HTML markdown attributes
-- iA Writer transclusion, CSV/TSV tables
-- ~20 commits
-
-### Session 3: Testing & Refinement (Today)
-- Comprehensive test suite (20 → 138 tests)
-- Known limitations resolution (5 of 6)
-- Bug fixes and polish
-- ~8 commits
-
----
-
-## Feature Completeness
-
-### Tier 1 (Critical): 100%
-- ✅ CommonMark compliance
-- ✅ GFM extensions
-- ✅ Metadata (YAML, MMD, Pandoc)
-- ✅ Callouts (Bear/Obsidian/Xcode)
-- ✅ File includes (all 3 syntaxes)
-- ✅ TOC generation
-- ✅ Definition lists
-- ✅ Abbreviations
-- ✅ IAL (core features)
-- ✅ Tables (basic + advanced)
-- ✅ GitHub emoji (350+)
-
-### Tier 2 (Important): 100%
-- ✅ Advanced footnotes
-- ✅ Advanced tables (rowspan/colspan)
-- ✅ MMD transclusion ({{file}})
-- ✅ HTML markdown attributes
-- ✅ iA Writer transclusion (/file)
-- ✅ CSV/TSV to tables
-- ✅ Special markers (page breaks, pauses)
-- ✅ End-of-block markers
-
-### Tier 3 (Edge Cases): 80%
-- ⚠️ IAL list items (not working)
-- ⚠️ ALD references (not working)
-
-**Overall: 98% feature complete**
-
----
-
-## Production Readiness
-
-### ✅ Ready for Production Use
-
-**Strengths**:
-
-- Comprehensive test coverage (95%)
-- All critical features working
-- Multiple Markdown flavor support
-- Robust error handling
-- Well-documented
-
-**Minor Gaps**:
-
-- IAL list items (rare use case)
-- ALD references (advanced feature)
-
-**Recommendation**:
-Deploy to production. The missing IAL features represent <
-2% of typical use cases and can be added as enhancements
-based on user feedback.
-
----
-
-## Documentation Status
-
-### Complete Documentation
-
-- ✅ `ARCHITECTURE.md` - System design
-- ✅ `USER_GUIDE.md` - End-user documentation
-- ✅ `API_REFERENCE.md` - Developer API
-- ✅ `MARKED_INTEGRATION.md` - Integration guide
-- ✅ `PROGRESS.md` - Feature tracking
-- ✅ `FUTURE_FEATURES.md` - Roadmap
-- ✅ `TEST_COVERAGE.md` - Test analysis
-- ✅ `LIMITATIONS_RESOLVED.md` - Resolution report
-- ✅ `tests/README.md` - Test guide
-- ✅ `README.md` - Project overview
-
-**10 comprehensive documentation files**
-
----
-
-## Next Steps (Optional)
-
-1. **Deploy to Marked** - Integrate Apex into Marked
-
-   application
-
-**Performance Testing** - Benchmark against other processors
-
-3. **User Feedback** - Gather real-world usage feedback
-4. **IAL Edge Cases** - If needed based on user requests
-
-   (2-3 hours)
-
-5. **Additional Emoji** - Expand beyond 350 if desired
-6. **More Tests** - Edge case coverage (optional)
-
----
-
-## Conclusion
-
-**Apex is feature-complete and production-ready!**
-
-- ✅ All major Markdown flavors supported
-- ✅ All critical features implemented
-- ✅ Comprehensive test coverage (138 tests)
-- ✅ Excellent documentation (10 files)
-- ✅ 5 of 6 limitations resolved
-- ✅ 98% feature completeness
-
-**Total Development**: ~50-60 hours across 3 sessions
-**Total Commits**: 58
-**Lines of Code**: ~8,571
-**Test Coverage**: 95%
-
-🎉 **One Markdown processor to rule them all!** 🎉
-