Module: Arachni::Reporter::Options

Extended by:
Options
Includes:
Component::Options
Included in:
Options
Defined in:
lib/arachni/reporter/options.rb

Overview

Provides some common options for the reports.

Author:

Instance Method Summary collapse

Instance Method Details

#outfile(extension = '', description = 'Where to save the report.') ⇒ Arachni::OptString

Returns a string option named ‘outfile`.

Default value is:

year-month-day hour.minute.second +timezone.extension

Parameters:

  • extension (String) (defaults to: '') —

    Extension for the outfile.

  • description (String) (defaults to: 'Where to save the report.') —

    Description of the option.

Returns:

  • (Arachni::OptString) 


28
29
30
31
32
33
 
# File 'lib/arachni/reporter/options.rb', line 28

def outfile( extension = '', description = 'Where to save the report.' )
    Options::String.new( :outfile,
                         description: description,
                         default:     Time.now.to_s.gsub( ':', '_' ) + extension
    )
end

#skip_responses ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/arachni/reporter/options.rb', line 35

def skip_responses
    Options::Bool.new( :skip_responses,
                       description: "Don't include the bodies of the HTTP " +
                                        'responses of the issues in the report' +
                                        ' -- will lead to a greatly decreased report file-size.',
                       default:     false
    )
end