fast_xlsx 0.1.2-x86_64-linux → 0.2.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee71d9fe02a62f3b5a9785d6082b0839dd16feefa9acee136b5ff59704746616
-  data.tar.gz: bb7886a5cb07dc30f45f41f592946408e777836ff17bf0acb745ca14660aad3a
+  metadata.gz: 385d5c9b69ab08b516cfa1f99e4075b691b9a264924c32498303f4d577abfeaa
+  data.tar.gz: 3c28e89e17339b7f2077d0be122eddf858789be99acd9d18a404c044e309ee44
 SHA512:
-  metadata.gz: 5f62c64428cd0912c8434fc484047faedea9136ac9c816bb47b54918ce57c5058ea5fb730180a111529d7958c234b7fa060081d886858337e424bb80910b4868
-  data.tar.gz: ed5bd6aa08844f50445c2ed780cd80eaa693ba32875f600bdbfa2572ddffa1b8721b81a274da55fb82401198aaba0489a4f4a77798bca1985aeaf8880f610e92
+  metadata.gz: 02670f7b5ebf4a2cf27955651de5a9a7409202700871cdd493f73788de50c7a0e8cb37d0732f8e5ad99ab13fd9017b4f452fac96c5cb6c361e203e4793c35dc0
+  data.tar.gz: 3744269cbb53e37c8519a5df27a196d0fbab8672f8ca985a24c74c06486f326707cd1c2f5303ef7498f994ce7f695ff905745f5c31e38db9eb08dd4c9937d308

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-10-01
+
+### Added
+
+- Range methods (`autofilter`, `merge_range`, `conditional_format`, `data_validation`, `add_table`) also take an Excel reference (`"A1:D10"`) or rows and columns as Integers or Ranges (`0..9, 0..3`).
+- `Workbook#define_name` for workbook-wide and sheet-scoped defined names.
+- `Worksheet#group_rows` and `#group_columns` (outline groups, optionally collapsed); `group_rows` raises in `:constant` / `:low` mode.
+- `Worksheet#protect(password:, allow:)` locks a sheet; `Format` options `locked: false` and `hidden: true` keep cells editable or hide formulas.
+
+### Changed
+
+- `column_width`, `column_format` and the other methods that take a Range raise `ArgumentError` for an empty, reversed or endless Range, or one that isn't Integers, instead of a `TypeError` or `RangeError`.
+
 ## [0.1.2] - 2026-09-30
 
 ### Fixed

data/README.md

@@ -1,5 +1,6 @@
 # FastXlsx
 
