railroader 4.3.5 → 4.3.7

data/lib/railroader/processors/controller_alias_processor.rb

@@ -3,21 +3,21 @@ require 'railroader/processors/lib/render_helper'
 require 'railroader/processors/lib/render_path'
 require 'railroader/processors/lib/find_return_value'
 
-#Processes aliasing in controllers, but includes following
-#renders in routes and putting variables into templates
+# Processes aliasing in controllers, but includes following
+# renders in routes and putting variables into templates
 class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
   include Railroader::RenderHelper
 
-  #If only_method is specified, only that method will be processed,
-  #other methods will be skipped.
-  #This is for rescanning just a single action.
+  # If only_method is specified, only that method will be processed,
+  # other methods will be skipped.
+  # This is for rescanning just a single action.
   def initialize app_tree, tracker, only_method = nil
     super tracker
     @app_tree = app_tree
     @only_method = only_method
     @rendered = false
     @current_class = @current_module = @current_method = nil
-    @method_cache = {} #Cache method lookups
+    @method_cache = {} # Cache method lookups
   end
 
   def process_controller name, src, file_name
@@ -34,7 +34,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     end
   end
 
-  #Process modules mixed into the controller, in case they contain actions.
+  # Process modules mixed into the controller, in case they contain actions.
   def process_mixins
     controller = @tracker.controllers[@current_class]
 
@@ -43,43 +43,43 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
 
       next unless mixin
 
-      #Process methods in alphabetical order for consistency
+      # Process methods in alphabetical order for consistency
       methods = mixin.methods_public.keys.map { |n| n.to_s }.sort.map { |n| n.to_sym }
 
       methods.each do |name|
-        #Need to process the method like it was in a controller in order
-        #to get the renders set
+        # Need to process the method like it was in a controller in order
+        # to get the renders set
         processor = Railroader::ControllerProcessor.new(@app_tree, @tracker)
         method = mixin.get_method(name)[:src].deep_clone
 
         if node_type? method, :defn
           method = processor.process_defn method
         else
-          #Should be a defn, but this will catch other cases
+          # Should be a defn, but this will catch other cases
           method = processor.process method
         end
 
         @file_name = mixin.file
-        #Then process it like any other method in the controller
+        # Then process it like any other method in the controller
         process method
       end
     end
   end
 
-  #Skip it, must be an inner class
+  # Skip it, must be an inner class
   def process_class exp
     exp
   end
 
-  #Processes a method definition, which may include
-  #processing any rendered templates.
+  # Processes a method definition, which may include
+  # processing any rendered templates.
   def process_defn exp
     meth_name = exp.method_name
 
     Railroader.debug "Processing #{@current_class}##{meth_name}"
 
-    #Skip if instructed to only process a specific method
-    #(but don't skip if this method was called from elsewhere)
+    # Skip if instructed to only process a specific method
+    # (but don't skip if this method was called from elsewhere)
     return exp if @current_method.nil? and @only_method and @only_method != meth_name
 
     is_route = route? meth_name
@@ -105,7 +105,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     exp
   end
 
-  #Look for calls to head()
+  # Look for calls to head()
   def process_call exp
     exp = super
     return exp unless call? exp
@@ -125,7 +125,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     exp
   end
 
-  #Check for +respond_to+
+  # Check for +respond_to+
   def process_iter exp
     super
 
@@ -136,9 +136,9 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     exp
   end
 
-  #Processes a call to a before filter.
-  #Basically, adds any instance variable assignments to the environment.
-  #TODO: method arguments?
+  # Processes a call to a before filter.
+  # Basically, adds any instance variable assignments to the environment.
+  # TODO: method arguments?
   def process_before_filter name
     filter = find_method name, @current_class
 
@@ -167,13 +167,13 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     end
   end
 
-  #Processes the default template for the current action
+  # Processes the default template for the current action
   def process_default_render exp
     process_layout
     process_template template_name, nil, nil, nil
   end
 
-  #Process template and add the current class and method name as called_from info
+  # Process template and add the current class and method name as called_from info
   def process_template name, args, _, line
     # If line is null, assume implicit render and set the end of the action
     # method as the line number
@@ -191,7 +191,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     super name, args, render_path, line
   end
 
