Class: Arachni::Report::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/report/base.rb

Overview

This class is abstract.

Arachni::Report::Base class

An abstract class for the reports.
All reports must extend this.

@author: Anastasios “Zapotek” Laskos

                                     <tasos.laskos@gmail.com>
                                     <zapotek@segfault.gr>

@version: 0.1-pre

Direct Known Subclasses

s::AP, s::HTML, s::Stdout

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) info

REQUIRED

Do not ommit any of the info.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/report/base.rb', line 42

def self.info
    {
        'Name'           => 'Report abstract class.',
        
        #
        # you can provide the user with options to allow him to
        # customize the report to his needs.
        #
        # Arachni doesn't do any checking whatsoever.
        #
        'Options'        => {
            # option name
            'option_one_something' =>
                [   # the available values for the option
                    'true/false (Default: true)',
                    # the description of the option
                    'Do something?'
                ],
            'option_two_something' =>
                [
                    '1..inf (Default: inf)',
                    'How many times to do something?'
                ]
        },
        'Description'    => %q{This class should be extended by all reports.},
        'Author'         => 'zapotek',
        'Version'        => '$Rev: 352 $',
    }
end

Instance Method Details

- (Object) run

REQUIRED



33
34
35
# File 'lib/report/base.rb', line 33

def run( )
    
end