rukbat 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6ea385045b568f6f5bae52724b003fcff14728cbcd3906eff5f7fd93e16ec9
-  data.tar.gz: 3e89c333f415e01537198f72e4c54e668da7664d4a3d561e867c2ae95cb6445f
+  metadata.gz: 3a2a475aecf838cbaf8d29c8f72a546dfb56bf3db1fe006693ce4f7dd6a9edc3
+  data.tar.gz: 85e3dd7726823898c5f92072752c97ada40deb073d7f4c557a1f0792c6bf4327
 SHA512:
-  metadata.gz: 546c1d4e7ee470e5cd0b58bd3f28a4c8d74fb50eacefcb4c3875569409770a1195c2da8bcbe83ea61e985f6f093813100baf441db040a91b3baf97871c1d9a0d
-  data.tar.gz: 23b96cef205cd02e05b743423c9c7e2b3220487fabef9810b4389d807cf93aa4b7f959dc5ce3eb0d2c7e97d75bc0b2b2d3117eb4e4b184aabd4be420cd04ceaa
+  metadata.gz: 7c3b8efedcdcc9792c74fbcd3df9d038534b2dddaff73df32feb1e322261a4d2550d642e0ef6989d2c2de714ba8e2fb9dc219ae3f5ad55cf803382575c5b8305
+  data.tar.gz: 89ebb5d63ac35ae5bae9425103bf78a2f3f09039fd152c734d5d5e12b0cae0bd2f40469d88d8deebdf460104ca2261c0634ca8974ff5d9e4042ea19b64a07a7d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.4.0 — 2026-09-24
+
+- Export spreadsheet pages through Zaniah vector recording and Okab PDF drawing while preserving pagination, formatting, and searchable text.
+
 ## 0.3.0 — 2026-09-24
 
 - Add range-based whole-number input validation with undo support.

data/README.md

@@ -1,29 +1,76 @@
-# Rukbat
+<h1 align="center">Rukbat</h1>
 
-Rukbat (α Sagittarii), from Arabic *rukbat al-rāmī* (“the archer’s knee”), is
-a spreadsheet application built on a sparse, persistent Denebola sheet and the
-Furud formula engine.
+<p align="center">
+  <strong>Ruby spreadsheet editor with sparse sheets, live formulas, and CSV/TSV workflows</strong>
+</p>
 
-The current implementation includes a virtualized million-row grid, formula
-editing and completion, multi-sheet formulas, range summaries, undo/redo,
-structural row/column edits, formatting, sorting, filtering, duplicate removal,
-find/replace, comments, named ranges, conditional formatting, basic pivot tables, line/bar/pie,
-donut/scatter/area/stacked charts, CSV/TSV import/export, and searchable PDF
-export. On arm64 macOS
-with Ruby 4.0.6, the million-row integrated scroll benchmark measured 11.383 ms
-against a 16.67 ms budget, and the 100,000-cell edit/recalculation benchmark
-measured 1.773 s against a 3 s budget. Formula compatibility, public CI, and
-dependency releases remain before the first release.
+<p align="center">
+  <a href="https://rubygems.org/gems/rukbat"><img src="https://img.shields.io/gem/v/rukbat.svg" alt="Gem version"></a>
+  <a href="https://rubygems.org/gems/rukbat"><img src="https://img.shields.io/gem/dt/rukbat.svg" alt="Gem downloads"></a>
+  <a href="https://github.com/noxdea/rukbat/actions/workflows/main.yml"><img src="https://github.com/noxdea/rukbat/actions/workflows/main.yml/badge.svg" alt="CI"></a>
+  <img src="https://img.shields.io/badge/Ruby-%3E%3D%203.2-cc342d.svg" alt="Ruby 3.2 or newer">
+  <a href="LICENSE.txt"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license"></a>
+</p>
 
-## Install
+<p align="center">
+  <a href="#features">Features</a> ·
+  <a href="#installation">Installation</a> ·
+  <a href="#quick-start">Quick start</a> ·
+  <a href="#workbook-api">Workbook API</a> ·
+  <a href="#development">Development</a>
+</p>
 
