railroader 4.3.5 → 4.3.7

data/lib/railroader/checks.rb

@@ -1,23 +1,23 @@
 require 'thread'
 require 'railroader/differ'
 
-#Collects up results from running different checks.
+# Collects up results from running different checks.
 #
-#Checks can be added with +Check.add(check_class)+
+# Checks can be added with +Check.add(check_class)+
 #
-#All .rb files in checks/ will be loaded.
+# All .rb files in checks/ will be loaded.
 class Railroader::Checks
   @checks = []
   @optional_checks = []
 
   attr_reader :warnings, :controller_warnings, :model_warnings, :template_warnings, :checks_run
 
-  #Add a check. This will call +_klass_.new+ when running tests
+  # Add a check. This will call +_klass_.new+ when running tests
   def self.add klass
     @checks << klass unless @checks.include? klass
   end
 
-  #Add an optional check
+  # Add an optional check
   def self.add_optional klass
     @optional_checks << klass unless @checks.include? klass
   end
@@ -31,7 +31,7 @@ class Railroader::Checks
   end
 
   def self.initialize_checks check_directory = ""
-    #Load all files in check_directory
+    # Load all files in check_directory
     Dir.glob(File.join(check_directory, "*.rb")).sort.each do |f|
       require f
     end
@@ -55,7 +55,7 @@ class Railroader::Checks
     []
   end
 
-  #No need to use this directly.
+  # No need to use this directly.
   def initialize options = { }
     if options[:min_confidence]
       @min_confidence = options[:min_confidence]
@@ -70,11 +70,11 @@ class Railroader::Checks
     @checks_run = []
   end
 
-  #Add Warning to list of warnings to report.
-  #Warnings are split into four different arrays
-  #for template, controller, model, and generic warnings.
+  # Add Warning to list of warnings to report.
+  # Warnings are split into four different arrays
+  # for template, controller, model, and generic warnings.
   #
-  #Will not add warnings which are below the minimum confidence level.
+  # Will not add warnings which are below the minimum confidence level.
   def add_warning warning
     unless warning.confidence > @min_confidence
       case warning.warning_set
@@ -92,7 +92,7 @@ class Railroader::Checks
     end
   end
 
-  #Return a hash of arrays of new and fixed warnings
+  # Return a hash of arrays of new and fixed warnings
   #
   #    diff = checks.diff old_checks
   #    diff[:fixed]  # [...]
@@ -103,13 +103,13 @@ class Railroader::Checks
     Railroader::Differ.new(my_warnings, other_warnings).diff
   end
 
-  #Return an array of all warnings found.
+  # Return an array of all warnings found.
   def all_warnings
     @warnings + @template_warnings + @controller_warnings + @model_warnings
   end
 
-  #Run all the checks on the given Tracker.
-  #Returns a new instance of Checks with the results.
+  # Run all the checks on the given Tracker.
+  # Returns a new instance of Checks with the results.
   def self.run_checks(app_tree, tracker)
     checks = self.checks_to_run(tracker)
     check_runner = self.new :min_confidence => tracker.options[:min_confidence]
@@ -134,8 +134,8 @@ class Railroader::Checks
         results << self.run_a_check(c, error_mutex, app_tree, tracker)
       end
 
-      #Maintain list of which checks were run
-      #mainly for reporting purposes
+      # Maintain list of which checks were run
+      # mainly for reporting purposes
       check_runner.checks_run << check_name[5..-1]
     end
 
@@ -203,7 +203,7 @@ class Railroader::Checks
   end
 end
 
-#Load all files in checks/ directory
+# Load all files in checks/ directory
 Dir.glob("#{File.expand_path(File.dirname(__FILE__))}/checks/*.rb").sort.each do |f|
   require f.match(/(railroader\/checks\/.*)\.rb$/)[0]
 end

data/lib/railroader/commandline.rb

@@ -115,7 +115,7 @@ module Railroader
 
       # Runs a regular report based on the options provided.
       def regular_report options
