module Xlsxrb::DslHelpers - xlsxrb Documentation

normalize_column_indices (index)

(untyped index) → Array[Integer]

Source

# File lib/xlsxrb/dsl_helpers.rb, line 74
def self.normalize_column_indices(index)
  case index
  when Range, Array
    index.map { |i| Elements::Cell.column_index(i) }
  else
    [Elements::Cell.column_index(index)]
  end
end

Normalizes column index or letter or Range to an array of 0-based column integers.

@param index [Integer, String, Symbol, Range, Array] @return [Array<Integer>]

normalize_merge_range (range = nil, row: nil, col_start: nil, col_end: nil, row_start: nil, row_end: nil, strict_excel_mode: true)

(untyped range, ?row: Integer?, ?col_start: (Integer | String)?, ?col_end: (Integer | String)?, ?row_start: Integer?, ?row_end: Integer?, ?strict_excel_mode: bool) → String

Source

# File lib/xlsxrb/dsl_helpers.rb, line 25
def self.normalize_merge_range(range = nil, row: nil, col_start: nil, col_end: nil, row_start: nil, row_end: nil, strict_excel_mode: true)
  if range.is_a?(Hash)
    row = range[:row]
    row_start = range[:row_start]
    row_end = range[:row_end]
    col_start = range[:col_start]
    col_end = range[:col_end]
    range = nil
  end

  if range
    raise ArgumentError, "Invalid merge range format: '#{range}'. Expected format like 'A1:B2'." if strict_excel_mode && !range.match?(/\A[A-Za-z]{1,3}\d+(:[A-Za-z]{1,3}\d+)?\z/)

    range
  else
    r_start = row || row_start || 0
    r_end = row || row_end || 0
    c_start = Elements::Cell.column_index(col_start || 0)
    c_end = Elements::Cell.column_index(col_end || 0)
    start_ref = "#{Elements::Cell.column_letter(c_start)}#{r_start + 1}"
    end_ref = "#{Elements::Cell.column_letter(c_end)}#{r_end + 1}"
    "#{start_ref}:#{end_ref}"
  end
end

Normalizes merge cell range string or coordinate components into a canonical range reference (e.g. “A1:C3”).

@param range [String, Hash, nil] @param row [Integer, nil] @param col_start [Integer, String, nil] @param col_end [Integer, String, nil] @param row_start [Integer, nil] @param row_end [Integer, nil] @param strict_excel_mode [Boolean] @return [String]

normalize_page_margins (left: nil, right: nil, top: nil, bottom: nil, header: nil, footer: nil)

(?left: Float?, ?right: Float?, ?top: Float?, ?bottom: Float?, ?header: Float?, ?footer: Float?) → Hash[Symbol, Float]

Source

# File lib/xlsxrb/dsl_helpers.rb, line 93
def self.normalize_page_margins(left: nil, right: nil, top: nil, bottom: nil, header: nil, footer: nil)
  { left: left, right: right, top: top, bottom: bottom, header: header, footer: footer }.compact
end

Normalizes page margins into a compact hash.

@param left [Float, nil] @param right [Float, nil] @param top [Float, nil] @param bottom [Float, nil] @param header [Float, nil] @param footer [Float, nil] @return [Hash{Symbol => Float}]

normalize_protection_options (opts)

(Hash[Symbol, untyped] opts) → Hash[Symbol, untyped]

Source

# File lib/xlsxrb/dsl_helpers.rb, line 55
def self.normalize_protection_options(opts)
  normalized = opts.dup
  plain_password = normalized[:password]
  needs_hash = plain_password.is_a?(String) && !plain_password.empty? &&
               normalized[:algorithm_name].nil? && normalized[:hash_value].nil? &&
               normalized[:salt_value].nil? && normalized[:spin_count].nil? &&
               !plain_password.match?(/\A[0-9A-Fa-f]{4}\z/)
  if needs_hash
    normalized.delete(:password)
    normalized.merge!(Ooxml::Utils.hash_password(plain_password))
  end
  normalized
end

Normalizes sheet protection options and hashes plain-text password if supplied.

@param opts [Hash] @return [Hash]

normalize_table_options (ref, columns:, name: nil, display_name: nil, style: nil, **opts)

(String ref, columns: untyped, ?name: String?, ?display_name: String?, ?style: String?, **untyped opts) → Hash[Symbol, untyped]

Source

# File lib/xlsxrb/dsl_helpers.rb, line 107
def self.normalize_table_options(ref, columns:, name: nil, display_name: nil, style: nil, **opts)
  tbl = { ref: ref, columns: columns }
  tbl[:name] = name if name
  tbl[:display_name] = display_name if display_name
  tbl[:style] = style if style
  tbl.merge!(opts)
  tbl
end

Normalizes table options hash.

@param ref [String] @param columns [Array<String>, Array<Hash>] @param name [String, nil] @param display_name [String, nil] @param style [String, nil] @param opts [Hash] @return [Hash]