xlsxrb 0.1.13 → 0.1.15

data/sig/generated/xlsxrb/ooxml/worksheet_parser.rbs

@@ -10,20 +10,32 @@ module Xlsxrb
 
       EMPTY_HASH: untyped
 
+      TAG_DELIM_BYTES: untyped
+
+      ROW_ATTR_START_BYTES: untyped
+
       # Parses all rows from a worksheet XML string.
       # Returns an Array of raw row hashes:
       #   { index:, cells: [{ ref:, type:, style_index:, value:, formula: }], attrs:, unmapped: }
-      def self.parse: (untyped xml_string, ?shared_strings: untyped) -> untyped
+      def self.parse: (untyped xml_string, ?shared_strings: untyped, ?styles: untyped) -> untyped
 
       # Streaming parse: yields one raw row hash at a time.
-      def self.each_row: (untyped xml_source, ?shared_strings: untyped, ?part_name: untyped) ?{ (?) -> untyped } -> untyped
+      def self.each_row: (untyped xml_source, ?shared_strings: untyped, ?part_name: untyped, ?styles: untyped, ?date1904: untyped, ?trim_empty_rows: untyped, ?pad_empty_rows: untyped, ?pad_empty_cells: untyped) ?{ (?) -> untyped } -> untyped
 
       # Parses column definitions (<cols>) from a worksheet.
-      def self.parse_columns: (untyped xml_string, ?part_name: untyped) -> untyped
+      def self.parse_columns: (untyped xml_string, ?untyped _part_name) -> untyped
 
       # Yields Event objects for columns, rows, cells, and hyperlinks.
       def self.each_event: (untyped xml_string, ?shared_strings: untyped, ?part_name: untyped) ?{ (?) -> untyped } -> untyped
 
+      # Parses all hyperlink elements from worksheet XML.
+      #
+      # @param xml_string [String, nil]
+      # @return [Array<Hash[Symbol, untyped]>]
+      # @api public
+      # : (String?) -> Array[Hash[Symbol, untyped]]
+      def self.parse_hyperlinks: (String?) -> Array[Hash[Symbol, untyped]]
+
       def self.fast_scan_events: (untyped xml_src, untyped shared_strings, untyped part_name) ?{ (?) -> untyped } -> untyped
 
       def self.extract_row_attrs: (untyped row_tag) -> untyped
@@ -43,6 +55,9 @@ module Xlsxrb
       # : (String str) -> String
       def self.decode_xml_entities: (String str) -> String
 
+      # : (String str) -> String
+      def self.normalize_text: (String str) -> String
+
       # Parses <cols> section for column definitions.
       class ColumnsListener
         include REXML::SAX2Listener
@@ -58,9 +73,11 @@ module Xlsxrb
         def characters: (untyped _text) -> untyped
       end
 
-      def self.fast_scan_rows_direct: (untyped xml_src, untyped shared_strings, untyped _part_name) ?{ (?) -> untyped } -> untyped
+      # rubocop:disable Style/OptionalBooleanParameter
+      def self.fast_scan_rows_direct: (untyped xml_src, untyped shared_strings, untyped _part_name, ?untyped styles, ?untyped date1904, ?untyped pad_empty_cells) ?{ (?) -> untyped } -> untyped
 
-      def self.scan_rows_stream: (untyped source, untyped shared_strings, untyped _part_name) ?{ (?) -> untyped } -> untyped
+      # rubocop:disable Style/OptionalBooleanParameter
+      def self.scan_rows_stream: (untyped source, untyped shared_strings, untyped _part_name, ?untyped styles, ?untyped date1904, ?untyped pad_empty_cells) ?{ (?) -> untyped } -> untyped
 
       COL_LETTERS: untyped
 
@@ -78,7 +95,12 @@ module Xlsxrb
 
       def self.fast_parse_cells_direct: (untyped xml, untyped from, untyped to, untyped shared_strings, untyped row_source, ?untyped prefix) -> untyped
 
-      def self.fast_scan_cells_direct: (untyped xml, untyped from, untyped to, untyped shared_strings, untyped row_source, ?untyped _prefix) ?{ (?) -> untyped } -> untyped
+      # rubocop:disable Style/OptionalBooleanParameter
+      def self.fast_scan_cells_direct: (untyped xml, untyped from, untyped to, untyped shared_strings, untyped row_source, ?untyped _prefix, ?untyped styles, ?untyped date1904) ?{ (?) -> untyped } -> untyped
+
+      # rubocop:disable Style/OptionalBooleanParameter
+      # : (String xml, Integer from, Integer to, Array[String] shared_strings, ?untyped styles, ?bool date1904, ?type_cast: bool) -> Array[untyped]
+      def self.fast_scan_row_values: (String xml, Integer from, Integer to, Array[String] shared_strings, ?untyped styles, ?bool date1904, ?type_cast: bool) -> Array[untyped]
     end
   end
 end

