railroader 4.3.5 → 4.3.7

data/lib/railroader/tracker.rb

@@ -7,21 +7,21 @@ require 'railroader/processors/lib/find_all_calls'
 require 'railroader/tracker/config'
 require 'railroader/tracker/constants'
 
-#The Tracker keeps track of all the processed information.
+# The Tracker keeps track of all the processed information.
 class Railroader::Tracker
   attr_accessor :controllers, :constants, :templates, :models, :errors,
     :checks, :initializers, :config, :routes, :processor, :libs,
     :template_cache, :options, :filter_cache, :start_time, :end_time,
     :duration, :ignored_filter
 
-  #Place holder when there should be a model, but it is not
-  #clear what model it will be.
+  # Place holder when there should be a model, but it is not
+  # clear what model it will be.
   UNKNOWN_MODEL = :RailroaderUnresolvedModel
 
-  #Creates a new Tracker.
+  # Creates a new Tracker.
   #
-  #The Processor argument is only used by other Processors
-  #that might need to access it.
+  # The Processor argument is only used by other Processors
+  # that might need to access it.
   def initialize(app_tree, processor = nil, options = {})
     @app_tree = app_tree
     @processor = processor
@@ -30,9 +30,9 @@ class Railroader::Tracker
     @config = Railroader::Config.new(self)
     @templates = {}
     @controllers = {}
-    #Initialize models with the unknown model so
-    #we can match models later without knowing precisely what
-    #class they are.
+    # Initialize models with the unknown model so
+    # we can match models later without knowing precisely what
+    # class they are.
     @models = {}
     @models[UNKNOWN_MODEL] = Railroader::Model.new(UNKNOWN_MODEL, nil, nil, nil, self)
     @routes = {}
@@ -50,8 +50,8 @@ class Railroader::Tracker
     @duration = nil
   end
 
-  #Add an error to the list. If no backtrace is given,
-  #the one from the exception will be used.
+  # Add an error to the list. If no backtrace is given,
+  # the one from the exception will be used.
   def error exception, backtrace = nil
     backtrace ||= exception.backtrace
     unless backtrace.is_a? Array
@@ -64,8 +64,8 @@ class Railroader::Tracker
     @errors << { :error => exception.to_s.gsub("\n", " "), :backtrace => backtrace }
   end
 
-  #Run a set of checks on the current information. Results will be stored
-  #in Tracker#checks.
+  # Run a set of checks on the current information. Results will be stored
+  # in Tracker#checks.
   def run_checks
     @checks = Railroader::Checks.run_checks(@app_tree, self)
 
@@ -78,7 +78,7 @@ class Railroader::Tracker
     @app_path ||= File.expand_path @options[:app_path]
   end
 
-  #Iterate over all methods in controllers and models.
+  # Iterate over all methods in controllers and models.
   def each_method
     classes = [self.controllers, self.models]
 
@@ -96,8 +96,8 @@ class Railroader::Tracker
     end
   end
 
-  #Iterates over each template, yielding the name and the template.
-  #Prioritizes templates which have been rendered.
+  # Iterates over each template, yielding the name and the template.
+  # Prioritizes templates which have been rendered.
   def each_template
     if @processed.nil?
       @processed, @rest = templates.keys.sort_by{|template| template.to_s}.partition { |k| k.to_s.include? "." }
@@ -129,24 +129,24 @@ class Railroader::Tracker
     end
   end
 
-  #Find a method call.
+  # Find a method call.
   #
-  #Options:
+  # Options:
   #  * :target => target name(s)
   #  * :method => method name(s)
   #  * :chained => search in method chains
   #
-  #If :target => false or :target => nil, searches for methods without a target.
-  #Targets and methods can be specified as a symbol, an array of symbols,
-  #or a regular expression.
+  # If :target => false or :target => nil, searches for methods without a target.
+  # Targets and methods can be specified as a symbol, an array of symbols,
+  # or a regular expression.
   #
