xlsxrb 0.1.12 → 0.1.13

data/lib/xlsxrb/stream_sheet.rb

@@ -36,15 +36,20 @@ module Xlsxrb
     # Initializes a streaming worksheet context.
     #
     # @param name [String] The sheet name.
-    # @param sheet_xml [String] Raw XML content of the worksheet.
+    # @param sheet_source [String, Proc, IO, nil] Raw XML content or chunk supplier/stream.
     # @param shared_strings [Array<String>] Shared strings table.
     # @param styles [Hash, nil] Optional parsed styles hash.
-    #: (String name, String sheet_xml, Array[String] shared_strings, ?Hash[untyped, untyped]? styles) -> void
-    def initialize(name, sheet_xml, shared_strings, styles = nil)
+    # @param zip_reader [Ooxml::ZipReader, nil] Optional ZipReader context.
+    # @param entry_name [String, nil] Archive entry name for this sheet.
+    #: (String name, untyped sheet_source, Array[String] shared_strings, ?Hash[untyped, untyped]? styles, ?zip_reader: Ooxml::ZipReader?, ?entry_name: String?) -> void
+    def initialize(name, sheet_source, shared_strings, styles = nil, zip_reader: nil, entry_name: nil)
       @name = name
-      @sheet_xml = sheet_xml
+      @sheet_source = sheet_source
       @shared_strings = shared_strings
       @styles = styles
+      @zip_reader = zip_reader
+      @entry_name = entry_name
+      @sheet_xml = sheet_source if sheet_source.is_a?(String)
     end
 
     # Iterates over rows in this streaming worksheet with O(1) memory.
@@ -63,7 +68,13 @@ module Xlsxrb
     def each_row(&)
       return enum_for(:each_row) unless block_given?
 
-      Ooxml::WorksheetParser.each_row(@sheet_xml, shared_strings: @shared_strings, &)
+      source = if @sheet_source
+                 @sheet_source
+               elsif @zip_reader && @entry_name
+                 ->(&blk) { @zip_reader.each_entry_chunk(@entry_name, &blk) }
+               end
+
+      Ooxml::WorksheetParser.each_row(source, shared_strings: @shared_strings, &)
     end
 
     # Iterates over all cells across all rows continuously with O(1) memory.
@@ -112,8 +123,85 @@ module Xlsxrb
     # @api public
     #: () -> Elements::Worksheet
     def load
-      Xlsxrb.send(:build_worksheet, @name, @sheet_xml, @shared_strings, @styles)
+      Xlsxrb.send(:build_worksheet, @name, raw_sheet_xml, @shared_strings, @styles)
     end
     alias to_worksheet load
+
+    # Returns merged cell ranges (e.g. ["A1:B2"]) for this worksheet.
+    #
+    # @return [Array<String>]
+    # @api public
+    #: () -> Array[String]
+    def merged_cells
+      @merged_cells ||= begin
+        listener = Ooxml::Reader::MergeCellsListener.new
+        Ooxml::XmlParser.parse(raw_sheet_xml, listener)
+        listener.ranges
+      end
+    end
+
+    # Returns the auto-filter range (e.g. "A1:E100") for this worksheet, or nil if none.
+    #
+    # @return [String, nil]
+    # @api public
+    #: () -> String?
+    def auto_filter
+      @auto_filter ||= begin
+        listener = Ooxml::Reader::AutoFilterListener.new
+        Ooxml::XmlParser.parse(raw_sheet_xml, listener)
+        listener.ref
+      end
+    end
+
+    # Returns data validation rules configured for this worksheet.
+    #
+    # @return [Array<Hash[Symbol, untyped]>]
+    # @api public
+    #: () -> Array[Hash[Symbol, untyped]]
+    def data_validations
+      @data_validations ||= begin
+        listener = Ooxml::Reader::DataValidationsListener.new
+        Ooxml::XmlParser.parse(raw_sheet_xml, listener)
+        listener.validations
+      end
+    end
+
+    # Returns conditional formatting rules configured for this worksheet.
+    #
+    # @return [Array<Hash[Symbol, untyped]>]
+    # @api public
+    #: () -> Array[Hash[Symbol, untyped]]
+    def conditional_formats
+      @conditional_formats ||= begin
+        listener = Ooxml::Reader::ConditionalFormattingListener.new
+        Ooxml::XmlParser.parse(raw_sheet_xml, listener)
+        listener.rules
+      end
+    end
+
+    # Closes any underlying reader resources.
+    #: () -> void
+    def close
+      @zip_reader&.close
+      nil
+    end
+
+    private
+
+    # Returns the full raw XML string for this worksheet, loaded on demand.
+    #: () -> String
+    def raw_sheet_xml
+      @raw_sheet_xml ||= if @sheet_source.is_a?(String)
+                           @sheet_source
+                         elsif @zip_reader && @entry_name
+                           @zip_reader.read_entry(@entry_name) || ""
+                         elsif @sheet_source.respond_to?(:call)
+                           buf = +""
+                           @sheet_source.call { |c| buf << c }
+                           buf
+                         else
+                           ""
+                         end
+    end
   end
 end