data/sig/generated/xlsxrb/ooxml/worksheet_writer.rbs

@@ -13,7 +13,9 @@ module Xlsxrb
 
       INTEGER_STRINGS: untyped
 
-      def initialize: (untyped io) -> untyped
+      def initialize: (untyped io, ?date1904: untyped) -> untyped
+
+      def set_column_style: (untyped col_index, untyped style_id) -> untyped
 
       # Write the worksheet header. Call once before writing rows.
       # Options for pre-sheetData elements:
@@ -22,7 +24,7 @@ module Xlsxrb
       #   split_pane: { x_split:, y_split:, top_left_cell: }
       #   selection: { active_cell:, sqref:, pane: }
       #   sheet_view: Hash of sheet view properties
-      def start: (?columns: untyped, ?sheet_properties: untyped, ?freeze_pane: untyped, ?split_pane: untyped, ?selection: untyped, ?sheet_view: untyped) -> untyped
+      def start: (?columns: untyped, ?sheet_properties: untyped, ?freeze_pane: untyped, ?split_pane: untyped, ?selection: untyped, ?sheet_view: untyped, ?sheet_format: untyped) -> untyped
 
       # Write a single row. Automatically calls start if needed.
       def write_row: (untyped row_index, untyped cells, ?attrs: untyped, ?unmapped: untyped, ?sst_index: untyped) -> untyped
@@ -32,16 +34,22 @@ module Xlsxrb
 
       # Write the worksheet footer. Call once after all rows.
       # Options for post-sheetData elements (in OOXML order):
-      def finish: (?drawing_rid: untyped, ?sheet_protection: untyped, ?auto_filter: untyped, ?filter_columns: untyped, ?sort_state: untyped, ?merge_cells: untyped, ?conditional_formats: untyped, ?data_validations: untyped, ?hyperlinks: untyped, ?print_options: untyped, ?page_margins: untyped, ?page_setup: untyped, ?header_footer: untyped, ?row_breaks: untyped, ?col_breaks: untyped, ?tables: untyped, ?table_start_rid: untyped, ?legacy_drawing_rid: untyped, ?sparkline_groups: untyped) -> untyped
+      def finish: (?drawing_rid: untyped, ?sheet_protection: untyped, ?protected_ranges: untyped, ?auto_filter: untyped, ?filter_columns: untyped, ?sort_state: untyped, ?merge_cells: untyped, ?conditional_formats: untyped, ?data_validations: untyped, ?hyperlinks: untyped, ?print_options: untyped, ?page_margins: untyped, ?page_setup: untyped, ?header_footer: untyped, ?row_breaks: untyped, ?col_breaks: untyped, ?cell_watches: untyped, ?tables: untyped, ?table_start_rid: untyped, ?legacy_drawing_rid: untyped, ?sparkline_groups: untyped) -> untyped
 
       private
 
+      def resolve_style_id: (untyped style, untyped style_map) -> untyped
+
       def write_sheet_properties: (untyped props) -> untyped
 
       def write_sheet_views: (?freeze_pane: untyped, ?split_pane: untyped, ?selection: untyped, ?sheet_view: untyped) -> untyped
 
+      def write_sheet_format_pr: (untyped fmt) -> untyped
+
       def write_sheet_protection: (untyped opts) -> untyped
 
+      def write_protected_ranges: (untyped ranges) -> untyped
+
       def write_auto_filter: (untyped range, untyped filter_columns, untyped sort_state) -> untyped
 
       def write_filter_column: (untyped col_id, untyped filter) -> untyped
@@ -66,6 +74,8 @@ module Xlsxrb
 
       def write_col_breaks: (untyped breaks) -> untyped
 
+      def write_cell_watches: (untyped watches) -> untyped
+
       def write_table_parts: (untyped tables, untyped start_rid) -> untyped
 
       def write_sparklines: (untyped groups) -> untyped

data/sig/generated/xlsxrb/ooxml/writer.rbs

