Class: Cornucopia::Util::ReportBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/cornucopia/util/report_builder.rb

Constant Summary collapse

MAX_OLD_FOLDERS = 
5
@@current_report = 
nil
@@on_close_blocks = 
[]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(folder_name = nil, parent_folder = nil) ⇒ ReportBuilder

Returns a new instance of ReportBuilder.



193
194
195
196
 
# File 'lib/cornucopia/util/report_builder.rb', line 193

def initialize(folder_name = nil, parent_folder = nil)
  @parent_folder_name = parent_folder || Cornucopia::Util::Configuration.base_folder
  @base_folder_name   = folder_name || Cornucopia::Util::Configuration.base_folder
end

Class Method Details

.build_index_section(section_name, section_items) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cornucopia/util/report_builder.rb', line 146

def build_index_section(section_name, section_items)
  section = "".html_safe

  section << "<div class=\"report-block\">".html_safe
  section << "  <h4>".html_safe
  section << section_name
  section << "</h4>\n".html_safe
  section << "  <ul class=\"index-list\">\n".html_safe

  section_items.each do |section_item|
    section << Cornucopia::Util::ReportBuilder.build_index_section_item(section_item)
  end

  section << "  </ul>\n".html_safe
  section << "</div>\n".html_safe

  section
end

.build_index_section_item(path_name) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cornucopia/util/report_builder.rb', line 134

def build_index_section_item(path_name)
  item_path = "".html_safe

  item_path << "  <li>\n".html_safe
  item_path << "    <a href=\"#{path_name}\" target=\"_blank\">".html_safe
  item_path << File.dirname(path_name)
  item_path << "</a>\n".html_safe
  item_path << "  </li>\n".html_safe

  item_path
end

.current_report(folder_name = nil, parent_folder = nil) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/cornucopia/util/report_builder.rb', line 16

def current_report(folder_name = nil, parent_folder = nil)
  if (@@current_report &&
      ((parent_folder && @@current_report.instance_variable_get(:@parent_folder_name) != parent_folder) ||
          (folder_name && @@current_report.instance_variable_get(:@base_folder_name) != folder_name)))
    @@current_report.close
    @@current_report = nil
  end

  folder_name   ||= Cornucopia::Util::Configuration.base_folder
  parent_folder ||= Cornucopia::Util::Configuration.base_folder

  @@current_report ||= Cornucopia::Util::ReportBuilder.new(folder_name, parent_folder)
end

.escape_string(value) ⇒ Object 



39
40
41
42
43
 
# File 'lib/cornucopia/util/report_builder.rb', line 39

def escape_string(value)
  value = value.to_s
  value = value + "" if value.frozen?
  "".html_safe + value.force_encoding("UTF-8")
end

.folder_name_to_section_name(folder_name) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/cornucopia/util/report_builder.rb', line 165

def folder_name_to_section_name(folder_name)
  case File.basename(folder_name)
    when Cornucopia::Util::Configuration.base_folder
      "Feature Tests"
    when "diagnostics_rspec_report"
      "RSPEC Tests"
    else
      File.basename(folder_name)
  end
end

.format_code_refs(value) ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/cornucopia/util/report_builder.rb', line 45

