xlsxrb 0.1.4 → 0.1.6

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

@@ -0,0 +1,21 @@
+# Generated from lib/xlsxrb/ooxml/shared_strings_parser.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # SAX-based parser for xl/sharedStrings.xml.
+    # Returns an Array of strings (index = SST index).
+    class SharedStringsParser
+      XML_ENTITIES: untyped
+
+      # Parses all shared strings and returns an Array of strings.
+      def self.parse: (untyped xml_string, ?_part_name: untyped) -> untyped
+
+      # Yields Event objects for each shared string.
+      def self.each_event: (untyped xml_string, ?part_name: untyped) ?{ (?) -> untyped } -> untyped
+
+      def self.fast_scan: (untyped xml_src) -> untyped
+
+      def self.extract_multi_t: (untyped xml, untyped from, untyped to) -> untyped
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# Generated from lib/xlsxrb/ooxml/styles_parser.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # SAX-based parser for xl/styles.xml.
+    # Returns a Hash with :num_fmts, :fonts, :fills, :borders, :cell_xfs, :cell_style_xfs.
+    class StylesParser
+      def self.parse: (untyped xml_string) -> untyped
+
+      # SAX listener for parsing styles.xml content.
+      class Listener
+        include REXML::SAX2Listener
+
+        attr_reader result: untyped
+
+        def initialize: () -> untyped
+
+        def start_element: (untyped _uri, untyped localname, untyped _qname, untyped attrs) -> untyped
+
+        def end_element: (untyped _uri, untyped localname, untyped _qname) -> untyped
+
+        def characters: (untyped _text) -> untyped
+
+        private
+
+        def parent_context?: (untyped tag) -> untyped
+
+        def handle_color: (untyped attrs) -> untyped
+
+        def handle_fill_color: (untyped localname, untyped attrs) -> untyped
+
+        def handle_border_side: (untyped side, untyped attrs) -> untyped
+
+        def handle_xf: (untyped attrs) -> untyped
+
+        def handle_alignment: (untyped attrs) -> untyped
+
+        def finalize_xf: () -> untyped
+
+        def extract_color: (untyped attrs) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# Generated from lib/xlsxrb/ooxml/utils.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # OOXML-specific utility methods and constants.
+    module Utils
+      # Excel 1900 date system epoch.
+      EPOCH_1900: untyped
+
+      # Built-in number format codes defined by SpreadsheetML.
+      BUILTIN_NUM_FMT_CODES: untyped
+
+      # Built-in numFmtIds that represent date/time formats.
+      BUILTIN_DATE_FMT_IDS: untyped
+
+      # Default date format code used by Writer for Date cells.
+      DEFAULT_DATE_FORMAT: ::String
+
+      # Default date-time format code used by Writer for Time cells.
+      DEFAULT_DATETIME_FORMAT: ::String
+
+      # Converts a Date to an Excel serial number (1900 system).
+      def self.date_to_serial: (untyped date) -> untyped
+
+      # Converts an Excel serial number (1900 system) to a Date.
+      def self.serial_to_date: (untyped serial) -> untyped
+
+      # Converts a Time to a fractional Excel serial number (1900 system).
+      def self.datetime_to_serial: (untyped time) -> untyped
+
+      # Converts a fractional Excel serial number to a Time (1900 system, UTC).
+      def self.serial_to_datetime: (untyped serial) -> untyped
+
+      # Hashes a plain-text password for use with sheet/workbook protection.
+      # Returns { algorithm_name:, hash_value:, salt_value:, spin_count: }.
+      # Algorithm per ECMA-376 Part 4 §2.4.2.24.
+      def self.hash_password: (untyped password, ?algorithm: untyped, ?salt: untyped, ?spin_count: untyped) -> untyped
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# Generated from lib/xlsxrb/ooxml/workbook_parser.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # SAX-based parser for xl/workbook.xml.
+    # Returns sheet list: [{ name:, sheet_id:, r_id: }, ...].
+    class WorkbookParser
+      def self.parse: (untyped xml_string) -> untyped
+
+      # SAX listener for workbook.xml sheets.
+      class Listener
+        include REXML::SAX2Listener
+
+        attr_reader sheets: untyped
+
+        def initialize: () -> untyped
+
+        def start_element: (untyped _uri, untyped localname, untyped _qname, untyped attrs) -> untyped
+
+        def end_element: (untyped _uri, untyped _localname, untyped _qname) -> untyped
+
+        def characters: (untyped _text) -> untyped
+      end
+    end
+
+    # Parses .rels files to build rId -> target mapping.
+    class RelationshipsParser
+      def self.parse: (untyped xml_string) -> untyped
+
+      # SAX listener for .rels relationship files.
+      class Listener
+        include REXML::SAX2Listener
+
+        attr_reader relationships: untyped
+
+        def initialize: () -> untyped
+
+        def start_element: (untyped _uri, untyped localname, untyped _qname, untyped attrs) -> untyped
+
+        def end_element: (untyped _uri, untyped _localname, untyped _qname) -> untyped
+
+        def characters: (untyped _text) -> untyped
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# Generated from lib/xlsxrb/ooxml/workbook_writer.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # Orchestrates writing a complete XLSX workbook.
+    # Generates all required OpenXML parts and assembles them into a ZIP.
+    class WorkbookWriter
+      SSML_NS: ::String
+
+      REL_NS: ::String
+
+      CT_NS: ::String
+
+      DOC_REL: ::String
+
+      # Wraps a ZipWriter entry to provide a standard IO-like #write interface.
+      class ZipEntryIO
+        def initialize: (untyped zip) -> untyped
+
+        def write: (untyped data) -> untyped
+
+        alias << write
+      end
+
+      def self.write: (untyped target, sheets: untyped, ?shared_strings: untyped, ?shared_strings_index: untyped, ?styles: untyped, ?defined_names: untyped, ?core_properties: untyped, ?app_properties: untyped, ?custom_properties: untyped, ?workbook_protection: untyped, ?workbook_properties: untyped) -> untyped
+
+      def initialize: (sheets: untyped, ?shared_strings: untyped, ?shared_strings_index: untyped, ?styles: untyped, ?defined_names: untyped, ?core_properties: untyped, ?app_properties: untyped, ?custom_properties: untyped, ?workbook_protection: untyped, ?workbook_properties: untyped) -> untyped
+
+      def write_to: (untyped target) -> untyped
+
+      private
+
+      def build_sheet_rels_from_list: (untyped rels) -> untyped
+
+      def build_content_types: () -> untyped
+
+      def build_root_rels: () -> untyped
+
+      def build_workbook_xml: () -> untyped
+
+      def build_workbook_rels: () -> untyped
+
+      def build_styles_xml: () -> untyped
+
+      def preprocess_conditional_formats!: () -> untyped
+
+      def extract_dxf_from_rule!: (untyped rule) -> untyped
+
+      def write_dxf_font: (untyped builder, untyped font) -> untyped
+
+      def write_dxf_fill: (untyped builder, untyped fill) -> untyped
+
+      def build_shared_strings_xml: () -> untyped
+
+      def write_worksheet_xml: (untyped io, untyped sheet, ?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, ?freeze_pane: untyped, ?split_pane: untyped, ?selection: untyped, ?sheet_view: untyped, ?sheet_properties: untyped, ?tables: untyped, ?table_start_rid: untyped, ?legacy_drawing_rid: untyped, ?sparkline_groups: untyped) -> untyped
+
+      def build_table_xml: (untyped tbl, untyped table_id) -> untyped
+
+      def build_core_properties_xml: () -> untyped
+
+      def build_app_properties_xml: () -> untyped
+
+      def build_custom_properties_xml: () -> untyped
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# Generated from lib/xlsxrb/ooxml/worksheet_parser.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # Streaming parser for xl/worksheets/sheetN.xml.
+    # Uses a fast string-scanning approach for row/cell extraction,
+    # falling back to REXML SAX only for column definitions and unmapped data.
+    class WorksheetParser
+      EMPTY_ARRAY: untyped
+
+      EMPTY_HASH: 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
+
+      # Streaming parse: yields one raw row hash at a time.
+      def self.each_row: (untyped xml_string, ?shared_strings: untyped, ?part_name: untyped) ?{ (?) -> untyped } -> untyped
+
+      # Parses column definitions (<cols>) from a worksheet.
+      def self.parse_columns: (untyped xml_string, ?part_name: untyped) -> 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
+
+      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
+
+      # Extract an attribute value from a small tag substring (bounded search).
+      def self.tag_attr: (untyped tag, untyped prefix) -> untyped
+
+      def self.fast_scan_cells_events: (untyped xml, untyped from, untyped to, untyped shared_strings, untyped row_source) ?{ (?) -> untyped } -> untyped
+
+      def self.extract_inline_text: (untyped xml, untyped from, untyped to) -> untyped
+
+      def self.resolve_fast_value: (untyped raw, untyped type, untyped shared_strings) -> untyped
+
+      XML_ENTITIES: untyped
+
+      # SECURITY NOTE: Decodes only standard predefined XML entities in a single pass.
+      # This completely prevents "Billion Laughs" attacks (exponential entity expansion)
+      # because it avoids recursive expansion and ignores custom entities entirely.
+      def self.decode_xml_entities: (untyped str) -> untyped
+
+      # Parses <cols> section for column definitions.
+      class ColumnsListener
+        include REXML::SAX2Listener
+
+        attr_reader columns: untyped
+
+        def initialize: () -> untyped
+
+        def start_element: (untyped _uri, untyped localname, untyped _qname, untyped attrs) -> untyped
+
+        def end_element: (untyped _uri, untyped localname, untyped _qname) -> untyped
+
+        def characters: (untyped _text) -> untyped
+      end
+
+      def self.fast_scan_rows_direct: (untyped xml_src, untyped shared_strings, untyped part_name) ?{ (?) -> untyped } -> untyped
+
+      def self.fast_parse_cells_direct: (untyped xml, untyped from, untyped to, untyped shared_strings, untyped row_source) -> untyped
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# Generated from lib/xlsxrb/ooxml/worksheet_writer.rb with RBS::Inline
+
+module Xlsxrb
+  module Ooxml
+    # Generates worksheet XML for a list of rows.
+    # Supports streaming: rows can be written one at a time.
+    class WorksheetWriter
+      SSML_NS: ::String
+
+      DOC_REL_NS: ::String
+
+      def initialize: (untyped io) -> untyped
+
+      # Write the worksheet header. Call once before writing rows.
+      # Options for pre-sheetData elements:
+      #   sheet_properties: Hash of sheet-level properties (:tab_color, etc.)
+      #   freeze_pane: { row:, col:, state: :frozen }
+      #   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
+
+      # 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
+
+      # Highly optimized row writing for StreamWriter that avoids allocating intermediate Hashes.
+      def write_row_values: (untyped row_index, untyped values, ?styles: untyped, ?style_map: untyped, ?sst: untyped, ?sst_index: untyped, ?attrs: untyped) -> untyped
+
+      # 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
+
+      private
+
+      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_protection: (untyped opts) -> untyped
+
+      def write_auto_filter: (untyped range, untyped filter_columns, untyped sort_state) -> untyped
+
+      def write_filter_column: (untyped col_id, untyped filter) -> untyped
+
+      def write_merge_cells: (untyped ranges) -> untyped
+
+      def write_conditional_formatting: (untyped rules) -> untyped
+
+      def write_data_validations: (untyped validations) -> untyped
+
+      def write_hyperlinks: (untyped links) -> untyped
+
+      def write_print_options: (untyped opts) -> untyped
+
+      def write_page_margins: (untyped margins) -> untyped
+
+      def write_page_setup: (untyped opts) -> untyped
+
+      def write_header_footer: (untyped opts) -> untyped
+
+      def write_row_breaks: (untyped breaks) -> untyped
+
+      def write_col_breaks: (untyped breaks) -> untyped
+
+      def write_table_parts: (untyped tables, untyped start_rid) -> untyped
+
+      def write_sparklines: (untyped groups) -> untyped
+
+      def write_sparkline_color: (untyped tag, untyped color) -> untyped
+
+      def write_columns: (untyped columns) -> untyped
+
+      def write_cell: (untyped cell) -> untyped
+
+      def cell_type: (untyped value) -> untyped
+
+      def xml_cell_value: (untyped value, untyped _type) -> untyped
+
+      def cell_ref: (untyped row_index, untyped col_index) -> untyped
+
+      def column_letter: (untyped index) -> untyped
+
+      INVALID_XML_CHARS_RE: ::Regexp
+
+      ESCAPE_RE: ::Regexp
+
+      ESCAPE_MAP: untyped
+
+      def escape_xml: (untyped value) -> untyped
+    end
+  end
+end