-        tracker = run_railroader options 
+        tracker = run_railroader options
 
         if tracker.options[:exit_on_warn] and not tracker.filtered_warnings.empty?
           quit Railroader::Warnings_Found_Exit_Code

data/lib/railroader/differ.rb

@@ -1,5 +1,5 @@
 # extracting the diff logic to it's own class for consistency. Currently handles
-# an array of Railroader::Warnings or plain hash representations.  
+# an array of Railroader::Warnings or plain hash representations.
 class Railroader::Differ
   DEFAULT_HASH = {:new => [], :fixed => []}
   OLD_WARNING_KEYS = [:warning_type, :location, :code, :message, :file, :link, :confidence, :user_input]
@@ -48,7 +48,7 @@ class Railroader::Differ
 
   def eql_except_line_number new_warning, fixed_warning
     # can't do this ahead of time, as callers may be expecting a Railroader::Warning
-    if new_warning.is_a? Railroader::Warning 
+    if new_warning.is_a? Railroader::Warning
       new_warning = new_warning.to_hash
       fixed_warning = fixed_warning.to_hash
     end

data/lib/railroader/options.rb

@@ -1,22 +1,22 @@
 require 'optparse'
 require 'set'
 
-#Parses command line arguments for Railroader
+# Parses command line arguments for Railroader
 module Railroader::Options
 
   class << self
 
-    #Parse argument array
+    # Parse argument array
     def parse args
       get_options args
     end
 
-    #Parse arguments and remove them from the array as they are matched
+    # Parse arguments and remove them from the array as they are matched
     def parse! args
       get_options args, true
     end
 
-    #Return hash of options and the parser
+    # Return hash of options and the parser
     def get_options args, destructive = false
       options = {}
 
@@ -55,7 +55,7 @@ module Railroader::Options
           options[:quiet] = quiet
         end
 
-        opts.on( "-z", "--[no-]exit-on-warn", "Exit code is non-zero if warnings found (Default)") do |exit_on_warn|
+        opts.on("-z", "--[no-]exit-on-warn", "Exit code is non-zero if warnings found (Default)") do |exit_on_warn|
           options[:exit_on_warn] = exit_on_warn
         end
 
@@ -171,7 +171,7 @@ module Railroader::Options
 
         opts.on "-t", "--test Check1,Check2,etc", Array, "Only run the specified checks" do |checks|
           checks.each_with_index do |s, index|
-            if s[0,5] != "Check"
+            if s[0, 5] != "Check"
               checks[index] = "Check" << s
             end
           end
@@ -182,7 +182,7 @@ module Railroader::Options
 
         opts.on "-x", "--except Check1,Check2,etc", Array, "Skip the specified checks" do |skip|
           skip.each do |s|
-            if s[0,5] != "Check"
+            if s[0, 5] != "Check"
               s = "Check" << s
             end
 

data/lib/railroader/parsers/rails2_erubis.rb

@@ -1,6 +1,6 @@
 Railroader.load_railroader_dependency 'erubis'
 
-#Erubis processor which ignores any output which is plain text.
+# Erubis processor which ignores any output which is plain text.
 class Railroader::ScannerErubis < Erubis::Eruby
   include Erubis::NoTextEnhancer
 end

data/lib/railroader/parsers/rails2_xss_plugin_erubis.rb

@@ -1,12 +1,12 @@
 Railroader.load_railroader_dependency 'erubis'
 
-#This is from the rails_xss plugin for Rails 2
+# This is from the rails_xss plugin for Rails 2
 class Railroader::Rails2XSSPluginErubis < ::Erubis::Eruby
   def add_preamble(src)
-    #src << "@output_buffer = ActiveSupport::SafeBuffer.new;"
+    # src << "@output_buffer = ActiveSupport::SafeBuffer.new;"
   end
 
-  #This is different from rails_xss - fixes some line number issues
+  # This is different from rails_xss - fixes some line number issues
   def add_text(src, text)
     if text == "\n"
       src << "\n"
@@ -43,6 +43,6 @@ class Railroader::Rails2XSSPluginErubis < ::Erubis::Eruby
   end
 
   def add_postamble(src)
-    #src << '@output_buffer.to_s'
+    # src << '@output_buffer.to_s'
   end
 end

data/lib/railroader/parsers/template_parser.rb

@@ -60,7 +60,7 @@ module Railroader
         require 'erb'
         src = if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
           ERB.new(text, trim_mode: path).src
-        else
+              else
           ERB.new(text, nil, path).src
         end
         src.sub!(/^#.*\n/, '') if Railroader::Scanner::RUBY_1_9

data/lib/railroader/processor.rb

@@ -1,14 +1,14 @@
-#Load all files in processors/
+# Load all files in processors/
 Dir.glob("#{File.expand_path(File.dirname(__FILE__))}/processors/*.rb").each { |f| require f.match(/railroader\/processors.*/)[0] }
 require 'railroader/tracker'
 require 'set'
 require 'pathname'
 
 module Railroader
-  #Makes calls to the appropriate processor.
+  # Makes calls to the appropriate processor.
   #
-  #The ControllerProcessor, TemplateProcessor, and ModelProcessor will
-  #update the Tracker with information about what is parsed.
+  # The ControllerProcessor, TemplateProcessor, and ModelProcessor will
+  # update the Tracker with information about what is parsed.
   class Processor
     include Util
 
@@ -21,22 +21,22 @@ module Railroader
       @tracker
     end
 
-    #Process configuration file source
+    # Process configuration file source
     def process_config src, file_name
       ConfigProcessor.new(@tracker).process_config src, file_name
     end
 
-    #Process Gemfile
+    # Process Gemfile
     def process_gems gem_files
       GemProcessor.new(@tracker).process_gems gem_files
     end
 
-    #Process route file source
+    # Process route file source
     def process_routes src
       RoutesProcessor.new(@tracker).process_routes src
     end
 
-    #Process controller source. +file_name+ is used for reporting
+    # Process controller source. +file_name+ is used for reporting
     def process_controller src, file_name
       if contains_class? src
         ControllerProcessor.new(@app_tree, @tracker).process_controller src, file_name
@@ -45,19 +45,19 @@ module Railroader
       end
     end
 
-    #Process variable aliasing in controller source and save it in the
-    #tracker.
+    # Process variable aliasing in controller source and save it in the
+    # tracker.
     def process_controller_alias name, src, only_method = nil, file = nil
       ControllerAliasProcessor.new(@app_tree, @tracker, only_method).process_controller name, src, file
     end
 
-    #Process a model source
+    # Process a model source
     def process_model src, file_name
       result = ModelProcessor.new(@tracker).process_model src, file_name
       AliasProcessor.new(@tracker).process result if result
     end
 
-    #Process either an ERB or HAML template
+    # Process either an ERB or HAML template
     def process_template name, src, type, called_from = nil, file_name = nil
       case type
       when :erb
@@ -72,8 +72,8 @@ module Railroader
         abort "Unknown template type: #{type} (#{name})"
       end
 
-      #Each template which is rendered is stored separately
-      #with a new name.
+      # Each template which is rendered is stored separately
+      # with a new name.
       if called_from
         name = ("#{name}.#{called_from}").to_sym
       end
@@ -82,19 +82,19 @@ module Railroader
       @tracker.templates[name].type = type
     end
 
-    #Process any calls to render() within a template
+    # Process any calls to render() within a template
     def process_template_alias template
       TemplateAliasProcessor.new(@tracker, template).process_safely template.src
     end
 
-    #Process source for initializing files
+    # Process source for initializing files
     def process_initializer file_name, src
       res = BaseProcessor.new(@tracker).process_file src, file_name
       res = AliasProcessor.new(@tracker).process_safely res, nil, file_name
       @tracker.initializers[Pathname.new(file_name).basename.to_s] = res
     end
 
-    #Process source for a library file
+    # Process source for a library file
     def process_lib src, file_name
       LibraryProcessor.new(@tracker).process_library src, file_name
     end