Class: Brakeman::Report::CSV

Inherits:
Table show all
Defined in:
lib/brakeman/report/report_csv.rb

Constant Summary

Constants inherited from Base

Base::TEXT_CONFIDENCE

Constants included from Util

Util::ALL_PARAMETERS, Util::COOKIES, Util::COOKIES_SEXP, Util::PARAMETERS, Util::PARAMS_SEXP, Util::PATH_PARAMETERS, Util::QUERY_PARAMETERS, Util::REQUEST_ENV, Util::REQUEST_PARAMETERS, Util::REQUEST_PARAMS, Util::SESSION, Util::SESSION_SEXP

Instance Attribute Summary

Attributes inherited from Base

#checks, #tracker

Instance Method Summary collapse

Methods inherited from Table

#generate_overview, #generate_templates, #render_array, #text_header

Methods inherited from Base

#all_warnings, #controller_warnings, #convert_controller_warning, #convert_ignored_warning, #convert_model_warning, #convert_template_warning, #convert_to_rows, #convert_warning, #filter_warnings, #generate_controller_warnings, #generate_controllers, #generate_errors, #generate_ignored_warnings, #generate_model_warnings, #generate_template_warnings, #generate_warning_overview, #generate_warnings, #generic_warnings, #ignored_warnings, #initialize, #model_warnings, #number_of_templates, #rails_version, #render_warnings, #sort, #template_warnings, #text_message, #warning_file, #warnings_summary

Methods included from Util

#array?, #block?, #call?, #camelize, #contains_class?, #context_for, #cookies?, #false?, #file_by_name, #file_for, #github_url, #hash?, #hash_access, #hash_insert, #hash_iterate, #integer?, #make_call, #node_type?, #number?, #params?, #pluralize, #regexp?, #relative_path, #request_env?, #request_value?, #result?, #set_env_defaults, #sexp?, #string?, #symbol?, #table_to_csv, #template_path_to_name, #true?, #truncate_table, #underscore

Constructor Details

This class inherits a constructor from Brakeman::Report::Base

Instance Method Details

#csv_headerObject

Generate header for CSV output


51
52
53
54
55
# File 'lib/brakeman/report/report_csv.rb', line 51

def csv_header
  header = CSV.generate_line(["Application Path", "Report Generation Time", "Checks Performed", "Rails Version"])
  header << CSV.generate_line([File.expand_path(tracker.app_path), Time.now.to_s, checks.checks_run.sort.join(", "), rails_version])
  "BRAKEMAN REPORT\n\n" + header
end

#generate_reportObject


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/brakeman/report/report_csv.rb', line 6

def generate_report
  output = csv_header
  output << "\nSUMMARY\n"

  output << table_to_csv(generate_overview) << "\n"

  output << table_to_csv(generate_warning_overview) << "\n"

  #Return output early if only summarizing
  if tracker.options[:summary_only]
    return output
  end

  if tracker.options[:report_routes] or tracker.options[:debug]
    output << "CONTROLLERS\n"
    output << table_to_csv(generate_controllers) << "\n"
  end

  if tracker.options[:debug]
    output << "TEMPLATES\n\n"
    output << table_to_csv(generate_templates) << "\n"
  end

  res = generate_errors
  output << "ERRORS\n" << table_to_csv(res) << "\n" if res

  res = generate_warnings
  output << "SECURITY WARNINGS\n" << table_to_csv(res) << "\n" if res

  output << "Controller Warnings\n"
  res = generate_controller_warnings
  output << table_to_csv(res) << "\n" if res

  output << "Model Warnings\n"
  res = generate_model_warnings
  output << table_to_csv(res) << "\n" if res

  res = generate_template_warnings
  output << "Template Warnings\n"
  output << table_to_csv(res) << "\n" if res

  output
end