Module: SpreadsheetArchitect::Utils::XLSX

Defined in:
lib/spreadsheet_architect/utils/xlsx.rb

Class Method Summary collapse

Class Method Details

.conditional_styles_for_row(conditional_row_styles, row_index, row_data) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/spreadsheet_architect/utils/xlsx.rb', line 151

def self.conditional_styles_for_row(conditional_row_styles, row_index, row_data)
  merged_conditional_styles = {}

  conditional_row_styles.each do |x|
    if x[:if] && x[:unless]
      raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Cannot pass both :if and :unless within the same :conditonal_row_styles entry')
    elsif !x[:if] && !x[:unless]
      raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must pass either :if or :unless within the each :conditonal_row_styles entry')
    elsif !x[:styles]
      raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must pass the :styles option within a :conditonal_row_styles entry')
    end

    conditions_met = (x[:if] || x[:unless]).call(row_data, row_index)

    if x[:unless]
      conditions_met = !conditions_met
    end

    if conditions_met
      merged_conditional_styles.merge!(x[:styles])
    end
  end

  return merged_conditional_styles
end

.convert_styles_to_axlsx(styles = {}) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/spreadsheet_architect/utils/xlsx.rb', line 27

def self.convert_styles_to_axlsx(styles={})
  styles = {} unless styles.is_a?(Hash)
  styles = self.symbolize_keys(styles)

  if styles[:fg_color].nil? && styles[:color] && styles[:color].respond_to?(:sub) && !styles[:color].empty?
    styles[:fg_color] = styles.delete(:color).sub('#','')
  end

  if styles[:bg_color].nil? && styles[:background_color] && styles[:background_color].respond_to?(:sub) && !styles[:background_color].empty?
    styles[:bg_color] = styles.delete(:background_color).sub('#','')
  end
  
  if styles[:alignment].nil? && styles[:align]
    if styles[:align].is_a?(Hash)
      styles[:alignment] = {
        horizontal: styles[:align][:horizontal], 
        vertical: styles[:align][:vertical], 
        wrap_text: styles[:align][:wrap_text]
      }
    else
      styles[:alignment] = {horizontal: (styles.delete(:align) || nil) }
    end

    styles.delete(:align)
  end

  if styles[:b].nil?
    styles[:b] = styles.delete(:bold) || nil
  end

  if styles[:sz].nil?
    styles[:sz] = styles.delete(:font_size) || nil
  end

  if styles[:i].nil?
    styles[:i] = styles.delete(:italic) || nil
  end

  if styles[:u].nil?
    styles[:u] = styles.delete(:underline) || nil
  end

  ### If `:u` is false instead of nil, it may be incorrectly rendered as true in Excel
  if styles[:u] == false
    styles[:u] = nil
  end
  
  styles.delete_if{|k,v| v.nil?}
end

.get_type(value, type = nil) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/spreadsheet_architect/utils/xlsx.rb', line 5

def self.get_type(value, type=nil)
  return type unless (type.respond_to?(:empty?) ? type.empty? : type.nil?)
  
  if value.is_a?(Numeric)
    if value.is_a?(Float) || value.is_a?(BigDecimal)
      type = :float
    else
      type = :integer
    end
  elsif value.respond_to?(:strftime)
    if value.is_a?(DateTime) || value.is_a?(Time)
      type = :time
    else
      type = :date
    end
  else
    type = :string
  end

  return type
end

.range_hash_to_str(hash, num_columns, num_rows) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/spreadsheet_architect/utils/xlsx.rb', line 77

def self.range_hash_to_str(hash, num_columns, num_rows)
  case hash[:columns]
  when Integer
    start_col = end_col = COL_NAMES[hash[:columns]]
  when String
    start_col = hash[:columns].first
    end_col = hash[:columns].last
  when Range
    start_col = hash[:columns].first
    unless start_col.is_a?(String)
      start_col = COL_NAMES[start_col]
    end

    end_col = hash[:columns].last
    unless end_col.is_a?(String)
      end_col = COL_NAMES[end_col]
    end
  when :all
    start_col = 'A'
    end_col = COL_NAMES[num_columns-1]
  else
    raise SpreadsheetArchitect::Exceptions::InvalidRangeStylesOptionError.new(:columns, hash)
  end

  case hash[:rows]
  when Integer
    start_row = end_row = hash[:rows]
  when Range
    start_row = hash[:rows].first
    end_row = hash[:rows].last
  when :all
    start_row = 1
    end_row = num_rows
  else
    raise SpreadsheetArchitect::Exceptions::InvalidRangeStylesOptionError.new(:rows, hash)
  end

  range_str = "#{start_col}#{start_row}:#{end_col}#{end_row}"

  unless hash[:columns] == :all && hash[:rows] == :all
    verify_range(range_str, num_rows)
  end

  return range_str
end

.verify_column(col, num_columns) ⇒ Object 



145
146
147
148
149
 
# File 'lib/spreadsheet_architect/utils/xlsx.rb', line 145

def self.verify_column(col, num_columns)
  unless (col.is_a?(String) && COL_NAMES.include?(col)) || (col.is_a?(Integer) && col >= 0 && col < num_columns)
    raise SpreadsheetArchitect::Exceptions::InvalidColumnError.new(col)
  end
end

.verify_range(range, num_rows) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/spreadsheet_architect/utils/xlsx.rb', line 123

def self.verify_range(range, num_rows)
  if range.is_a?(String)
    if range.include?(':')
      front, back = range.split(':')
      start_col, start_row = front.scan(/\d+|\D+/)
      end_col, end_row = back.scan(/\d+|\D+/)

      unless COL_NAMES.include?(start_col) && COL_NAMES.include?(end_col)
        raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:columns, range)
      end
      
      unless start_row.to_i <= num_rows && end_row.to_i <= num_rows
        raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:rows, range)
      end
    else
      raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:format, range)
    end
  else
    raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:type, range)
  end
end