inkmark 0.1.0-x86_64-linux → 0.1.2-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b116ee9f04b19a57ba1bf985c9dd372b361246d90780a913d08ab3b034c13092
-  data.tar.gz: 5b5d9691fd1d91b64fa3ef8dcd7af8dee83c747c5fc6718983a38a112784cc81
+  metadata.gz: bad7213c3988c5b14773d0f35819253a35ac7c5feed26a05b61567705a5f211d
+  data.tar.gz: a2b0dd76afc2d15b811ac318c26d40f96e571e1e6fdbfdda2bdee99c7d764d69
 SHA512:
-  metadata.gz: ec32f93d77ac6218f43b113f05bbd95c780daa7561f12ac20b7edc91ecb68ee83f34a4197abc9738ebfbb52986b386f28ec403b872c316703de7f167c4d6c876
-  data.tar.gz: 797ac1cb0416f55a0f81393d13b259fa9de97c99b43e26eea658a4eafefc1890b3877bb9c2178fd2a48671cadeafbe74083ebf000d42eeb1b6966346c941218f
+  metadata.gz: b8b010daac54b71e9b66f35a08787f4fa42421d002de4edd01b9317ff97ac9f882a7d66b56deb3a2404828c3ba9e7565676e19c8d304f73dee6c77d1662e9631
+  data.tar.gz: 220d5715c270a05adf091c9eb0745024db9a08862f5d7f2284640d3db994b686e9381bd7fa68d01f7ca8da0dfeb29d55062ed99dd082842e3d419d8128f25fb3

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.1.2] - 2026-06-21
+
+- Fix `Inkmark.truncate_markdown` raising `TypeError` when called without explicit `options:`.
+- Update dependencies on the Rust side.
+
+## [0.1.1] - 2026-04-22
+
+- Strip DWARF debug info from shipped Linux and Windows binaries via `strip = "debuginfo"`.
+
 ## [0.1.0] - 2026-04-22
 
 - Initial public release

data/README.md

@@ -1,6 +1,6 @@
 # Inkmark
 
