railroader 4.3.5 → 4.3.7

data/lib/railroader/report/report_html.rb

@@ -8,7 +8,7 @@ class Railroader::Report::HTML < Railroader::Report::Base
   def initialize *args
     super
 
-    @element_id = 0 #Used for HTML ids
+    @element_id = 0 # Used for HTML ids
   end
 
   def generate_report
@@ -42,7 +42,7 @@ class Railroader::Report::HTML < Railroader::Report::Base
       Railroader::Report::Renderer.new('overview', :locals => locals).render
   end
 
-  #Generate listings of templates and their output
+  # Generate listings of templates and their output
   def generate_templates
     out_processor = Railroader::OutputProcessor.new
     template_rows = {}
@@ -92,7 +92,7 @@ class Railroader::Report::HTML < Railroader::Report::Base
     warning
   end
 
-  #Return header for HTML output. Uses CSS from tracker.options[:html_style]
+  # Return header for HTML output. Uses CSS from tracker.options[:html_style]
   def html_header
     if File.exist? tracker.options[:html_style]
       css = File.read tracker.options[:html_style]
@@ -111,7 +111,7 @@ class Railroader::Report::HTML < Railroader::Report::Base
     Railroader::Report::Renderer.new('header', :locals => locals).render
   end
 
-  #Generate HTML for warnings, including context show/hidden via Javascript
+  # Generate HTML for warnings, including context show/hidden via Javascript
   def with_context warning, message
     context = context_for(@app_tree, warning)
     full_message = nil
@@ -197,7 +197,7 @@ class Railroader::Report::HTML < Railroader::Report::Base
     output << "</tbody></table></div>"
   end
 
-  #Escape warning message and highlight user input in HTML output
+  # Escape warning message and highlight user input in HTML output
   def html_message warning, message
     message = CGI.escapeHTML(message)
 

data/lib/railroader/report/report_markdown.rb

@@ -34,7 +34,7 @@ class Railroader::Report::Markdown < Railroader::Report::Table
     generate_overview.to_s << "\n\n" <<
     generate_warning_overview.to_s << "\n\n"
 
-    #Return output early if only summarizing
+    # Return output early if only summarizing
     return out if tracker.options[:summary_only]
 
     if tracker.options[:report_routes] or tracker.options[:debug]
@@ -98,7 +98,7 @@ class Railroader::Report::Markdown < Railroader::Report::Table
     end
     if warning.code
       code = warning.format_code
-      message.gsub(code, "`#{code.gsub('`','``').gsub(/\A``|``\z/, '` `')}`")
+      message.gsub(code, "`#{code.gsub('`', '``').gsub(/\A``|``\z/, '` `')}`")
     else
       message
     end

data/lib/railroader/report/report_table.rb

@@ -17,7 +17,7 @@ class Railroader::Report::Table < Railroader::Report::Base
         truncate_table(generate_warning_overview.to_s) << "\n"
     end
 
-    #Return output early if only summarizing
+    # Return output early if only summarizing
     if summary_option == :summary_only or summary_option == true
       return out
     end
@@ -62,7 +62,7 @@ class Railroader::Report::Table < Railroader::Report::Base
     end
   end
 
-  #Generate listings of templates and their output
+  # Generate listings of templates and their output
   def generate_templates
     out_processor = Railroader::OutputProcessor.new
     template_rows = {}
@@ -100,7 +100,7 @@ class Railroader::Report::Table < Railroader::Report::Base
     end
   end
 
-  #Generate header for text output
+  # Generate header for text output
   def text_header
     <<-HEADER
 

data/lib/railroader/report/report_tabs.rb

@@ -1,5 +1,5 @@
-#Generated tab-separated output suitable for the Jenkins Railroader Plugin:
-#https://github.com/presidentbeef/railroader-jenkins-plugin
+# Generated tab-separated output suitable for the Jenkins Railroader Plugin:
+# https://github.com/presidentbeef/railroader-jenkins-plugin
 class Railroader::Report::Tabs < Railroader::Report::Base
   def generate_report
     [[:generic_warnings, "General"], [:controller_warnings, "Controller"],

data/lib/railroader/report/report_text.rb

@@ -19,7 +19,7 @@ class Railroader::Report::Text < Railroader::Report::Base
     add_chunk generate_controllers if tracker.options[:debug] or tracker.options[:report_routes]
     add_chunk generate_templates if tracker.options[:debug]
     add_chunk generate_obsolete
-    add_chunk generate_errors 
+    add_chunk generate_errors
     add_chunk generate_warnings
   end
 
@@ -35,7 +35,7 @@ class Railroader::Report::Text < Railroader::Report::Base
 
   def generate_header
     [
-      header("Railroader Report"), 
+      header("Railroader Report"),
       label("Application Path", tracker.app_path),
       label("Rails Version", rails_version),
       label("Railroader Version", Railroader::Version),
@@ -92,7 +92,7 @@ class Railroader::Report::Text < Railroader::Report::Base
     errors = tracker.errors.map do |e|
       trace = if full_trace
         e[:backtrace].join("\n")
-      else
+              else
         e[:backtrace][0]
       end
 
@@ -195,4 +195,3 @@ class Railroader::Report::Text < Railroader::Report::Base
     double_space "Controller Overview", controllers
   end
 end
-

data/lib/railroader/report.rb

@@ -1,8 +1,8 @@
 require 'railroader/report/report_base'
 
-#Generates a report based on the Tracker and the results of
-#Tracker#run_checks. Be sure to +run_checks+ before generating
-#a report.
+# Generates a report based on the Tracker and the results of
+# Tracker#run_checks. Be sure to +run_checks+ before generating
+# a report.
 class Railroader::Report
   attr_reader :tracker
 

data/lib/railroader/rescanner.rb

@@ -2,25 +2,25 @@ require 'railroader/scanner'
 require 'railroader/util'
 require 'railroader/differ'
 
-#Class for rescanning changed files after an initial scan
+# Class for rescanning changed files after an initial scan
 class Railroader::Rescanner < Railroader::Scanner
  include Railroader::Util
   KNOWN_TEMPLATE_EXTENSIONS = Railroader::TemplateParser::KNOWN_TEMPLATE_EXTENSIONS
   SCAN_ORDER = [:config, :gemfile, :initializer, :lib, :routes, :template,
     :model, :controller]
 
-  #Create new Rescanner to scan changed files
+  # Create new Rescanner to scan changed files
   def initialize options, processor, changed_files
     super(options, processor)
 
     @paths = changed_files.map {|f| @app_tree.expand_path(f) }
-    @old_results = tracker.filtered_warnings  #Old warnings from previous scan
-    @changes = nil                 #True if files had to be rescanned
+    @old_results = tracker.filtered_warnings  # Old warnings from previous scan
+    @changes = nil                 # True if files had to be rescanned
     @reindex = Set.new
   end
 
-  #Runs checks.
-  #Will rescan files if they have not already been scanned
+  # Runs checks.
+  # Will rescan files if they have not already been scanned
   def recheck
     rescan if @changes.nil?
 
@@ -29,7 +29,7 @@ class Railroader::Rescanner < Railroader::Scanner
     Railroader::RescanReport.new @old_results, tracker
   end
 
-  #Rescans changed files
+  # Rescans changed files
   def rescan
     tracker.template_cache.clear
 
@@ -63,7 +63,7 @@ class Railroader::Rescanner < Railroader::Scanner
     self
   end
 
-  #Rescans a single file
+  # Rescans a single file
   def rescan_file path, type = nil
     type ||= file_type path
 
@@ -93,7 +93,7 @@ class Railroader::Rescanner < Railroader::Scanner
 
       process_gems
     else
-      return false #Nothing to do, file hopefully does not need to be rescanned
+      return false # Nothing to do, file hopefully does not need to be rescanned
     end
 
     true
@@ -106,8 +106,8 @@ class Railroader::Rescanner < Railroader::Scanner
       process_controller astfile
     end
 
-    #Process data flow and template rendering
-    #from the controller
+    # Process data flow and template rendering
+    # from the controller
     tracker.controllers.each do |name, controller|
       if controller.files.include?(path)
         tracker.templates.each do |template_name, template|
@@ -141,8 +141,8 @@ class Railroader::Rescanner < Railroader::Scanner
 
     rescan = Set.new
 
-    #Search for processed template and process it.
-    #Search for rendered versions of template and re-render (if necessary)
+    # Search for processed template and process it.
+    # Search for rendered versions of template and re-render (if necessary)
     tracker.templates.each do |_name, template|
       if template.file == path or template.file.nil?
         next unless template.render_path and template.name.to_sym == template_name.to_sym
@@ -185,7 +185,7 @@ class Railroader::Rescanner < Railroader::Scanner
       process_model astfile.path, astfile.ast
     end
 
-    #Only need to rescan other things if a model is added or removed
+    # Only need to rescan other things if a model is added or removed
     if num_models != tracker.models.length
       process_template_data_flows
       process_controller_data_flows
@@ -231,7 +231,7 @@ class Railroader::Rescanner < Railroader::Scanner
     end
   end
 
-  #Handle rescanning when a file is deleted
+  # Handle rescanning when a file is deleted
   def rescan_deleted_file path, type
     case type
     when :controller
@@ -260,13 +260,13 @@ class Railroader::Rescanner < Railroader::Scanner
 
     template_name = template_path_to_name(path)
 
-    #Remove template
+    # Remove template
     tracker.reset_template template_name
 
     rendered_from_controller = /^#{template_name}\.(.+Controller)#(.+)/
     rendered_from_view = /^#{template_name}\.Template:(.+)/
 
-    #Remove any rendered versions, or partials rendered from it
+    # Remove any rendered versions, or partials rendered from it
     tracker.templates.delete_if do |_name, template|
       template.file == path or template.name.to_sym == template_name.to_sym
     end
@@ -289,8 +289,8 @@ class Railroader::Rescanner < Railroader::Scanner
     tracker.initializers.delete Pathname.new(path).basename.to_s
   end
 
-  #Check controllers, templates, models and libs for data from file
-  #and delete it.
+  # Check controllers, templates, models and libs for data from file
+  # and delete it.
   def remove_deleted_file path
     deleted = false
 
@@ -313,7 +313,7 @@ class Railroader::Rescanner < Railroader::Scanner
     deleted
   end
 
-  #Guess at what kind of file the path contains
+  # Guess at what kind of file the path contains
   def file_type path
     case path
     when /\/app\/controllers/
@@ -346,7 +346,7 @@ class Railroader::Rescanner < Railroader::Scanner
 
     to_rescan = []
 
-    #Rescan controllers that mixed in library
+    # Rescan controllers that mixed in library
     tracker.controllers.each do |_name, controller|
       if controller.includes.include? lib.name
         controller.files.each do |path|
@@ -364,9 +364,9 @@ class Railroader::Rescanner < Railroader::Scanner
 
     to_rescan = []
 
-    #Check if a method from this mixin was used to render a template.
-    #This is not precise, because a different controller might have the
-    #same method...
+    # Check if a method from this mixin was used to render a template.
+    # This is not precise, because a different controller might have the
+    # same method...
     tracker.templates.each do |name, template|
       next unless template.render_path
 
@@ -395,7 +395,7 @@ class Railroader::Rescanner < Railroader::Scanner
   end
 end
 
-#Class to make reporting of rescan results simpler to deal with
+# Class to make reporting of rescan results simpler to deal with
 class Railroader::RescanReport
   include Railroader::Util
   attr_reader :old_results, :new_results
@@ -407,46 +407,46 @@ class Railroader::RescanReport
     @diff = nil
   end
 
-  #Returns true if any warnings were found (new or old)
+  # Returns true if any warnings were found (new or old)
   def any_warnings?
     not all_warnings.empty?
   end
 
-  #Returns an array of all warnings found
+  # Returns an array of all warnings found
   def all_warnings
     @all_warnings ||= @tracker.filtered_warnings
   end
 
-  #Returns an array of warnings which were in the old report but are not in the
-  #new report after rescanning
+  # Returns an array of warnings which were in the old report but are not in the
+  # new report after rescanning
   def fixed_warnings
     diff[:fixed]
   end
 
-  #Returns an array of warnings which were in the new report but were not in
-  #the old report
+  # Returns an array of warnings which were in the new report but were not in
+  # the old report
   def new_warnings
     diff[:new]
   end
 
-  #Returns true if there are any new or fixed warnings
+  # Returns true if there are any new or fixed warnings
   def warnings_changed?
     not (diff[:new].empty? and diff[:fixed].empty?)
   end
 
-  #Returns a hash of arrays for :new and :fixed warnings
+  # Returns a hash of arrays for :new and :fixed warnings
   def diff
     @diff ||= Railroader::Differ.new(all_warnings, @old_results).diff
   end
 
-  #Returns an array of warnings which were in the old report and the new report
+  # Returns an array of warnings which were in the old report and the new report
   def existing_warnings
     @old ||= all_warnings.select do |w|
       not new_warnings.include? w
     end
   end
 
-  #Output total, fixed, and new warnings
+  # Output total, fixed, and new warnings
   def to_s(verbose = false)
     Railroader.load_railroader_dependency 'terminal-table'
 
@@ -457,7 +457,7 @@ Fixed warnings: #{fixed_warnings.length}
 New warnings: #{new_warnings.length}
       OUTPUT
     else
-      #Eventually move this to different method, or make default to_s
+      # Eventually move this to different method, or make default to_s
       out = ""
 
       {:fixed => fixed_warnings, :new => new_warnings, :existing => existing_warnings}.each do |warning_type, warnings|

data/lib/railroader/scanner.rb

@@ -12,12 +12,12 @@ rescue LoadError => e
   exit(-1)
 end
 
-#Scans the Rails application.
+# Scans the Rails application.
 class Railroader::Scanner
   attr_reader :options
   RUBY_1_9 = RUBY_VERSION >= "1.9.0"
 
-  #Pass in path to the root of the Rails application
+  # Pass in path to the root of the Rails application
   def initialize options, processor = nil
     @options = options
     @app_tree = Railroader::AppTree.from_options(options)
@@ -29,12 +29,12 @@ class Railroader::Scanner
     @processor = processor || Railroader::Processor.new(@app_tree, options)
   end
 
-  #Returns the Tracker generated from the scan
+  # Returns the Tracker generated from the scan
   def tracker
     @processor.tracked_events
   end
 
-  #Process everything in the Rails application
+  # Process everything in the Rails application
   def process
     Railroader.notify "Processing gems..."
     process_gems
@@ -90,9 +90,9 @@ class Railroader::Scanner
     @file_list = fp.file_list
   end
 
-  #Process config/environment.rb and config/gems.rb
+  # Process config/environment.rb and config/gems.rb
   #
-  #Stores parsed information in tracker.config
+  # Stores parsed information in tracker.config
   def process_config
     if options[:rails3] or options[:rails4] or options[:rails5]
       process_config_file "application.rb"
@@ -128,7 +128,7 @@ class Railroader::Scanner
 
   private :process_config_file
 
-  #Process Gemfile
+  # Process Gemfile
   def process_gems
     gem_files = {}
     if @app_tree.exists? "Gemfile"
@@ -151,7 +151,7 @@ class Railroader::Scanner
     tracker.error e.exception(e.message + "\nWhile processing Gemfile"), e.backtrace
   end
 
-  #Set :rails3/:rails4 option if version was not determined from Gemfile
+  # Set :rails3/:rails4 option if version was not determined from Gemfile
   def guess_rails_version
     unless tracker.options[:rails3] or tracker.options[:rails4]
       if @app_tree.exists?("script/rails")
@@ -170,9 +170,9 @@ class Railroader::Scanner
     end
   end
 
-  #Process all the .rb files in config/initializers/
+  # Process all the .rb files in config/initializers/
   #
-  #Adds parsed information to tracker.initializers
+  # Adds parsed information to tracker.initializers
   def process_initializers
     track_progress @file_list[:initializers] do |init|
       Railroader.debug "Processing #{init[:path]}"
@@ -180,14 +180,14 @@ class Railroader::Scanner
     end
   end
 
-  #Process an initializer
+  # Process an initializer
   def process_initializer init
     @processor.process_initializer(init.path, init.ast)
   end
 
-  #Process all .rb in lib/
+  # Process all .rb in lib/
   #
-  #Adds parsed information to tracker.libs.
+  # Adds parsed information to tracker.libs.
   def process_libs
     if options[:skip_libs]
       Railroader.notify '[Skipping]'
@@ -200,14 +200,14 @@ class Railroader::Scanner
     end
   end
 
-  #Process a library
+  # Process a library
   def process_lib lib
     @processor.process_lib lib.ast, lib.path
   end
 
-  #Process config/routes.rb
+  # Process config/routes.rb
   #
-  #Adds parsed information to tracker.routes
+  # Adds parsed information to tracker.routes
   def process_routes
     if @app_tree.exists?("config/routes.rb")
       begin
@@ -222,9 +222,9 @@ class Railroader::Scanner
     end
   end
 
-  #Process all .rb files in controllers/
+  # Process all .rb files in controllers/
   #
-  #Adds processed controllers to tracker.controllers
+  # Adds processed controllers to tracker.controllers
   def process_controllers
     track_progress @file_list[:controllers] do |controller|
       Railroader.debug "Processing #{controller.path}"
@@ -242,7 +242,7 @@ class Railroader::Scanner
       end
     end
 
-    #No longer need these processed filter methods
+    # No longer need these processed filter methods
     tracker.filter_cache.clear
   end
 
@@ -254,9 +254,9 @@ class Railroader::Scanner
     end
   end
 
-  #Process all views and partials in views/
+  # Process all views and partials in views/
   #
-  #Adds processed views to tracker.views
+  # Adds processed views to tracker.views
   def process_templates
     templates = @file_list[:templates].sort_by { |t| t[:path] }
 
@@ -279,9 +279,9 @@ class Railroader::Scanner
     end
   end
 
-  #Process all the .rb files in models/
+  # Process all the .rb files in models/
   #
-  #Adds the processed models to tracker.models
+  # Adds the processed models to tracker.models
   def process_models
     track_progress @file_list[:models] do |model|
       Railroader.debug "Processing #{model[:path]}"

data/lib/railroader/tracker/config.rb

@@ -47,7 +47,7 @@ module Railroader
     end
 
     def escape_html_entities_in_json?
-      #TODO add version-specific information here
+      # TODO add version-specific information here
       @rails[:active_support] and
         true? @rails[:active_support][:escape_html_entities_in_json]
     end
@@ -115,9 +115,9 @@ module Railroader
       end
     end
 
-    #Returns true if low_version <= RAILS_VERSION <= high_version
+    # Returns true if low_version <= RAILS_VERSION <= high_version
     #
-    #If the Rails version is unknown, returns false.
+    # If the Rails version is unknown, returns false.
     def version_between? low_version, high_version, current_version = nil
       current_version ||= rails_version
       return false unless current_version

data/lib/railroader/tracker/controller.rb

@@ -106,8 +106,8 @@ module Railroader
     def before_filter_to_hash processor, args
       filter = {}
 
-      #Process args for the uncommon but possible situation
-      #in which some variables are used in the filter.
+      # Process args for the uncommon but possible situation
+      # in which some variables are used in the filter.
       args.each do |a|
         if sexp? a
           a = processor.process_default a