-  #If :chained => true, matches target at head of method chain and method at end.
+  # If :chained => true, matches target at head of method chain and method at end.
   #
-  #For example:
+  # For example:
   #
   #    find_call :target => User, :method => :all, :chained => true
   #
-  #could match
+  # could match
   #
   #    User.human.active.all(...)
   #
@@ -155,7 +155,7 @@ class Railroader::Tracker
     @call_index.find_calls options
   end
 
-  #Searches the initializers for a method call
+  # Searches the initializers for a method call
   def check_initializers target, method
     finder = Railroader::FindCall.new target, method, self
 
@@ -166,7 +166,7 @@ class Railroader::Tracker
     finder.matches
   end
 
-  #Returns a Report with this Tracker's information
+  # Returns a Report with this Tracker's information
   def report
     Railroader::Report.new(@app_tree, self)
   end
@@ -226,15 +226,15 @@ class Railroader::Tracker
     @call_index = Railroader::CallIndex.new finder.calls
   end
 
-  #Reindex call sites
+  # Reindex call sites
   #
-  #Takes a set of symbols which can include :templates, :models,
-  #or :controllers
+  # Takes a set of symbols which can include :templates, :models,
+  # or :controllers
   #
-  #This will limit reindexing to the given sets
+  # This will limit reindexing to the given sets
   def reindex_call_sites locations
-    #If reindexing templates, models, and controllers, just redo
-    #everything
+    # If reindexing templates, models, and controllers, just redo
+    # everything
     if locations.length == 3
       return index_call_sites
     end
@@ -278,9 +278,9 @@ class Railroader::Tracker
     @call_index.index_calls finder.calls
   end
 
-  #Clear information related to templates.
-  #If :only_rendered => true, will delete templates rendered from
-  #controllers (but not those rendered from other templates)
+  # Clear information related to templates.
+  # If :only_rendered => true, will delete templates rendered from
+  # controllers (but not those rendered from other templates)
   def reset_templates options = { :only_rendered => false }
     if options[:only_rendered]
       @templates.delete_if do |_name, template|
@@ -294,7 +294,7 @@ class Railroader::Tracker
     @template_cache.clear
   end
 
-  #Clear information related to template
+  # Clear information related to template
   def reset_template name
     name = name.to_sym
     @templates.delete name
@@ -303,7 +303,7 @@ class Railroader::Tracker
     @template_cache.clear
   end
 
-  #Clear information related to model
+  # Clear information related to model
   def reset_model path
     model_name = nil
 
@@ -317,7 +317,7 @@ class Railroader::Tracker
     @models.delete model_name
   end
 
-  #Clear information related to model
+  # Clear information related to model
   def reset_lib path
     lib_name = nil
 
@@ -334,12 +334,12 @@ class Railroader::Tracker
   def reset_controller path
     controller_name = nil
 
-    #Remove from controller
+    # Remove from controller
     @controllers.each do |name, controller|
       if controller.files.include?(path)
         controller_name = name
 
-        #Remove templates rendered from this controller
+        # Remove templates rendered from this controller
         @templates.each do |template_name, template|
           if template.render_path and template.render_path.include_controller? name
             reset_template template_name
@@ -347,7 +347,7 @@ class Railroader::Tracker
           end
         end
 
-        #Remove calls indexed from this controller
+        # Remove calls indexed from this controller
         @call_index.remove_indexes_by_class [name]
         break
       end
@@ -355,7 +355,7 @@ class Railroader::Tracker
     @controllers.delete controller_name
   end
 
-  #Clear information about routes
+  # Clear information about routes
   def reset_routes
     @routes = {}
   end

data/lib/railroader/util.rb

@@ -1,7 +1,7 @@
 require 'set'
 require 'pathname'
 
-#This is a mixin containing utility methods.
+# This is a mixin containing utility methods.
 module Railroader::Util
 
   QUERY_PARAMETERS = Sexp.new(:call, Sexp.new(:call, nil, :request), :query_parameters)
