Class: NtqExcelsior::Exporter

Inherits:
Object
  • Object
show all
Defined in:
lib/ntq_excelsior/exporter.rb

Constant Summary collapse

DEFAULT_STYLES = 
{
  date_format: {
    format_code: 'dd-mm-yyyy'
  },
  time_format: {
    format_code: 'dd-mm-yyyy hh:mm:ss'
  },
  bold: {
    b: true
  },
  italic: {
    i: true
  },
  center: {
    alignment: { wrap_text: true }
  }
}
COLUMN_NAMES = 
Array('A'..'Z').freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ Exporter

Returns a new instance of Exporter.



38
39
40
41
 
# File 'lib/ntq_excelsior/exporter.rb', line 38

def initialize(data)
  @data = data
  @data_count = data.size.to_d
end

Instance Attribute Details

#context ⇒ Object

Returns the value of attribute context.



6
7
8
 
# File 'lib/ntq_excelsior/exporter.rb', line 6

def context
  @context
end

#data ⇒ Object

Returns the value of attribute data.



5
6
7
 
# File 'lib/ntq_excelsior/exporter.rb', line 5

def data
  @data
end

#progression_tracker ⇒ Object

Returns the value of attribute progression_tracker.



7
8
9
 
# File 'lib/ntq_excelsior/exporter.rb', line 7

def progression_tracker
  @progression_tracker
end

Class Method Details

.schema(value = nil) ⇒ Object 



30
31
32
 
# File 'lib/ntq_excelsior/exporter.rb', line 30

def schema(value = nil)
  @schema ||= value
end

.styles(value = nil) ⇒ Object 



33
34
35
 
# File 'lib/ntq_excelsior/exporter.rb', line 33

def styles(value = nil)
  @styles ||= value
end

Instance Method Details

#add_sheet_content(content, wb_styles, sheet) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/ntq_excelsior/exporter.rb', line 248

def add_sheet_content(content, wb_styles, sheet)
  content[:rows].each_with_index do |row, index|
    row_style = []
    if row[:styles].is_a?(Array) && row[:styles].any?
      row[:styles].each do |style|
        row_style << wb_styles.add_style(style || {})
      end
    end
    sheet.add_row row[:values], style: row_style, height: row[:height], types: row[:types]
    if progression_tracker&.is_a?(Proc)
      at = 50 + ((((index + 1).to_d / @data_count) * 100.to_d) / 2).round(2)
      progression_tracker.call(at) if at % 5 == 0 || index == content[:rows].length - 1
    end
    if row[:data_validations]
      row[:data_validations].each do |validation|
        sheet.add_data_validation(validation[:range], validation[:config])
      end
    end
    if row[:merge_cells]
      row[:merge_cells]&.each do |range|
        sheet.merge_cells range
      end
    end
  end

  # do not apply styles if there are no rows
  if content[:rows].present?
    content[:styles]&.each_with_index do |(range, sty), index|
      begin
        sheet.add_style range, sty.except(:border) if range && sty
        sheet.add_border range, sty[:border] if range && sty && sty[:border]
      rescue NoMethodError
        # do not apply styles if error
      end
    end

    sheet.column_widths * content[:col_widths] if content[:col_widths].present?
  end

  sheet
end

#cell_name(col, row = nil, *lock) ⇒ Object 



66
67
68
 
# File 'lib/ntq_excelsior/exporter.rb', line 66

def cell_name(col, row = nil, *lock)
  "#{lock.include?(:col) ? '$' : ''}#{column_name(col)}#{lock.include?(:row) ? '$' : ''}#{row}"
end

#cells_range(starting = [], ending = []) ⇒ Object 



70
71
72
 
# File 'lib/ntq_excelsior/exporter.rb', line 70

def cells_range(starting = [], ending = [])
  "#{cell_name(*starting)}:#{cell_name(*ending)}"
end

#column_is_visible?(column, record = nil) ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
101
102
 
# File 'lib/ntq_excelsior/exporter.rb', line 97

def column_is_visible?(column, record = nil)
  return true if !column.key?(:visible)
  return column[:visible].call(record, context) if column[:visible].is_a?(Proc)

  column[:visible]
end

#column_name(col_index) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ntq_excelsior/exporter.rb', line 51

def column_name(col_index)
  index = col_index - 1
  return COLUMN_NAMES[index] if index < 26

  letters = []
  letters << index % 26

  while index >= 26 do
    index = (index / 26) - 1
    letters << index % 26
  end

  letters.reverse.map { |i| COLUMN_NAMES[i] }.join
end

#column_width(column) ⇒ Object 



104
105
106
107
108
 
# File 'lib/ntq_excelsior/exporter.rb', line 104

def column_width(column)
  return column[:width].call(context) if column[:width] && column[:width].is_a?(Proc)

  column[:width] || 1
end

#content ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/ntq_excelsior/exporter.rb', line 228

def content
  content = { rows: [] }
  index = 0
  (schema[:extra_headers] || []).each_with_index do |header|
    index += 1
    content[:rows] << resolve_header_row(header, index)
  end
  index += 1
  content[:rows] << resolve_header_row(schema[:columns], index)
  @data.each_with_index do |record, index|
    index += 1
    if progression_tracker&.is_a?(Proc)
      at = ((((index + 1).to_d / @data_count) * 100.to_d) / 2).round(2)
      progression_tracker.call(at) if at % 5 == 0
    end
    content[:rows] << resolve_record_row(schema[:columns], record, index)
  end
  content
end

#dig_value(value, accessors = []) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ntq_excelsior/exporter.rb', line 139

