fast_xlsx 0.1.1 → 0.2.0

data/ext/fast_xlsx/tests/ruby_suite.rs

@@ -0,0 +1,23 @@
+// Runs the Ruby test suite against this crate's current source.
+//
+// The extension's behaviour is tested from Ruby (test/), but cargo-mutants only
+// runs `cargo test`. This test rebuilds the extension from the (possibly
+// mutated) source and runs the Ruby suite, so a mutant counts as caught when a
+// Ruby test fails. The dev profile shares build artifacts with `cargo test`.
+use std::path::Path;
+use std::process::Command;
+
+#[test]
+fn ruby_test_suite_passes() {
+    let root = Path::new(env!("CARGO_MANIFEST_DIR")).join("../..");
+    let status = Command::new("bundle")
+        .args(["exec", "rake", "compile", "test"])
+        .current_dir(&root)
+        .env("RB_SYS_CARGO_PROFILE", "dev")
+        // The suite needs a few CPU seconds; a mutant that loops forever is
+        // stopped instead of running on after cargo-mutants gives up on it.
+        .env("FAST_XLSX_TEST_CPU_SECONDS", "120")
+        .status()
+        .expect("could not run `bundle exec rake compile test`");
+    assert!(status.success(), "the Ruby test suite failed");
+}

data/lib/fast_xlsx/version.rb

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

data/lib/fast_xlsx.rb

@@ -84,6 +84,11 @@ module FastXlsx
       worksheets.find { |ws| ws.name == name }
     end
 
+    # path: a String, Pathname or anything responding to #to_path.
+    def save(path)
+      _save(File.path(path))
+    end
+
     # Document properties shown in Excel's File > Info: title:, subject:,
     # author:, manager:, company:, category:, keywords:, comments:, status:.
     # Later calls add to earlier ones.
@@ -108,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
 
@@ -124,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.
@@ -165,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".
@@ -187,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,7 +36,8 @@ module FastXlsx
                      ?company: String, ?category: String, ?keywords: String,
                      ?comments: String, ?status: String) -> self
     def to_xlsx: () -> String
-    def save: (String path) -> void
+    def define_name: (String name, String formula) -> self
+    def save: (String | _ToPath path) -> void
   end
 
   class Format
@@ -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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fast_xlsx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Zac
@@ -48,6 +48,7 @@ files:
 - ext/fast_xlsx/build.rs
 - ext/fast_xlsx/extconf.rb
 - ext/fast_xlsx/src/lib.rs
+- ext/fast_xlsx/tests/ruby_suite.rs
 - lib/fast_xlsx.rb
 - lib/fast_xlsx/version.rb
 - sig/fast_xlsx.rbs