@@ -28,20 +28,20 @@ module Railroader::Util
 
   SAFE_LITERAL = s(:lit, :BRAKEMAN_SAFE_LITERAL)
 
-  #Convert a string from "something_like_this" to "SomethingLikeThis"
+  # Convert a string from "something_like_this" to "SomethingLikeThis"
   #
-  #Taken from ActiveSupport.
+  # Taken from ActiveSupport.
   def camelize lower_case_and_underscored_word
     lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
   end
 
-  #Convert a string from "Something::LikeThis" to "something/like_this"
+  # Convert a string from "Something::LikeThis" to "something/like_this"
   #
-  #Taken from ActiveSupport.
+  # Taken from ActiveSupport.
   def underscore camel_cased_word
     camel_cased_word.to_s.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z\d])([A-Z])/, '\1_\2').
       tr("-", "_").
       downcase
   end
@@ -51,8 +51,8 @@ module Railroader::Util
     word + "s"
   end
 
-  #Returns a class name as a Symbol.
-  #If class name cannot be determined, returns _exp_.
+  # Returns a class name as a Symbol.
+  # If class name cannot be determined, returns _exp_.
   def class_name exp
     case exp
     when Sexp
@@ -79,11 +79,11 @@ module Railroader::Util
     end
   end
 
-  #Takes an Sexp like
+  # Takes an Sexp like
   # (:hash, (:lit, :key), (:str, "value"))
-  #and yields the key and value pairs to the given block.
+  # and yields the key and value pairs to the given block.
   #
-  #For example:
+  # For example:
   #
   # h = Sexp.new(:hash, (:lit, :name), (:str, "bob"), (:lit, :name), (:str, "jane"))
   # names = []
@@ -99,10 +99,10 @@ module Railroader::Util
     end
   end
 
-  #Insert value into Hash Sexp
+  # Insert value into Hash Sexp
   def hash_insert hash, key, value
     index = 1
-    hash_iterate hash.dup do |k,v|
+    hash_iterate hash.dup do |k, v|
       if k == key
         hash[index + 1] = value
         return hash
@@ -115,9 +115,9 @@ module Railroader::Util
     hash
   end
 
-  #Get value from hash using key.
+  # Get value from hash using key.
   #
-  #If _key_ is a Symbol, it will be converted to a Sexp(:lit, key).
+  # If _key_ is a Symbol, it will be converted to a Sexp(:lit, key).
   def hash_access hash, key
     if key.is_a? Symbol
       key = Sexp.new(:lit, key)
@@ -130,21 +130,21 @@ module Railroader::Util
     nil
   end
 
-  #These are never modified
+  # These are never modified
   PARAMS_SEXP = Sexp.new(:params)
   SESSION_SEXP = Sexp.new(:session)
   COOKIES_SEXP = Sexp.new(:cookies)
 
-  #Adds params, session, and cookies to environment
-  #so they can be replaced by their respective Sexps.
+  # Adds params, session, and cookies to environment
+  # so they can be replaced by their respective Sexps.
   def set_env_defaults
     @env[PARAMETERS] = PARAMS_SEXP
     @env[SESSION] = SESSION_SEXP
     @env[COOKIES] = COOKIES_SEXP
   end
 
-  #Check if _exp_ represents a hash: s(:hash, {...})
-  #This also includes pseudo hashes params, session, and cookies.
+  # Check if _exp_ represents a hash: s(:hash, {...})
+  # This also includes pseudo hashes params, session, and cookies.
   def hash? exp
     exp.is_a? Sexp and (exp.node_type == :hash or
                         exp.node_type == :params or
@@ -152,12 +152,12 @@ module Railroader::Util
                         exp.node_type == :cookies)
   end
 
-  #Check if _exp_ represents an array: s(:array, [...])
+  # Check if _exp_ represents an array: s(:array, [...])
   def array? exp
     exp.is_a? Sexp and exp.node_type == :array
   end
 
