red_quilt 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a53fcc10d442493f6de26bbced9811a9f54e5328fbfa3aae39e44491bcbdf99c
+  data.tar.gz: 6b0f0be3ccf229a341421f08a3b5eaa6b95bc99ed14a1d0e02a7c4675e9e100e
+SHA512:
+  metadata.gz: f919427e21c232babe5c5672e125928557d09a5b3e80fe70a6902913cc0c1796d7478cc180edcbde2cb8b5c861c94d8b0d4fb4a5ece5f876d795b17c4a6ff891
+  data.tar.gz: da179b152732e9cfffb8c7580a550191f5d0798a5d6a62be8b2fab17bc4c33fd6725b1a2ebdcf001ad38bba8681030e7f27f7d036cfc68dab0ee96e61e43cb53

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,109 @@
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  NewCops: enable
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IdenticalConditionalBranches:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: percent
+  MinSize: 8
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: diff_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: diff_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: diff_comma
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Lint/DuplicateBranch:
+  Enabled: false
+
+Lint/UselessConstantScoping:
+  Enabled: false
+
+Style/BitwisePredicate:
+  Enabled: false
+
+Style/ComparableBetween:
+  Enabled: false
+
+Style/PartitionInsteadOfDoubleSelect:
+  Enabled: false
+
+Style/RedundantArgument:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --no-offense-counts --no-auto-gen-timestamp`
+# using RuboCop version 1.86.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.6.1] - 2026-05-29
+
+### Added
+
+- Opt-in GitHub-style footnotes (`footnotes: true`, off by default):
+  `[^label]` references and `[^label]: …` definitions (multi-paragraph and
+  lazy continuation), numbered in first-reference order, rendered as a GFM
+  `<section class="footnotes">` with backrefs; also emitted to mdast.
+- Bundled standalone HTML theme via `Document#to_html(theme:)` / the
+  `--theme` CLI flag: `default` (a compact, dark-mode-aware stylesheet
+  embedded inline) or `none` (bare). CLI defaults to `default`, the library
+  API to `none`.
+
+### Security
+
+- Block script-executing schemes (`javascript:`/`vbscript:`/`data:`) in
+  autolinks, which previously rendered as links.
+
+### Fixed
+
+- Numeric character references: enforce digit caps; map NUL, surrogate, and
+  out-of-range code points to U+FFFD.
+- Enforce the 999-char link-label cap and tighten reference-definition
+  destination validation.
+- Restrict whitespace in autolinks, raw HTML tags, link tails, and reference
+  definitions to spaces/tabs (plus one line ending); reject form feed and
+  vertical tab.
+- Normalize input: CRLF/CR → LF, NUL → U+FFFD.
+- GFM tables: require a row's column count to match the header; reject
+  autolinks with underscored domains.
+
+### Performance
+
+- Cut inline allocations ~43% (shared byte→char table; skip no-op string
+  scans) and redundant per-line / whole-document scans in block parsing.
+- Make the per-line record a positional Struct.
+
+### Changed
+
+- Rename `Arena#replace_str1` / `replace_int3` to `update_str1` / `update_int3`.
+
+### Internal
+
+- Extract `Inline::LinkScanner` and `RedQuilt::Indentation`; add
+  `Arena#source_end`; consolidate ASCII-punctuation tables; make
+  `Delimiter` / `Bracket` / `Line` Structs.
+- Drop `__send__` between block-parser collaborators via a public
+  collaborator interface on `BlockParser`.
+- Add an allocation-regression CI gate and RSpec / RuboCop workflows;
+  support Ruby >= 3.3.

data/README.md