+[![Gem Version](https://badge.fury.io/rb/fast_xlsx.svg)](https://badge.fury.io/rb/fast_xlsx)
 [![codecov](https://codecov.io/gh/7a6163/fast_xlsx/graph/badge.svg)](https://codecov.io/gh/7a6163/fast_xlsx)
 
 Fast `.xlsx` writer for Ruby, built on [rust_xlsxwriter](https://github.com/jmcnamara/rust_xlsxwriter) via [magnus](https://github.com/matsadler/magnus).
@@ -75,6 +76,8 @@ ws.write(1, 2, Date.today, date)                         # format one cell
 | `valign` | `:top`, `:center`, `:bottom` |
 | `border`, `border_left`, `border_right`, `border_top`, `border_bottom` | `:thin`, `:medium`, `:thick`, `:dashed`, `:dotted`, `:double`, `:hair` |
 | `border_color` | `"#RRGGBB"` or `0xRRGGBB` |
+| `locked` | `false` keeps the cell editable on a protected sheet (default `true`) |
+| `hidden` | `true` hides the cell's formula on a protected sheet |
 
 Per-side borders override `border`. Unknown options and invalid values raise `ArgumentError`.
 
@@ -85,7 +88,18 @@ ws.column_width(0, 20)        # column A, width in characters
 ws.column_width(1..3, 12)     # columns B–D
 ws.column_format(4, FastXlsx::Format.new(num_format: "#,##0.00")) # default for cells in E written without a format
 ws.autofit                        # size other columns to the data written so far; set widths are kept
-ws.autofilter(0, 0, 100, 3)       # filter buttons on A1:D101 (first_row, first_col, last_row, last_col)
+ws.autofilter("A1:D101")          # filter buttons on A1:D101
+```
+
+### Cell ranges
+
+`autofilter`, `merge_range`, `conditional_format`, `data_validation` and `add_table` take a range in any of these styles:
+
+```ruby
+ws.autofilter(0, 0, 100, 3)   # four 0-based numbers: first_row, first_col, last_row, last_col
+ws.autofilter("A1:D101")      # an Excel reference; "$A$1:$D$101" and a single "B2" work too
+ws.autofilter(0..100, 0..3)   # rows and columns, each an Integer or a Range
+ws.merge_range(0, 0..3, "Q3 report", title) # row 1, columns A–D
 ```
 
 `autofit` only sees rows still in memory, so in `:constant` / `:low` memory mode it ignores rows already written to disk; set widths with `column_width` instead.
@@ -103,6 +117,36 @@ ws.page_footer("&L&A", margin: 0.2)             # sheet name on the left; margin
 ws.margins(left: 0.5, top: 1)              # other margins keep Excel's defaults
 ```
 
+### Outline groups
+
+```ruby
+ws.group_rows(1..10)                     # rows 2–11 get an expand/collapse button
+ws.group_rows(1..4)                      # grouping again nests them (up to 7 levels)
+ws.group_columns(2..3, collapsed: true)  # columns C–D, collapsed until expanded
+```
+
+`group_rows` needs `memory: :standard`: in `:constant` / `:low` mode rust_xlsxwriter writes rows without their outline level, so it raises. `group_columns` works in every mode.
+
+### Defined names
+
+```ruby
+wb.define_name("Rate", "=0.96")                      # workbook-wide; use as =A1*Rate
+wb.define_name("Report!Sales", "=Report!$B$2:$B$13") # only on the Report sheet
+```
+
+Invalid names raise `FastXlsx::Error` right away; duplicate names, and names for a sheet that doesn't exist, raise when saving.
+
+### Protection
+
+```ruby
+input = FastXlsx::Format.new(locked: false)
+ws.write(1, 1, 0, input)                                  # B2 stays editable
+ws.protect                                                # lock everything else
+ws.protect(password: "secret", allow: %i[sort use_autofilter]) # or with a password and allowed actions
+```
+
+`allow:` takes `:format_cells`, `:format_columns`, `:format_rows`, `:insert_columns`, `:insert_rows`, `:insert_links`, `:delete_columns`, `:delete_rows`, `:sort`, `:use_autofilter`, `:use_pivot_tables`, `:edit_scenarios`, `:edit_objects`. The password only stops editing in Excel; it does not encrypt the file.
+
 ### Conditional formats
 
 ```ruby

data/bench/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    fast_xlsx (0.1.2)
+    fast_xlsx (0.2.0)
       rb_sys (~> 0.9.130)
 
 GEM
@@ -77,7 +77,7 @@ DEPENDENCIES
 CHECKSUMS
   caxlsx (4.5.0) sha256=e3d98d859f148df05d5462086b5079b523f29c1766b569535f1d68629ce743ff
   fast_excel (0.5.0) sha256=59c418bdcf586a6030798d4e3a9f575742badaceaf7bb90f38eee5feb5bdc478
-  fast_xlsx (0.1.2)
+  fast_xlsx (0.2.0)
   ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
   ffi (1.17.4-aarch64-linux-musl) sha256=9286b7a615f2676245283aef0a0a3b475ae3aae2bb5448baace630bb77b91f39
   ffi (1.17.4-arm-linux-gnu) sha256=d6dbddf7cb77bf955411af5f187a65b8cd378cb003c15c05697f5feee1cb1564

data/lib/fast_xlsx/3.3/fast_xlsx.so

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: data/lib/fast_xlsx/3.3/fast_xlsx.so
-size: 45102408 bytes
-sha256: dea286735fd70bded17f2a079a184262f668c0ee7c0210f774c28f454a55bde3
+size: 45375128 bytes
+sha256: 043624848d4e4d9f2b26792a9593ea1fb0efe93072ede8d879f9b3b80e5e6f87

data/lib/fast_xlsx/3.4/fast_xlsx.so

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: data/lib/fast_xlsx/3.4/fast_xlsx.so
-size: 45180760 bytes
-sha256: 3ffbc87abdd0c3280c4c902d57a4c3b507de8dc9c6c9dd36825a09fc0788f358
+size: 45453952 bytes
+sha256: bdd409fc4cb74c8f2a099f0f8878e5288dc1cd645ded3cedfa1b520ee22197df

data/lib/fast_xlsx/4.0/fast_xlsx.so

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: data/lib/fast_xlsx/4.0/fast_xlsx.so
-size: 45158792 bytes
-sha256: 8fcc45abc6808d51a8e85ffc6cc888ebf45d75bc8955c6e4fbb8d69ba190ad2a
+size: 45431888 bytes
+sha256: f71f589703ec307fbb068f251dbc8d39e7f6ee850962b93cd1b9fc253ded2728

data/lib/fast_xlsx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FastXlsx
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/fast_xlsx.rb

@@ -113,11 +113,11 @@ module FastXlsx
 
     # columns: a 0-based column index or a Range of them. width is in characters.
     def column_width(columns, width)
-      bounds = column_bounds(columns)
-      _column_width(*bounds, width)
+      range = CellRange.bounds(columns)
+      _column_width(*range, width)
       @fixed_widths ||= {}
-      @fixed_widths.delete(bounds) # re-insert so autofit replays calls in order
-      @fixed_widths[bounds] = width
+      @fixed_widths.delete(range) # re-insert so autofit replays calls in order
+      @fixed_widths[range] = width
       self
     end
 
@@ -129,21 +129,32 @@ module FastXlsx
       self
     end
 
+    # The methods below take a cell range in any of these styles:
+    #   (first_row, first_col, last_row, last_col)  four 0-based numbers
+    #   ("A1:D10") or ("B2")                        an Excel reference
+    #   (rows, cols)                                Integers or Ranges, e.g. (0..9, 0..3)
+
+    # Filter buttons on the range's first row.
+    def autofilter(*range)
+      _autofilter(*CellRange.split(range).first)
+    end
+
     # Merges the range and writes value (any cell type) into its first cell.
-    def merge_range(first_row, first_col, last_row, last_col, value, format = nil)
-      _merge_range(first_row, first_col, last_row, last_col, value, format)
+    def merge_range(*args)
+      range, (value, format) = CellRange.split(args, 1..2)
+      _merge_range(*range, value, format)
     end
 
     # Highlights cells in the range by rule. type: :cell, :text, :formula,
     # :data_bar or :color_scale; see the README for each type's options.
-    def conditional_format(first_row, first_col, last_row, last_col, type:, **)
-      _conditional_format(first_row, first_col, last_row, last_col, { type: type, ** })
+    def conditional_format(*range, type:, **)
+      _conditional_format(*CellRange.split(range).first, { type: type, ** })
     end
 
     # Restricts what can be entered in the range. type: :list, :whole_number,
     # :decimal or :text_length; see the README for the options.
-    def data_validation(first_row, first_col, last_row, last_col, type:, **)
-      _data_validation(first_row, first_col, last_row, last_col, { type: type, ** })
+    def data_validation(*range, type:, **)
+      _data_validation(*CellRange.split(range).first, { type: type, ** })
     end
 
     # Adds a comment (Excel "note") to a cell.
@@ -170,8 +181,8 @@ module FastXlsx
     # into an Excel table. columns: header Strings or { header:, total:,
     # total_label:, format: }; other options: style:, name:, total_row:,
     # banded_rows:, autofilter:.
-    def add_table(first_row, first_col, last_row, last_col, **)
-      _add_table(first_row, first_col, last_row, last_col, { ** })
+    def add_table(*range, **)
+      _add_table(*CellRange.split(range).first, { ** })
     end
 
     # Printed page header/footer using Excel codes such as "&CPage &P of &N".
@@ -192,18 +203,106 @@ module FastXlsx
       self
     end
 
+    # Outline group with an expand/collapse button. rows: a 0-based row index
+    # or a Range; grouping rows already grouped nests them (up to 7 levels).
+    # collapsed: true hides them until expanded.
+    def group_rows(rows, collapsed: false)
+      _group_rows(*CellRange.bounds(rows), collapsed)
+    end
+
+    def group_columns(columns, collapsed: false)
+      _group_columns(*CellRange.bounds(columns), collapsed)
+    end
+
+    # Locks the sheet against editing. Cells whose format has locked: false
+    # stay editable. allow: actions users may still take, any of :format_cells,
+    # :format_columns, :format_rows, :insert_columns, :insert_rows,
+    # :insert_links, :delete_columns, :delete_rows, :sort, :use_autofilter,
+    # :use_pivot_tables, :edit_scenarios, :edit_objects.
+    def protect(password: nil, allow: [])
+      _protect(password, Array(allow))
+    end
+
     # Default format for cells in these columns that are written without one.
     def column_format(columns, format)
-      _column_format(*column_bounds(columns), format)
+      _column_format(*CellRange.bounds(columns), format)
       self
     end
+  end
+
+  # Cell ranges in the styles Worksheet methods accept: four 0-based numbers,
+  # an Excel reference ("A1:D10", "B2"), or rows and columns as Integers or
+  # Ranges.
+  module CellRange
+    REF = /\A\$?([A-Za-z]{1,3})\$?([1-9]\d*)\z/ # ASCII only: /i also matches the Kelvin sign
+    FORMS = 'a range is (first_row, first_col, last_row, last_col), "A1:D10" or (rows, cols)'
+
+    module_function
+
+    # Splits a range off the front of args and checks how many args follow.
+    # Returns [[first_row, first_col, last_row, last_col], the args after it].
+    def split(args, following = 0..0)
+      range, rest = parse(args)
+      unless following.cover?(rest.size)
+        expected = following.minmax.uniq.join("..")
+        raise ArgumentError, "wrong number of arguments after the cell range (given #{rest.size}, " \
+                             "expected #{expected}); #{FORMS}"
+      end
+
+      [range, rest]
+    end
+
+    def parse(args)
+      case args
+      in [Numeric, Numeric, Numeric, Numeric, *rest] then [args.first(4), rest]
+      in [String => ref, *rest] then [excel(ref), rest]
+      in [Integer | Range => rows, Integer | Range => cols, *rest]
+        [rows_and_cols(rows, cols), rest]
+      else
+        raise ArgumentError, "expected a cell range, got #{args.inspect}; #{FORMS}"
+      end
+    end
+
+    def rows_and_cols(rows, cols)
+      first_row, last_row = bounds(rows)
+      first_col, last_col = bounds(cols)
+      [first_row, first_col, last_row, last_col]
+    end
+
+    # "A1:D10", "$A$1:$D$10" or a single "B2".
+    def excel(ref)
+      cells = cell_matches(ref)
+      rows = cells.map { |m| m[2].to_i - 1 }
+      cols = cells.map { |m| column(m[1]) }
+      [rows.min, cols.min, rows.max, cols.max]
+    end
+
+    def cell_matches(ref)
+      cells = ref.split(":", -1).map { |cell| REF.match(cell) }
+      return cells if (1..2).cover?(cells.size) && cells.all?
+
+      raise ArgumentError, "invalid cell range #{ref.inspect}: use e.g. \"A1:D10\" or \"B2\""
+    end
+
+    # "A" => 0, "AA" => 26.
+    def column(letters)
+      letters.upcase.each_char.reduce(0) { |n, c| (n * 26) + c.ord - 64 } - 1
+    end
+
+    # [first, last] of an index or a Range.
+    def bounds(indexes)
+      return [indexes, indexes] if indexes.is_a?(Integer)
+      unless indexes.is_a?(Range) && indexes.begin.is_a?(Integer) && indexes.end.is_a?(Integer)
+        raise ArgumentError, "expected an Integer or a Range of Integers, got #{indexes.inspect}"
+      end
 
-    private
+      first, last = indexes.minmax
+      raise ArgumentError, "empty range #{indexes.inspect}" unless first
 
-    def column_bounds(columns)
-      columns.is_a?(Integer) ? [columns, columns] : columns.minmax
+      [first, last]
     end
   end
+  private_constant :CellRange
 
   # Cell style, e.g. Format.new(bold: true). Pass to Worksheet#write.
   class Format

data/sig/fast_xlsx.rbs

@@ -36,6 +36,7 @@ module FastXlsx
                      ?company: String, ?category: String, ?keywords: String,
                      ?comments: String, ?status: String) -> self
     def to_xlsx: () -> String
+    def define_name: (String name, String formula) -> self
     def save: (String | _ToPath path) -> void
   end
 
@@ -46,7 +47,7 @@ module FastXlsx
     type underline = bool | :single | :double | :single_accounting | :double_accounting
 
     def self.new: (?bold: bool, ?italic: bool, ?underline: underline, ?strikeout: bool, ?text_wrap: bool,
-                   ?shrink: bool, ?num_format: String, ?font_size: Numeric, ?font_name: String,
+                   ?shrink: bool, ?locked: bool, ?hidden: bool, ?num_format: String, ?font_size: Numeric, ?font_name: String,
                    ?font_color: color, ?bg_color: color, ?font_script: :superscript | :subscript,
                    ?align: :left | :center | :right, ?valign: :top | :center | :bottom,
                    ?rotation: Integer, ?indent: Integer,
@@ -62,7 +63,14 @@ module FastXlsx
     def column_width: (Integer | Range[Integer] columns, Numeric width) -> self
     def column_format: (Integer | Range[Integer] columns, Format format) -> self
     def autofit: () -> self
+    # A cell range: four 0-based numbers, an Excel reference ("A1:D10"), or
+    # rows and columns as Integers or Ranges. Methods with options take it as
+    # *cell_range so the keywords can follow.
+    type indexes = Integer | Range[Integer]
+    type cell_range = Integer | String | Range[Integer]
     def autofilter: (Integer first_row, Integer first_col, Integer last_row, Integer last_col) -> self
+                  | (String range) -> self
+                  | (indexes rows, indexes cols) -> self
     def freeze_panes: (Integer row, Integer col) -> self
     def row_height: (Integer row, Numeric height) -> self
     def page_breaks: (Array[Integer] rows) -> self
@@ -71,12 +79,20 @@ module FastXlsx
     def page_footer: (String text, ?margin: Numeric?) -> self
     def margins: (?left: Numeric?, ?right: Numeric?, ?top: Numeric?, ?bottom: Numeric?,
                   ?header: Numeric?, ?footer: Numeric?) -> self
+    type protect_action = :format_cells | :format_columns | :format_rows | :insert_columns | :insert_rows
+                        | :insert_links | :delete_columns | :delete_rows | :sort | :use_autofilter
+                        | :use_pivot_tables | :edit_scenarios | :edit_objects
+    def group_rows: (Integer | Range[Integer] rows, ?collapsed: bool) -> self
+    def group_columns: (Integer | Range[Integer] columns, ?collapsed: bool) -> self
+    def protect: (?password: String?, ?allow: protect_action | Array[protect_action] | nil) -> self
     def merge_range: (Integer first_row, Integer first_col, Integer last_row, Integer last_col, cell value, ?Format? format) -> self
-    def conditional_format: (Integer first_row, Integer first_col, Integer last_row, Integer last_col,
+                   | (String range, cell value, ?Format? format) -> self
+                   | (indexes rows, indexes cols, cell value, ?Format? format) -> self
+    def conditional_format: (*cell_range range,
                              type: :cell | :text | :formula | :data_bar | :color_scale,
                              ?criteria: Symbol, ?value: Numeric | String | Array[Numeric | String],
                              ?format: Format, ?colors: 2 | 3) -> self
-    def data_validation: (Integer first_row, Integer first_col, Integer last_row, Integer last_col,
+    def data_validation: (*cell_range range,
                           type: :list | :whole_number | :decimal | :text_length,
                           ?criteria: Symbol, ?value: Numeric | String | Array[Numeric | String],
                           ?input_title: String, ?input_message: String,
@@ -91,7 +107,7 @@ module FastXlsx
                        ?width: Integer, ?height: Integer) -> self
     type table_column = String | { header: String, ?total: Symbol, ?total_label: String, ?format: Format }
 
-    def add_table: (Integer first_row, Integer first_col, Integer last_row, Integer last_col,
+    def add_table: (*cell_range range,
                     ?columns: Array[table_column], ?style: Symbol, ?name: String,
                     ?total_row: bool, ?banded_rows: bool, ?autofilter: bool) -> self
     def name: () -> String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: x86_64-linux
 authors:
 - Zac
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies: []
 description: Writes Excel .xlsx files from Ruby through a native Rust extension (rust_xlsxwriter
   + magnus).