-  #Turns a method name into a template name
+  # Turns a method name into a template name
   def template_name name = nil
     name ||= @current_method
     name = name.to_s
@@ -204,7 +204,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     end
   end
 
-  #Determines default layout name
+  # Determines default layout name
   def layout_name
     controller = @tracker.controllers[@current_class]
 
@@ -218,7 +218,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     nil
   end
 
-  #Returns true if the given method name is also a route
+  # Returns true if the given method name is also a route
   def route? method
     if @tracker.routes[:allow_all_actions] or @tracker.options[:assume_all_routes]
       true
@@ -228,7 +228,7 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     end
   end
 
-  #Get list of filters, including those that are inherited
+  # Get list of filters, including those that are inherited
   def before_filter_list method, klass
     controller = @tracker.controllers[klass]
 
@@ -239,11 +239,11 @@ class Railroader::ControllerAliasProcessor < Railroader::AliasProcessor
     end
   end
 
-  #Finds a method in the given class or a parent class
+  # Finds a method in the given class or a parent class
   #
-  #Returns nil if the method could not be found.
+  # Returns nil if the method could not be found.
   #
-  #If found, returns hash table with controller name and method sexp.
+  # If found, returns hash table with controller name and method sexp.
   def find_method method_name, klass
     return nil if sexp? method_name
     method_name = method_name.to_sym

data/lib/railroader/processors/controller_processor.rb

@@ -2,7 +2,7 @@ require 'railroader/processors/base_processor'
 require 'railroader/processors/lib/module_helper'
 require 'railroader/tracker/controller'
 
-#Processes controller. Results are put in tracker.controllers
+# Processes controller. Results are put in tracker.controllers
 class Railroader::ControllerProcessor < Railroader::BaseProcessor
   include Railroader::ModuleHelper
 
@@ -19,20 +19,20 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
     @concerns = Set.new
   end
 
-  #Use this method to process a Controller
+  # Use this method to process a Controller
   def process_controller src, file_name = nil
     @file_name = file_name
     process src
   end
 
-  #s(:class, NAME, PARENT, s(:scope ...))
+  # s(:class, NAME, PARENT, s(:scope ...))
   def process_class exp
     name = class_name(exp.class_name)
     parent = class_name(exp.parent_name)
 
-    #If inside a real controller, treat any other classes as libraries.
-    #But if not inside a controller already, then the class may include
-    #a real controller, so we can't take this shortcut.
+    # If inside a real controller, treat any other classes as libraries.
+    # But if not inside a controller already, then the class may include
+    # a real controller, so we can't take this shortcut.
     if @current_class and @current_class.name.to_s.end_with? "Controller"
       Railroader.debug "[Notice] Treating inner class as library: #{name}"
       Railroader::LibraryProcessor.new(@tracker).process_library exp, @file_name
@@ -41,11 +41,11 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
 
     if not name.to_s.end_with? "Controller"
       Railroader.debug "[Notice] Adding noncontroller as library: #{name}"
-      #Set the class to be a module in order to get the right namespacing.
-      #Add class to libraries, in case it is needed later (e.g. it's used
-      #as a parent class for a controller.)
-      #However, still want to process it in this class, so have to set
-      #@current_class to this not-really-a-controller thing.
+      # Set the class to be a module in order to get the right namespacing.
+      # Add class to libraries, in case it is needed later (e.g. it's used
+      # as a parent class for a controller.)
+      # However, still want to process it in this class, so have to set
+      # @current_class to this not-really-a-controller thing.
       process_module exp, parent
 
       return exp
@@ -73,7 +73,7 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
     end
   end
 
-  #Look for specific calls inside the controller
+  # Look for specific calls inside the controller
   def process_call exp
     return exp if process_call_defn? exp
 
@@ -86,17 +86,17 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
     first_arg = exp.first_arg
     last_arg = exp.last_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? and @current_class
-      if first_arg.nil? #No args
+      if first_arg.nil? # No args
         case method
         when :private, :protected, :public
           @visibility = method
         when :protect_from_forgery
           @current_class.options[:protect_from_forgery] = true
         else
-          #??
+          # ??
         end
       else
         case method
@@ -122,7 +122,7 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
           @current_class.skip_filter exp
         when :layout
           if string? last_arg