-  #Check if _exp_ represents a String: s(:str, "...")
+  # Check if _exp_ represents a String: s(:str, "...")
   def string? exp
     exp.is_a? Sexp and exp.node_type == :str
   end
@@ -166,57 +166,57 @@ module Railroader::Util
     exp.is_a? Sexp and exp.node_type == :dstr
   end
 
-  #Check if _exp_ represents a Symbol: s(:lit, :...)
+  # Check if _exp_ represents a Symbol: s(:lit, :...)
   def symbol? exp
     exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Symbol
   end
 
-  #Check if _exp_ represents a method call: s(:call, ...)
+  # Check if _exp_ represents a method call: s(:call, ...)
   def call? exp
     exp.is_a? Sexp and
       (exp.node_type == :call or exp.node_type == :safe_call)
   end
 
-  #Check if _exp_ represents a Regexp: s(:lit, /.../)
+  # Check if _exp_ represents a Regexp: s(:lit, /.../)
   def regexp? exp
     exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Regexp
   end
 
-  #Check if _exp_ represents an Integer: s(:lit, ...)
+  # Check if _exp_ represents an Integer: s(:lit, ...)
   def integer? exp
     exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Integer
   end
 
-  #Check if _exp_ represents a number: s(:lit, ...)
+  # Check if _exp_ represents a number: s(:lit, ...)
   def number? exp
     exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Numeric
   end
 
-  #Check if _exp_ represents a result: s(:result, ...)
+  # Check if _exp_ represents a result: s(:result, ...)
   def result? exp
     exp.is_a? Sexp and exp.node_type == :result
   end
 
-  #Check if _exp_ represents a :true, :lit, or :string node
+  # Check if _exp_ represents a :true, :lit, or :string node
   def true? exp
     exp.is_a? Sexp and (exp.node_type == :true or
                         exp.node_type == :lit or
                         exp.node_type == :string)
   end
 
-  #Check if _exp_ represents a :false or :nil node
+  # Check if _exp_ represents a :false or :nil node
   def false? exp
     exp.is_a? Sexp and (exp.node_type == :false or
                         exp.node_type == :nil)
   end
 
-  #Check if _exp_ represents a block of code
+  # Check if _exp_ represents a block of code
   def block? exp
     exp.is_a? Sexp and (exp.node_type == :block or
                         exp.node_type == :rlist)
   end
 
-  #Check if _exp_ is a params hash
+  # Check if _exp_ is a params hash
   def params? exp
     if exp.is_a? Sexp
       return true if exp.node_type == :params or ALL_PARAMETERS.include? exp
@@ -253,7 +253,7 @@ module Railroader::Util
     call? exp and (exp == REQUEST_ENV or exp[1] == REQUEST_ENV)
   end
 
-  #Check if exp is params, cookies, or request_env
+  # Check if exp is params, cookies, or request_env
   def request_value? exp
     params? exp or
     cookies? exp or
@@ -264,19 +264,19 @@ module Railroader::Util
     node_type? exp, :const, :colon2, :colon3
   end
 
-  #Check if _exp_ is a Sexp.
+  # Check if _exp_ is a Sexp.
   def sexp? exp
     exp.is_a? Sexp
   end
 
-  #Check if _exp_ is a Sexp and the node type matches one of the given types.
+  # Check if _exp_ is a Sexp and the node type matches one of the given types.
   def node_type? exp, *types
     exp.is_a? Sexp and types.include? exp.node_type
   end
 
-  #Returns true if the given _exp_ contains a :class node.
+  # Returns true if the given _exp_ contains a :class node.
   #
-  #Useful for checking if a module is just a module or if it is a namespace.
+  # Useful for checking if a module is just a module or if it is a namespace.
   def contains_class? exp
     todo = [exp]
 
@@ -297,10 +297,10 @@ module Railroader::Util
     call = Sexp.new(:call, target, method)
 
     if args.empty? or args.first.empty?
-      #nothing to do
+      # nothing to do
     elsif node_type? args.first, :arglist
       call.concat args.first[1..-1]
-    elsif args.first.node_type.is_a? Sexp #just a list of args
+    elsif args.first.node_type.is_a? Sexp # just a list of args
       call.concat args.first
     else
       call.concat args
@@ -329,7 +329,7 @@ module Railroader::Util
     @tracker.config.rails_version
   end
 
-  #Return file name related to given warning. Uses +warning.file+ if it exists
+  # Return file name related to given warning. Uses +warning.file+ if it exists
   def file_for warning, tracker = nil
     if tracker.nil?
       tracker = @tracker || self.tracker
@@ -355,10 +355,10 @@ module Railroader::Util
     end
   end
 
-  #Attempt to determine path to context file based on the reported name
-  #in the warning.
+  # Attempt to determine path to context file based on the reported name
+  # in the warning.
   #
-  #For example,
+  # For example,
   #
   #  file_by_name FileController #=> "/rails/root/app/controllers/file_controller.rb
   def file_by_name name, type, tracker = nil
@@ -405,8 +405,8 @@ module Railroader::Util
     path
   end
 
-  #Return array of lines surrounding the warning location from the original
-  #file.
+  # Return array of lines surrounding the warning location from the original
+  # file.
   def context_for app_tree, warning, tracker = nil
     file = file_for warning, tracker
     context = []
@@ -446,7 +446,7 @@ module Railroader::Util
     end
   end
 
-  #Convert path/filename to view name
+  # Convert path/filename to view name
   #
   # views/test/something.html.erb -> test/something
   def template_path_to_name path

data/lib/railroader/version.rb

@@ -1,3 +1,3 @@
 module Railroader
-  Version = "4.3.5"
+  Version = "4.3.7"
 end

data/lib/railroader/warning.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'digest/sha2'
 require 'railroader/warning_codes'
 
-#The Warning class stores information about warnings
+# The Warning class stores information about warnings
 class Railroader::Warning
   attr_reader :called_from, :check, :class, :confidence, :controller,
     :line, :method, :model, :template, :user_input, :user_input_type,
@@ -59,7 +59,7 @@ class Railroader::Warning
       @code ||= result[:call]
       @file ||= result[:location][:file]
 
-      if result[:location][:type] == :template #template result
+      if result[:location][:type] == :template # template result
         @template ||= result[:location][:template]
       else
         @class ||= result[:location][:class]
@@ -141,7 +141,7 @@ class Railroader::Warning
     raise "Invalid confidence: `#{@confidence}`" unless TEXT_CONFIDENCE[@confidence]
   end
 
-  #Returns name of a view, including where it was rendered from
+  # Returns name of a view, including where it was rendered from
   def view_name(include_renderer = true)
     if called_from and include_renderer
       @view_name = "#{template.name} (#{called_from.last})"
@@ -150,14 +150,14 @@ class Railroader::Warning
     end
   end
 
-  #Return String of the code output from the OutputProcessor and
-  #stripped of newlines and tabs.
+  # Return String of the code output from the OutputProcessor and
+  # stripped of newlines and tabs.
   def format_code strip = true
     format_ruby self.code, strip
   end
 
-  #Return String of the user input formatted and
-  #stripped of newlines and tabs.
+  # Return String of the user input formatted and
+  # stripped of newlines and tabs.
   def format_user_input strip = true
     format_ruby self.user_input, strip
   end
@@ -172,7 +172,7 @@ class Railroader::Warning
     end
   end
 
-  #Return formatted warning message
+  # Return formatted warning message
   def format_message
     return @format_message if @format_message
 
@@ -206,7 +206,7 @@ class Railroader::Warning
     @link
   end
 
-  #Generates a hash suitable for inserting into a table
+  # Generates a hash suitable for inserting into a table
   def to_row type = :warning
     @row = { "Confidence" => self.confidence,
       "Warning Type" => self.warning_type.to_s,
@@ -291,4 +291,3 @@ class Railroader::Warning
     formatted
   end
 end
-