Class: Arachni::Plugin::Formatter

Inherits:
Object
  • Object
show all
Includes:
UI::Output
Defined in:
lib/arachni/plugin/formatter.rb

Overview

Will be extended by plugin formatters which provide plugin data formatting for the reports.

Plugin formatters will be in turn ran by Report::Bas#format_plugin_results.

Author:

  • Tasos “Zapotek” Laskos <tasos.laskos@arachni-scanner.com>

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from UI::Output

#debug?, #debug_level_1?, #debug_level_2?, #debug_level_3?, #debug_level_4?, #debug_off, #debug_on, #disable_only_positives, #included, #mute, #muted?, #only_positives, #only_positives?, #print_bad, #print_debug, #print_debug_backtrace, #print_debug_level_1, #print_debug_level_2, #print_debug_level_3, #print_debug_level_4, #print_error, #print_error_backtrace, #print_exception, #print_info, #print_line, #print_ok, #print_status, #print_verbose, #reroute_to_file, #reroute_to_file?, reset_output_options, #unmute, #verbose?, #verbose_on

Constructor Details

#initialize(parent, report, plugin_data) ⇒ Formatter

Returns a new instance of Formatter.



26
27
28
29
30
31
 
# File 'lib/arachni/plugin/formatter.rb', line 26

def initialize( parent, report, plugin_data )
    @parent       = parent
    @report       = report
    @results      = plugin_data[:results]
    @description  = plugin_data[:description]
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



24
25
26
 
# File 'lib/arachni/plugin/formatter.rb', line 24

def description
  @description
end

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



21
22
23
 
# File 'lib/arachni/plugin/formatter.rb', line 21

def parent
  @parent
end

#report ⇒ Object (readonly)

Returns the value of attribute report.



22
23
24
 
# File 'lib/arachni/plugin/formatter.rb', line 22

def report
  @report
end

#results ⇒ Object (readonly)

Returns the value of attribute results.



23
24
25
 
# File 'lib/arachni/plugin/formatter.rb', line 23

def results
  @results
end

Instance Method Details

#run ⇒ Object

This method is abstract. 


34
35
 
# File 'lib/arachni/plugin/formatter.rb', line 34

def run
end