rbxl 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b16579845423af49cff940ed7557164236d66b2e3e7f92e8bcece2a69c486e0
-  data.tar.gz: 3976e30db04742ea0b22b5d1edf95bccaf269e0ee6b6d209af3fe14bbaace7f0
+  metadata.gz: d17b36b2ac6f09ffead848335751f05b6213d804243ba9056f7522cf54c683db
+  data.tar.gz: 790a5a387010f137caedd61a88d89569a238c165eeac3b5d5f6fe1b58c032712
 SHA512:
-  metadata.gz: 2dcba5f510b571dd546ca36b8c86dd607dd406298691e71bf01575e124c15bac6f526bcdb8aa7183f4980fb06c16e7dfe8b4d0f7ce3743c57b214f5e90d6c1c4
-  data.tar.gz: 2cd7f062d75b0af0ae1fdbe13606dcbe5b1c6df0d2aa48be94e7ef2b06bf178ef8ae315d8c9c1c11629b265d9f2829beef60f4127294ac7a91b4de088f4d2a09
+  metadata.gz: c4ea18b5ddba87bc83950fd4b92267963ab213b5ef95740e1abdde9abf4688f07b2c59f4bcf33f5bbd59b57811347bee5924f7338b2ac0411e42a628aec3e06e
+  data.tar.gz: c9e84af9e9dca0758f6799b8569d91f9e18218e1fbe0bba9a3f6827c050ebf262c793a5a4fcf19d97fab5c64630f197a15ee9e7cbcd6b8431b382da334e44228

data/CHANGELOG.md

@@ -4,6 +4,50 @@ All notable changes to this project are documented here. The format is based
 on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
 follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.0] - 2026-10-31
+
+### Changed
+
+- The `rubyzip` dependency is widened from `~> 2.3` to `>= 2.4, < 4`, so
+  rbxl now installs alongside rubyzip 3.x. The floor moves to 2.4, the
+  first release accepting the `create:` keyword that 3.x requires. No
+  library code changes were needed; the test suite passes against both
+  rubyzip 2.4 and 3.x.
+
+## [1.4.0] - 2026-05-01
+
+### Added
+
+- `Rbxl.open(path, edit: true)` opens a new `Rbxl::EditableWorkbook` for
+  surgical read-modify-save passes against an existing `.xlsx`. The design
+  promise is borrowed from rbpptx: parts you don't touch round-trip
+  byte-for-byte (`copy_raw_entry` straight from the source ZIP), and inside
+  a worksheet you do edit only the targeted `<c>` element is rewritten —
+  sibling cells, row attributes, `<mergeCells>`, `<conditionalFormatting>`,
+  `<dataValidations>`, comments, drawings, charts, pivot caches, and any
+  unknown OOXML extensions stay in place. The cell's `s` (style index)
+  attribute survives an overwrite so template number formats, fonts, and
+  fills carry through to the new value. Cells written by this mode become
+  inline strings (`t="inlineStr"`); `xl/sharedStrings.xml` is never
+  mutated, so the output is deterministic without a second SST pass.
+  Touched sheets are parsed as full Nokogiri DOMs, so this is the right
+  tool for template fill-ins — not for rewriting the data area of a large
+  worksheet (use `Rbxl.new` for that). `Rbxl::EditableCell#value=` accepts
+  `nil`, `String`, `Integer`, `Float`, and `true`/`false`; `Date`/`Time`
+  raise `Rbxl::EditableCellTypeError` so 1.4.0 doesn't ship a half-baked
+  numFmt write. New cells (and their enclosing rows) are inserted in
+  column- and row-sorted positions.
+- `Rbxl::EditableWorkbook#save` accepts no path to save in place,
+  rewriting the original via temp file plus atomic rename so a crash
+  mid-save never produces a half-written workbook.
+
+### Changed
+
+- Shared-strings parsing factored into `Rbxl::SharedStringsLoader` so the
+  read-only and editable workbooks share a single SST decoder rather than
+  carrying parallel copies. Behavior and limits (`Rbxl.max_shared_strings`,
+  `Rbxl.max_shared_string_bytes`) are unchanged.
+
 ## [1.3.0] - 2026-04-27
 
 ### Added

data/README.md