@@ -432,6 +432,8 @@ module Xlsxrb
       # : (untyped name, untyped value) -> untyped
       def set_workbook_property: (untyped name, untyped value) -> untyped
 
+      alias workbook_property set_workbook_property
+
       # Returns workbook properties hash.
       # : () -> untyped
       def workbook_properties: () -> untyped

data/sig/generated/xlsxrb/ooxml/xml_builder.rbs

@@ -46,7 +46,9 @@ module Xlsxrb
       # : (untyped value) -> String
       def self.escape: (untyped value) -> String
 
-      # Unescapes predefined XML entities in a string in a single pass.
+      NUM_ENTITY_RE: ::Regexp
+
+      # Unescapes predefined and numeric/hex XML entities in a string.
       #
       # @param value [Object]
       # @return [String]

data/sig/generated/xlsxrb/ooxml/zip_reader.rbs

@@ -62,6 +62,8 @@ module Xlsxrb
         private
 
         def fetch_chunk: (untyped chunk_size) -> untyped
+
+        def check_bom_encoding!: () -> untyped
       end
 
       # Opens a ZIP from a file path or IO and yields the reader.
@@ -128,6 +130,17 @@ module Xlsxrb
       def decompress: (untyped raw, untyped method) -> untyped
 
       def safe_inflate: (untyped raw, untyped wbits) -> untyped
+
+      def normalize_entry_name: (untyped name) -> untyped
+
+      def lookup_entry: (untyped name) -> untyped
+
+      def ci_catalog: () -> untyped
+
+      def normalize_text_encoding: (untyped data) -> untyped
+
+      # : (String extra_data, Integer usize, Integer csize, Integer offset) -> [Integer, Integer, Integer]
+      def parse_zip64_extra: (String extra_data, Integer usize, Integer csize, Integer offset) -> [ Integer, Integer, Integer ]
     end
   end
 end

data/sig/generated/xlsxrb/stream_row.rbs

@@ -23,8 +23,14 @@ module Xlsxrb
 
     attr_reader custom_height: untyped
 
+    attr_reader collapsed: untyped
+
     attr_reader outline_level: untyped
 
+    attr_reader style_index: untyped
+
+    attr_reader pad_empty_cells: untyped
+
     # @param index [Integer] 0-based row index.
     # @param xml_bytes [String] Raw ASCII-8BIT XML bytes.
     # @param from [Integer] Byte offset where cells start.
@@ -34,12 +40,58 @@ module Xlsxrb
     # @param height [Float, Integer, nil] Row height in points.
     # @param hidden [Boolean] Whether the row is hidden.
     # @param custom_height [Boolean] Whether custom height is set.
+    # @param collapsed [Boolean] Whether the row is collapsed.
     # @param outline_level [Integer, nil] Grouping/outline level.
-    # : (index: Integer, xml_bytes: String, from: Integer, to: Integer, shared_strings: Array[String], ?prefix: String, ?height: Float | Integer | nil, ?hidden: bool, ?custom_height: bool, ?outline_level: Integer | nil) -> void
-    def initialize: (index: Integer, xml_bytes: String, from: Integer, to: Integer, shared_strings: Array[String], ?prefix: String, ?height: Float | Integer | nil, ?hidden: bool, ?custom_height: bool, ?outline_level: Integer | nil) -> void
+    # @param style_index [Integer, nil] Style index.
+    # @param date1904 [Boolean] Whether the 1904 date system is active.
+    # @param pad_empty_cells [Boolean] Whether missing cells in this row are padded.
+    # : (index: Integer, xml_bytes: String, from: Integer, to: Integer, shared_strings: Array[String], ?prefix: String, ?height: Float | Integer | nil, ?hidden: bool, ?custom_height: bool, ?collapsed: bool, ?outline_level: Integer | nil, ?style_index: Integer | nil, ?styles: Hash[untyped, untyped]?, ?date1904: bool, ?pad_empty_cells: bool) -> void
+    def initialize: (index: Integer, xml_bytes: String, from: Integer, to: Integer, shared_strings: Array[String], ?prefix: String, ?height: Float | Integer | nil, ?hidden: bool, ?custom_height: bool, ?collapsed: bool, ?outline_level: Integer | nil, ?style_index: Integer | nil, ?styles: Hash[untyped, untyped]?, ?date1904: bool, ?pad_empty_cells: bool) -> void
 
     # rubocop:disable Style/OptionalBooleanParameter
