nasldoc 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/LICENSE +3 -3
- data/NEWS.markdown +9 -5
- data/README.markdown +38 -41
- data/Rakefile +49 -3
- data/TODO.markdown +20 -0
- data/bin/nasldoc +27 -1
- data/lib/nasldoc.rb +27 -1
- data/lib/nasldoc/assets/css/bootstrap.css +6004 -0
- data/lib/nasldoc/assets/css/bootstrap.min.css +859 -0
- data/lib/nasldoc/assets/css/shCore.css +226 -0
- data/lib/nasldoc/assets/css/shThemeDefault.css +117 -0
- data/lib/nasldoc/assets/{stylesheet.css → css/stylesheet.css} +37 -15
- data/lib/nasldoc/assets/img/glyphicons-halflings-white.png +0 -0
- data/lib/nasldoc/assets/img/glyphicons-halflings.png +0 -0
- data/lib/nasldoc/assets/{nessus.jpg → img/nessus.jpg} +0 -0
- data/lib/nasldoc/assets/js/bootstrap.js +2036 -0
- data/lib/nasldoc/assets/js/bootstrap.min.js +7 -0
- data/lib/nasldoc/assets/js/jquery-1.8.2.js +9440 -0
- data/lib/nasldoc/assets/js/shBrushNasl.js +33 -0
- data/lib/nasldoc/assets/js/shCore.js +17 -0
- data/lib/nasldoc/cli.rb +26 -0
- data/lib/nasldoc/cli/application.rb +150 -222
- data/lib/nasldoc/cli/comment.rb +317 -0
- data/lib/nasldoc/templates/file.erb +362 -154
- data/lib/nasldoc/templates/index.erb +93 -9
- data/lib/nasldoc/templates/old/file.erb +332 -0
- data/lib/nasldoc/templates/old/xfile.erb +267 -0
- data/lib/nasldoc/templates/old/xindex.erb +16 -0
- data/lib/nasldoc/templates/old/xoverview.erb +26 -0
- data/lib/nasldoc/templates/old/xsidebar.erb +21 -0
- data/lib/nasldoc/templates/xindex.erb +16 -0
- data/nasldoc.gemspec +45 -18
- metadata +45 -13
- data/lib/nasldoc/templates/overview.erb +0 -27
- data/lib/nasldoc/templates/sidebar.erb +0 -20
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!DOCTYPE HTML>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<title>nasldoc</title>
|
|
5
|
+
<!--<link rel="stylesheet" type="text/css" href="stylesheet.css">-->
|
|
6
|
+
<script src="jquery.js"></script>
|
|
7
|
+
<script src="bootstrap.js"></script>
|
|
8
|
+
<link rel="stylesheet" type="text/css" href="bootstrap.css">
|
|
9
|
+
</head>
|
|
10
|
+
<frameset cols="20%,80%">
|
|
11
|
+
<frame name="sidebar" src="sidebar.html">
|
|
12
|
+
<frameset rows="100%">
|
|
13
|
+
<frame name="content" src="overview.html">
|
|
14
|
+
</frameset>
|
|
15
|
+
</frameset>
|
|
16
|
+
</html>
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>nasldoc</title>
|
|
4
|
+
<link rel="stylesheet" type="text/css" href="stylesheet.css">
|
|
5
|
+
</head>
|
|
6
|
+
<body>
|
|
7
|
+
<div id="content">
|
|
8
|
+
<table class="nopad">
|
|
9
|
+
<tr class="TableHeadingColor">
|
|
10
|
+
<td>
|
|
11
|
+
<a name="top"></a>
|
|
12
|
+
<h1>File Summary</h1>
|
|
13
|
+
</td>
|
|
14
|
+
</tr>
|
|
15
|
+
<% @file_list.sort.each do |file| %>
|
|
16
|
+
<% link = url(file) %>
|
|
17
|
+
<tr>
|
|
18
|
+
<td>
|
|
19
|
+
<a href="<%= link %>" target="content"><%= link %></a>
|
|
20
|
+
</td>
|
|
21
|
+
</tr>
|
|
22
|
+
<% end %>
|
|
23
|
+
</table>
|
|
24
|
+
</div>
|
|
25
|
+
</body>
|
|
26
|
+
</html>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<html>
|
|
2
|
+
<head>
|
|
3
|
+
<title>nasldoc</title>
|
|
4
|
+
<link rel="stylesheet" type="text/css" href="stylesheet.css">
|
|
5
|
+
</head>
|
|
6
|
+
<body>
|
|
7
|
+
<img src="nessus.jpg" />
|
|
8
|
+
<ul>
|
|
9
|
+
<li><a href="overview.html" target="content">Overview</a></li>
|
|
10
|
+
</ul>
|
|
11
|
+
<ul>
|
|
12
|
+
<% @file_list.sort.each_with_index do |file, i| %>
|
|
13
|
+
<% row = i.even? ? 'even' : 'odd' %>
|
|
14
|
+
<% link = url(file) %>
|
|
15
|
+
<li class="<%= row %>">
|
|
16
|
+
<a href="<%= link %>" target="content"><%= link %></a>
|
|
17
|
+
</li>
|
|
18
|
+
<% end %>
|
|
19
|
+
</ul>
|
|
20
|
+
</body>
|
|
21
|
+
</html>
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!DOCTYPE HTML>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<title>nasldoc</title>
|
|
5
|
+
<!--<link rel="stylesheet" type="text/css" href="stylesheet.css">-->
|
|
6
|
+
<script src="jquery.js"></script>
|
|
7
|
+
<script src="bootstrap.js"></script>
|
|
8
|
+
<link rel="stylesheet" type="text/css" href="bootstrap.css">
|
|
9
|
+
</head>
|
|
10
|
+
<frameset cols="20%,80%">
|
|
11
|
+
<frame name="sidebar" src="sidebar.html">
|
|
12
|
+
<frameset rows="100%">
|
|
13
|
+
<frame name="content" src="overview.html">
|
|
14
|
+
</frameset>
|
|
15
|
+
</frameset>
|
|
16
|
+
</html>
|
data/nasldoc.gemspec
CHANGED
|
@@ -1,27 +1,54 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
# Copyright (c) 2011-2013 Tenable Network Security.
|
|
2
|
+
# All rights reserved.
|
|
3
|
+
#
|
|
4
|
+
# Redistribution and use in source and binary forms, with or without
|
|
5
|
+
# modification, are permitted provided that the following conditions are met:
|
|
6
|
+
#
|
|
7
|
+
# * Redistributions of source code must retain the above copyright
|
|
8
|
+
# notice, this list of conditions and the following disclaimer.
|
|
9
|
+
# * Redistributions in binary form must reproduce the above copyright
|
|
10
|
+
# notice, this list of conditions and the following disclaimer in the
|
|
11
|
+
# documentation and/or other materials provided with the distribution.
|
|
12
|
+
# * Neither the name of the Tenable Network Security nor the names of its contributors
|
|
13
|
+
# may be used to endorse or promote products derived from this software
|
|
14
|
+
# without specific prior written permission.
|
|
15
|
+
#
|
|
16
|
+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
17
|
+
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
18
|
+
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
19
|
+
# DISCLAIMED. IN NO EVENT SHALL TENABLE NETWORK SECURITY BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
20
|
+
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
21
|
+
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
|
|
22
|
+
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
23
|
+
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
|
24
|
+
# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
25
|
+
# OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
26
|
+
|
|
27
|
+
$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
|
|
3
28
|
|
|
4
29
|
require 'rubygems'
|
|
5
30
|
require 'nasldoc'
|
|
6
31
|
|
|
7
32
|
Gem::Specification.new do |s|
|
|
8
|
-
s.name
|
|
9
|
-
s.version
|
|
10
|
-
s.homepage
|
|
11
|
-
s.summary
|
|
12
|
-
s.description
|
|
13
|
-
s.license
|
|
33
|
+
s.name = "#{NaslDoc::APP_NAME}"
|
|
34
|
+
s.version = NaslDoc::VERSION
|
|
35
|
+
s.homepage = "http://github.com/tenable/nasldoc"
|
|
36
|
+
s.summary = "#{NaslDoc::APP_NAME}"
|
|
37
|
+
s.description = "#{NaslDoc::APP_NAME} is a NASL documentation generator"
|
|
38
|
+
s.license = "BSD"
|
|
39
|
+
|
|
40
|
+
s.author = "Jacob Hammack"
|
|
41
|
+
s.email = "jhammack@tenable.com"
|
|
14
42
|
|
|
15
|
-
s.
|
|
16
|
-
s.
|
|
43
|
+
s.files = Dir['[A-Z]*'] + Dir['lib/**/*'] + ["#{NaslDoc::APP_NAME}.gemspec"]
|
|
44
|
+
s.bindir = "bin"
|
|
45
|
+
s.executables = "#{NaslDoc::APP_NAME}"
|
|
46
|
+
s.require_paths = ["lib"]
|
|
47
|
+
s.has_rdoc = 'yard'
|
|
48
|
+
s.extra_rdoc_files = ["README.markdown", "NEWS.markdown", "TODO.markdown"]
|
|
17
49
|
|
|
18
|
-
s.
|
|
19
|
-
s.
|
|
20
|
-
s.executables = "#{NaslDoc::APP_NAME}"
|
|
21
|
-
s.require_paths = ["lib"]
|
|
22
|
-
s.has_rdoc = 'yard'
|
|
23
|
-
s.extra_rdoc_files = ["README.markdown", "NEWS.markdown", "TODO.markdown"]
|
|
50
|
+
s.required_rubygems_version = ">= 1.8.24"
|
|
51
|
+
s.rubyforge_project = "#{NaslDoc::APP_NAME}"
|
|
24
52
|
|
|
25
|
-
s.
|
|
26
|
-
s.rubyforge_project = "#{NaslDoc::APP_NAME}"
|
|
53
|
+
s.add_dependency('nasl', ['>= 0.0.8'])
|
|
27
54
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: nasldoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -9,8 +9,24 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
13
|
-
dependencies:
|
|
12
|
+
date: 2013-01-29 00:00:00.000000000 Z
|
|
13
|
+
dependencies:
|
|
14
|
+
- !ruby/object:Gem::Dependency
|
|
15
|
+
name: nasl
|
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
|
17
|
+
none: false
|
|
18
|
+
requirements:
|
|
19
|
+
- - ! '>='
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: 0.0.8
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
25
|
+
none: false
|
|
26
|
+
requirements:
|
|
27
|
+
- - ! '>='
|
|
28
|
+
- !ruby/object:Gem::Version
|
|
29
|
+
version: 0.0.8
|
|
14
30
|
description: nasldoc is a NASL documentation generator
|
|
15
31
|
email: jhammack@tenable.com
|
|
16
32
|
executables:
|
|
@@ -21,23 +37,39 @@ extra_rdoc_files:
|
|
|
21
37
|
- NEWS.markdown
|
|
22
38
|
- TODO.markdown
|
|
23
39
|
files:
|
|
24
|
-
- README.markdown
|
|
25
40
|
- LICENSE
|
|
26
41
|
- NEWS.markdown
|
|
27
|
-
- TODO.markdown
|
|
28
42
|
- Rakefile
|
|
43
|
+
- README.markdown
|
|
44
|
+
- TODO.markdown
|
|
45
|
+
- lib/nasldoc/assets/css/bootstrap.css
|
|
46
|
+
- lib/nasldoc/assets/css/bootstrap.min.css
|
|
47
|
+
- lib/nasldoc/assets/css/shCore.css
|
|
48
|
+
- lib/nasldoc/assets/css/shThemeDefault.css
|
|
49
|
+
- lib/nasldoc/assets/css/stylesheet.css
|
|
50
|
+
- lib/nasldoc/assets/img/glyphicons-halflings-white.png
|
|
51
|
+
- lib/nasldoc/assets/img/glyphicons-halflings.png
|
|
52
|
+
- lib/nasldoc/assets/img/nessus.jpg
|
|
53
|
+
- lib/nasldoc/assets/js/bootstrap.js
|
|
54
|
+
- lib/nasldoc/assets/js/bootstrap.min.js
|
|
55
|
+
- lib/nasldoc/assets/js/jquery-1.8.2.js
|
|
56
|
+
- lib/nasldoc/assets/js/shBrushNasl.js
|
|
57
|
+
- lib/nasldoc/assets/js/shCore.js
|
|
58
|
+
- lib/nasldoc/cli/application.rb
|
|
59
|
+
- lib/nasldoc/cli/comment.rb
|
|
60
|
+
- lib/nasldoc/cli.rb
|
|
29
61
|
- lib/nasldoc/templates/file.erb
|
|
30
62
|
- lib/nasldoc/templates/index.erb
|
|
31
|
-
- lib/nasldoc/templates/
|
|
32
|
-
- lib/nasldoc/templates/
|
|
33
|
-
- lib/nasldoc/
|
|
34
|
-
- lib/nasldoc/
|
|
35
|
-
- lib/nasldoc/
|
|
36
|
-
- lib/nasldoc/
|
|
63
|
+
- lib/nasldoc/templates/old/file.erb
|
|
64
|
+
- lib/nasldoc/templates/old/xfile.erb
|
|
65
|
+
- lib/nasldoc/templates/old/xindex.erb
|
|
66
|
+
- lib/nasldoc/templates/old/xoverview.erb
|
|
67
|
+
- lib/nasldoc/templates/old/xsidebar.erb
|
|
68
|
+
- lib/nasldoc/templates/xindex.erb
|
|
37
69
|
- lib/nasldoc.rb
|
|
38
70
|
- nasldoc.gemspec
|
|
39
71
|
- bin/nasldoc
|
|
40
|
-
homepage: http://
|
|
72
|
+
homepage: http://github.com/tenable/nasldoc
|
|
41
73
|
licenses:
|
|
42
74
|
- BSD
|
|
43
75
|
post_install_message:
|
|
@@ -55,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
55
87
|
requirements:
|
|
56
88
|
- - ! '>='
|
|
57
89
|
- !ruby/object:Gem::Version
|
|
58
|
-
version: 1.
|
|
90
|
+
version: 1.8.24
|
|
59
91
|
requirements: []
|
|
60
92
|
rubyforge_project: nasldoc
|
|
61
93
|
rubygems_version: 1.8.24
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
<html>
|
|
2
|
-
<head>
|
|
3
|
-
<title>nasldoc</title>
|
|
4
|
-
<link rel = 'stylesheet' type= 'text/css' href='stylesheet.css'>
|
|
5
|
-
</head>
|
|
6
|
-
<body>
|
|
7
|
-
<div id="content">
|
|
8
|
-
<table class="nopad">
|
|
9
|
-
<tr class='TableHeadingColor'>
|
|
10
|
-
<td>
|
|
11
|
-
<a name='top'></a><h1>File Summary</h1>
|
|
12
|
-
</td>
|
|
13
|
-
</tr>
|
|
14
|
-
|
|
15
|
-
<% @file_list.sort.each do |file| %>
|
|
16
|
-
<% output_file = file.gsub(".", "_") %>
|
|
17
|
-
<% output_file = File.basename(file).gsub(".", "_") %>
|
|
18
|
-
<tr>
|
|
19
|
-
<td>
|
|
20
|
-
<a href='<%= output_file %>.html' target='content'><%= File.basename(file) %></a>
|
|
21
|
-
</td>
|
|
22
|
-
</tr>
|
|
23
|
-
<% end %>
|
|
24
|
-
</table>
|
|
25
|
-
</div>
|
|
26
|
-
</body>
|
|
27
|
-
</html>
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<html>
|
|
2
|
-
<head>
|
|
3
|
-
<title>nasldoc</title>
|
|
4
|
-
<link rel = 'stylesheet' type= 'text/css' href='stylesheet.css'>
|
|
5
|
-
</head>
|
|
6
|
-
<body>
|
|
7
|
-
<img src='nessus.jpg' />
|
|
8
|
-
<br><br><br>
|
|
9
|
-
<ul>
|
|
10
|
-
<% @file_list.sort.each_with_index do |file, i| %>
|
|
11
|
-
<% row_class = i % 2 == 0 ? "even" : "odd" %>
|
|
12
|
-
<% output_file = file.gsub(".", "_") %>
|
|
13
|
-
<% output_file = File.basename(file).gsub(".", "_") %>
|
|
14
|
-
<li class="<%= row_class %>"><a href='<%= output_file %>.html' target='content'><%= File.basename(file) %></a></li>
|
|
15
|
-
<% end %>
|
|
16
|
-
</ul>
|
|
17
|
-
<br><br><br>
|
|
18
|
-
<ul><a href='overview.html' target='content'>Home</a></ul>
|
|
19
|
-
</body>
|
|
20
|
-
</html>
|