def format_code_refs(value)
  safe_text = Cornucopia::Util::ReportBuilder.escape_string(value)

  safe_text = safe_text.gsub(/(#{Cornucopia::Util::ReportBuilder.root_folder}|\.\/|(?=(?:^features|^spec)\/))([^\:\n]*\:[^\:\n\>& ]*)/,
                             "\\1 <span class=\"cornucopia-app-file\">\\2\\3</span> ").html_safe

  safe_text
end

.new_report(folder_name = nil, parent_folder = nil) ⇒ Object 



30
31
32
33
34
35
36
37
 
# File 'lib/cornucopia/util/report_builder.rb', line 30

def new_report(folder_name = nil, parent_folder = nil)
  if (@@current_report)
    @@current_report.close
    @@current_report = nil
  end

  @@current_report = Cornucopia::Util::ReportBuilder.new(folder_name, parent_folder)
end

.on_close(&block) ⇒ Object 



188
189
190
 
# File 'lib/cornucopia/util/report_builder.rb', line 188

def on_close(&block)
  @@on_close_blocks << block
end

.page_dump(page_html) ⇒ Object 



184
185
186
 
# File 'lib/cornucopia/util/report_builder.rb', line 184

def page_dump(page_html)
  "<textarea class=\"cornucopia-page-dump\">#{Cornucopia::Util::ReportBuilder.escape_string(page_html)}</textarea>\n".html_safe
end

.pretty_array(array, format_sub_items = true) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cornucopia/util/report_builder.rb', line 54

def pretty_array(array, format_sub_items = true)
  if (array.is_a?(Array))
    array.map do |value|
      # This is not expected to be called on an array of arrays,
      # block this and just convert sub-arrays to strings.
      format_value = value
      format_value = value.to_s if value.is_a?(Array)

      if format_sub_items
        Cornucopia::Util::ReportBuilder.pretty_format(format_value).rstrip
      else
        format_value
      end
    end.join("\n").html_safe
  else
    Cornucopia::Util::ReportBuilder.pretty_format(array)
  end
end

.pretty_format(value) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cornucopia/util/report_builder.rb', line 123

def pretty_format(value)
  pretty_text = value

  pretty_text = Cornucopia::Util::ReportBuilder.pretty_object(pretty_text)
  pretty_text = Cornucopia::Util::ReportBuilder.escape_string(pretty_text)
  pretty_text = Cornucopia::Util::PrettyFormatter.format_string(pretty_text)
  pretty_text = Cornucopia::Util::ReportBuilder.format_code_refs(pretty_text)

  pretty_text
end

.pretty_object(value) ⇒ Object

I've seen some objects with pretty_inspect get stuck in an infinite loop (or close to it), so they take literally hours to print. This function uses Timeout to prevent this. either the class prints quickly, or we kill it and try something else.

If the something else doesn't work, we just give up...



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/cornucopia/util/report_builder.rb', line 78

def pretty_object(value)
  timed_out    = false
  return_value = nil

  begin
    begin
      timeout_length = Cornucopia::Util::Configuration.print_timeout_min
      if Object.const_defined?("Capybara")
        timeout_length = [timeout_length, ::Capybara.default_wait_time].max
      end
      timeout_length = [timeout_length, 60 * 60].max if Rails.env.development?

      Timeout::timeout(timeout_length) do
        if value.is_a?(String)
          return_value = value
        elsif value.is_a?(Array)
          return_value = Cornucopia::Util::ReportBuilder.pretty_array(value, false)
        elsif value.respond_to?(:pretty_inspect)
          return_value = value.pretty_inspect
        else
          return_value = value.to_s
        end
      end
    rescue Timeout::Error
      timed_out = true
    end
  rescue Exception => error
    error.to_s
  end

  # If it timed out or threw an exception, try .to_s
  # That may also timeout or throw an exception, and if it does, give up.
  if timed_out || !return_value
    begin
      Timeout::timeout(timeout_length) do
        return_value = value.to_s
      end
    rescue Timeout::Error
      return_value = "Timed out rendering"
    end
  end

  return_value
end

.root_folder ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/cornucopia/util/report_builder.rb', line 176

def root_folder
  if Object.const_defined?("Rails")
    Rails.root
  else
    FileUtils.pwd
  end
end

Instance Method Details

#backup_report_folder ⇒ Object 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/cornucopia/util/report_builder.rb', line 257

def backup_report_folder
  if Dir.exists?(@report_folder_name)
    if File.exists?(File.join(@report_folder_name, "index.html"))
      update_time = File.ctime(File.join(@report_folder_name, "index.html"))
    else
      update_time = File.ctime(@report_folder_name)
    end

    # ensure the name is unique...
    new_sub_dir = File.join(index_folder_name, "#{@base_folder_name}_#{update_time.strftime("%Y_%m_%d_%H_%M_%S")}").to_s
    index       = 0
    while Dir.exists?(new_sub_dir)
      if new_sub_dir[-1 * "_alt_#{index}".length..-1] == "_alt_#{index}"
        new_sub_dir = new_sub_dir[0..-1 * "_alt_#{index}".length - 1]
      end

      index       += 1
      new_sub_dir += "_alt_#{index}"
    end

    FileUtils.mv @report_folder_name,
                 new_sub_dir
  end
end

#close ⇒ Object

This does nothing in a normal report because reports are built as you go. If nothing has been reported though, this will create a report indicating that nothing happened.



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
227
228
229
230
231
232
233
234
 
# File 'lib/cornucopia/util/report_builder.rb', line 201

def close
  exceptions = []

  if @@on_close_blocks
    @@on_close_blocks.each do |on_close_block|
      begin
        on_close_block.yield
      rescue
        exceptions << $!
      end
    end
  end

  if File.exists?(report_contents_page_name)
    if Cornucopia::Util::Configuration.open_report_after_generation(@base_folder_name)
      # `open #{report_base_page_name}` rescue nil
      system("open #{report_base_page_name}") rescue nil
    end
  else
    initialize_report_files
    File.open(report_contents_page_name, "a:UTF-8") do |write_file|
      write_file.write %Q[<p class=\"cornucopia-no-errors\">No Errors to report</p>]
      write_file.write "\n"
    end
  end

  if self == @@current_report
    @@current_report = nil
  end

  exceptions.each do |exception|
    raise exception
  end
end

#delete_old_folders ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/cornucopia/util/report_builder.rb', line 282

def delete_old_folders
  old_directories = Dir[File.join(index_folder_name, "#{@base_folder_name}_*")].
      map { |dir| File.directory?(dir) ? dir : nil }.compact

  if Array.wrap(old_directories).length > MAX_OLD_FOLDERS
    old_directories.each_with_index do |dir, index|
      break if index >= old_directories.length - MAX_OLD_FOLDERS

      FileUtils.rm_rf dir
    end
  end
end

#image_link(image_file_name) ⇒ Object 



417
418
419
420
421
422
423
 
# File 'lib/cornucopia/util/report_builder.rb', line 417

def image_link(image_file_name)
  dest_file_name = unique_file_name(File.basename(image_file_name))

  FileUtils.mv image_file_name, File.join(report_folder_name, dest_file_name)

  "<img class=\"cornucopia-section-image\" src=\"./#{dest_file_name}\" />".html_safe
end

#index_base_page_name ⇒ Object 



353
354
355
 
# File 'lib/cornucopia/util/report_builder.rb', line 353

def index_base_page_name
  File.join(index_folder_name, "index.html")
end

#index_contents_page_name ⇒ Object 



357
358
359
 
# File 'lib/cornucopia/util/report_builder.rb', line 357

def index_contents_page_name
  File.join(index_folder_name, "report_contents.html")
end

#index_folder_name ⇒ Object 



247
248
249
250
251
252
253
254
255
 
# File 'lib/cornucopia/util/report_builder.rb', line 247

def index_folder_name
  unless @index_folder_name
    @index_folder_name = File.join(Cornucopia::Util::ReportBuilder.root_folder, "#{@parent_folder_name}/")

    FileUtils.mkdir_p @index_folder_name
  end

  @index_folder_name
end

#initialize_report_files ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/cornucopia/util/report_builder.rb', line 361

def initialize_report_files()
  support_folder_name = report_folder_name

  FileUtils.mkdir_p @report_folder_name

  unless File.exists?(report_base_page_name)
    FileAsset.asset("report_base.html").add_file(File.join(support_folder_name, "index.html"))
    rebuild_index_page
  end

  FileAsset.asset("report_contents.html").add_file(File.join(support_folder_name, "report_contents.html"))
  FileAsset.asset("collapse.gif").add_file(File.join(support_folder_name, "collapse.gif"))
  FileAsset.asset("expand.gif").add_file(File.join(support_folder_name, "expand.gif"))
  FileAsset.asset("more_info.js").add_file(File.join(support_folder_name, "more_info.js"))
  FileAsset.asset("cornucopia.css").add_file(File.join(support_folder_name, "cornucopia.css"))
end

#open_report_contents_file(&block) ⇒ Object 



378
379
380
381
382
 
# File 'lib/cornucopia/util/report_builder.rb', line 378

def open_report_contents_file(&block)
  initialize_report_files

  File.open(report_contents_page_name, "a:UTF-8", &block)
end

#padded_frame(padded_text) ⇒ Object 



441
442
443
444
445
 
# File 'lib/cornucopia/util/report_builder.rb', line 441

def padded_frame(padded_text)
  padded_val = "<div class=\"padded-frame\">".html_safe
  padded_val << padded_text
  padded_val << "</div>".html_safe
end

#page_frame(page_html) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/cornucopia/util/report_builder.rb', line 429

def page_frame(page_html)
  dump_file_name = unique_file_name("page_dump.html")

  File.open(File.join(report_folder_name, dump_file_name), "w:UTF-8") do |dump_file|
    page_text = page_html.to_s
    page_text = page_text + "" if page_text.frozen?
    dump_file.write page_text.force_encoding("UTF-8")
  end

  padded_frame("<iframe src=\"#{dump_file_name}\" class=\"cornucopia-sample-frame\"></iframe>\n".html_safe)
end

#page_text(page_html) ⇒ Object 



425
426
427
 
# File 'lib/cornucopia/util/report_builder.rb', line 425

def page_text(page_html)
  padded_frame("<textarea class=\"cornucopia-page-dump\">#{Cornucopia::Util::ReportBuilder.escape_string(page_html)}</textarea>\n".html_safe)
end

#rebuild_index_page ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/cornucopia/util/report_builder.rb', line 295

def rebuild_index_page
  index_folder = index_folder_name

  FileUtils.mkdir_p index_folder_name
  FileUtils.rm_rf index_contents_page_name

  FileAsset.asset("index_base.html").create_file(File.join(index_folder, "index.html"))
  FileAsset.asset("index_contents.html").add_file(File.join(index_folder, "report_contents.html"))
  FileAsset.asset("cornucopia.css").add_file(File.join(index_folder, "cornucopia.css"))

  index_file = "".html_safe
  if File.exists?(File.join(Cornucopia::Util::ReportBuilder.root_folder, "coverage/index.html"))
    index_file << Cornucopia::Util::ReportBuilder.build_index_section("Coverage", ["../coverage/index.html"])
  end

  last_folder = nil
  group_items = []
  Dir[File.join(@index_folder_name, "*")].sort.each do |directory_item|
    if File.directory?(directory_item) && File.exists?(File.join(directory_item, "index.html"))
      directory_item = directory_item[@index_folder_name.to_s.length..-1]

      if last_folder
        if directory_item =~ /^#{last_folder}_/
          group_items << File.join(directory_item, "index.html")
        else
          unless group_items.empty?
            index_file << Cornucopia::Util::ReportBuilder.build_index_section(
                Cornucopia::Util::ReportBuilder.folder_name_to_section_name(last_folder), group_items)
          end

          last_folder = directory_item
          group_items = [File.join(last_folder, "index.html")]
        end
      else
        last_folder = directory_item
        group_items = [File.join(last_folder, "index.html")]
      end
    end
  end

  unless group_items.empty?
    index_file << Cornucopia::Util::ReportBuilder.build_index_section(
        Cornucopia::Util::ReportBuilder.folder_name_to_section_name(last_folder), group_items)
  end

  File.open(index_contents_page_name, "a:UTF-8") do |write_file|
    write_file << index_file
  end
end

#report_base_page_name ⇒ Object 



345
346
347
 
# File 'lib/cornucopia/util/report_builder.rb', line 345

def report_base_page_name
  File.join(report_folder_name, "index.html")
end

#report_contents_page_name ⇒ Object 



349
350
351
 
# File 'lib/cornucopia/util/report_builder.rb', line 349

def report_contents_page_name
  File.join(report_folder_name, "report_contents.html")
end

#report_folder_name ⇒ Object 



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/cornucopia/util/report_builder.rb', line 236

def report_folder_name
  unless @report_folder_name
    @report_folder_name = File.join(index_folder_name, "#{@base_folder_name}/")

    backup_report_folder
    delete_old_folders
  end

  @report_folder_name
end

#unique_file_name(file_base_name) ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/cornucopia/util/report_builder.rb', line 447

def unique_file_name(file_base_name)
  file_parts = file_base_name.split(".")
  base_name  = file_parts[0..-2].join(".")
  extension  = file_parts[-1]

  unique_num = 1
  num_string = ""
  while File.exists?(File.join(report_folder_name, "#{base_name}#{num_string}.#{extension}"))
    num_string = "_#{unique_num}"
    unique_num += 1
  end

  "#{base_name}#{num_string}.#{extension}"
end

#unique_folder_name(folder_base_name) ⇒ Object 



462
463
464
465
466
467
468
469
470
471
 
# File 'lib/cornucopia/util/report_builder.rb', line 462

def unique_folder_name(folder_base_name)
  unique_num = 1
  num_string = ""
  while File.exists?(File.join(report_folder_name, "#{folder_base_name}#{num_string}"))
    num_string = "_#{unique_num}"
    unique_num += 1
  end

  "#{folder_base_name}#{num_string}"
end

#within_section(section_text, &block) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/cornucopia/util/report_builder.rb', line 384

def within_section(section_text, &block)
  begin
    open_report_contents_file do |write_file|
      write_file.write "<div class=\"cornucopia-section\">\n"
      write_file.write "<p class=\"cornucopia-section-label\">#{Cornucopia::Util::ReportBuilder.escape_string(section_text)}</p>\n".
                           force_encoding("UTF-8")
    end
    block.yield self
  ensure
    open_report_contents_file do |write_file|
      write_file.write "</div>\n"
    end
  end
end

#within_table(options = {}, &block) ⇒ Object 



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/cornucopia/util/report_builder.rb', line 399

def within_table(options = {}, &block)
  report_table         = nil
  options_report_table = options[:report_table]

  begin
    Cornucopia::Util::ReportTable.new(options) do |table|
      report_table = table
      block.yield(report_table)
    end
  ensure
    if report_table && !options_report_table
      open_report_contents_file do |write_file|
        write_file.write report_table.full_table.force_encoding("UTF-8")
      end
    end
  end
end