-```ruby
-gem "rukbat"
+---
+
+Rukbat combines [Denebola](https://github.com/noxdea/denebola)'s persistent,
+sparse sheets with [Furud](https://github.com/noxdea/furud)'s formula engine.
+It opens CSV and TSV files in a graphical editor or an interactive terminal,
+and also exposes workbooks as a Ruby API.
+Its name comes from Rukbat (α Sagittarii), Arabic *rukbat al-rāmī*
+(“the archer’s knee”).
+
+## Features
+
+- A virtualized million-row grid with formula editing, completion, multi-sheet references, and range summaries
+- Undo/redo, row and column edits, formatting, sorting, filtering, duplicate removal, find/replace, comments, and named ranges
+- Whole-number input validation, conditional formatting, freeze panes, and static pivot tables
+- Line, bar, pie, donut, scatter, area, and stacked charts in the editor
+- CSV/TSV import and export, plus searchable PDF export with an embedded font
+
+## Installation
+
+Rukbat requires Ruby 3.2 or newer. Install the published gem:
+
+```sh
+gem install rukbat
+rukbat --version
+```
+
+Or add `gem "rukbat"` to your Gemfile. The editor needs a supported desktop
+display or an interactive terminal; the workbook API can be used without one.
+
+## Quick start
+
+Open a CSV file, start a new one, or select tab-delimited input and output:
+
+```sh
+rukbat sales.csv
+rukbat new.csv
+rukbat --tsv data.tsv
 ```
 
-Rukbat requires Ruby 3.2 or newer.
+Use the mouse to select cells, arrow keys to move, and Enter or a double-click
+to edit. The formula bar's **Apply** button commits its value. Save with
+Ctrl-S (Cmd-S on macOS); Ctrl-Z/Cmd-Z undoes, and the shifted shortcut redoes.
+The status bar shows the selected range's count, numeric count, sum, and average.
 
-## Workbooks
+The toolbar provides formats, sorting, filtering, duplicate removal,
+search/replace, comments, named ranges, conditional highlighting, freeze
+panes, print areas, and charts.
+
+## Workbook API
+
+Coordinates and formula references are one-based:
 
 ```ruby
 require "rukbat"
@@ -40,12 +87,28 @@ book.undo
 book.redo
 ```
 
-Workbook coordinates and Furud references are one-based. Denebola storage is
-zero-based internally. Sheets are immutable persistent snapshots, so undo and
-redo retain prior roots instead of copying all cells. The formula engine is
-storage-agnostic; Rukbat adapts sparse range iteration through `CellSource`.
+Denebola stores zero-based, immutable sheet snapshots internally. Undo and
+redo retain prior roots instead of copying every cell; Rukbat feeds sparse
+ranges to Furud through `CellSource`.
+
+### Validation and pivots
+
+Select a range in the editor, enter inclusive bounds, and choose **Apply
+whole-number rule**. Nonblank edits, including calculated formula results,
+must then be whole numbers within the bounds. Invalid edits are rejected
+atomically; existing values are not changed when a rule is added. **Clear
+rule** removes validation from the selected range. Rules follow structural
+edits and undo/redo, but reset when a CSV/TSV workbook is reopened.
 
-## CSV and TSV
+To create a pivot, select a rectangle including its header row, enter the
+one-based key and value column positions within that selection, choose **Sum**
+or **Count**, then **Create pivot**. The result is a static `Pivot` sheet (or
+the next unused `Pivot2`, etc.), not a live link. Formula results are used;
+groups retain first-seen order and match exact key values. Sum accepts finite
+real numbers, while Count counts nonblank values. One Undo removes the
+generated sheet.
+
+## Files and export
 
 ```ruby
 book = Rukbat::CSVFile.read("sales.csv", hint: "Windows-31J")
@@ -53,57 +116,34 @@ Rukbat::CSVFile.write(book, "sales-export.csv")
 Rukbat::CSVFile.read("data.tsv", delimiter: :tsv)
 ```
 
-Import detects and strictly decodes text with Menkar, then infers integer and
-decimal literals while leaving other fields as strings. Export writes UTF-8
-with CRLF row separators; formula cells export their calculated values by
-default. Pass `values: :input` to export stored formulas/inputs instead.
-The application refuses to replace an existing file unless it is the exact
-file read into the workbook and has not changed since loading.
-
-Run `bundle exec rukbat sales.csv` to open the graphical editor. A missing CSV
-path starts a new workbook; `--tsv` selects tab-delimited input and output.
-Use the mouse to select ranges, arrow keys to move, Enter or a double-click to
-edit, and Apply to commit the formula bar value. `Ctrl-S`/`Cmd-S` saves;
-`Ctrl-Z`/`Cmd-Z` undo and the shifted shortcut redoes. The selected range's
-count, numeric count, sum, and average appear in the status bar.
-
-The toolbar provides common number, font, alignment, fill, and border formats;
-sorting, filtering, duplicate removal, search/replace, comments, named ranges,
-positive-value highlighting, freeze/unfreeze panes, print areas, and line, bar,
-pie, donut, scatter, area, stacked-area, and stacked-bar charts.
-Select a range, enter inclusive minimum/maximum values, and choose **Apply whole-number rule**
-to require each nonblank edited value (including a formula's calculated result) to be
-a whole number in that range. Invalid edits are rejected atomically; clearing cells is
-allowed. **Clear rule** removes validation from the selected range, including only the
-selected portion of a larger rule. Rules follow row/column insertions and deletions and
-are included in undo/redo. Existing values are not retroactively changed when a rule is
-applied. Input validations are session metadata: CSV/TSV has no place to store them, so
-they reset when the workbook is reopened. A workbook supports up to 256 validation
-ranges.
-For a pivot, select a source rectangle including its header row, enter the one-based
-key and value column positions relative to that selection, choose **Sum** or **Count**,
-and choose **Create pivot**. Formula results are used; groups match exact key values
-(text is case-sensitive), retain their first-seen order, and blank keys form their own
-group. **Sum** adds finite real numbers only, and **Count**
-counts nonblank values in the selected value column. The output is static data in a new
-`Pivot` sheet (or the next unused `Pivot2`, etc.), not a live link to the source. At most
-100,000 data rows and 10,000 groups can be summarized.
-Creating a pivot leaves its source sheet active. CSV/TSV saves the active sheet only;
-select the pivot sheet before saving if you want to export the summary instead. One
-Undo removes the generated pivot sheet.
-Freeze panes are kept per sheet and restored by undo/redo; the selected cell and
-the row/column headers before it stay visible while scrolling. **Unfreeze** removes
-all frozen rows and columns. Clear highlights removes conditional formatting
-from the active sheet.
-Select a range and choose **Set print area** to constrain PDF export; **Clear
-print area** restores full-sheet output. **Export PDF** prompts for an embeddable
-font and output path, applying the current print area. The CLI can also export
-with `bundle exec rukbat --export-pdf report.pdf --font /path/to/font.ttf`.
-Print areas are also session metadata and reset when the workbook is reopened.
-PDF export embeds the supplied font, resolves formatted font families from the
-system font database, and applies bold/italic along with cell formatting; bold
-and italic are synthesized in the PDF when the selected face has no matching
-variant. Charts are not yet rendered.
+Import uses [Menkar](https://github.com/noxdea/menkar) to detect and decode
+text, infers integer and decimal literals, and leaves other fields as strings.
+Export writes UTF-8 with CRLF row separators and uses calculated formula
+values by default; pass `values: :input` to export stored formulas. Saving an
+opened file rejects external changes made since it was loaded.
+
+CSV/TSV saves only the active sheet. Pivot creation leaves the source sheet
+active, so activate the pivot sheet before exporting its summary. Formatting,
+validation rules, print areas, and other workbook metadata are not stored in
+CSV/TSV.
+
+Set a print area in the editor to limit PDF output, then choose **Export PDF**
+and supply an embeddable font. The command line can export directly:
+
+```sh
+rukbat --export-pdf report.pdf --font /path/to/font.ttf sales.csv
+```
+
+PDF export draws formatted cells from Zaniah's vector recording and keeps text
+searchable in Okab's PDF output. Charts are not rendered
+in PDFs. Print areas reset when the workbook is reopened.
+
+## Limits
+
+- Workbooks support 1,048,576 rows and 16,384 columns; the grid renders visible cells rather than all rows at once.
+- A workbook supports up to 256 validation ranges. A pivot handles up to 100,000 data rows and 10,000 groups.
+- CSV/TSV export is limited to 10 million cells; PDF export is limited to 100,000 cells.
+- Rukbat does not open or save XLSX/ODS files. CSV/TSV does not preserve multiple sheets or workbook metadata.
 
 ## Development
 
@@ -115,6 +155,6 @@ bundle exec rbs -I sig -I "$(bundle info --path furud)/sig" -I "$(bundle info --
 gem build --strict rukbat.gemspec
 ```
 
-The implementation is not yet a `0.1.0` release. Local performance gates pass;
-check the workplan's M17 acceptance gate for remaining compatibility, public
-CI, and dependency-release checks.
+## License
+
+Rukbat is released under the [MIT License](LICENSE.txt).

data/lib/rukbat/pdf_file.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "tempfile"
+require "zaniah/vector"
+require "okab/zaniah_vector"
 
 module Rukbat
   module PDFFile
@@ -25,14 +27,17 @@ module Rukbat
       columns = area ? area.right - area.left + 1 : [current.column_count, 1].max
       raise Error, "PDF export exceeds #{MAX_CELLS} cells" if rows * columns > MAX_CELLS
 
+      renderer = Zaniah::TextSystem::Renderer.new(font: font.face)
       document = Okab::Document.new(title: "#{sheet} — Rukbat", author: "Yudai Takada", creator: "Rukbat")
       (0...rows).step(ROWS_PER_PAGE) do |row_offset|
         (0...columns).step(COLUMNS_PER_PAGE) do |column_offset|
-          render_page(document, workbook, font, font_db, font_cache, sheet, origin_row, origin_column, row_offset, column_offset,
+          render_page(document, workbook, font, renderer, font_db, font_cache, sheet, origin_row, origin_column, row_offset, column_offset,
             [rows - row_offset, ROWS_PER_PAGE].min, [columns - column_offset, COLUMNS_PER_PAGE].min)
         end
       end
       document.render
+    ensure
+      renderer&.close
     end
 
     def write(workbook, path, font:, sheet: workbook.active_sheet, font_db: nil)
@@ -55,22 +60,35 @@ module Rukbat
       raise Error, "cannot write PDF: #{error.message}"
     end
 
-    def render_page(document, workbook, font, font_db, font_cache, sheet, origin_row, origin_column, row_offset, column_offset, row_count, column_count)
-      document.page(width: PAGE_WIDTH, height: PAGE_HEIGHT) do |page|
-        first_row = origin_row + row_offset + 1
-        last_row = first_row + row_count - 1
-        page.text("#{sheet} — rows #{first_row}-#{last_row}",
-          x: MARGIN, y: PAGE_HEIGHT - MARGIN, font: font, size: 10)
-        data_top = PAGE_HEIGHT - MARGIN - 24
-        (0..row_count).each do |row_index|
-          (0..column_count).each do |column_index|
-            x = MARGIN + (column_index.zero? ? 0 : 38 + (column_index - 1) * CELL_WIDTH)
-            width = column_index.zero? ? 38 : CELL_WIDTH
-            y = data_top - row_index * CELL_HEIGHT
-            text, style = cell_text(workbook, sheet, origin_row, origin_column,
-              row_offset, column_offset, row_index, column_index)
-            paint_cell(page, text, style, font_for_style(style, font, font_db, font_cache), x, y, width)
+    def render_page(document, workbook, font, renderer, font_db, font_cache, sheet, origin_row, origin_column,
+      row_offset, column_offset, row_count, column_count)
+      styled_text = []
+      vector = Zaniah::Vector.record(width: PAGE_WIDTH, height: PAGE_HEIGHT, text_system: renderer) do
+        Zaniah::Canvas.new do |_bounds, cx|
+          scene = cx.scene
+          first_row = origin_row + row_offset + 1
+          last_row = first_row + row_count - 1
+          header = "#{sheet} — rows #{first_row}-#{last_row}"
+          renderer.paint_line(scene, renderer.layout_line(header, font: font.face, size: 10),
+            x: MARGIN, y: MARGIN, color: "#000000")
+          data_top = PAGE_HEIGHT - MARGIN - 24
+          (0..row_count).each do |row_index|
+            (0..column_count).each do |column_index|
+              x = MARGIN + (column_index.zero? ? 0 : 38 + (column_index - 1) * CELL_WIDTH)
+              width = column_index.zero? ? 38 : CELL_WIDTH
+              y = data_top - row_index * CELL_HEIGHT
+              text, style = cell_text(workbook, sheet, origin_row, origin_column,
+                row_offset, column_offset, row_index, column_index)
+              paint_cell(scene, styled_text, renderer, text, style,
+                font_for_style(style, font, font_db, font_cache), x, y, width)
+            end
           end
+        end.w(PAGE_WIDTH).h(PAGE_HEIGHT)
+      end
+      document.page(width: PAGE_WIDTH, height: PAGE_HEIGHT) do |page|
+        Okab::ZaniahVector.draw(page, vector)
+        styled_text.each do |text, x, y, font, size, color, bold, italic|
+          page.text(text, x: x, y: y, font: font, size: size, color: color, bold: bold, italic: italic)
         end
       end
     end
@@ -87,13 +105,11 @@ module Rukbat
     end
     private_class_method :cell_text
 
-    def paint_cell(page, text, style, font, x, top, width)
+    def paint_cell(scene, styled_text, renderer, text, style, font, x, top, width)
       y = top - CELL_HEIGHT
-      if style[:background]
-        page.rect(x, y, width, CELL_HEIGHT).fill(rgb(style[:background]))
-      end
-      page.rect(x, y, width, CELL_HEIGHT).stroke(rgb(style[:border_color] || "#B8BEC8"),
-        width: style[:border_width] || 0.5)
+      scene.quad(x, PAGE_HEIGHT - top, width, CELL_HEIGHT,
+        color: style[:background] || "#0000", border_color: style[:border_color] || "#B8BEC8",
+        border_width: style[:border_width] || 0.5)
       text = text.to_s.lines.first.to_s.chomp
       text = text.encode(Encoding::UTF_8)
       # ponytail: fixed-height PDF rows cap text at 13pt; variable page geometry can lift the ceiling.
@@ -111,8 +127,15 @@ module Rukbat
         when :bottom then y + 2
         else y + (CELL_HEIGHT - size) / 2
         end
-        page.text(text, x: text_x, y: baseline, font: font, size: size,
-          color: rgb(style[:color] || "#20242C"), bold: style[:bold] || false, italic: style[:italic] || false)
+        color = style[:color] || "#20242C"
+        if style[:bold] || style[:italic]
+          # GlyphRun has no synthetic-style fields; retain Okab's searchable
+          # faux-bold/italic text operator for those cells only.
+          styled_text << [text, text_x, baseline, font, size, rgb(color), !!style[:bold], !!style[:italic]]
+        else
+          renderer.paint_line(scene, renderer.layout_line(text, font: font.face, size: size),
+            x: text_x, y: PAGE_HEIGHT - baseline, color: color)
+        end
       end
     end
     private_class_method :paint_cell

data/lib/rukbat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rukbat
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rukbat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: spica
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.9.0
 description: A Ruby spreadsheet app built on persistent sparse sheets and the Furud
   calculation engine.
 email: