Merge pull request #7 from fwininger/refactoring

Refactoring with rubocop

.rubocop_todo.yml

@@ -1,47 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-12-05 12:02:20 +0100 using RuboCop version 0.51.0.
+# on 2017-12-05 14:20:35 +0100 using RuboCop version 0.51.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 10
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, IndentOneStep, IndentationWidth.
-# SupportedStyles: case, end
-Layout/CaseIndentation:
-  Exclude:
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-
-# Offense count: 11
-# Cop supports --auto-correct.
-Layout/ElseAlignment:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/event.rb'
-    - 'lib/ruby-nessus/Version2/event.rb'
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: normal, rails
-Layout/IndentationConsistency:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/host.rb'
-    - 'lib/ruby-nessus/Version1/version1.rb'
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-    - 'lib/ruby-nessus/cli.rb'
-
-# Offense count: 11
-# Cop supports --auto-correct.
-# Configuration parameters: Width, IgnoredPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/event.rb'
-    - 'lib/ruby-nessus/Version2/event.rb'
-
 # Offense count: 4
 Lint/AmbiguousOperator:
   Exclude:
@@ -52,15 +16,6 @@ Lint/DuplicateMethods:
   Exclude:
     - 'lib/ruby-nessus/Version1/port.rb'
 
-# Offense count: 11
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
-# SupportedStylesAlignWith: keyword, variable, start_of_line
-Lint/EndAlignment:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/event.rb'
-    - 'lib/ruby-nessus/Version2/event.rb'
-
 # Offense count: 1
 Lint/RescueWithoutErrorClass:
   Exclude:
@@ -84,23 +39,23 @@ Lint/UselessAssignment:
 
 # Offense count: 8
 Metrics/AbcSize:
-  Max: 69
+  Max: 70
 
-# Offense count: 8
+# Offense count: 7
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Max: 82
 
 # Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 226
+  Max: 234
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 59
+# Offense count: 61
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
@@ -148,17 +103,6 @@ Performance/StringReplacement:
     - 'lib/ruby-nessus/Version1/version1.rb'
     - 'lib/ruby-nessus/Version2/host.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# IgnoredMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'ruby-nessus.gemspec'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -201,53 +145,14 @@ Style/Documentation:
     - 'lib/ruby-nessus/parse.rb'
     - 'lib/ruby-nessus/ruby-nessus.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/Encoding:
-  Exclude:
-    - 'Rakefile'
-    - 'ruby-nessus.gemspec'
-
-# Offense count: 18
+# Offense count: 14
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/ruby-nessus/Version1/host.rb'
     - 'lib/ruby-nessus/Version1/port.rb'
     - 'lib/ruby-nessus/Version1/version1.rb'
     - 'lib/ruby-nessus/Version2/host.rb'
     - 'lib/ruby-nessus/Version2/version2.rb'
-    - 'lib/ruby-nessus/parse.rb'
-
-# Offense count: 34
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'bin/recess'
-    - 'lib/ruby-nessus/parse.rb'
-
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: line_count_dependent, lambda, literal
-Style/Lambda:
-  Exclude:
-    - 'ruby-nessus.gemspec'
-    - 'spec/ruby-nessus/parse_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'lib/ruby-nessus/version.rb'
 
 # Offense count: 3
 # Cop supports --auto-correct.
@@ -260,98 +165,10 @@ Style/NumericPredicate:
     - 'lib/ruby-nessus/Version2/host.rb'
     - 'lib/ruby-nessus/Version2/version2.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/ParallelAssignment:
-  Exclude:
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/version1.rb'
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantBegin:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/port.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/RedundantConditional:
-  Exclude:
-    - 'lib/ruby-nessus/core_ext/helpers.rb'
-
-# Offense count: 21
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/event.rb'
-    - 'lib/ruby-nessus/Version1/host.rb'
-    - 'lib/ruby-nessus/Version1/port.rb'
-    - 'lib/ruby-nessus/Version1/version1.rb'
-    - 'lib/ruby-nessus/Version2/event.rb'
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-    - 'lib/ruby-nessus/core_ext/helpers.rb'
-
-# Offense count: 7
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/host.rb'
-    - 'lib/ruby-nessus/Version1/version1.rb'
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-    - 'lib/ruby-nessus/cli.rb'
-    - 'lib/ruby-nessus/core_ext/helpers.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
     - 'lib/ruby-nessus/Version1/port.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: use_perl_names, use_english_names
-Style/SpecialGlobalVars:
-  Exclude:
-    - 'ruby-nessus.gemspec'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnlessElse:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/event.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/UnneededCapitalW:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/version1.rb'
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-
-# Offense count: 31
-# Cop supports --auto-correct.
-Style/UnneededInterpolation:
-  Exclude:
-    - 'lib/ruby-nessus/Version1/event.rb'
-    - 'lib/ruby-nessus/Version1/host.rb'
-    - 'lib/ruby-nessus/Version1/port.rb'
-    - 'lib/ruby-nessus/Version1/version1.rb'
-    - 'lib/ruby-nessus/Version2/host.rb'
-    - 'lib/ruby-nessus/Version2/version2.rb'
-    - 'lib/ruby-nessus/cli.rb'
-    - 'lib/ruby-nessus/log.rb'

Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'rake'
 
@@ -24,8 +22,8 @@ rescue LoadError => e
   end
 end
 
-task :test    => :spec
-task :default => :spec
+task test: :spec
+task default: :spec
 
 begin
   gem 'yard', '~> 0.8'
@@ -37,4 +35,4 @@ rescue LoadError => e
     abort 'Please run `gem install yard` to install YARD.'
   end
 end
-task :doc => :yard
+task doc: :yard

bin/recess

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 
 lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
-unless $LOAD_PATH.include?(lib_dir)
-  $LOAD_PATH << lib_dir
-end
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
 require 'ruby-nessus/cli'
 require 'ruby-nessus/version'

examples/example.rb

@@ -40,6 +40,6 @@ def print_info(host)
 
 # From a string:
 puts '+ Using an XML string:'
-Nessus::Parse.new(nil, { :xml => File.read('example_v1.nessus') }) do |scan|
+Nessus::Parse.new(nil, { xml: File.read('example_v1.nessus') }) do |scan|
   scan.each_host(&method(:print_info))
 end

examples/example_bid.rb

@@ -18,7 +18,7 @@ def print_info(host)
   end
 end
 
-Nessus::Parse.new('example_v3.nessus', :version => 2) do |scan|
+Nessus::Parse.new('example_v3.nessus', version: 2) do |scan|
   scan.each_host do |host|
     host.each_event do |event|
       puts "Bid value: #{event.bid}"

examples/example_cpe.rb

@@ -18,7 +18,7 @@ def print_info(host)
   end
 end
 
-Nessus::Parse.new('example_v3.nessus', :version => 2) do |scan|
+Nessus::Parse.new('example_v3.nessus', version: 2) do |scan|
   scan.each_host do |host|
     host.each_event do |event|
       puts "CPE value: #{event.cpe}"

examples/example_cve.rb

@@ -26,7 +26,7 @@ def print_info(host)
   end
 end
 
-Nessus::Parse.new('example_v3.nessus', :version => 2) do |scan|
+Nessus::Parse.new('example_v3.nessus', version: 2) do |scan|
   scan.each_host do |host|
     host.each_event do |event|
       puts "CVE value: #{event.cve}"

lib/ruby-nessus/Version1/event.rb

@@ -53,13 +53,13 @@ def plugin_id
       def plugin_name
         s = @event.at('pluginName').inner_text
 
-        @plugin_name ||= unless s.empty?
-                           @event.at('pluginName').inner_text || 'N/A'
-                         else
+        @plugin_name ||= if s.empty?
                            false
+                         else
+                           @event.at('pluginName').inner_text || 'N/A'
                          end
 
-        return @plugin_name
+        @plugin_name
       end
       alias name plugin_name
 
@@ -70,14 +70,14 @@ def plugin_name
       #   event.output        #=> "..."
       #   event.data          #=> "..."
       def data
-        d = "#{@event.at('data')}" || ''
+        d = @event.at('data').to_s || ''
 
-        @data ||= unless d.empty?
-                           @event.at('data').inner_text || 'N/A'
-                         else
-                           false
-                         end
-        return @data
+        @data ||= if d.empty?
+                    false
+                  else
+                    @event.at('data').inner_text || 'N/A'
+                  end
+        @data
       end
       alias output data
     end