@@ -2,11 +2,14 @@
 
 [![Gem Version](https://badge.fury.io/rb/rbxl.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/rbxl)
 
-Fast, memory-friendly Ruby gem for row-by-row `.xlsx` reads and append-only writes.
+Fast, memory-friendly Ruby gem for row-by-row `.xlsx` reads, surgical edits
+of existing `.xlsx` files, and append-only writes.
 
-`rbxl` is built for the two workbook workflows that scale cleanly:
+`rbxl` is built for the three workbook workflows that scale cleanly:
 
 - read-only row-by-row iteration
+- read-modify-save surgical edits ("template fill-in") that round-trip
+  every untouched part byte-for-byte
 - write-only workbook generation
 
 The API is intentionally small and `openpyxl`-inspired, with an optional
@@ -16,30 +19,42 @@ Supported:
 
 - write-only workbook generation
 - read-only row-by-row iteration
+- read-modify-save surgical edits via `Rbxl.open(path, edit: true)` —
+  byte-for-byte preservation of untouched parts (styles, drawings, charts,
+  comments, pivot caches, custom XML, untouched sheets)
 - opt-in date/time conversion driven by the workbook's `numFmt` styles
 - optional C extension (`rbxl/native`) for maximum performance
 
 Out of scope:
 
-- in-place editing of an existing `.xlsx` file — rbxl opens workbooks
-  read-only and generates new workbooks write-only, with no read-modify-save
-  path. If you need to open a file, tweak a handful of cells, and write it
-  back preserving everything else, use a full-object-model library instead.
+- bulk rewrites of a worksheet's data area in edit mode — use the
+  write-only mode (`Rbxl.new`) for that. Edit mode is the right tool for
+  template fill-ins (a handful of cells in a templated workbook); the
+  touched sheet is loaded into a Nokogiri DOM, so memory scales with that
+  sheet's on-disk size
+- inserting / deleting / reordering / duplicating sheets
+- editing styles, formulas, named ranges, drawings, or shared strings
+- `Date` / `Time` / `DateTime` writes via edit mode (raise
+  `Rbxl::EditableCellTypeError`); convert to a numeric Excel serial
+  yourself if you need a date cell
 - legacy `.xls` (BIFF/CFB) input — rbxl reads OOXML `.xlsx` only. Convert
   first, e.g. `libreoffice --headless --convert-to xlsx file.xls` or
   `ssconvert file.xls file.xlsx` (Gnumeric). `Rbxl.open` detects the OLE
   compound-file magic on open and raises `Rbxl::UnsupportedFormatError`
   with the conversion hint rather than surfacing an opaque ZIP parse
   error from rubyzip.
-- preserving arbitrary workbook structure on save
-- rich style round-tripping
-- formulas, images, charts, comments
+- preserving arbitrary workbook structure on _write-only_ save (edit mode
+  preserves every untouched part)
+- rich style round-tripping when generating new workbooks
+- formulas, images, charts, comments — readable in edit mode, but not
+  introspected or edited
 
 ## Usage
 
-`Rbxl.open` defaults to read-only and `Rbxl.new` defaults to write-only;
-the `read_only:` / `write_only:` keywords remain for call-site clarity and
-to leave room for a future read/write mode.
+`Rbxl.open` defaults to read-only, `Rbxl.open(path, edit: true)` opens an
+existing workbook for surgical edits, and `Rbxl.new` defaults to
+write-only. The mode is selected by the wrapper at the module level so the
+call site doesn't have to juggle backend classes.
 
 ### Writing a new workbook
 
@@ -233,6 +248,83 @@ default; leaving it off skips the styles parse entirely and keeps the
 native fast path in use. Turning it on routes reads through the pure-Ruby
 worksheet parser.
 
+### Editing an existing workbook
+
+Open a workbook in edit mode to surgically replace cell values without
+rebuilding the file from scratch. The classic use case is template
+fill-in: open a stylized template, write a handful of named cells, save
+back. Every part you don't touch — styles, drawings, charts, comments,
+pivot caches, custom XML, untouched worksheets — round-trips byte-for-byte
+straight from the source ZIP, so unknown OOXML extensions and
+PowerPoint-style add-ins survive the save.
+
+```ruby
+require "rbxl"
+
+Rbxl.open("template.xlsx", edit: true) do |book|
+  sheet = book.sheet("Invoice")
+  sheet["B2"].value = "Acme Inc."
+  sheet["B3"].value = Date.today.strftime("%Y-%m-%d")  # Strings are fine
+  sheet["E10"].value = 1_250.0                          # Numbers are fine
+  book.save("invoice-acme.xlsx")
+end
+```
+
+`book.save` with no argument overwrites the original file via temp file
+plus atomic rename, so a crash mid-save never produces a half-written
+workbook:
+
+```ruby
+Rbxl.open("template.xlsx", edit: true) do |book|
+  book.sheet(0)["A1"].value = "Q3 results"
+  book.save                # in-place, atomic
+end
+```
+
+Inside an edited worksheet, only the targeted `<c>` element is rewritten;
+sibling cells, the row's other attributes, `<mergeCells>`,
+`<conditionalFormatting>`, `<dataValidations>`, and any unknown OOXML
+extensions remain in place. The cell's `s` (style index) attribute is
+preserved when you overwrite an existing cell, so template formatting
+(number format, font, fill, alignment) carries through. New cells (and
+their enclosing rows) are inserted in column- and row-sorted positions.
+
+`EditableCell#value=` accepts:
+
+| Ruby                    | XLSX representation              |
+|-------------------------|----------------------------------|
+| `nil`                   | empty cell (preserves `s` style) |
+| `String`                | `t="inlineStr"` with `<is><t/>`  |
+| `Integer`, `Float`      | `<v>` numeric (no `t` attribute) |
+| `true`, `false`         | `t="b"` with `<v>1</v>`/`<v>0</v>` |
+| `Date`, `Time`          | raises `Rbxl::EditableCellTypeError` |
+
+Strings always round-trip as inline strings — `xl/sharedStrings.xml` is
+never mutated, so the SST entries that the cells you _didn't_ touch still
+reference stay byte-identical, and the touched cells get their text
+inlined. The trade-off is that overwriting a previously-shared-string
+cell leaves an orphaned SST entry; for template fill-ins that's
+negligible, and it's the simplest design that guarantees deterministic
+output.
+
+`Date`/`Time`/`DateTime` writes raise `Rbxl::EditableCellTypeError` in
+1.4.0 — the cell's `numFmt` style would also have to be the right
+date-pattern style for Excel to render the value, and silently picking
+one is the kind of magic this design promise is built to avoid. Convert
+to an Excel serial yourself if you need a date cell, and rely on the
+template's existing date-formatted style index to render it.
+
+#### Out of scope for edit mode
+
+- inserting / deleting / reordering / duplicating sheets
+- editing styles, formulas, named ranges, drawings, or shared strings
+- recomputing the worksheet `<dimension>` when a write expands the bounds
+  (Excel recomputes on open; openpyxl-style normalization may arrive in
+  a later release)
+- bulk rewrites of a worksheet's data area — touched sheets are loaded
+  into a Nokogiri DOM, so memory scales with that sheet's size on disk.
+  For data-area rewrites, use `Rbxl.new` instead.
+
 ## Native C Extension
 
 Add a single `require` to opt-in to the libxml2-based C extension for

data/lib/rbxl/editable_cell.rb

@@ -0,0 +1,176 @@
+module Rbxl
+  # A view onto a single +<c>+ element inside an {EditableWorksheet}.
+  #
+  # Cells are not stored — each call to {EditableWorksheet#cell} returns a
+  # fresh {EditableCell} that resolves the underlying +<c>+ node on demand.
+  # Reads decode the current XML; writes mutate the worksheet's DOM and
+  # mark the sheet dirty so the next {EditableWorkbook#save} re-serializes
+  # it.
+  #
+  # == Type matrix on write
+  #
+  # * +nil+ — clears the cell's value (children + +t+ attribute removed),
+  #   leaving an empty +<c>+ that retains its +s+ (style index)
+  # * +true+ / +false+ — boolean cell (+t="b"+)
+  # * +Integer+ / +Float+ — number cell (no +t+ attribute)
+  # * +String+ — inline string cell (+t="inlineStr"+); +xl/sharedStrings.xml+
+  #   is never mutated, so this round-trips deterministically without a
+  #   second pass over the SST
+  # * +Date+ / +Time+ / +DateTime+ — raises {EditableCellTypeError}; convert
+  #   to a numeric serial yourself if you need a date cell. Date support is
+  #   intentionally deferred so 1.4.0 doesn't ship a half-baked numFmt write
+  #
+  # When overwriting an existing cell, the +s+ (style index) attribute is
+  # preserved so template formatting (number format, font, fill, alignment)
+  # carries through to the new value. Any +<f>+ (formula) and cached +<v>+
+  # are dropped — assigning a value means the cell is no longer a formula.
+  class EditableCell
+    # Namespace for the main SpreadsheetML schema.
+    MAIN_NS = "http://schemas.openxmlformats.org/spreadsheetml/2006/main".freeze
+
+    # @return [String] Excel-style coordinate, e.g. +"B5"+
+    attr_reader :coordinate
+
+    # @api private
+    # Construct via {EditableWorksheet#cell}; not for direct use.
+    #
+    # @param worksheet [EditableWorksheet]
+    # @param coordinate [String] already-normalized +A1+-style coordinate
+    def initialize(worksheet:, coordinate:)
+      @worksheet = worksheet
+      @coordinate = coordinate
+    end
+
+    # Decodes the current value of the cell.
+    #
+    # @return [String, Integer, Float, true, false, nil] the cell's value, or
+    #   +nil+ if the cell does not exist or has no stored value. Boolean
+    #   cells return +true+/+false+; numeric cells return +Integer+ when the
+    #   stored value is integer-shaped, +Float+ otherwise; +t="s"+ cells
+    #   resolve through the workbook's shared strings table; +t="inlineStr"+
+    #   and +t="str"+ cells return the literal text
+    def value
+      node = @worksheet.find_or_create_cell_node(@coordinate, create: false)
+      return nil unless node
+
+      decode(node)
+    end
+
+    # Sets the cell's value. See the class-level "Type matrix on write"
+    # documentation for accepted Ruby types and how each is serialized.
+    #
+    # @param new_value [String, Integer, Float, true, false, nil]
+    # @return [Object] +new_value+
+    # @raise [Rbxl::EditableCellTypeError] for unsupported types
+    #   (+Date+/+Time+, arbitrary objects)
+    def value=(new_value)
+      reject_unsupported_type!(new_value)
+
+      node = @worksheet.find_or_create_cell_node(@coordinate, create: true)
+      apply_value(node, new_value)
+      @worksheet.mark_dirty!
+      new_value
+    end
+
+    private
+
+    WHITESPACE_BYTES = [" ".ord, "\t".ord, "\n".ord, "\r".ord].freeze
+    private_constant :WHITESPACE_BYTES
+
+    def reject_unsupported_type!(value)
+      case value
+      when nil, true, false, Integer, Float, String
+        # supported
+      when Date, Time, DateTime
+        raise EditableCellTypeError,
+              "Date/Time/DateTime are not supported by EditableCell in 1.4.0; " \
+              "convert to a numeric Excel serial yourself if you need a date cell"
+      when Numeric
+        # other Numerics (Rational, BigDecimal) — coerce to Float on apply
+      else
+        raise EditableCellTypeError,
+              "unsupported cell value type: #{value.class}"
+      end
+    end
+
+    def apply_value(node, value)
+      node.children.unlink
+      node.delete("t")
+
+      case value
+      when nil
+        # empty cell — preserve <c r="..." s="..."/>
+      when true
+        node["t"] = "b"
+        node.add_child("<v>1</v>")
+      when false
+        node["t"] = "b"
+        node.add_child("<v>0</v>")
+      when Integer
+        node.add_child("<v>#{value}</v>")
+      when Float
+        # Ruby's Float#to_s gives the shortest round-trippable form. Excel
+        # accepts standard decimal and scientific notation as <v> text.
+        node.add_child("<v>#{value}</v>")
+      when String
+        node["t"] = "inlineStr"
+        text = CGI.escapeHTML(value)
+        space_attr = preserve_whitespace?(value) ? ' xml:space="preserve"' : ""
+        node.add_child("<is><t#{space_attr}>#{text}</t></is>")
+      when Numeric
+        node.add_child("<v>#{value.to_f}</v>")
+      end
+    end
+
+    def decode(node)
+      type = node["t"]
+      case type
+      when "s"
+        text = first_text_at(node, "v")
+        text ? @worksheet.shared_string_at(text.to_i) : nil
+      when "inlineStr"
+        decode_inline_string(node)
+      when "str"
+        first_text_at(node, "v")
+      when "b"
+        first_text_at(node, "v") == "1"
+      when "e"
+        first_text_at(node, "v")
+      else
+        raw = first_text_at(node, "v")
+        decode_numeric(raw)
+      end
+    end
+
+    def first_text_at(node, local_name)
+      child = node.at_xpath("./main:#{local_name}", "main" => MAIN_NS)
+      child&.text
+    end
+
+    def decode_inline_string(node)
+      is_node = node.at_xpath("./main:is", "main" => MAIN_NS)
+      return nil unless is_node
+
+      is_node.xpath(".//main:t", "main" => MAIN_NS).map(&:text).join
+    end
+
+    def decode_numeric(raw)
+      return nil if raw.nil? || raw.empty?
+
+      if raw.match?(/\A-?\d+\z/)
+        raw.to_i
+      elsif raw.match?(/\A-?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][+-]?\d+)?\z/)
+        raw.to_f
+      else
+        raw
+      end
+    end
+
+    def preserve_whitespace?(string)
+      return false if string.empty?
+
+      WHITESPACE_BYTES.include?(string.getbyte(0)) ||
+        WHITESPACE_BYTES.include?(string.getbyte(string.bytesize - 1))
+    end
+  end
+end