@@ -0,0 +1,284 @@
+# RedQuilt
+
+A modern Markdown document processor in pure Ruby, with an arena-style AST.
+Passes the full CommonMark spec test suite, and generally faster than kramdown.
+
+## Installation
+
+Add this line to Gemfile:
+
+```ruby
+gem "red_quilt"
+```
+
+## Quick Start
+
+### Parsing and rendering
+
+```ruby
+require "red_quilt"
+
+# Parse Markdown to a document
+doc = RedQuilt.parse("# Hello\n\nThis is **bold**.")
+html = doc.to_html
+# => "<h1>Hello</h1>\n<p>This is <strong>bold</strong>.</p>\n"
+
+# Or render directly (without building AST)
+html = RedQuilt.render_html("# Hello\n\n**bold**")
+```
+
+### HTML is safe by default
+
+```ruby
+RedQuilt.render_html("Hi <em>tag</em>")
+# => "<p>Hi &lt;em&gt;tag&lt;/em&gt;</p>\n"
+
+RedQuilt.render_html("Hi <em>tag</em>", allow_html: true)
+# => "<p>Hi <em>tag</em></p>\n"
+```
+
+## API Reference
+
+### Document
+
+```ruby
+doc = RedQuilt.parse("# Title\n\nBody")
+
+doc.root              # Root node (NodeRef)
+doc.walk              # Traverse all nodes (block: { |node| ... } or Enumerator)
+doc.to_html           # Render as HTML
+doc.to_ast            # Export complete AST as Hash
+doc.to_json           # Export as MDAST-compatible JSON
+doc.to_mdast          # Export as MDAST Hash
+doc.source_map        # Line/column lookup (lazy memoized)
+doc.allow_html?       # Check HTML pass-through setting
+```
+
+### NodeRef (AST node wrapper)
+
+```ruby
+node = doc.root.children.first
+
+# Traversal
+node.type             # :heading, :paragraph, :link, etc. (Symbol)
+node.children         # Array[NodeRef]
+node.walk             # Enumerator[NodeRef] or { |node| ... } block
+node.find_all(:link)  # Array[NodeRef] with matching type
+node.text             # String (concatenated child text)
+
+# Position information (byte offset)
+node.source_span      # SourceSpan with start_byte, end_byte
+
+# Position information (line/column)
+node.source_location  # { start_line, start_column, end_line, end_column }
+                      # line: 1-indexed, column: 0-indexed (character-based)
+
+# AST export
+node.to_h             # Export subtree as Hash[Symbol, untyped]
+```
+
+### SourceSpan
+
+```ruby
+span = node.source_span
+span.start_byte       # Integer (0-indexed byte offset)
+span.end_byte         # Integer (exclusive)
+span.length           # Computed: end_byte - start_byte
+```
+
+## Supported Syntax
+
+### Block elements
+
+- Paragraphs: Plain text blocks
+- Headings: ATX headings (`# Title`)
+- Thematic breaks: `---`, `***`, `___`
+- Code blocks: Indented and fenced (with info string)
+- Block quotes: `> quote text`
+- Lists: Ordered (`1.`) and unordered (`-`, `*`, `+`)
+- List items: Nested blocks, tight/loose detection
+- Tables: GFM syntax with header/body rows
+- Raw HTML blocks: 7 types (script, comment, etc.)
+- Link reference definitions: `[foo]: /url "title"`
+
+### Inline elements
+
+- Text: Plain strings
+- Emphasis/Strong: `*em*`, `**strong**`, `_em_`, `__strong__`
+- Code spans: `` `code` ``
+- Links: `[text](/url)`, `[text](/url "title")`, reference links
+- Images: `![alt](/url)`, `![alt](/url "title")`, reference images
+- Soft/Hard line breaks: Implicit (soft) and explicit `\` or two spaces
+- Raw HTML inline: `<a href="#">link</a>`
+- Autolinks: `<http://example.com>`, `<user@example.com>`
+- Character references: `&amp;`, `&#x27;`, etc.
+
+## CommonMark Compatibility
+
+RedQuilt achieves 100% compliance with the CommonMark v0.31.2 specification.
+
+## Command-line Tool
+
+RedQuilt ships with a `redquilt` CLI for converting Markdown files to HTML or inspecting the AST.
+
+### Basic usage
+
+```bash
+# Convert Markdown file to HTML
+redquilt input.md > output.html
+
+# Convert from stdin
+echo "# Hello" | redquilt
+
+# Output as AST (for debugging)
+redquilt --format ast input.md
+
+# Output as MDAST-compatible JSON (for external tools)
+redquilt --format json input.md
+
+# Standalone HTML document with title
+redquilt --standalone --title "My Document" input.md
+
+# Enable GFM extended autolinks
+redquilt --extended-autolinks input.md
+```
+
+### Options
+
+```
+--format FORMAT          Output format: html (default), ast, json
+--allow-html             Pass raw HTML through to the output
+--extended-autolinks     Linkify bare URLs and email addresses (GFM)
+--[no-]standalone        Wrap HTML in full document (default: on)
+--auto-title             Use the first heading's text as <title>
+--title TITLE            Explicit <title> text
+--lang LANG              html lang attribute (default: "en")
+--css URL                Add a stylesheet link
+--diagnostics            Print diagnostics to stderr
+--diagnostics-only       Print diagnostics only (suppress output)
+-h, --help               Show help
+-v, --version            Show version
+```
+
+Exit code is 0 on success, 1 if errors are detected.
+
+## Safe-by-Default HTML Rendering
+
+### Security model
+
+RedQuilt prioritizes security by default:
+
+```ruby
+# Default: All HTML is escaped, dangerous URLs blocked
+RedQuilt.render_html("<script>alert('xss')</script>")
+# => "<p>&lt;script&gt;alert('xss')&lt;/script&gt;</p>"
+
+RedQuilt.render_html("[click](javascript:alert(1))")
+# => "<p><a href=\"\">click</a></p>"
+```
+
+### Allowed URL schemes
+
+In link/image destinations, only these schemes are permitted:
+
+- Absolute: `http://`, `https://`, `ftp://`, `tel:`, `ssh://`
+- Relative: `/path`, `#anchor`, `path/to/file`
+- Special: `mailto:` (autolinks only)
+
+All other schemes (`javascript:`, `data:`, `vbscript:`, etc.) are blocked by replacing the URL with an empty string.
+
+### Opting into HTML pass-through
+
+```ruby
+# Allow raw HTML (use with trusted input only)
+RedQuilt.render_html(user_markdown, allow_html: true)
+
+# This passes HTML blocks and inline tags through unchanged
+```
+
+## Usage Examples
+
+### Extract all headings
+
+```ruby
+doc = RedQuilt.parse(source)
+headings = doc.root.find_all(:heading)
+
+headings.each do |node|
+  level = node.to_h[:attributes][:level]
+  text = node.text
+  puts "#{'#' * level} #{text}"
+end
+```
+
+### Walk the AST with line numbers
+
+```ruby
+doc = RedQuilt.parse(source)
+
+doc.root.walk do |node|
+  loc = node.source_location
+  if loc
+    puts "#{node.type} at line #{loc[:start_line]}"
+  end
+end
+```
+
+### Export and transform
+
+```ruby
+doc = RedQuilt.parse("# Title\n\nBody with [link](/url)")
+ast = doc.to_ast
+
+# Print AST structure (for debugging)
+pp ast
+
+# Process nodes
+doc.root.find_all(:link).each do |link|
+  attrs = link.to_h[:attributes]
+  puts "Link: #{link.text} → #{attrs[:destination]}"
+end
+```
+
+## Development
+
+### Running tests
+
+```bash
+bundle exec rake spec
+```
+
+Runs 70+ CommonMark compatibility and feature tests.
+
+### Benchmark
+
+```bash
+ruby spec/bench_inline.rb
+ruby spec/bench_block.rb
+```
+
+Profiles parse performance on various Markdown patterns.
+
+## Performance (v0.6.1, Ruby 4.0.5)
+
+Comparison against [kramdown](https://kramdown.gettalong.org/) on arm64-darwin (Apple Silicon), measured with `spec/bench_vs_kramdown.rb` (benchmark-ips):
+
+| Fixture | Size | RedQuilt (i/s) | kramdown (i/s) | RedQuilt vs kramdown |
+|---------|-----:|---------------:|---------------:|---------------------:|
+| short_paragraph | 49 B | 26,531 | 5,416 | 4.90x faster |
+| long_paragraph | 1.4 KB | 981 | 926 | within error |
+| nested_emphasis | 1.4 KB | 999 | 689 | 1.45x faster |
+| many_links | 2.0 KB | 1,131 | 794 | 1.43x faster |
+| mixed_markup | 1.8 KB | 1,028 | 729 | 1.41x faster |
+| deep_nesting | 800 B | 827 | 349 | 2.37x faster |
+| cmark_spec | 205 KB | 39.1 | 30.2 | 1.30x faster |
+
+Reproduce locally:
+
+```bash
+bundle exec ruby spec/bench_vs_kramdown.rb
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec