railroader 4.3.5 → 4.3.7

data/lib/railroader/processors/lib/rails3_route_processor.rb

@@ -1,9 +1,9 @@
 require 'railroader/processors/lib/basic_processor'
 
-#Processes the Sexp from routes.rb. Stores results in tracker.routes.
+# Processes the Sexp from routes.rb. Stores results in tracker.routes.
 #
-#Note that it is only interested in determining what methods on which
-#controllers are used as routes, not the generated URLs for routes.
+# Note that it is only interested in determining what methods on which
+# controllers are used as routes, not the generated URLs for routes.
 class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
   include Railroader::RouteHelper
 
@@ -12,10 +12,10 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
   def initialize tracker
     super
     @map = Sexp.new(:lvar, :map)
-    @nested = nil  #used for identifying nested targets
-    @prefix = [] #Controller name prefix (a module name, usually)
+    @nested = nil  # used for identifying nested targets
+    @prefix = [] # Controller name prefix (a module name, usually)
     @current_controller = nil
-    @with_options = nil #For use inside map.with_options
+    @with_options = nil # For use inside map.with_options
     @controller_block = false
     @file_name = "config/routes.rb"
   end
@@ -62,7 +62,7 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
 
   def process_namespace exp
     arg = exp.block_call.first_arg
-    return exp unless symbol? arg or string? arg 
+    return exp unless symbol? arg or string? arg
 
     name = arg.value
     block = exp.block
@@ -76,7 +76,7 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #TODO: Need test for this
+  # TODO: Need test for this
   def process_root exp
     if value = hash_access(exp.first_arg, :to)
       if string? value
@@ -96,12 +96,12 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
 
       matcher = first_arg.value
       if matcher == ':controller(/:action(/:id(.:format)))' or
-        matcher.include? ':controller' and action_route?(matcher)  #Default routes
+        matcher.include? ':controller' and action_route?(matcher)  # Default routes
         @tracker.routes[:allow_all_actions] = first_arg
         return exp
       elsif action_route?(first_arg)
           if hash? second_arg and controller_name = hash_access(second_arg, :controller)
-            loose_action(controller_name, "matched") #TODO: Parse verbs
+            loose_action(controller_name, "matched") # TODO: Parse verbs
           end
       elsif second_arg.nil? and in_controller_block? and not matcher.include? ":"
         add_route matcher
@@ -173,7 +173,7 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
         end
       end
     elsif string? first_arg
-      if first_arg.value.include? ':controller' and action_route?(first_arg) #Default routes
+      if first_arg.value.include? ':controller' and action_route?(first_arg) # Default routes
         @tracker.routes[:allow_all_actions] = first_arg
       end
 
@@ -209,7 +209,7 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
 
     if second_arg and second_arg.node_type == :hash
       self.current_controller = first_arg.value
-      #handle hash
+      # handle hash
       add_resources_routes
     elsif exp.args.all? { |s| symbol? s }
       exp.each_arg do |s|
@@ -223,14 +223,14 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
   end
 
   def process_resource exp
-    #Does resource even take more than one controller name?
+    # Does resource even take more than one controller name?
     exp.each_arg do |s|
       if symbol? s
         self.current_controller = pluralize(s.value.to_s)
         add_resource_routes
       else
-        #handle something else, like options
-        #or something?
+        # handle something else, like options
+        # or something?
       end
     end
 
@@ -259,7 +259,7 @@ class Railroader::Rails3RoutesProcessor < Railroader::BasicProcessor
   end
 
   def process_scope_block exp
-    #How to deal with options?
+    # How to deal with options?
     process exp.block
     exp
   end

data/lib/railroader/processors/lib/render_helper.rb

@@ -1,9 +1,9 @@
 require 'digest/sha1'
 
-#Processes a call to render() in a controller or template
+# Processes a call to render() in a controller or template
 module Railroader::RenderHelper
 
-  #Process s(:render, TYPE, OPTION?, OPTIONS)
+  # Process s(:render, TYPE, OPTION?, OPTIONS)
   def process_render exp
     process_default exp
     @rendered = true
@@ -23,7 +23,7 @@ module Railroader::RenderHelper
     exp
   end
 
-  #Processes layout
+  # Processes layout
   def process_layout name = nil
     if name.nil? and defined? layout_name
       name = layout_name
@@ -34,7 +34,7 @@ module Railroader::RenderHelper
     process_template name, nil, nil, nil
   end
 
-  #Determines file name for partial and then processes it
+  # Determines file name for partial and then processes it
   def process_partial name, args, line
     if name == "" or !(string? name or symbol? name)
       return
@@ -45,19 +45,19 @@ module Railroader::RenderHelper
     process_template template_name(names.join("/")), args, nil, line
   end
 
-  #Processes a given action
+  # Processes a given action
   def process_action name, args, line
     if name.is_a? String or name.is_a? Symbol
       process_template template_name(name), args, nil, line
     end
   end
 
-  #Processes a template, adding any instance variables
-  #to its environment.
+  # Processes a template, adding any instance variables
+  # to its environment.
   def process_template name, args, called_from = nil, *_
 
     Railroader.debug "Rendering #{name} (#{called_from})"
-    #Get scanned source for this template
+    # Get scanned source for this template
     name = name.to_s.gsub(/^\//, "")
     template = @tracker.templates[name.to_sym]
     unless template
@@ -67,26 +67,26 @@ module Railroader::RenderHelper
 
     template_env = only_ivars(:include_request_vars)
 
-    #Hash the environment and the source of the template to avoid
-    #pointlessly processing templates, which can become prohibitively
-    #expensive in terms of time and memory.
+    # Hash the environment and the source of the template to avoid
+    # pointlessly processing templates, which can become prohibitively
+    # expensive in terms of time and memory.
     digest = Digest::SHA1.new.update(template_env.instance_variable_get(:@env).to_a.sort.to_s << name).to_s.to_sym
 
     if @tracker.template_cache.include? digest
-      #Already processed this template with identical environment
+      # Already processed this template with identical environment
       return
     else
       @tracker.template_cache << digest
 
       options = get_options args
 
-      #Process layout
+      # Process layout
       if string? options[:layout]
         process_template "layouts/#{options[:layout][1]}", nil, nil, nil
       elsif node_type? options[:layout], :false
-        #nothing
+        # nothing
       elsif not template.name.to_s.match(/[^\/_][^\/]+$/)
-        #Don't do this for partials
+        # Don't do this for partials
 
         process_layout
       end
@@ -99,11 +99,11 @@ module Railroader::RenderHelper
 
       if options[:collection]
 
-        #The collection name is the name of the partial without the leading
-        #underscore.
+        # The collection name is the name of the partial without the leading
+        # underscore.
         variable = template.name.to_s.match(/[^\/_][^\/]+$/)[0].to_sym
 
-        #Unless the :as => :variable_name option is used
+        # Unless the :as => :variable_name option is used
         if options[:as]
           if string? options[:as] or symbol? options[:as]
             variable = options[:as].value.to_sym
@@ -115,19 +115,19 @@ module Railroader::RenderHelper
         template_env[Sexp.new(:call, nil, variable)] = Sexp.new(:call, Sexp.new(:const, collection), :new)
       end
 
-      #Set original_line for values so it is clear
-      #that values came from another file
+      # Set original_line for values so it is clear
+      # that values came from another file
       template_env.all.each do |_var, value|
         unless value.original_line
-          #TODO: This has been broken for a while now and no one noticed
-          #so maybe we can skip it
+          # TODO: This has been broken for a while now and no one noticed
+          # so maybe we can skip it
           value.original_line = value.line
         end
       end
 
-      #Run source through AliasProcessor with instance variables from the
-      #current environment.
-      #TODO: Add in :locals => { ... } to environment
+      # Run source through AliasProcessor with instance variables from the
+      # current environment.
+      # TODO: Add in :locals => { ... } to environment
       src = Railroader::TemplateAliasProcessor.new(@tracker, template, called_from).process_safely(template.src, template_env)
 
       digest = Digest::SHA1.new.update(name + src.to_s).to_s.to_sym
@@ -138,21 +138,21 @@ module Railroader::RenderHelper
         @tracker.template_cache << digest
       end
 
-      #Run alias-processed src through the template processor to pull out
-      #information and outputs.
-      #This information will be stored in tracker.templates, but with a name
-      #specifying this particular route. The original source should remain
-      #pristine (so it can be processed within other environments).
+      # Run alias-processed src through the template processor to pull out
+      # information and outputs.
+      # This information will be stored in tracker.templates, but with a name
+      # specifying this particular route. The original source should remain
+      # pristine (so it can be processed within other environments).
       @tracker.processor.process_template name, src, template.type, called_from
     end
   end
 
-  #Override to process name, such as adding the controller name.
+  # Override to process name, such as adding the controller name.
   def template_name name
     raise "RenderHelper#template_name should be overridden."
   end
 
-  #Turn options Sexp into hash
+  # Turn options Sexp into hash
   def get_options args
     options = {}
     return options unless hash? args

data/lib/railroader/processors/lib/route_helper.rb

@@ -1,7 +1,7 @@
 module Railroader::RouteHelper
-  #Manage Controller prefixes
-  #@prefix is an Array, but this method returns a string
-  #suitable for prefixing onto a controller name.
+  # Manage Controller prefixes
+  # @prefix is an Array, but this method returns a string
+  # suitable for prefixing onto a controller name.
   def prefix
     if @prefix.length > 0
       @prefix.join("::") << "::"
@@ -10,20 +10,20 @@ module Railroader::RouteHelper
     end
   end
 
-  #Sets the controller name to a proper class name.
-  #For example
+  # Sets the controller name to a proper class name.
+  # For example
   # self.current_controller = :session
   # @controller == :SessionController #true
   #
-  #Also prepends the prefix if there is one set.
+  # Also prepends the prefix if there is one set.
   def current_controller= name
     @current_controller = (prefix + camelize(name) + "Controller").to_sym
     @tracker.routes[@current_controller] ||= Set.new
   end
 
-  #Add route to controller. If a controller is specified,
-  #the current controller will be set to that controller.
-  #If no controller is specified, uses current controller value.
+  # Add route to controller. If a controller is specified,
+  # the current controller will be set to that controller.
+  # If no controller is specified, uses current controller value.
   def add_route route, controller = nil
     if node_type? route, :str, :lit
       route = route.value
@@ -42,13 +42,13 @@ module Railroader::RouteHelper
     end
 
     routes = @tracker.routes[@current_controller]
-    
+
     if routes and not routes.include? :allow_all_actions
       routes << route
     end
   end
 
-  #Add default routes
+  # Add default routes
   def add_resources_routes
     existing_routes = @tracker.routes[@current_controller]
 
@@ -57,7 +57,7 @@ module Railroader::RouteHelper
     end
   end
 
-  #Add default routes minus :index
+  # Add default routes minus :index
   def add_resource_routes
     existing_routes = @tracker.routes[@current_controller]
 

data/lib/railroader/processors/library_processor.rb

@@ -3,7 +3,7 @@ require 'railroader/processors/alias_processor'
 require 'railroader/processors/lib/module_helper'
 require 'railroader/tracker/library'
 
-#Process generic library and stores it in Tracker.libs
+# Process generic library and stores it in Tracker.libs
 class Railroader::LibraryProcessor < Railroader::BaseProcessor
   include Railroader::ModuleHelper
 

data/lib/railroader/processors/model_processor.rb

@@ -2,7 +2,7 @@ require 'railroader/processors/base_processor'
 require 'railroader/processors/lib/module_helper'
 require 'railroader/tracker/model'
 
-#Processes models. Puts results in tracker.models
+# Processes models. Puts results in tracker.models
 class Railroader::ModelProcessor < Railroader::BaseProcessor
   include Railroader::ModuleHelper
 
@@ -15,18 +15,18 @@ class Railroader::ModelProcessor < Railroader::BaseProcessor
     @file_name = nil
   end
 
-  #Process model source
+  # Process model source
   def process_model src, file_name = nil
     @file_name = file_name
     process src
   end
 
-  #s(:class, NAME, PARENT, BODY)
+  # s(:class, NAME, PARENT, BODY)
   def process_class exp
     name = class_name(exp.class_name)
     parent = class_name(exp.parent_name)
 
-    #If inside an inner class we treat it as a library.
+    # If inside an inner class we treat it as a library.
     if @current_class
       Railroader.debug "[Notice] Treating inner class as library: #{name}"
       Railroader::LibraryProcessor.new(@tracker).process_library exp, @file_name
@@ -40,8 +40,8 @@ class Railroader::ModelProcessor < Railroader::BaseProcessor
     handle_module exp, Railroader::Model
   end
 
-  #Handle calls outside of methods,
-  #such as include, attr_accessible, private, etc.
+  # Handle calls outside of methods,
+  # such as include, attr_accessible, private, etc.
   def process_call exp
     return exp unless @current_class
     return exp if process_call_defn? exp
@@ -54,8 +54,8 @@ class Railroader::ModelProcessor < Railroader::BaseProcessor
     method = exp.method
     first_arg = exp.first_arg
 
-    #Methods called inside class definition
-    #like attr_* and other settings
+    # Methods called inside class definition
+    # like attr_* and other settings
     if @current_method.nil? and target.nil?
       if first_arg.nil?
         case method
@@ -64,7 +64,7 @@ class Railroader::ModelProcessor < Railroader::BaseProcessor
         when :attr_accessible
           @current_class.set_attr_accessible
         else
-          #??
+          # ??
         end
       else
         case method

data/lib/railroader/processors/output_processor.rb

@@ -1,14 +1,14 @@
 Railroader.load_railroader_dependency 'ruby2ruby'
 require 'railroader/util'
 
-#Produces formatted output strings from Sexps.
-#Recommended usage is
+# Produces formatted output strings from Sexps.
+# Recommended usage is
 #
 #  OutputProcessor.new.format(Sexp.new(:str, "hello"))
 class Railroader::OutputProcessor < Ruby2Ruby
   include Railroader::Util
 
-  #Copies +exp+ and then formats it.
+  # Copies +exp+ and then formats it.
   def format exp, user_input = nil, &block
     @user_input = user_input
     @user_input_block = block

data/lib/railroader/processors/slim_template_processor.rb

@@ -44,8 +44,8 @@ class Railroader::SlimTemplateProcessor < Railroader::TemplateProcessor
     end
   end
 
-  #Slim likes to interpolate output into strings then pass them to safe_concat.
-  #Better to pull those values out directly.
+  # Slim likes to interpolate output into strings then pass them to safe_concat.
+  # Better to pull those values out directly.
   def process_inside_interp exp
     exp.map! do |e|
       if node_type? e, :evstr
@@ -104,8 +104,8 @@ class Railroader::SlimTemplateProcessor < Railroader::TemplateProcessor
   end
 
   def process_render exp
-    #Still confused as to why this is not needed in other template processors
-    #but is needed here
+    # Still confused as to why this is not needed in other template processors
+    # but is needed here
     exp
   end
 end

data/lib/railroader/processors/template_alias_processor.rb

@@ -4,8 +4,8 @@ require 'railroader/processors/lib/render_helper'
 require 'railroader/processors/lib/render_path'
 require 'railroader/tracker'
 
-#Processes aliasing in templates.
-#Handles calls to +render+.
+# Processes aliasing in templates.
+# Handles calls to +render+.
 class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
   include Railroader::RenderHelper
 
@@ -17,7 +17,7 @@ class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
     @called_from = called_from
   end
 
-  #Process template
+  # Process template
   def process_template name, args, _, line = nil, file_name = nil
     @file_name = file_name || relative_path(@template.file || @tracker.templates[@template.name])
 
@@ -33,7 +33,7 @@ class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
     end
   end
 
-  #Determine template name
+  # Determine template name
   def template_name name
     if !name.to_s.include?('/') && @template.name.to_s.include?('/')
       name = "#{@template.name.to_s.match(/^(.*\/).*$/)[1]}#{name}"
@@ -44,7 +44,7 @@ class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
   UNKNOWN_MODEL_CALL = Sexp.new(:call, Sexp.new(:const, Railroader::Tracker::UNKNOWN_MODEL), :new)
   FORM_BUILDER_CALL = Sexp.new(:call, Sexp.new(:const, :FormBuilder), :new)
 
-  #Looks for form methods and iterating over collections of Models
+  # Looks for form methods and iterating over collections of Models
   def process_iter exp
     process_default exp
 
@@ -56,7 +56,7 @@ class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
       arg = exp.block_args.first_param
       block = exp.block
 
-      #Check for e.g. Model.find.each do ... end
+      # Check for e.g. Model.find.each do ... end
       if method == :each and arg and block and model = get_model_target(target)
         if arg.is_a? Symbol
           if model == target.target
@@ -81,12 +81,12 @@ class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
 
   COLLECTION_METHODS = [:all, :find, :select, :where]
 
-  #Checks if +exp+ is a call to Model.all or Model.find*
+  # Checks if +exp+ is a call to Model.all or Model.find*
   def get_model_target exp
     if call? exp
       target = exp.target
 
-      if COLLECTION_METHODS.include? exp.method or exp.method.to_s[0,4] == "find"
+      if COLLECTION_METHODS.include? exp.method or exp.method.to_s[0, 4] == "find"
         models = Set.new @tracker.models.keys
         name = class_name target
         return target if models.include?(name)
@@ -98,8 +98,8 @@ class Railroader::TemplateAliasProcessor < Railroader::AliasProcessor
     false
   end
 
-  #Ignore `<<` calls on template variables which are used by the templating
-  #library (HAML, ERB, etc.)
+  # Ignore `<<` calls on template variables which are used by the templating
+  # library (HAML, ERB, etc.)
   def find_push_target exp
     if sexp? exp
       if exp.node_type == :lvar and (exp.value == :_buf or exp.value == :_erbout)

data/lib/railroader/processors/template_processor.rb

@@ -1,12 +1,12 @@
 require 'railroader/processors/base_processor'
 require 'railroader/tracker/template'
 
-#Base Processor for templates/views
+# Base Processor for templates/views
 class Railroader::TemplateProcessor < Railroader::BaseProcessor
 
-  #Initializes template information.
+  # Initializes template information.
   def initialize tracker, template_name, called_from = nil, file_name = nil
-    super(tracker) 
+    super(tracker)
     @current_template = Railroader::Template.new template_name, called_from, file_name, tracker
     @file_name = file_name
 
@@ -19,7 +19,7 @@ class Railroader::TemplateProcessor < Railroader::BaseProcessor
     @inside_concat = false
   end
 
-  #Process the template Sexp.
+  # Process the template Sexp.
   def process exp
     begin
       super
@@ -30,9 +30,9 @@ class Railroader::TemplateProcessor < Railroader::BaseProcessor
     end
   end
 
-  #Ignore initial variable assignment
+  # Ignore initial variable assignment
   def process_lasgn exp
-    if exp.lhs == :_erbout and exp.rhs.node_type == :str  #ignore
+    if exp.lhs == :_erbout and exp.rhs.node_type == :str  # ignore
       ignore
     elsif exp.lhs == :_buf and exp.rhs.node_type == :str
       ignore
@@ -42,7 +42,7 @@ class Railroader::TemplateProcessor < Railroader::BaseProcessor
     end
   end
 
-  #Adds output to the list of outputs.
+  # Adds output to the list of outputs.
   def process_output exp
     exp.value = process exp.value
     @current_template.add_output exp unless exp.original_line

data/lib/railroader/report/renderer.rb

@@ -21,4 +21,4 @@ class Railroader::Report
       ERB.new(template).result(binding)
     end
   end
-end
+end

data/lib/railroader/report/report_base.rb

@@ -22,7 +22,7 @@ class Railroader::Report::Base
     @warnings_summary = nil
   end
 
-  #Generate table of how many warnings of each warning type were reported
+  # Generate table of how many warnings of each warning type were reported
   def generate_warning_overview
     types = warnings_summary.keys
     types.delete :high_confidence
@@ -32,7 +32,7 @@ class Railroader::Report::Base
     render_array('warning_overview', ['Warning Type', 'Total'], values, locals)
   end
 
-  #Generate table of controllers and routes found for those controllers
+  # Generate table of controllers and routes found for those controllers
   def generate_controllers
     controller_rows = []
 
@@ -43,9 +43,9 @@ class Railroader::Report::Base
       if tracker.routes.include? :allow_all_actions or (tracker.routes[name] and tracker.routes[name].include? :allow_all_actions)
         routes = c.methods_public.keys.map{|e| e.to_s}.sort.join(", ")
       elsif tracker.routes[name].nil?
-        #No routes defined for this controller.
-        #This can happen when it is only a parent class
-        #for other controllers, for example.
+        # No routes defined for this controller.
+        # This can happen when it is only a parent class
+        # for other controllers, for example.
         routes = "[None]"
 
       else
@@ -74,7 +74,7 @@ class Railroader::Report::Base
     render_array('controller_overview', cols, values, locals)
   end
 
-  #Generate table of errors or return nil if no errors
+  # Generate table of errors or return nil if no errors
   def generate_errors
     values = tracker.errors.collect{|error| [error[:error], error[:backtrace][0]]}
     render_array('error_overview', ['Error', 'Location'], values, {:tracker => tracker})
@@ -93,7 +93,7 @@ class Railroader::Report::Base
                     'Class'
   end
 
-  #Generate table of template warnings or return nil if no warnings
+  # Generate table of template warnings or return nil if no warnings
   def generate_template_warnings
     render_warnings template_warnings,
                     :template,
@@ -103,7 +103,7 @@ class Railroader::Report::Base
 
   end
 
-  #Generate table of model warnings or return nil if no warnings
+  # Generate table of model warnings or return nil if no warnings
   def generate_model_warnings
     render_warnings model_warnings,
                     :model,
@@ -112,7 +112,7 @@ class Railroader::Report::Base
                     'Model'
   end
 
-  #Generate table of controller warnings or nil if no warnings
+  # Generate table of controller warnings or nil if no warnings
   def generate_controller_warnings
     render_warnings controller_warnings,
                     :controller,
@@ -193,7 +193,7 @@ class Railroader::Report::Base
     end
   end
 
-  #Return summary of warnings in hash and store in @warnings_summary
+  # Return summary of warnings in hash and store in @warnings_summary
   def warnings_summary
     return @warnings_summary if @warnings_summary
 
@@ -254,7 +254,7 @@ class Railroader::Report::Base
   end
 
   def number_of_templates tracker
-    Set.new(tracker.templates.map {|k,v| v.name.to_s[/[^.]+/]}).length
+    Set.new(tracker.templates.map {|k, v| v.name.to_s[/[^.]+/]}).length
   end
 
   def warning_file warning, absolute = @tracker.options[:absolute_paths]
@@ -280,7 +280,7 @@ class Railroader::Report::Base
     end
   end
 
-  #Escape warning message and highlight user input in text output
+  # Escape warning message and highlight user input in text output
   def text_message warning, message
     if @highlight_user_input and warning.user_input
       user_input = warning.format_user_input

data/lib/railroader/report/report_csv.rb

@@ -10,7 +10,7 @@ class Railroader::Report::CSV < Railroader::Report::Table
 
     output << table_to_csv(generate_warning_overview) << "\n"
 
-    #Return output early if only summarizing
+    # Return output early if only summarizing
     if tracker.options[:summary_only]
       return output
     end
@@ -46,7 +46,7 @@ class Railroader::Report::CSV < Railroader::Report::Table
     output
   end
 
-  #Generate header for CSV output
+  # Generate header for CSV output
   def csv_header
     header = CSV.generate_line(["Application Path", "Report Generation Time", "Checks Performed", "Rails Version"])
     header << CSV.generate_line([File.expand_path(tracker.app_path), Time.now.to_s, checks.checks_run.sort.join(", "), rails_version])