-    def self.fast_create: (untyped index, untyped xml_bytes, untyped from, untyped to, untyped shared_strings, ?untyped prefix, ?untyped height, ?untyped hidden, ?untyped custom_height, ?untyped outline_level) -> untyped
+    def self.fast_create: (untyped index, untyped xml_bytes, untyped from, untyped to, untyped shared_strings, ?untyped prefix, ?untyped height, ?untyped hidden, ?untyped custom_height, ?untyped outline_level, ?untyped style_index, ?untyped styles, ?untyped date1904, ?untyped collapsed, ?untyped pad_empty_cells) -> untyped
+
+    # Returns whether the row is hidden.
+    #
+    # @return [Boolean]
+    # @api public
+    # : () -> bool
+    def hidden?: () -> bool
+
+    # Returns whether the row is collapsed.
+    #
+    # @return [Boolean]
+    # @api public
+    # : () -> bool
+    def collapsed?: () -> bool
+
+    # Returns whether custom height is set.
+    #
+    # @return [Boolean]
+    # @api public
+    # : () -> bool
+    def custom_height?: () -> bool
+
+    # Returns a frozen Hash of row attributes.
+    #
+    # @return [Hash{Symbol => Object}]
+    # @api public
+    # : () -> Hash[Symbol, untyped]
+    def attributes: () -> Hash[Symbol, untyped]
+
+    # Returns whether the row uses the 1904 date system.
+    #
+    # @return [Boolean]
+    # @api public
+    # : () -> bool
+    def date1904?: () -> bool
+
+    # Returns whether missing cells in this row are padded.
+    #
+    # @return [Boolean]
+    # @api public
+    # : () -> bool
+    def pad_empty_cells?: () -> bool
 
     # Iterate over cells in this streaming row one by one.
     #
@@ -86,6 +138,14 @@ module Xlsxrb
     # : (Integer col_index) -> Elements::Cell?
     def cell_at: (Integer col_index) -> Elements::Cell?
 
+    # Convert row cells to a coordinate-keyed Hash (e.g. {"A1" => "value", "B1" => 123}).
+    #
+    # @param type_cast [Boolean] Whether to coerce date/time serial numbers into Date/Time instances.
+    # @return [Hash{String => Object}]
+    # @api public
+    # : (?type_cast: bool) -> Hash[String, untyped]
+    def to_h: (?type_cast: bool) -> Hash[String, untyped]
+
     # Convert row cells to an Array of raw values (sparse columns get nil).
     #
     # @return [Array<Object>]
@@ -93,12 +153,34 @@ module Xlsxrb
     # : () -> Array[untyped]
     def to_a: () -> Array[untyped]
 
-    # Returns cell values as an Array.
+    # Returns cell values as an Array (sparse columns get nil).
     #
+    # @param type_cast [Boolean] Whether to coerce date/time serial numbers into Date/Time instances.
     # @return [Array<Object>]
     # @api public
-    # : () -> Array[untyped]
-    def values: () -> Array[untyped]
+    # : (?type_cast: bool) -> Array[untyped]
+    def values: (?type_cast: bool) -> Array[untyped]
+
+    # Convert row cells to an Array of raw string values (sparse columns get nil).
+    #
+    # @return [Array<String, nil>]
+    # @api public
+    # : () -> Array[String?]
+    def raw_values: () -> Array[String?]
+
+    # Convert row cells to an Array of formatted string representations (sparse columns get nil).
+    #
+    # @return [Array<String, nil>]
+    # @api public
+    # : () -> Array[String?]
+    def formatted_values: () -> Array[String?]
+
+    # Convert row cells to an Array of formula expressions without leading '=' (sparse columns get nil).
+    #
+    # @return [Array<String, nil>]
+    # @api public
+    # : () -> Array[String?]
+    def formulas: () -> Array[String?]
 
     # Returns whether the row is valid according to OOXML specifications.
     #
@@ -107,6 +189,13 @@ module Xlsxrb
     # : () -> bool
     def valid?: () -> bool
 
+    # Returns whether the row contains no cell values (or all cell values are nil or empty strings).
+    #
+    # @return [Boolean]
+    # @api public
+    # : () -> bool
+    def empty?: () -> bool
+
     # Unmapped metadata for compatibility with Elements::Row.
     #
     # @return [Hash]
@@ -127,5 +216,10 @@ module Xlsxrb
     # @api public
     # : () -> String
     def inspect: () -> String
+
+    private
+
+    # : (bool) -> Array[untyped]
+    def values_from_cells: (bool) -> Array[untyped]
   end
 end