nasldoc 0.2.1 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjFhNmI2Y2VmNjQ0YTdiN2I2NjY4YTg5MTYwZDlkOWUxZTkzZmI5Nw==
-  data.tar.gz: !binary |-
-    Y2ZkYzUzMGZjZDFlYWE1NDEzODg3NDM5NWEwNWY2ZDU1MDlkMTM0Nw==
+SHA1:
+  metadata.gz: 018bc2a6c15d0274f028720661ad5a6d77f9bd8c
+  data.tar.gz: 7cc54bfe4c54f1f8e3a7a129b342e39aa530deed
 SHA512:
-  metadata.gz: !binary |-
-    YTE4YzhlYzA5MGI0Y2IzYWQ5YWU4MTQ0ZWNkMWE1MjAxYzYxNDA2NWFjNWQz
-    NzgxMjhjYTRkMTk0MzM4MjkzY2IwNmEwNTcxNWU5OTUzYWM0MTVhYzY3NTM3
-    MWNlYTA5YmZlMDM0NDFhYmNjNzdhY2EyODcwMzQ1YzVkNjI5MWU=
-  data.tar.gz: !binary |-
-    N2Q5NGE5N2NlMzRjN2VjNGRhOGVhNTJlYTlmNWRmZmQxZDRjY2I1MDMzNWQx
-    MGJkYmViYTQwZDYyYTRjZjNhOGFjYTQ3NmEyMzk2NGVkY2E1MmM3NGEwMjA4
-    ZGM5NWIzMzg5ODJkZDRmMWZiMjc5NmVlMWE2MGViZDE5NWEwNDk=
+  metadata.gz: 74c2f8090ef9c12c4847f88b7ca1b2886235e34e00ebb5ebacb82db46addb250c866c0ba6d8f04cff35f55b3a33df678576d8446b9d6f35fd4e4447a3809c289
+  data.tar.gz: 73741d08264c9c2b80b4e3c0c0507944c69a6d5031bb986ee97201156e68b42cfdc2fcab302ee9ea3d2ea3cd853a82d1010864344706299a2d4f030eab0fedc9

data/README.markdown

@@ -8,29 +8,29 @@ Installation is really easy, all you need to do is gem install!
 
 #Usage
 
-Using nasldoc is fairly simple just pass it a directory or a single file that you want to generate the documentation for. Nasldoc is configured to only parse .inc files which special comment markup.
+Using `nasldoc` is fairly simple; just pass it a directory or a single file that you want to generate the documentation for. `nasldoc` is designed to only parse .inc files which special comment markup.
 
 	% nasldoc /opt/nessus/lib/nessus/plugins/
 
-This will cause a directory called nasldoc/ to be created in your current directory. This directory will contain all of the generated html documents, just open index.html inside of nasldoc/ and view the documentation.
+This will cause a directory called `nasldoc/` to be created in your current directory. This directory will contain all of the generated HTML documents. After running `nasldoc`, open `index.html` inside of `nasldoc/` and view the documentation.
 
 #Comment Markup
 
-Nasldoc comments are inclosed in ## blocks and use special tags to mark items, currently there are only 3 tags. Tags can be added in a matter of minutes to the parser.
+`nasldoc` comments are inclosed in ## blocks and use special tags to mark items. Currently, there are only 3 tags. Tags can be added in a matter of minutes to the parser.
 
-Nasldoc supports several markup tags this tags are:
+nasldoc supports several markup tags:
 
 - @param - used to label named arguments to a function
 - @anonparam - used to label anonymous arguments to a function
 - @return - what the function returns
-- @deprecated - Notation for functions that shouldn't be used
-- @nessus - Minimum Nessus version supported
-- @category - Type of category for the function
-- @remark - Special notes or remarks
+- @deprecated - notation for functions that shouldn't be used
+- @nessus - minimum Nessus version supported
+- @category - type of category for the function
+- @remark - special notes or remarks
 
 #Function Description Block
 
-The function description block is free form text from the first ## to the first @tag in the nasldoc body, the lines are split on the # and rejoined with spaces.
+The function description block is free form text from the first ## block to the first @tag in the `nasldoc` body. The lines are split on the # and rejoined with spaces.
 
 #Example
 
