nasl-pedant 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTNkZDBhYzc5YzY5MjE1ZGFmMzgxZDViMDg0YmEwNGQyODE2ODlmMA==
+    ZmFmYzVkY2QxNzg0Y2U2NGFlZmRhNTQ3NzhkMDExODY2NDU5YzZlYQ==
   data.tar.gz: !binary |-
-    MWI3Njg1YzY0ODMyNzJhZWViOGFiMzI3NDg1YjU1ZGI1NjY2NWNkOA==
+    NjBhMzY0NDMwZjNlNzA0MzUyN2ZlMWU3MjIzNTQ4ZDAxMWY1OGY2YQ==
 SHA512:
   metadata.gz: !binary |-
-    NTViZDYwZWUxOWRhZWQ3OWZlNmRlZTYwYmVhMDY0ZjkzYmIwZmY5YTg5NWM2
-    NjU1NmEwYmM0YmFlNjkwZjNlMzhjNzFmMmZkMzkzOTU0Nzg3YzA3ZjcwOWM4
-    MWEwZTkwOGExY2IzNDEwOWZmN2JkNjRjNGI4OTI1YzJhNmY2OTI=
+    ZjBjZjQxODJmNDEyZjI4ZDIyYWJmMjk2NjFhMWViNTAzZjBhNWQ0ZjI1OGIz
+    ZTlmNjgzZmQwOGYwZjg4YmYzZWFhNjkxZDkyOGI3ZGMyYTBlYWU1MDZmY2Ex
+    ZjhkOTg3YTQ1MGJmMWM3NDUzYTBjNWIxOGMwMTAzYjlmZmE3OGQ=
   data.tar.gz: !binary |-
-    OGJlYTZiODkxZWQwZWU2MTk3YTg1NmM1OTdkNTZjNzdkYWQ1YjFkYmNiMzZi
-    YmQxYTI2YTVjNGJhMTQ0OTMxNjZiYjBlZmJkMDAwY2RmMmQ3NDQyNTU4MzBk
-    NTVjZjcyZmJhMTM5OWQ4MDZjYTdiMjAzNDNmNzZlZWUwMDI3MjU=
+    MDM2MjJiZjc3Mzg4ZmM4NTk4ZTdhOWRlZjRiMmEzYmMxMTE4Nzg2NDFlNjUx
+    ZTY3OGViZmE4ZWM3YWQ3YWM5MjdkOWY3M2E5M2MwOTk2Y2JhNDI3OGY3Yzgw
+    OGYxODdkNzAxMzVkYmNjMTkyZGYxOTdkOGMwOTFiN2ZhMTA3M2Y=

data/lib/pedant/check.rb

@@ -29,12 +29,12 @@ module Pedant
     attr_reader :result
 
     @@statuses = {
-      :died => Rainbow('DIED').color(:red),
-      :fail => Rainbow('FAIL').color(:red),
-      :pass => Rainbow('PASS').color(:green),
-      :skip => Rainbow('SKIP').color(:green),
-      :warn => Rainbow('WARN').color(:yellow),
-      :void => Rainbow('VOID').color(:magenta)
+      :fatal => Rainbow('DIED').color(:red),
+      :fail  => Rainbow('FAIL').color(:red),
+      :pass  => Rainbow('PASS').color(:green),
+      :skip  => Rainbow('SKIP').color(:green),
+      :warn  => Rainbow('WARN').color(:yellow),
+      :void  => Rainbow('VOID').color(:magenta)
     }
 
     @@levels = [:error, :warn, :info]
@@ -92,6 +92,7 @@ module Pedant
       # Try to run each pending check, until we've run all our checks or
       # deadlocked.
       fatal = false
+      run_checks = []
       until checks.empty? || fatal
         # Find all of the checks that can run right now.
         ready = checks.select { |cls| cls.ready?(kb) }
@@ -106,7 +107,7 @@ module Pedant
           chk.run
 
           # Yield the results of the finished check
-          yield chk if block_given?
+          run_checks << chk
 
           # Fatal errors mean that no further checks should be processed.
           if chk.result == :fatal
@@ -115,6 +116,7 @@ module Pedant
           end
         end
       end
+      run_checks
     end
 
     def report(level, text=nil)
@@ -151,7 +153,7 @@ module Pedant
 
     def fatal
       report(:error, "This is a fatal error.")