data/lib/xlsxrb/stream_writer.rb

@@ -911,39 +911,11 @@ module Xlsxrb
       sheet if @current_sheet.nil?
 
       row_index = @current_row_index
-      # See: https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
-      if @strict_excel_mode
-        raise ArgumentError, "Row index #{row_index} exceeds Excel limit of 1,048,576 rows" if row_index >= 1_048_576
-        raise ArgumentError, "Row height #{height} must be between 0 and 409 points (Excel limitation)" if height && (height.negative? || height > 409)
-      end
+      DslHelpers.validate_row_bounds!(row_index, height, strict_excel_mode: @strict_excel_mode)
       @current_row_index += 1
 
-      if values.is_a?(Hash)
-        max_col = values.keys.map { |k| Elements::Cell.column_index(k) }.max || -1
-        cells_array = Array.new(max_col + 1)
-        values.each do |k, v|
-          idx = Elements::Cell.column_index(k)
-          cells_array[idx] = v
-        end
-        values = cells_array
-      end
-
-      if styles.is_a?(Hash)
-        expanded_styles = {}
-        styles.each do |k, v|
-          if k.is_a?(Range) || k.is_a?(Array)
-            k.each { |idx| expanded_styles[Elements::Cell.column_index(idx)] = v }
-          else
-            expanded_styles[Elements::Cell.column_index(k)] = v
-          end
-        end
-        max_col_style = expanded_styles.keys.max || -1
-        styles_array = Array.new(max_col_style + 1)
-        expanded_styles.each do |idx, v|
-          styles_array[idx] = v
-        end
-        styles = styles_array
-      end
+      values = DslHelpers.normalize_row_values(values)
+      styles = DslHelpers.normalize_row_styles(styles)
 
       if @current_charts && !@current_charts.empty?
         @current_cells ||= {}
@@ -1509,37 +1481,35 @@ module Xlsxrb
     def close
       raise ArgumentError, "Workbook must contain at least one sheet (Excel limitation)" if @strict_excel_mode && @sheets.empty? && @current_sheet.nil?
 
-      Xlsxrb.in_span("StreamWriter#close") do
-        flush_current_sheet
-
-        styles_definition = {
-          fonts: @style_writer.fonts.dup,
-          fills: @style_writer.fills.dup,
-          borders: @style_writer.borders.dup,
-          xf_entries: @style_writer.xf_entries.dup,
-          num_fmts: @style_writer.num_fmts.dup,
-          dxfs: @dxfs || []
-        }
-
-        resolved_names = resolve_defined_names(@defined_names, @sheets)
-
-        wb_writer = Ooxml::WorkbookWriter.new(
-          sheets: @sheets,
-          shared_strings: @sst,
-          shared_strings_index: @sst_index,
-          styles: styles_definition,
-          defined_names: resolved_names.empty? ? nil : resolved_names,
-          core_properties: @core_properties.empty? ? nil : @core_properties,
-          app_properties: @app_properties.empty? ? nil : @app_properties,
-          custom_properties: @custom_properties.empty? ? nil : @custom_properties,
-          workbook_protection: @workbook_protection,
-          workbook_properties: @workbook_properties
-        )
-        wb_writer.write_package_parts(@zip)
-
-        @zip.close
-        @io.close if @owns_io && !@io.closed?
-      end
+      flush_current_sheet
+
+      styles_definition = {
+        fonts: @style_writer.fonts.dup,
+        fills: @style_writer.fills.dup,
+        borders: @style_writer.borders.dup,
+        xf_entries: @style_writer.xf_entries.dup,
+        num_fmts: @style_writer.num_fmts.dup,
+        dxfs: @dxfs || []
+      }
+
+      resolved_names = resolve_defined_names(@defined_names, @sheets)
+
+      wb_writer = Ooxml::WorkbookWriter.new(
+        sheets: @sheets,
+        shared_strings: @sst,
+        shared_strings_index: @sst_index,
+        styles: styles_definition,
+        defined_names: resolved_names.empty? ? nil : resolved_names,
+        core_properties: @core_properties.empty? ? nil : @core_properties,
+        app_properties: @app_properties.empty? ? nil : @app_properties,
+        custom_properties: @custom_properties.empty? ? nil : @custom_properties,
+        workbook_protection: @workbook_protection,
+        workbook_properties: @workbook_properties
+      )
+      wb_writer.write_package_parts(@zip)
+
+      @zip.close
+      @io.close if @owns_io && !@io.closed?
     ensure
       cleanup!
     end
@@ -1570,10 +1540,7 @@ module Xlsxrb
 
     #: (untyped range) -> untyped
     def absolute_range(range)
-      # simplecov:disable
-      # Edge case / untested delegation block
-      range.gsub(/([A-Z]+)(\d+)/, '$\1$\2')
-      # simplecov:enable
+      DslHelpers.absolute_range(range)
     end
 
     #: (untyped names, untyped sheets) -> untyped

data/lib/xlsxrb/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 module Xlsxrb
-  VERSION = "0.1.12"
+  VERSION = "0.1.13"
 end

data/lib/xlsxrb/workbook_builder.rb

@@ -210,7 +210,7 @@ module Xlsxrb
 
     #: (untyped range) -> untyped
     def absolute_range(range)
-      range.gsub(/([A-Z]+)(\d+)/, '$\1$\2')
+      DslHelpers.absolute_range(range)
     end
 
     #: (untyped names, untyped sheets) -> untyped

data/lib/xlsxrb/worksheet_builder.rb

@@ -87,38 +87,10 @@ module Xlsxrb
     #: (Array[untyped] | Hash[untyped, untyped] values, ?styles: untyped, ?height: Float | Integer | nil, ?hidden: bool, ?custom_height: bool, ?outline_level: Integer | nil) -> void
     def row(values, styles: nil, height: nil, hidden: false, custom_height: false, outline_level: nil)
       row_index = @rows.size
-      # See: https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
-      if @strict_excel_mode
-        raise ArgumentError, "Row index #{row_index} exceeds Excel limit of 1,048,576 rows" if row_index >= 1_048_576
-        raise ArgumentError, "Row height #{height} must be between 0 and 409 points (Excel limitation)" if height && (height.negative? || height > 409)
-      end
-
-      if values.is_a?(Hash)
-        max_col = values.keys.map { |k| Elements::Cell.column_index(k) }.max || -1
-        cells_array = Array.new(max_col + 1)
-        values.each do |k, v|
-          idx = Elements::Cell.column_index(k)
-          cells_array[idx] = v
-        end
-        values = cells_array
-      end
+      DslHelpers.validate_row_bounds!(row_index, height, strict_excel_mode: @strict_excel_mode)
 
-      if styles.is_a?(Hash)
-        expanded_styles = {}
-        styles.each do |k, v|
-          if k.is_a?(Range) || k.is_a?(Array)
-            k.each { |idx| expanded_styles[Elements::Cell.column_index(idx)] = v }
-          else
-            expanded_styles[Elements::Cell.column_index(k)] = v
-          end
-        end
-        max_col_style = expanded_styles.keys.max || -1
-        styles_array = Array.new(max_col_style + 1)
-        expanded_styles.each do |idx, v|
-          styles_array[idx] = v
-        end
-        styles = styles_array
-      end
+      values = DslHelpers.normalize_row_values(values)
+      styles = DslHelpers.normalize_row_styles(styles)
 
       # Auto-detect Date / Time for built-in styles
       values.each_with_index do |val, idx|