Class: RubyXL::Reference

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyXL/objects/reference.rb

Constant Summary collapse

ROW_MAX = 
1024 * 1024
COL_MAX = 
16393

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*params) ⇒ Reference

RubyXL::Reference.new(row, col) RubyXL::Reference.new(row_from, row_to, col_from, col_to) RubyXL::Reference.new(reference_string) RubyXL::Reference.new(row_from:, row_to:, col_from:, col_to:)



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/rubyXL/objects/reference.rb', line 12

def initialize(*params)
  row_from = row_to = col_from = col_to = nil

  case params.size
  when 4 then row_from, row_to, col_from, col_to = params
  when 2 then row_from, col_from = params
  when 1 then
    case params.first
    when Hash then
      row_from, row_to, col_from, col_to = params.first.fetch_values(:row_from, :row_to, :col_from, :col_to)
    when String then
      from, to = params[0].split(':')
      row_from, col_from = self.class.ref2ind(from)
      row_to, col_to = self.class.ref2ind(to) unless to.nil?
    else
      raise ArgumentError.new("invalid value for #{self.class}: #{params[0].inspect}") unless params[0].is_a?(String)
    end
  end

  @row_range = Range.new(row_from || 0, row_to || row_from || ROW_MAX)
  @col_range = Range.new(col_from || 0, col_to || col_from || COL_MAX)
end

Instance Attribute Details

#col_range ⇒ Object (readonly)

Returns the value of attribute col_range.



6
7
8
 
# File 'lib/rubyXL/objects/reference.rb', line 6

def col_range
  @col_range
end

#row_range ⇒ Object (readonly)

Returns the value of attribute row_range.



6
7
8
 
# File 'lib/rubyXL/objects/reference.rb', line 6

def row_range
  @row_range
end

Class Method Details

.ind2ref(row = 0, col = 0) ⇒ Object

Converts row and col zero-based indices to Excel-style cell reference <0> A…Z, AA…AZ, BA… …ZZ, AAA… …AZZ, BAA… …XFD <16383>



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rubyXL/objects/reference.rb', line 89

def self.ind2ref(row = 0, col = 0)
  str = ''

  loop do
    x = col % 26
    str = ('A'.ord + x).chr + str
    col = (col / 26).floor - 1
    break if col < 0
  end

  str += (row + 1).to_s
end

.ref2ind(str) ⇒ Object

Converts Excel-style cell reference to row and col zero-based indices.



103
104
105
106
107
 
# File 'lib/rubyXL/objects/reference.rb', line 103

def self.ref2ind(str)
  return [ -1, -1 ] unless str =~ /\A([A-Z]+)(\d+)\Z/
  [ Regexp.last_match(2).to_i - 1,
    Regexp.last_match(1).each_byte.inject(0) { |col, chr| (col * 26) + (chr - 64) } - 1 ]
end

Instance Method Details

#==(other) ⇒ Object 



59
60
61
 
# File 'lib/rubyXL/objects/reference.rb', line 59

def ==(other)
  !other.nil? && (@row_range == other.row_range) && (@col_range == other.col_range)
end

#cover?(other) ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
66
67
68
 
# File 'lib/rubyXL/objects/reference.rb', line 63

def cover?(other)
  !other.nil? && (@row_range.cover?(other.row_range.begin) &&
                  @row_range.cover?(other.row_range.end) &&
                  @col_range.cover?(other.col_range.begin) &&
                  @col_range.cover?(other.col_range.end))
end

#first_col ⇒ Object 



51
52
53
 
# File 'lib/rubyXL/objects/reference.rb', line 51

def first_col
  @col_range.begin
end

#first_row ⇒ Object 



43
44
45
 
# File 'lib/rubyXL/objects/reference.rb', line 43

def first_row
  @row_range.begin
end

#inspect ⇒ Object 



79
80
81
82
83
84
85
 
# File 'lib/rubyXL/objects/reference.rb', line 79

def inspect
  if single_cell? then
    "#<#{self.class} @row=#{@row_range.begin} @col=#{@col_range.begin}>"
  else
    "#<#{self.class} @row_range=#{@row_range} @col_range=#{@col_range}>"
  end
end

#last_col ⇒ Object 



55
56
57
 
# File 'lib/rubyXL/objects/reference.rb', line 55

def last_col
  @col_range.end
end

#last_row ⇒ Object 



47
48
49
 
# File 'lib/rubyXL/objects/reference.rb', line 47

def last_row
  @row_range.end
end

#single_cell? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/rubyXL/objects/reference.rb', line 35

def single_cell?
  (@row_range.begin == @row_range.end) && (@col_range.begin == @col_range.end)
end

#to_s ⇒ Object 



70
71
72
73
74
75
76
77
 
# File 'lib/rubyXL/objects/reference.rb', line 70

def to_s
  if single_cell? then
    self.class.ind2ref(@row_range.begin, @col_range.begin)
  else
    self.class.ind2ref(@row_range.begin, @col_range.begin) + ':' +
                       self.class.ind2ref(@row_range.end, @col_range.end)
  end
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/rubyXL/objects/reference.rb', line 39

def valid?
  !(row_range.begin.negative? || col_range.begin.negative?)
end