Module: ToSpreadsheet::Selectors

Included in:
Rule::Base
Defined in:
lib/to_spreadsheet/selectors.rb

Overview

This is the DSL context for ‘format_xls` Query types: :css, :column, :row or :range Query values: For css: [String] css selector For column and row: [Fixnum] column/row number For range: [String] table range, e.g. A4:B5

Instance Method Summary collapse

Instance Method Details

#column_number_match?(column_number, xls_cell) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/to_spreadsheet/selectors.rb', line 77

def column_number_match?(column_number, xls_cell)
  xls_cell.index == column_number if xls_cell.is_a?(Axlsx::Cell)
end

#css_match(css_selector, xml_node, &block) ⇒ Object 



59
60
61
62
63
 
# File 'lib/to_spreadsheet/selectors.rb', line 59

def css_match(css_selector, xml_node, &block)
  result = xml_node.css(css_selector)
  block.call(xml_node) if xml_node.matches?(css_selector)
  result.each(&block)
end

#css_match?(css_selector, xml_document, xml_node) ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/to_spreadsheet/selectors.rb', line 65

def css_match?(css_selector, xml_document, xml_node)
  xml_document.css(css_selector).include?(xml_node)
end

#each_cell(context, sheet, selector_type, selector_query, &block) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/to_spreadsheet/selectors.rb', line 36

def each_cell(context, sheet, selector_type, selector_query, &block)
  if !selector_type
    sheet.rows.each do |row|
      sheet.cells.each do |cell|
        block.(cell)
      end
    end
    return
  end
  case selector_type
    when :css
      css_match selector_query, context.to_xml_node(sheet) do |xml_node|
        block.(context.to_xls_entity(xml_node))
      end
    when :column
      sheet.cols[selector_query].cells.each(&block)
    when :row
      sheet.cols[selector_query].cells.each(&block)
    when :range
      sheet[range].each(&block)
  end
end

#query_match?(options) ⇒ Boolean

Flexible API query match Options (all optional):

xls_worksheet
xls_entity
xml_document
xml_node
selector_type :css, :column, :row or :range
selector_query

Returns:

  • (Boolean) 


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/to_spreadsheet/selectors.rb', line 17

def query_match?(options)
  return true if !options[:selector_query]
  case options[:selector_type]
    when :css
      css_match? options[:selector_query], options[:xml_document], options[:xml_node]
    when :column
      return false unless [Axlsx::Row, Axlsx::Cell].include?(options[:xml_node].class)
      column_number_match? options[:selector_query], options[:xml_node]
    when :row
      return false unless Axlsx::Cell == options[:xml_node].class
      row_number_match? options[:selector_query], options[:xml_node]
    when :range
      return false if entity.is_a?(Axlsx::Cell)
      range_contains? options[:selector_query], options[:xml_node]
    else
      raise "Unsupported type #{options[:selector_type].inspect} (:css, :column, :row or :range expected)"
  end
end

#range_contains?(range, xls_cell) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
88
89
 
# File 'lib/to_spreadsheet/selectors.rb', line 85

def range_contains?(range, xls_cell)
  pos                 = xls_cell.pos
  top_left, bot_right = range.split(':').map { |s| Axlsx.name_to_indices(s) }
  pos[0] >= top_left[0] && pos[0] <= bot_right[0] && pos[1] >= top_left[1] && pos[1] <= bot_right[1]
end

#range_match(range, xls_sheet) ⇒ Object 



81
82
83
 
# File 'lib/to_spreadsheet/selectors.rb', line 81

def range_match(range, xls_sheet)
  xls_sheet[range]
end

#row_number_match?(row_number, xls_row_or_cell) ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
72
73
74
75
 
# File 'lib/to_spreadsheet/selectors.rb', line 69

def row_number_match?(row_number, xls_row_or_cell)
  if xls_row_or_cell.is_a? Axlsx::Row
    row_number == xls_row_or_cell.index
  elsif xls_row_or_cell.is_a? Axlsx::Cell
    row_number == xls_row_or_cell.row.index
  end
end