-      @result = :died
+      @result = :fatal
     end
 
     def pass

data/lib/pedant/checks/confusing_variable_names.rb

@@ -87,9 +87,9 @@ module Pedant
       return if confusable_name_groups.length == 0
 
       warn
-      report(:error, "These sets of names differ only by capitalization or underscores:")
+      report(:warn, "These sets of names differ only by capitalization or underscores:")
       confusable_name_groups.each do |names|
-        report(:error, "  #{names.join(', ')}")
+        report(:warn, "  #{names.join(', ')}")
       end
     end
 

data/lib/pedant/checks/contains_no_tabs.rb

@@ -24,6 +24,8 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ################################################################################
 
+require 'rainbow'
+
 module Pedant
   class CheckContainsNoTabs < Check
     def self.requires
@@ -31,9 +33,19 @@ module Pedant
     end
 
     def check(file, code)
-      return unless code =~ /\t/
+      tab_lines = Hash.new
+      code.split("\n").each_with_index do |line, linenum|
+        tab_lines[linenum + 1] = line if line =~ /\t/
+      end
+
+      return if tab_lines.length == 0
+
+      report(:warn, "Tabs were found in #{file}, on these lines: #{tab_lines.keys.sort.join(', ')}")
+      report(:warn, "Showing up to five lines:")
+      tab_lines.keys.sort.first(5).each do |linenum|
+        report(:warn, "#{linenum}: #{tab_lines[linenum].gsub(/\t/, Rainbow("    ").background(:red))}")
+      end
 
-      report(:warn, "Tabs were found in #{file}.")
       warn
     end
 

data/lib/pedant/checks/files_parse_without_errors.rb

@@ -54,7 +54,7 @@ module Pedant
           @kb[:codes][file] = contents
           report(:info, "Read contents of #{path}.")
         rescue
-          report(:error, "Failed to read contents #{path}.")
+          report(:error, "Failed to read contents of #{path}.")
           return fatal
         end
 
@@ -62,7 +62,7 @@ module Pedant
           tree = Nasl::Parser.new.parse(contents, path)
           @kb[:trees][file] = tree
           report(:info, "Parsed contents of #{path}.")
-        rescue
+        rescue Nasl::ParseException, Nasl::TokenException
           # XXX-MAK: Incorporate the error from the parser, as it gives full,
           # coloured context.
           report(:error, "Failed to parse #{path}.")

data/lib/pedant/commands/check.rb

@@ -89,6 +89,10 @@ module Pedant
           puts Check.list
           exit 0
         end
+
+        opts.on('-q', '--quiet', "Only speak up when something should be fixed.") do
+          options[:quiet] = true
+        end
       end
 
       # Load all of the checks.
@@ -128,7 +132,6 @@ module Pedant
     end
 
     def self.run_one(opts, path)
-      puts Rainbow("CHECKING: #{path}").cyan
       # Get a list of the checks we're going to be running.
       if not opts[:checks].empty?
         pending = opts[:checks].to_a
@@ -140,14 +143,23 @@ module Pedant
       # other checks.
       kb = KnowledgeBase.new(:file_mode, path)
 
-      Check.run_checks_in_dependency_order(kb, pending) do |chk|
+      run_checks = Check.run_checks_in_dependency_order(kb, pending)
+      # When in quiet mode, only make a report for this file if a check did not pass
+      return if opts[:quiet] && run_checks.all? { |chk| [:skip, :pass].include? chk.result }
+
+      puts Rainbow("CHECKING: #{path}").cyan
+      run_checks.each do |chk|
+        next if [:skip, :pass].include?(chk.result) && opts[:quiet]
         puts chk.report(opts[:verbosity])
       end
-
       # Notify the user if any checks did not run due to unsatisfied
       # dependencies or a fatal error occurring before they had the chance to
       # run.
-      pending.each { |cls| puts cls.new(kb).report(opts[:verbosity]) }
+      pending.each do |cls|
+        # Special case. This check is a shim to set things up for unit tests.
+        next if cls == CheckParseTestCode
+        puts cls.new(kb).report(opts[:verbosity])
+      end
       puts
     end
   end

data/lib/pedant/version.rb

@@ -1,3 +1,3 @@
 module Pedant
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nasl-pedant
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Mak Kolybabi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake