bidi

Crystal port of the Rust unicode-bidi crate (v0.3.18) — Unicode Bidirectional Algorithm implementation for mixed RTL/LTR text display.

Quick Start

git clone https://github.com/dsisnero/bidi.git
cd bidi
git submodule update --init
make install
make test

Example

require "bidi"

text = "Hello שלום"  # Mixed LTR/RTL text
info = Bidi::BidiInfo.new(text, nil)

para = info.paragraphs[0]
reordered = info.reorder_line(para, para.range)
puts reordered  # "Hello םולש"

# Single paragraph API
info = Bidi::ParagraphBidiInfo.new(text, nil)
puts info.reorder_line(0...text.bytesize)

# Base direction detection
puts Bidi.get_base_direction("Hello")  # Ltr
puts Bidi.get_base_direction("שלום")   # Rtl

API

Rust API	Crystal	Status
`BidiInfo`	`Bidi::BidiInfo`	✅
`ParagraphBidiInfo`	`Bidi::ParagraphBidiInfo`	✅
`UTF16::BidiInfo`	`Bidi::UTF16::BidiInfo`	✅
`UTF16::ParagraphBidiInfo`	`Bidi::UTF16::ParagraphBidiInfo`	✅
`Level`	`Bidi::Level`	✅
`BidiClass`	`Bidi::BidiClass`	✅
`Direction`	`Bidi::Direction`	✅
`get_base_direction`	`Bidi.get_base_direction`	✅
`reorder_visual`	`Bidi::BidiInfo.reorder_visual`	✅

Source Map

Rust (`vendor/unicode-bidi/src/`)	Crystal (`src/bidi/`)
`char_data/mod.rs`, `tables.rs`	`char_data.cr`, `char_data/tables.cr`, `char_data/tables_data.cr`
`level.rs`	`level.cr`
`format_chars.rs`	`format_chars.cr`
`data_source.rs`	`data_source.cr`
`explicit.rs`	`explicit.cr`
`prepare.rs`	`prepare.cr`
`implicit.rs`	`implicit.cr`
`lib.rs`	`info.cr`, `bidi_info_common.cr`
`utf16.rs`	`utf16.cr`
`deprecated.rs`	(not ported)

Development

make install    # Install dependencies (shards install)
make update     # Update dependencies (shards update)
make format     # Format code (crystal tool format)
make lint       # Lint code (format check + ameba)
make test       # Run tests (crystal spec)
make clean      # Clean build artifacts

Documentation

Document	Purpose
Architecture	System design, data flow, type mappings
Development	Setup, workflow, debugging
Coding Guidelines	Code style, error handling, naming
Testing	Test commands, spec file layout
Examples	Usage examples for common scenarios
PR Workflow	Commits, PRs, review process
Parity Tracker	Port status, feature checklist, work plan