-A very fast, feature-packed, AI-first markdown gem for Ruby.
+A very fast, feature-packed, AI-first Markdown gem for Ruby.
 
 [![GitHub Release](https://img.shields.io/github/v/release/yaroslav/inkmark)](https://github.com/yaroslav/inkmark/releases)
 [![Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/gems/inkmark)
@@ -12,12 +12,17 @@ A very fast, feature-packed, AI-first markdown gem for Ruby.
 - **Very fast**. Up to 1.3× faster than redcarpet _(not CommonMark-conformant)_, about 3×–9× faster than other Ruby Markdown gems with native extensions. Built with Rust, based on [pulldown-cmark](https://github.com/pulldown-cmark/pulldown-cmark), uses SIMD.
 - **No surprises**. CommonMark + GitHub Flavored Markdown conformance.
 - **"Batteries included" approach**. Build lots of useful features, make them easy to use and as fast as possible.
-- **Easy to use**. As simple as a one-method API. Pass options inline as a hash, set them one by one, or set default options for the entire application. 
-- **Feature-packed**. Server-side syntax highlighting with themes, frontmatter support, table of contents in Markdown and HTML, plain text export, extraction of headers/links/images, statistics (character and word count, likely document language, blocks count), lazy image loading attributes, emoji shortcodes, autolinks, heading IDs with Unicode-transliterated slugs, wikilinks, footnotes, tables, task lists, smart punctuation, hard wraps, "nofollow/noopener" on external links.
+- **Easy to use**. As simple as a one-method API. Pass options inline as a hash, set them one by one, or set default options for the entire application.
+- **Feature-packed**. Server-side syntax highlighting with themes, frontmatter support, table of contents in Markdown and HTML, plain text export, extraction of headings/links/images, statistics (character and word count, likely document language, blocks count), lazy image loading attributes, emoji shortcodes, autolinks, heading IDs with Unicode-transliterated slugs, wikilinks, footnotes, tables, task lists, smart punctuation, hard wraps, "nofollow/noopener" on external links.
 - **AI-first**. Two chunking primitives: heading-based with breadcrumbs and per-chunk character/word counts, and sliding-window with overlap for size-bounded chunks where headings are absent or uneven. Block-aware or word-aware truncation for context-window budgeting. Markdown-to-Markdown pipeline. Plain-text extraction for embedding models. Structured extraction of headings, images, links, code blocks—each carrying byte ranges back into the source.
 - **Security conscious**. Raw HTML denied by default. Hostname and URL-scheme allowlists for both links and images. GFM tagfilter for dangerous tags. A Rust-backed gem.
 - **Easy extension API**. Hook any element with a Ruby block—no subclassing, no intermediate AST, no HTML post-processing. Rewrite URLs, swap code blocks for your own renderer, drop subtrees, or just walk the document for analysis. Handlers fire inside the single-pass parser, so extension costs essentially nothing beyond the render itself—and far less than regexing over output HTML.
 
+**See the introductory post for background and motivation**:
+
+**[Inkmark: a very fast, feature-packed, AI-first Markdown gem for Ruby
+](https://yaroslav.io/posts/inkmark-fast-ai-first-markdown)**
+
 ## Contents
 
 - [Installation](#installation)
@@ -50,6 +55,8 @@ gem "inkmark"
 
 Ruby 3.3+ is supported.
 
+The gem comes precompiled, a compiler toolchain is _not_ required for installation.
+
 ## Quick start
 
 ```ruby
@@ -91,7 +98,7 @@ for nested element-policy hashes). You can—and are recommended to!—override
 - **`:trusted`**: `:recommended` plus raw HTML pass-through.
   **Dangerous.** Intended only for content you fully trust: internal,
   team-authored. With raw HTML on, Inkmark does no sanitization beyond
-  the narrow GFM tagfilter (turn it off on your own risk); the caller is
+  the narrow GFM tagfilter (turn it off at your own risk); the caller is
   responsible for output safety. Do not apply this preset to anything a user can influence, directly or indirectly.
 
 - **`:gfm`**: the bare default. CommonMark plus the core GFM extensions
@@ -129,7 +136,7 @@ Inkmark.to_html(internal_doc, options: { preset: :trusted })
 ## Options
 
 GFM extensions are on by default; raw HTML rendering is off by default.
-Pass a hash to `Inkmark.to_html` / `Inkmark.new`, or mutate a `Inkmark::Options`
+Pass a hash to `Inkmark.to_html` / `Inkmark.new`, or mutate an `Inkmark::Options`
 instance via its accessors.
 
 | Key | Default | Description |
@@ -158,7 +165,7 @@ instance via its accessors.
 | `wikilinks` | `false` | `[[Page]]` and `[[Page\|label]]` render as links. |
 | `frontmatter` | `false` | Frontmatter (YAML metadata at the start of the document). Parsed and exposed via `Inkmark#frontmatter`; the block is stripped from rendered output. |
 
-Options can be supplied either way:
+Options can be supplied in several ways:
 
 ```ruby
 # As a hash at construction
@@ -185,7 +192,7 @@ Inkmark.new("x", options: { taples: true })
 
 ## Raw HTML
 
-Raw HTML is suppressed by default. This is safe-by-default for rendering untrusted markdown:
+Raw HTML is suppressed by default. This is safe-by-default for rendering untrusted Markdown:
 
 ```ruby
 Inkmark.to_html("<script>alert(1)</script>")
@@ -248,7 +255,7 @@ relative URLs.
 
 ## URL scheme filtering
 
-For rendering untrusted markdown, opt in to scheme allowlists to block
+For rendering untrusted Markdown, opt in to scheme allowlists to block
 `javascript:`, `data:`, and other dangerous URL schemes in links and
 images:
 
@@ -274,7 +281,7 @@ Inkmark.to_html("![pic](data:image/svg+xml,<svg/onload=evil()>)",
 # => "<p>pic</p>\n"   # dropped to alt text
 ```
 
-**Scope:** scheme filtering applies to markdown-emitted links and images
+**Scope:** scheme filtering applies to Markdown-emitted links and images
 (`[text](url)` / `![alt](url)`). Raw HTML `<a href>` / `<img src>` inside
 `raw_html: true` content is *not* filtered—for that case use a
 downstream HTML sanitizer like Loofah.
@@ -394,7 +401,7 @@ parent. Root-level sections and the preamble have an empty array. Skipped
 levels are omitted, so an `###` directly under an `#` has `breadcrumb:
 ["Top"]`, not `["Top", nil]`. RAG pipelines typically prepend the
 breadcrumb to each chunk before embedding—it gives the vector model a
-cheap signal about the chunk's place in the document:
+cheap signal about the chunk's place in the document.
 
 Enable `statistics: true` to add `:character_count` and `:word_count` to
 every section entry. Counts reflect the section's filter-applied text
@@ -460,7 +467,7 @@ embedding quality for downstream semantic search.
 sections = Inkmark.chunks_by_heading(doc, options: {
   emoji_shortcodes: true,    # keep—improves semantic signal
   links: {
-    autolink:        true,                # keep—proper anchor markdown
+    autolink:        true,                # keep—proper anchor Markdown
     allowed_schemes: %w[http https mailto], # keep—safe URLs
     nofollow:        false                 # off—would embed <a rel=...> HTML
   },
@@ -907,7 +914,10 @@ Use `parent_kind` and `ancestor_kinds` for context-sensitive decisions:
 md.on(:image) { |img| img.delete if img.ancestor_kinds.include?(:link) }
 
 # Only process top-level paragraphs
-md.on(:paragraph) { |p| next unless p.parent_kind.nil? }
+md.on(:paragraph) do |p|
+  next unless p.parent_kind.nil?
+  # ... only top-level paragraphs reach here
+end
 ```
 
 `depth` gives the nesting level (0 = top-level block):
@@ -927,7 +937,7 @@ original source to recover the raw Markdown for any element:
 source = File.read("post.md")
 md = Inkmark.new(source)
 md.on(:heading) do |h|
-  puts "#{h.byte_range}: #{source[h.byte_range].inspect}"
+  puts "#{h.byte_range}: #{source.byteslice(h.byte_range).inspect}"
 end
 md.walk
 ```
@@ -939,7 +949,7 @@ and `:hard_break`. Also `nil` for `:link` when `links: { autolink: true }` is en
 
 ### Event object reference
 
-Every handler receives a `Inkmark::Event` with these fields and methods:
+Every handler receives an `Inkmark::Event` with these fields and methods:
 
 | Field / method | Type | Description |
 |---|---|---|
@@ -972,7 +982,7 @@ Every handler receives a `Inkmark::Event` with these fields and methods:
 | `:list` |—| `html=`, `markdown=` |
 | `:ordered_list` |—| `html=`, `markdown=` |
 | `:list_item` | `text` | `html=`, `markdown=` |
-| `:code_block` | `text`, `lang` | `html=`, `markdown=` |
+| `:code_block` | `text` (alias `source`), `lang` | `html=`, `markdown=` |
 | `:table` |—| `html=`, `markdown=` |
 | `:table_head` |—| `html=`, `markdown=` |
 | `:table_row` | `text` | `html=`, `markdown=` |
@@ -1023,7 +1033,7 @@ Post-render filters (`syntax_highlight`, allowlists, `images: { lazy: true }`,
 
 Inkmark ships a benchmark harness comparing it against `kramdown`,
 `commonmarker`, `redcarpet`, `markly`, and `rdiscount` on a sweep of real
-markdown inputs. 
+Markdown inputs.
 
 Measuring apples to apples: every adapter is tuned for **feature parity** with
 Inkmark's defaults—CommonMark + core GFM (tables, strikethrough, tasklists,

data/lib/inkmark/version.rb

@@ -2,5 +2,5 @@
 
 class Inkmark
   # Current gem version.
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/inkmark.rb

@@ -222,7 +222,13 @@ class Inkmark
       params = normalize_truncate_params(
         chars: chars, words: words, at: at, marker: marker
       )
-      _native_truncate_markdown(source, params, resolve_frozen_options(options))
+      # truncate's native binding requires an options Hash; unlike the
+      # to_html/to_plain_text bindings it has no nil fast path, so fall
+      # back to the default options hash when the resolver returns nil.
+      _native_truncate_markdown(
+        source, params,
+        resolve_frozen_options(options) || default_options.to_native_hash_frozen
+      )
     end
 
     # Render +source+ through the filter pipeline and serialize to plain

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inkmark
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: x86_64-linux
 authors:
 - Yaroslav Markin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-04-22 00:00:00.000000000 Z
+date: 2026-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A very fast, feature-packed, AI-first markdown (CommonMark/GFM) gem for
+description: A very fast, feature-packed, AI-first Markdown (CommonMark/GFM) gem for
   Ruby, based on pulldown-cmark (Rust).
 email:
 - yaroslav@markin.net
@@ -174,5 +174,5 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
-summary: Very fast, feature-packed, AI-first markdown gem for Ruby.
+summary: Very fast, feature-packed, AI-first Markdown gem for Ruby.
 test_files: []