@@ -40,7 +40,7 @@ The function description block is free form text from the first ## to the first
 	# @param arg1 first number to add
 	# @param arg2 second number to add
 	#
-	# @return The sum of arg1 and arg2
+	# @return the sum of arg1 and arg2
 	##
 	function add(arg1, arg2)
 	{
@@ -49,7 +49,7 @@ The function description block is free form text from the first ## to the first
 
 #Templates
 
-Nasldoc uses the ERB templating engine to make generating the output html dead simple. Attached is an example of the sidebar, ruby code can be injected to help generate the layout.
+`nasldoc` uses the ERB templating engine to make generating the output HTML trivial. Attached is an example of the sidebar; ruby code can be injected to help generate the layout.
 
 ##Example
 

data/lib/nasldoc.rb

@@ -26,7 +26,7 @@
 
 module NaslDoc
 	APP_NAME = "nasldoc"
-	VERSION = "0.2.1"
+	VERSION = "0.3.0"
 end
 
 require 'erb'

data/lib/nasldoc/cli/application.rb

@@ -51,6 +51,12 @@ module NaslDoc
 
 				@overview = nil
 
+				@fn_ns_map = {}
+				@obj_ns_map = {}
+				@obj_fn_map = {}
+
+				@namespaces = []
+
 				@template_dir = Pathname.new(__FILE__).realpath.to_s.gsub('cli/application.rb', 'templates')
 				@asset_dir = Pathname.new(__FILE__).realpath.to_s.gsub('cli/application.rb', 'assets')
 				@current_file = "(unknown)"
@@ -77,6 +83,31 @@ module NaslDoc
 				base(path).gsub('.', '_') + '.html'
 			end
 
+			# Generates namespace mappings
+			def build_namespace_map(tree, namespaces, fn_map, obj_map, obj_fn_map, level=0, prefix = nil, object = nil)
+				cur_namespace = prefix
+				for node in tree do
+					if(node.class.to_s == "Nasl::Namespace")
+						if(level == 0)
+							namespaces << node.name.name
+							build_namespace_map(node, namespaces, fn_map, obj_map, obj_fn_map, level + 1, node.name.name)
+						else
+							ns = prefix + '::' + node.name.name
+							namespaces << ns
+							build_namespace_map(node, namespaces, fn_map, obj_map, obj_fn_map, level + 1, ns)
+						end
+					elsif(node.class.to_s == "Nasl::Function")
+						fn_map[node.to_s] = cur_namespace
+						if(!object.nil?)
+							obj_fn_map[node.to_s] = object 
+						end
+					elsif(node.class.to_s == "Nasl::Object")
+						obj_map[node.to_s] = cur_namespace
+						build_namespace_map(node, namespaces, fn_map, obj_map, obj_fn_map, level + 1, cur_namespace, node.name.name)
+					end
+				end
+			end
+
 			# Compiles a template for each file
 			def build_template name, path=nil
 				path ||= name
@@ -105,18 +136,55 @@ module NaslDoc
 					return nil
 				end
 
+				# get namespace mapping
+				build_namespace_map(tree, @namespaces, @fn_ns_map, @obj_ns_map, @obj_fn_map)
+				
 				# Collect the functions.
 				@functions = Hash.new()
 				tree.all(:Function).map do |fn|
-					@functions[fn.name.name] = {
-						:code => fn.context(nil, false, false),
-						:params => fn.params.map(&:name)
+					ns = @fn_ns_map[fn.to_s]
+					show_ns = 0
+					if(fn.fn_type == "normal" and !ns.nil?)
+						show_ns = 1
+					end
+					code_snip = fn.context(nil, false, false)
+					if (!code_snip.nil?)
+						code_snip = code_snip.gsub(/#*$/, "").rstrip
+					end
+					@functions[fn.to_s] = {
+						:name => fn.name.name,
+						:code => code_snip,
+						:params => fn.params.map(&:name),
+						:namespace => ns,
+						:fn_type => fn.fn_type,
+						:show_ns => show_ns,
+						:object => @obj_fn_map[fn.to_s]
 					}
 					@function_count += 1
 				end
 
-				@funcs_prv = @functions.select { |n, p| n =~ /^_/ }
-				@funcs_pub = @functions.reject { |n, p| @funcs_prv.key? n }
+				@funcs_prv = {}
+				@funcs_pub = {}
+
+				for function in tree.all(:Function) do
+					if (defined? function.tokens[0].type and function.tokens[0].type == :PUBLIC)
+						@funcs_pub[function.to_s] = @functions[function.to_s]
+					elsif (defined? function.tokens[0].type and function.tokens[0].type == :PRIVATE)
+						@funcs_prv[function.to_s] = @functions[function.to_s]
+					elsif (function.fn_type == 'obj' and defined? function.tokens[0].type and function.tokens[0].type.nil?)
+						if(obj_fn_map[function.to_s] == function.name.name) # handle constructor
+							@funcs_pub[function.to_s] = @functions[function.to_s]
+						else
+							@funcs_prv[function.to_s] = @functions[function.to_s]
+						end
+					elsif (function.name.name =~ /^_/)
+						@funcs_prv[function.to_s] = @functions[function.to_s]
+					else
+						@funcs_pub[function.to_s] = @functions[function.to_s]
+					end
+				end
+#				@funcs_prv = @functions.select { |n, p| n =~ /^_/ }
+#				@funcs_pub = @functions.reject { |n, p| @funcs_prv.key? n }
 
 				# Collect the globals.
 				@globals = tree.all(:Global).map(&:idents).flatten.map do |id|

data/lib/nasldoc/cli/comment.rb

@@ -240,6 +240,7 @@ module NaslDoc
 									raise TagFormatException, "Failed to parse the #{tag}'s block for #@name."
 								end
 								block.lstrip!
+								block = block.gsub(/^.*>/, "")
 
 								# Check for previous declarations of this name.
 								if @anonparams.key?(name)
@@ -252,6 +253,7 @@ module NaslDoc
 
 								hash = self.send(attr + 's')
 								hash[name] = block
+
 							when '@category'
 								unless @categories.empty?
 									raise DuplicateTagException, "The #{tag} tag appears more than once for #@name."
@@ -296,7 +298,8 @@ module NaslDoc
 			def extract_function(node)
 				# Remember the function name.
 				fn = node.next
-				@function = fn.name.name
+				@function = fn.to_s
+				@fn_type = fn.fn_type
 
 				# Name this comment for use in error messages.
 				@name = "function #@function"

data/lib/nasldoc/templates/file.erb

@@ -26,6 +26,34 @@
   end
 %>
 
+<%
+  def build_fn_name(name, colorize = 0)
+    fn_str = ''
+    if (!@functions[name][:namespace].nil?)
+      if(colorize)
+	fn_str += "<font color='#770877'>" + @functions[name][:namespace] + "</font><b>::</b>"
+      else
+      	fn_str += @functions[name][:namespace] + "::"
+      end
+    end
+    if (!@functions[name][:object].nil?)
+      if(colorize)
+        fn_str += "<font color='#B83E0D'>" + @functions[name][:object] + "</font><b>.</b>"
+      else
+        fn_str += @functions[name][:object] + "."
+      end
+    end
+    if(colorize)
+        color = "#50A40B"
+	color = "#086E6E" if @functions[name][:fn_type] == "obj"
+        fn_str += "<font color='#" + color + "'><b>" + @functions[name][:name] + "()</b></font>"
+    else
+      fn_str += @functions[name][:name]
+    end
+    fn_str
+  end
+%>
+
 <!DOCTYPE html>
 <html lang="en">
   <head>
@@ -161,9 +189,9 @@
 			<th>Name</th>
 			<th>Summary</th>
 		  </tr>
-		  <% list.each do |name| %>
+                  <% list.each do |name| %>
 		  <tr>
-			<td><a href="#<%= name %>"><%= name %></a></td>
+			<td><a href="#<% name %>"><%= name %></a></td>
 			<td><%= safe(comment(name, :global), "", :summary) %></td>
 		  </tr>
 		  <% end %>
@@ -190,9 +218,11 @@
 			<th>Name</th>
 			<th>Summary</th>
 		  </tr>
-		  <% list.keys.sort.each do |name| %>
+		  <% list.keys.sort_by { |key| [@functions[key][:name]] }.each do |name| %>
 		  <tr>
-			<td><a href="#<%= name %>"><%= name %></a></td>
+			<td><a href="#<%= build_fn_name(name) %>">
+			<%= build_fn_name(name, 1) %>
+			</a></td>
 			<td><%= safe(comment(name, :function), "", :summary) %></td>
 		  </tr>
 		  <% end %>
@@ -258,7 +288,7 @@
 		<% unless list.empty? %>
 		<h1><%= name %> Function Details</h1>
 		<% list.keys.sort.each do |name| %>
-		<h2 id="<%= name %>"><%= name %></h2>
+		<h2 id="<%= build_fn_name(name) %>"><%= @functions[name][:name] %></h2>
 		<% comm = comment(name, :function) %>
 
 		<% unless comm.nil? %>
@@ -267,6 +297,16 @@
 		<p class="summary"><%= comm.summary %></p>
 		<% end %>
 
+		<% unless @functions[name][:namespace].nil? %>
+		<h3>Namespace</h3>
+                <p class="namespace"><%= @functions[name][:namespace] %></p>
+		<% end %>
+
+		<% unless @functions[name][:object].nil? %>
+		<h3>Object</h3>
+                <p class="object"><%= @functions[name][:object] %></p>
+		<% end %>
+		
 		<% unless comm.description.empty? %>
 		<h3>Description</h3>
 		<% comm.description.each do |para| %>
@@ -332,7 +372,9 @@
 		<h3>Code</h3>
                 <!-- The contents must not have indentation, else formatting is off. -->
 		<pre class="brush: nasl">
+<% unless @functions[name][:code].nil? %>
 <%= CGI::escapeHTML(@functions[name][:code]) %>
+<% end %>
 		</pre>
 		<a href="#top">top</a>
 		<hr>
@@ -346,7 +388,7 @@
 	<hr>
 
 	<footer>
-		<p>&copy; Tenable Network Security 2014</p>
+		<p>&copy; Tenable Network Security 2018</p>
 	</footer>
 
   </div><!--/.fluid-container-->

data/lib/nasldoc/templates/index.erb

@@ -82,7 +82,7 @@
 			<hr>
 
 			<footer>
-				<p>&copy; Tenable Network Security 2014</p>
+				<p>&copy; Tenable Network Security 2018</p>
 			</footer>
 
 		</div><!--/.fluid-container-->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasldoc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jacob Hammack
@@ -10,68 +10,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: nasl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC4yLjA=
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC4yLjA=
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          Mi4w
-    - - ! '>='
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          Mi4wLjA=
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          Mi4w
-    - - ! '>='
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          Mi4wLjA=
+        version: 2.0.0
 description: nasldoc is a NASL documentation generator
 email:
 - jhammack@tenable.com
@@ -87,7 +81,6 @@ extra_rdoc_files:
 files:
 - Gemfile
 - Gemfile.ci
-- Gemfile.lock
 - LICENSE
 - NEWS.markdown
 - README.markdown
@@ -110,8 +103,6 @@ files:
 - lib/nasldoc/assets/js/shCore.js
 - lib/nasldoc/cli.rb
 - lib/nasldoc/cli/application.rb
-- lib/nasldoc/cli/application.rb.orig
-- lib/nasldoc/cli/application.rb.rej
 - lib/nasldoc/cli/comment.rb
 - lib/nasldoc/templates/file.erb
 - lib/nasldoc/templates/index.erb
@@ -126,17 +117,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.24
 requirements: []
 rubyforge_project: nasldoc
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: nasldoc

data/Gemfile.lock

@@ -1,17 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    builder (3.2.2)
-    nasl (0.2.0)
-      builder (~> 3.1)
-      rainbow (~> 2.0)
-    rainbow (2.0.0)
-    rake (10.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  nasl (= 0.2.0)
-  rainbow (= 2.0.0)
-  rake (= 10.3.2)

data/lib/nasldoc/cli/application.rb.orig

@@ -1,290 +0,0 @@
-################################################################################
-# Copyright (c) 2011-2014, Tenable Network Security
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# 1. Redistributions of source code must retain the above copyright notice, this
-#    list of conditions and the following disclaimer.
-#
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-#    this list of conditions and the following disclaimer in the documentation
-#    and/or other materials provided with the distribution.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-################################################################################
-
-require 'nasldoc/cli/comment'
-
-module NaslDoc
-	module CLI
-		class Application
-			attr_accessor :error_count
-
-			# Initializes the Application class
-			#
-			# - Sets the default output directory to nasldoc_output/
-			# - Sets the template directory to lib/templates
-			# - Sets the assets directory to lib/assets
-			#
-			def initialize
-				@file_list = Array.new
-				@function_count = 0
-				@error_count = 0
-				@options = Hash.new
-
-				@options[:output_directory] = "nasldoc_ouput/"
-
-				@functions = Array.new
-				@globals = Array.new
-				@includes = Array.new
-
-				@overview = nil
-
-				@template_dir = Pathname.new(__FILE__).realpath.to_s.gsub('cli/application.rb', 'templates')
-				@asset_dir = Pathname.new(__FILE__).realpath.to_s.gsub('cli/application.rb', 'assets')
-				@current_file = "(unknown)"
-			end
-
-			# For ERB Support
-			#
-			# @return ERB Binding for access to instance variables in templates
-			def get_binding
-				binding
-			end
-
-			# Generates the base name for a path
-			#
-			# @return htmlized file name for .inc file
-			def base path
-				File.basename(path, '.inc')
-			end
-
-			# Generates the HTML base name for a path
-			#
-			# @return htmlized file name for .inc file
-			def url path
-				base(path).gsub('.', '_') + '.html'
-			end
-
-			# Compiles a template for each file
-			def build_template name, path=nil
-				path ||= name
-
-				dest = url(path)
-				puts "[**] Creating #{dest}"
-				@erb = ERB.new File.new("#{@template_dir}/#{name}.erb").read, nil, "%"
-				html = @erb.result(get_binding)
-
-				File.open("#{@options[:output_directory]}/#{dest}", 'w+') do |f|
-					f.puts html
-				end
-			end
-
-			# Processes each .inc file and sets instance variables for each template
-			def build_file_page path
-				puts "[*] Processing file: #{path}"
-				@current_file = File.basename(path)
-				contents = File.open(path, "rb") { |f| f.read }
-
-				# Parse the input file.
-				tree = Nasl::Parser.new.parse(contents, path)
-
-				# Collect the functions.
-				@functions = Hash.new()
-				tree.all(:Function).map do |fn|
-					@functions[fn.name.name] = {
-						:code => fn.context(nil, false, false),
-						:params => fn.params.map(&:name)
-					}
-					@function_count += 1
-				end
-
-				@funcs_prv = @functions.select { |n, p| n =~ /^_/ }
-				@funcs_pub = @functions.reject { |n, p| @funcs_prv.key? n }
-
-				# Collect the globals.
-				@globals = tree.all(:Global).map(&:idents).flatten.map do |id|
-					if id.is_a? Nasl::Assignment
-						id.lval.name
-					else
-						id.name
-					end
-				end.sort
-
-				@globs_prv = @globals.select { |n| n =~ /^_/ }
-				@globs_pub = @globals.reject { |n| @globs_prv.include? n }
-
-				# Collect the includes.
-				@includes = tree.all(:Include).map(&:filename).map(&:text).sort
-
-				# Parse the comments.
-				@comments = tree.all(:Comment)
-				puts "[**] #{@comments.size} comment(s) were found"
-				@comments.map! do |comm|
-					begin
-						NaslDoc::CLI::Comment.new(comm, path)
-					rescue CommentException => e
-						# A short message is okay for format errors.
-						puts "[!!!] #{e.class.name} #{e.message}"
-						@error_count += 1
-						nil
-					rescue Exception => e
-						# A detailed message is given for programming errors.
-						puts "[!!!] #{e.class.name} #{e.message}"
-						puts e.backtrace.map{ |l| l.prepend "[!!!!] " }.join("\n")
-						nil
-					end
-				end
-				@comments.compact!
-				@comments.keep_if &:valid
-				puts "[**] #{@comments.size} nasldoc comment(s) were parsed"
-
-				# Find the overview comment.
-				@overview = @comments.select{ |c| c.type == :file }.shift
-
-				build_template "file", path
-			end
-
-			# Builds each page from the file_list
-			def build_file_pages
-				@file_list.each do |f|
-					build_file_page(f)
-				end
-			end
-
-			# Copies required assets to the final build directory
-			def copy_assets
-				puts `cp -vr #{@asset_dir}/* #{@options[:output_directory]}/`
-			end
-
-			# Prints documentation stats to stdout
-			def print_documentation_stats
-				puts "\n\nDocumentation Statistics"
-				puts "Files: #{@file_list.size}"
-				puts "Functions: #{@function_count}"
-				puts "Errors: #{@error_count}"
-			end
-
-			# Removes blacklisted files from the file list
-			def remove_blacklist file_list
-				blacklist = [
-					"apple_device_model_list.inc",
-					"blacklist_dss.inc",
-					"blacklist_rsa.inc",
-					"blacklist_ssl_rsa1024.inc",
-					"blacklist_ssl_rsa2048.inc",
-					"custom_CA.inc",
-					"daily_badip.inc",
-					"daily_badip2.inc",
-					"daily_badurl.inc",
-					"known_CA.inc",
-					"oui.inc",
-					"oval-definitions-schematron.inc",
-					"ovaldi32-rhel5.inc",
-					"ovaldi32-win-dyn-v100.inc",
-					"ovaldi32-win-dyn-v90.inc",
-					"ovaldi32-win-static.inc",
-					"ovaldi64-rhel5.inc",
-					"ovaldi64-win-dyn-v100.inc",
-					"ovaldi64-win-dyn-v90.inc",
-					"ovaldi64-win-static.inc",
-					"plugin_feed_info.inc",
-					"sc_families.inc",
-					"scap_schema.inc",
-					"ssl_known_cert.inc"
-				]
-
-				new_file_list = file_list.dup
-
-				file_list.each_with_index do |file, index|
-					blacklist.each do |bf|
-						if file =~ /#{bf}/
-							new_file_list.delete(file)
-						end
-					end
-				end
-
-				return new_file_list
-			end
-
-			# Parses the command line arguments
-			def parse_args
-				opts = OptionParser.new do |opt|
-					opt.banner = "#{APP_NAME} v#{VERSION}\nTenable Network Security.\njhammack@tenable.com\n\n"
-					opt.banner << "Usage: #{APP_NAME} [options] [file|directory]"
-
-					opt.separator ''
-					opt.separator 'Options'
-
-					opt.on('-o', '--output DIRECTORY', "Directory to output results to, created if it doesn't exit") do |option|
-						@options[:output_directory] = option
-					end
-
-					opt.separator ''
-					opt.separator 'Other Options'
-
-					opt.on_tail('-v', '--version', "Shows application version information") do
-						puts "#{APP_NAME} - #{VERSION}"
-						exit
-					end
-
-					opt.on_tail('-?', '--help', 'Show this message') do
-						puts opt.to_s + "\n"
-						exit
-					end
-				end
-
-				if ARGV.length != 0
-					opts.parse!
-				else
-					puts opts.to_s + "\n"
-					exit
-				end
-			end
-
-			# Main function for running nasldoc
-			def run
-				parse_args
-
-				if File.directory?(ARGV.first) == true
-					pattern = File.join(ARGV.first, '**', '*.inc')
-					@file_list = Dir.glob pattern
-				else
-					@file_list << ARGV.first
-				end
-
-				# Ensure the output directory exists.
-				if File.directory?(@options[:output_directory]) == false
-					Dir.mkdir @options[:output_directory]
-				end
-
-				# Get rid of non-NASL files.
-				@file_list = remove_blacklist(@file_list)
-
-				# Ensure we process files in a consistent order.
-				@file_list.sort! do |a, b|
-					base(a) <=> base(b)
-				end
-
-				puts "[*] Building documentation..."
-
-				build_template "index"
-				build_file_pages
-				copy_assets
-
-				print_documentation_stats
-			end
-		end
-	end
-end

data/lib/nasldoc/cli/application.rb.rej

@@ -1,16 +0,0 @@
---- application.rb
-+++ application.rb
-@@ -98,7 +98,12 @@ module NaslDoc
-                                contents = File.open(path, "rb") { |f| f.read }
- 
-                                # Parse the input file.
--                               tree = Nasl::Parser.new.parse(contents, path)
-+                               begin
-+                                       tree = Nasl::Parser.new.parse(contents, path)
-+                               rescue Nasl::ParseException, Nasl::TokenException
-+                                       puts "[!!!] File '#{path}' couldn't be parsed. It should be added to the blacklist."
-+                                       return nil
-+                               end
- 
-                                # Collect the functions.
-                                @functions = Hash.new()