def dig_value(value, accessors = [])
  v = value
  return  v unless accessors && accessors.length > 0

  return v.dig(*accessors) if v.is_a?(Hash)

  v = v.send(accessors[0])
  return v if accessors.length == 1
  return dig_value(v, accessors.slice(1..-1))
end

#export ⇒ Object 



297
298
299
300
301
302
303
304
305
 
# File 'lib/ntq_excelsior/exporter.rb', line 297

def export
  package = Axlsx::Package.new
  wb = package.workbook
  wb_styles = wb.styles

  generate_workbook(wb, wb_styles)

  package
end

#format_value(resolver, record) ⇒ Object 



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

def format_value(resolver, record)
  styles = []
  type = nil
  if resolver.is_a?(Proc)
    value = resolver.call(record) 
  else
    accessors = resolver
    accessors = accessors.split(".") if accessors.is_a?(String)
    value = dig_value(record, accessors)
  end
  if value.is_a?(String)
    type = :string
  end
  if value.is_a?(Date)
    value = value.strftime("%Y-%m-%d")
    styles << :date_format
    type = :date
  end
  if value.is_a?(Time) | value.is_a?(DateTime)
    value = value.strftime("%Y-%m-%d %H:%M:%S")
    styles << :time_format
    type = :time
  end
  { value: value, styles: styles, type: type }
end

#generate_workbook(wb, wb_styles) ⇒ Object 



290
291
292
293
294
295
 
# File 'lib/ntq_excelsior/exporter.rb', line 290

def generate_workbook(wb, wb_styles)
  columns = schema[:columns]
  wb.add_worksheet(name: schema[:name]) do |sheet|
    add_sheet_content content, wb_styles, sheet
  end
end

#get_styles(row_styles, cell_styles = []) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ntq_excelsior/exporter.rb', line 85

def get_styles(row_styles, cell_styles = [])
  row_styles ||= []
  return {} if row_styles.length == 0 && cell_styles.length == 0

  styles_hash = {}
  stylesheet = styles || {}
  (row_styles + cell_styles).each do |style_key|
    styles_hash = styles_hash.merge(stylesheet[style_key] || DEFAULT_STYLES[style_key] || {})
  end
  styles_hash
end

#list_data_validation_for_column(list_config) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ntq_excelsior/exporter.rb', line 199

def list_data_validation_for_column(list_config)
  if list_config.is_a?(Array)
    return {
      type: :list,
      formula1: "\"#{list_config.join(', ')}\""
    }
  end

  config = {
    type: :list,
    formula1: "\"#{list_config[:options].join(', ')}\"",
    showErrorMessage: list_config[:show_error_message] || false,
    showInputMessage: list_config[:show_input_message] || false,
  }

  if list_config[:show_error_message]
    config[:error] = list_config[:error] || ''
    config[:errorStyle] = list_config[:error_style] || :stop
    config[:errorTitle] = list_config[:error_title] || ''
  end

  if list_config[:show_input_message]
    config[:promptTitle] = list_config[:prompt_title] || ''
    config[:prompt] = list_config[:prompt] || ''
  end

  config
end

#number_of_headers_row(columns, count = 1) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ntq_excelsior/exporter.rb', line 74

def number_of_headers_row(columns, count = 1)
  columns_with_children = columns.select{ |c| c[:children] && c[:children].any? }
  return count unless columns_with_children && columns_with_children.size > 0

  columns_with_children.each do |column|
    number_of_children = number_of_headers_row(column[:children], count += 1) 
    count = number_of_children if number_of_children > count
  end
  count
end

#resolve_header_row(headers, index) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/ntq_excelsior/exporter.rb', line 110

def resolve_header_row(headers, index)
  row = { values: [], styles: [], merge_cells: [], height: nil }
  return row unless headers

  col_index = 1
  headers.each do |header|
    next unless column_is_visible?(header)

    width = column_width(header)
    row[:values] << header[:title] || ''
    row[:styles] << get_styles(header[:header_styles] || header[:styles])
    row[:data_validations] ||= []
    if header[:list]
      row[:data_validations].push({
        range: cells_range([col_index, index + 1], [col_index, 1_000_000]),
        config: list_data_validation_for_column(header[:list])
      })
    end
    if width > 1
      colspan = width - 1
      row[:values].push(*Array.new(colspan, nil))
      row[:merge_cells].push cells_range([col_index, index], [col_index + colspan, index])
      col_index += colspan
    end
    col_index += 1
  end
  row
end

#resolve_record_row(schema, record, index) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ntq_excelsior/exporter.rb', line 176

def resolve_record_row(schema, record, index)
  row = { values: [], styles: [], merge_cells: [], height: nil, types: [] }
  col_index = 1
  schema.each do |column|
    next unless column_is_visible?(column, record)

    width = column_width(column)
    formatted_value = format_value(column[:resolve], record)
    row[:values] << formatted_value[:value]
    row[:types] << (column[:type] || formatted_value[:type])
    row[:styles] << get_styles(column[:styles], formatted_value[:styles])
    if width > 1
      colspan = width - 1
      row[:values].push(*Array.new(colspan, nil))
      row[:merge_cells].push cells_range([col_index, index], [col_index + colspan, index])
      col_index += colspan
    end

    col_index += 1
  end
  row
end

#schema ⇒ Object 



43
44
45
 
# File 'lib/ntq_excelsior/exporter.rb', line 43

def schema
  self.class.schema
end

#styles ⇒ Object 



47
48
49
 
# File 'lib/ntq_excelsior/exporter.rb', line 47

def styles
  self.class.styles
end