-            #layout "some_layout"
+            # layout "some_layout"
 
             name = last_arg.value.to_s
             if @app_tree.layout_exists?(name)
@@ -131,7 +131,7 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
               Railroader.debug "[Notice] Layout not found: #{name}"
             end
           elsif node_type? last_arg, :nil, :false
-            #layout :false or layout nil
+            # layout :false or layout nil
             @current_class.layout = false
           end
         else
@@ -143,10 +143,10 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
     elsif target == nil and method == :render
       make_render exp
     elsif exp == FORMAT_HTML and context[1] != :iter
-      #This is an empty call to
+      # This is an empty call to
       # format.html
-      #Which renders the default template if no arguments
-      #Need to make more generic, though.
+      # Which renders the default template if no arguments
+      # Need to make more generic, though.
       call = Sexp.new :render, :default, @current_method
       call.line(exp.line)
       call
@@ -157,12 +157,12 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
     end
   end
 
-  #Look for before_filters and add fake ones if necessary
+  # Look for before_filters and add fake ones if necessary
   def process_iter exp
     if @current_method.nil? and call? exp.block_call
       block_call_name = exp.block_call.method
 
-      if block_call_name == :before_filter  or block_call_name == :before_action
+      if block_call_name == :before_filter or block_call_name == :before_action
         add_fake_filter exp
       else
         super
@@ -172,22 +172,22 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
     end
   end
 
-  #Sets default layout for renders inside Controller
+  # Sets default layout for renders inside Controller
   def set_layout_name
     return if @current_class.layout
 
     name = underscore(@current_class.name.to_s.split("::")[-1].gsub("Controller", ''))
 
-    #There is a layout for this Controller
+    # There is a layout for this Controller
     if @app_tree.layout_exists?(name)
       @current_class.layout = "layouts/#{name}"
     end
   end
 
-  #This is to handle before_filter do |controller| ... end
+  # This is to handle before_filter do |controller| ... end
   #
-  #We build a new method and process that the same way as usual
-  #methods and filters.
+  # We build a new method and process that the same way as usual
+  # methods and filters.
   def add_fake_filter exp
     unless @current_class
       Railroader.debug "Skipping before_filter outside controller: #{exp}"
@@ -211,7 +211,7 @@ class Railroader::ControllerProcessor < Railroader::BaseProcessor
       block_inner = [exp.block]
     end
 
-    #Build Sexp for filter method
+    # Build Sexp for filter method
     body = Sexp.new(:lasgn,
                     block_variable,
                     Sexp.new(:call, Sexp.new(:const, @current_class.name), :new))

data/lib/railroader/processors/erb_template_processor.rb

@@ -1,18 +1,18 @@
 require 'railroader/processors/template_processor'
 
-#Processes ERB templates
-#(those ending in .html.erb or .rthml).
+# Processes ERB templates
+# (those ending in .html.erb or .rthml).
 class Railroader::ErbTemplateProcessor < Railroader::TemplateProcessor
-  
-  #s(:call, TARGET, :method, ARGS)
+
+  # s(:call, TARGET, :method, ARGS)
   def process_call exp
     target = exp.target
     if sexp? target
       target = process target
     end
     method = exp.method
-    
-    #_erbout is the default output variable for erb
+
+    # _erbout is the default output variable for erb
     if node_type? target, :lvar and target.value == :_erbout
       if method == :concat or method == :<<
         @inside_concat = true
@@ -25,7 +25,7 @@ class Railroader::ErbTemplateProcessor < Railroader::TemplateProcessor
 
         arg = normalize_output(exp.first_arg)
 
-        if arg.node_type == :str #ignore plain strings
+        if arg.node_type == :str # ignore plain strings
           ignore
         else
           add_output arg
@@ -45,7 +45,7 @@ class Railroader::ErbTemplateProcessor < Railroader::TemplateProcessor
     end
   end
 
-  #Process block, removing irrelevant expressions
+  # Process block, removing irrelevant expressions
   def process_block exp
     exp = exp.dup
     exp.shift

data/lib/railroader/processors/erubis_template_processor.rb

@@ -1,9 +1,9 @@
 require 'railroader/processors/template_processor'
 
-#Processes ERB templates using Erubis instead of erb.
+# Processes ERB templates using Erubis instead of erb.
 class Railroader::ErubisTemplateProcessor < Railroader::TemplateProcessor
 
-  #s(:call, TARGET, :method, ARGS)
+  # s(:call, TARGET, :method, ARGS)
   def process_call exp
     target = exp.target
     if sexp? target
@@ -14,13 +14,13 @@ class Railroader::ErubisTemplateProcessor < Railroader::TemplateProcessor
     exp.arglist = process exp.arglist
     method = exp.method
 
-    #_buf is the default output variable for Erubis
+    # _buf is the default output variable for Erubis
     if node_type?(target, :lvar, :ivar) and (target.value == :_buf or target.value == :@output_buffer)
       if method == :<< or method == :safe_concat
 
         arg = normalize_output(exp.first_arg)
 
-        if arg.node_type == :str #ignore plain strings
+        if arg.node_type == :str # ignore plain strings
           ignore
         elsif node_type? target, :ivar and target.value == :@output_buffer
           add_escaped_output arg
@@ -39,7 +39,7 @@ class Railroader::ErubisTemplateProcessor < Railroader::TemplateProcessor
     end
   end
 
-  #Process blocks, ignoring :ignore exps
+  # Process blocks, ignoring :ignore exps
   def process_block exp
     exp = exp.dup
     exp.shift
@@ -56,7 +56,7 @@ class Railroader::ErubisTemplateProcessor < Railroader::TemplateProcessor
     block
   end
 
-  #Look for assignments to output buffer that look like this:
+  # Look for assignments to output buffer that look like this:
   #  @output_buffer.append = some_output
   #  @output_buffer.safe_append = some_output
   #  @output_buffer.safe_expr_append = some_output

data/lib/railroader/processors/gem_processor.rb

@@ -1,6 +1,6 @@
 require 'railroader/processors/lib/basic_processor'
 
-#Processes Gemfile and Gemfile.lock
+# Processes Gemfile and Gemfile.lock
 class Railroader::GemProcessor < Railroader::BasicProcessor
 
   def initialize *args

data/lib/railroader/processors/haml_template_processor.rb

@@ -1,13 +1,13 @@
 require 'railroader/processors/template_processor'
 
-#Processes HAML templates.
+# Processes HAML templates.
 class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
   HAML_FORMAT_METHOD = /format_script_(true|false)_(true|false)_(true|false)_(true|false)_(true|false)_(true|false)_(true|false)/
   HAML_HELPERS = s(:colon2, s(:const, :Haml), :Helpers)
   JAVASCRIPT_FILTER = s(:colon2, s(:colon2, s(:const, :Haml), :Filters), :Javascript)
   COFFEE_FILTER = s(:colon2, s(:colon2, s(:const, :Haml), :Filters), :Coffee)
 
-  #Processes call, looking for template output
+  # Processes call, looking for template output
   def process_call exp
     target = exp.target
     if sexp? target
@@ -18,7 +18,7 @@ class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
 
     if (call? target and target.method == :_hamlout)
       res = case method
-            when :adjust_tabs, :rstrip!, :attributes #Check attributes, maybe?
+            when :adjust_tabs, :rstrip!, :attributes # Check attributes, maybe?
               ignore
             when :options, :buffer
               exp
@@ -69,22 +69,22 @@ class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
       res.line(exp.line)
       res
 
-      #_hamlout.buffer <<
-      #This seems to be used rarely, but directly appends args to output buffer.
-      #Has something to do with values of blocks?
+      # _hamlout.buffer <<
+      # This seems to be used rarely, but directly appends args to output buffer.
+      # Has something to do with values of blocks?
     elsif sexp? target and method == :<< and is_buffer_target? target
       @inside_concat = true
       exp.first_arg = process(exp.first_arg)
       out = normalize_output(exp.first_arg)
       @inside_concat = false
 
-      if out.node_type == :str #ignore plain strings
+      if out.node_type == :str # ignore plain strings
         ignore
       else
         add_output out
       end
     elsif target == nil and method == :render
-      #Process call to render()
+      # Process call to render()
       exp.arglist = process exp.arglist
       make_render_in_view exp
     elsif target == nil and method == :find_and_preserve and exp.first_arg
@@ -102,7 +102,7 @@ class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
     end
   end
 
-  #If inside an output stream, only return the final expression
+  # If inside an output stream, only return the final expression
   def process_block exp
     exp = exp.dup
     exp.shift
@@ -126,8 +126,8 @@ class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
     end
   end
 
-  #Checks if the buffer is the target in a method call Sexp.
-  #TODO: Test this
+  # Checks if the buffer is the target in a method call Sexp.
+  # TODO: Test this
   def is_buffer_target? exp
     exp.node_type == :call and
     node_type? exp.target, :lvar and
@@ -135,8 +135,8 @@ class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
     exp.method == :buffer
   end
 
-  #HAML likes to put interpolated values into _hamlout.push_text
-  #but we want to handle those individually
+  # HAML likes to put interpolated values into _hamlout.push_text
+  # but we want to handle those individually
   def build_output_from_push_text exp, default = :output
     if string_interp? exp
       exp.map! do |e|
@@ -153,7 +153,7 @@ class Railroader::HamlTemplateProcessor < Railroader::TemplateProcessor
     end
   end
 
-  #Gets outputs from values interpolated into _hamlout.push_text
+  # Gets outputs from values interpolated into _hamlout.push_text
   def get_pushed_value exp, default = :output
     return exp unless sexp? exp
 

data/lib/railroader/processors/lib/call_conversion_helper.rb

@@ -68,7 +68,7 @@ module Railroader
       if args.length == 1 and integer? args.first
         index = args.first.value
 
-        #Have to do this because first element is :array and we have to skip it
+        # Have to do this because first element is :array and we have to skip it
         array[1..-1][index] or original_exp
       else
         original_exp

data/lib/railroader/processors/lib/find_all_calls.rb

@@ -12,8 +12,8 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
     @cache = {}
   end
 
-  #Process the given source. Provide either class and method being searched
-  #or the template. These names are used when reporting results.
+  # Process the given source. Provide either class and method being searched
+  # or the template. These names are used when reporting results.
   def process_source exp, opts
     @current_class = opts[:class]
     @current_method = opts[:method]
@@ -23,7 +23,7 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
     process exp
   end
 
-  #Process body of method
+  # Process body of method
   def process_defn exp
     return exp unless @current_method
     process_all exp.body
@@ -31,7 +31,7 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
 
   alias process_defs process_defn
 
-  #Process body of block
+  # Process body of block
   def process_rlist exp
     process_all exp
   end
@@ -54,7 +54,7 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
 
       process exp.block
     else
-      #Probably a :render call with block
+      # Probably a :render call with block
       process call
       process exp.block
     end
@@ -62,8 +62,8 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
     exp
   end
 
-  #Calls to render() are converted to s(:render, ...) but we would
-  #like them in the call cache still for speed
+  # Calls to render() are converted to s(:render, ...) but we would
+  # like them in the call cache still for speed
   def process_render exp
     process exp.last if sexp? exp.last
 
@@ -72,8 +72,8 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
     exp
   end
 
-  #Technically, `` is call to Kernel#`
-  #But we just need them in the call cache for speed
+  # Technically, `` is call to Kernel#`
+  # But we just need them in the call cache for speed
   def process_dxstr exp
     process exp.last if sexp? exp.last
 
@@ -100,7 +100,7 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
     exp
   end
 
-  #Process an assignment like a call
+  # Process an assignment like a call
   def process_attrasgn exp
     process_call exp
   end
@@ -116,8 +116,8 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
                 :parent => @current_call }
   end
 
-  #Gets the target of a call as a Symbol
-  #if possible
+  # Gets the target of a call as a Symbol
+  # if possible
   def get_target exp, include_calls = false
     if sexp? exp
       case exp.node_type
@@ -154,8 +154,8 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
     end
   end
 
-  #Returns method chain as an array
-  #For example, User.human.alive.all would return [:User, :human, :alive, :all]
+  # Returns method chain as an array
+  # For example, User.human.alive.all would return [:User, :human, :alive, :all]
   def get_chain call
     if node_type? call, :call, :attrasgn, :safe_call, :safe_attrasgn
       get_chain(call.target) + [call.method]
@@ -187,7 +187,7 @@ class Railroader::FindAllCalls < Railroader::BasicProcessor
 
   end
 
-  #Return info hash for a call Sexp
+  # Return info hash for a call Sexp
   def create_call_hash exp
     target = get_target exp.target