Module: Roo::Utils

Extended by:
Utils
Included in:
Utils
Defined in:
lib/roo/utils.rb

Constant Summary collapse

LETTERS = 
('A'..'Z').to_a

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.num_cells_in_range(str) ⇒ Object

Compute upper bound for cells in a given cell range.

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
 
# File 'lib/roo/utils.rb', line 58

def self.num_cells_in_range(str)
  cells = str.split(':')
  return 1 if cells.count == 1
  raise ArgumentError.new("invalid range string: #{str}. Supported range format 'A1:B2'") if cells.count != 2
  x1, y1 = split_coordinate(cells[0])
  x2, y2 = split_coordinate(cells[1])
  (x2 - (x1 - 1)) * (y2 - (y1 - 1))
end

Instance Method Details

#each_element(path, elements) ⇒ Object

Yield each element of a given type (‘row’, ‘c’, etc.) to caller



74
75
76
77
78
79
 
# File 'lib/roo/utils.rb', line 74

def each_element(path, elements)
  Nokogiri::XML::Reader(::File.open(path, 'rb'), nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).each do |node|
    next unless node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT && Array(elements).include?(node.name)
    yield Nokogiri::XML(node.outer_xml).root if block_given?
  end
end

#letter_to_number(letters) ⇒ Object

convert letters like ‘AB’ to a number (‘A’ => 1, ‘B’ => 2, …)



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/roo/utils.rb', line 44

def letter_to_number(letters)
  result = 0
  while letters && letters.length > 0
    character = letters[0, 1].upcase
    num       = LETTERS.index(character)
    fail ArgumentError, "invalid column character '#{letters[0, 1]}'" if num.nil?
    num     += 1
    result  = result * 26 + num
    letters = letters[1..-1]
  end
  result
end

#load_xml(path) ⇒ Object 



67
68
69
70
71
 
# File 'lib/roo/utils.rb', line 67

def load_xml(path)
  ::File.open(path, 'rb') do |file|
    ::Nokogiri::XML(file)
  end
end

#number_to_letter(n) ⇒ Object

convert a number to something like ‘AB’ (1 => ‘A’, 2 => ‘B’, …)



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/roo/utils.rb', line 25

def number_to_letter(n)
  letters = ''
  if n > 26
    while n % 26 == 0 && n != 0
      letters << 'Z'
      n = ((n - 26) / 26).to_i
    end
    while n > 0
      num     = n % 26
      letters = LETTERS[num - 1] + letters
      n       = (n / 26).to_i
    end
  else
    letters = LETTERS[n - 1]
  end
  letters
end

#split_coord(s) ⇒ Object 



14
15
16
17
18
19
20
21
22
 
# File 'lib/roo/utils.rb', line 14

def split_coord(s)
  if s =~ /([a-zA-Z]+)([0-9]+)/
    letter = Regexp.last_match[1]
    number = Regexp.last_match[2].to_i
  else
    fail ArgumentError
  end
  [letter, number]
end

#split_coordinate(str) ⇒ Object Also known as: ref_to_key 



5
6
7
8
9
10
 
# File 'lib/roo/utils.rb', line 5

def split_coordinate(str)
  letter, number = split_coord(str)
  x              = letter_to_number(letter)
  y              = number
  [y, x]
end