railroader 4.3.5 → 4.3.7

data/lib/railroader/processors/lib/find_call.rb

@@ -1,10 +1,10 @@
 require 'railroader/processors/lib/basic_processor'
 
-#Finds method calls matching the given target(s).
+# Finds method calls matching the given target(s).
 #   #-- This should be deprecated --#
 #   #--  Do not use for new code  --#
 #
-#Targets/methods can be:
+# Targets/methods can be:
 #
 # - nil: matches anything, including nothing
 # - Empty array: matches nothing
@@ -13,12 +13,12 @@ require 'railroader/processors/lib/basic_processor'
 # - Regular expression: matches the expression
 # - Array of regular expressions: matches any of the expressions
 #
-#If a target is also the name of a class, methods called on instances
-#of that class will also be matched, in a very limited way.
-#(Any methods called on Klass.new, basically. More useful when used
-#in conjunction with AliasProcessor.)
+# If a target is also the name of a class, methods called on instances
+# of that class will also be matched, in a very limited way.
+# (Any methods called on Klass.new, basically. More useful when used
+# in conjunction with AliasProcessor.)
 #
-#Examples:
+# Examples:
 #
 # #To find any uses of this class:
 # FindCall.new :FindCall, nil
@@ -43,23 +43,23 @@ class Railroader::FindCall < Railroader::BasicProcessor
     @in_depth = in_depth
   end
 
-  #Returns a list of results.
+  # Returns a list of results.
   #
-  #A result looks like:
+  # A result looks like:
   #
   # s(:result, :ClassName, :method_name, s(:call, ...))
   #
-  #or
+  # or
   #
   # s(:result, :template_name, s(:call, ...))
   def matches
     @calls
   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.
   #
-  #Use FindCall#matches to retrieve results.
+  # Use FindCall#matches to retrieve results.
   def process_source exp, klass = nil, method = nil, template = nil
     @current_class = klass
     @current_method = method
@@ -67,19 +67,19 @@ class Railroader::FindCall < Railroader::BasicProcessor
     process exp
   end
 
-  #Process body of method
+  # Process body of method
   def process_defn exp
     process_all exp.body
   end
 
   alias :process_defs :process_defn
 
-  #Process body of block
+  # Process body of block
   def process_rlist exp
     process_all exp
   end
 
-  #Look for matching calls and add them to results
+  # Look for matching calls and add them to results
   def process_call exp
     target = get_target exp.target
     method = exp.method
@@ -95,13 +95,13 @@ class Railroader::FindCall < Railroader::BasicProcessor
       end
 
     end
-    
-    #Normally FindCall won't match a method invocation that is the target of
-    #another call, such as:
+
+    # Normally FindCall won't match a method invocation that is the target of
+    # another call, such as:
     #
     #  User.find(:first, :conditions => "user = '#{params['user']}').name
     #
-    #A search for User.find will not match this unless @in_depth is true.
+    # A search for User.find will not match this unless @in_depth is true.
     if @in_depth and call? exp.target
       process exp.target
     end
@@ -109,15 +109,15 @@ class Railroader::FindCall < Railroader::BasicProcessor
     exp
   end
 
-  #Process an assignment like a call
+  # Process an assignment like a call
   def process_attrasgn exp
     process_call exp
   end
 
   private
 
-  #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
     if sexp? exp
       case exp.node_type
@@ -135,7 +135,7 @@ class Railroader::FindCall < Railroader::BasicProcessor
     end
   end
 
-  #Checks if the search terms match the given item
+  # Checks if the search terms match the given item
   def match search_terms, item
     case search_terms
     when Symbol
@@ -152,7 +152,7 @@ class Railroader::FindCall < Railroader::BasicProcessor
       if search_terms.empty?
         item == nil
       else
-        search_terms.each do|term|
+        search_terms.each do |term|
           if match(term, item)
             return true
           end
@@ -168,7 +168,7 @@ class Railroader::FindCall < Railroader::BasicProcessor
     end
   end
 
-  #Checks if +item+ is an instance of +klass+ by looking for Klass.new
+  # Checks if +item+ is an instance of +klass+ by looking for Klass.new
   def is_instance_of? item, klass
     if call? item
       if sexp? item.target

data/lib/railroader/processors/lib/find_return_value.rb

@@ -1,16 +1,16 @@
 require 'railroader/processors/alias_processor'
 
-#Attempts to determine the return value of a method.
+# Attempts to determine the return value of a method.
 #
-#Preferred usage:
+# Preferred usage:
 #
 #  Railroader::FindReturnValue.return_value exp
 class Railroader::FindReturnValue
   include Railroader::Util
 
-  #Returns a guess at the return value of a given method or other block of code.
+  # Returns a guess at the return value of a given method or other block of code.
   #
-  #If multiple return values are possible, returns all values in an :or Sexp.
+  # If multiple return values are possible, returns all values in an :or Sexp.
   def self.return_value exp, env = nil
     self.new.get_return_value exp, env
   end
@@ -24,7 +24,7 @@ class Railroader::FindReturnValue
     @uses_ivars
   end
 
-  #Find return value of Sexp. Takes an optional starting environment.
+  # Find return value of Sexp. Takes an optional starting environment.
   def get_return_value exp, env = nil
     process_method exp, env
     value = make_return_value
@@ -32,7 +32,7 @@ class Railroader::FindReturnValue
     value
   end
 
-  #Process method (or, actually, any Sexp) for return value.
+  # Process method (or, actually, any Sexp) for return value.
   def process_method exp, env = nil
     exp = Railroader::AliasProcessor.new.process_safely exp, env
 
@@ -55,7 +55,7 @@ class Railroader::FindReturnValue
     exp
   end
 
-  #Searches expression for return statements.
+  # Searches expression for return statements.
   def find_explicit_return_values exp
     todo = [exp]
 
@@ -72,7 +72,7 @@ class Railroader::FindReturnValue
     end
   end
 
-  #Determines the "last value" of an expression.
+  # Determines the "last value" of an expression.
   def last_value exp
     case exp.node_type
     when :rlist, :block, :scope, Sexp
@@ -95,7 +95,7 @@ class Railroader::FindReturnValue
           value = make_or(true_branch, false_branch)
           value.original_line = value.rhs.line
           value
-        else #Unlikely?
+        else # Unlikely?
           true_branch or false_branch
         end
       end
@@ -140,7 +140,7 @@ class Railroader::FindReturnValue
   end
 
   def make_or lhs, rhs
-    #Better checks in future
+    # Better checks in future
     if lhs == rhs
       lhs
     else
@@ -148,7 +148,7 @@ class Railroader::FindReturnValue
     end
   end
 
-  #Turns the array of return values into an :or Sexp
+  # Turns the array of return values into an :or Sexp
   def make_return_value
     @return_values.compact!
     @return_values.uniq!

data/lib/railroader/processors/lib/module_helper.rb

@@ -47,7 +47,7 @@ module Railroader::ModuleHelper
       @current_class = collection[name]
       @current_class.add_file @file_name, exp
     else
-      @current_class = tracker_class.new name, parent, @file_name, exp, @tracker 
+      @current_class = tracker_class.new name, parent, @file_name, exp, @tracker
       collection[name] = @current_class
     end
 

data/lib/railroader/processors/lib/processor_helper.rb

@@ -1,4 +1,4 @@
-#Contains a couple shared methods for Processors.
+# Contains a couple shared methods for Processors.
 module Railroader::ProcessorHelper
   def process_all exp
     exp.each_sexp do |e|
@@ -19,9 +19,9 @@ module Railroader::ProcessorHelper
     exp
   end
 
-  #Process the arguments of a method call. Does not store results.
+  # Process the arguments of a method call. Does not store results.
   #
-  #This method is used because Sexp#args and Sexp#arglist create new objects.
+  # This method is used because Sexp#args and Sexp#arglist create new objects.
   def process_call_args exp
     exp.each_arg do |a|
       process a if sexp? a
@@ -38,7 +38,7 @@ module Railroader::ProcessorHelper
     exp
   end
 
-  #Sets the current module.
+  # Sets the current module.
   def process_module exp
     module_name = class_name(exp.class_name).to_s
     prev_module = @current_module

data/lib/railroader/processors/lib/rails2_config_processor.rb

@@ -1,39 +1,39 @@
 require 'railroader/processors/lib/basic_processor'
 
-#Processes configuration. Results are put in tracker.config.
+# Processes configuration. Results are put in tracker.config.
 #
-#Configuration of Rails via Rails::Initializer are stored in tracker.config.rails.
-#For example:
+# Configuration of Rails via Rails::Initializer are stored in tracker.config.rails.
+# For example:
 #
 #  Rails::Initializer.run |config|
 #    config.action_controller.session_store = :cookie_store
 #  end
 #
-#will be stored in
+# will be stored in
 #
 #  tracker.config[:rails][:action_controller][:session_store]
 #
-#Values for tracker.config.rails will still be Sexps.
+# Values for tracker.config.rails will still be Sexps.
 class Railroader::Rails2ConfigProcessor < Railroader::BasicProcessor
-  #Replace block variable in
+  # Replace block variable in
   #
   #  Rails::Initializer.run |config|
   #
-  #with this value so we can keep track of it.
+  # with this value so we can keep track of it.
   RAILS_CONFIG = Sexp.new(:const, :"!BRAKEMAN_RAILS_CONFIG")
 
   def initialize *args
     super
   end
 
-  #Use this method to process configuration file
+  # Use this method to process configuration file
   def process_config src, file_name
     @file_name = file_name
     res = Railroader::ConfigAliasProcessor.new.process_safely(src, nil, file_name)
     process res
   end
 
-  #Check if config is set to use Erubis
+  # Check if config is set to use Erubis
   def process_call exp
     target = exp.target
     target = process target if sexp? target
@@ -46,13 +46,13 @@ class Railroader::Rails2ConfigProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Look for configuration settings
+  # Look for configuration settings
   def process_attrasgn exp
     if exp.target == RAILS_CONFIG
-      #Get rid of '=' at end
+      # Get rid of '=' at end
       attribute = exp.method.to_s[0..-2].to_sym
       if exp.args.length > 1
-        #Multiple arguments?...not sure if this will ever happen
+        # Multiple arguments?...not sure if this will ever happen
         @tracker.config.rails[attribute] = exp.args
       else
         @tracker.config.rails[attribute] = exp.first_arg
@@ -71,9 +71,9 @@ class Railroader::Rails2ConfigProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Check for Rails version
+  # Check for Rails version
   def process_cdecl exp
-    #Set Rails version required
+    # Set Rails version required
     if exp.lhs == :RAILS_GEM_VERSION
       @tracker.config.rails_version = exp.rhs.value
     end
@@ -81,7 +81,7 @@ class Railroader::Rails2ConfigProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Check if an expression includes a call to set Rails config
+  # Check if an expression includes a call to set Rails config
   def include_rails_config? exp
     target = exp.target
     if call? target
@@ -97,11 +97,11 @@ class Railroader::Rails2ConfigProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Returns an array of symbols for each 'level' in the config
+  # Returns an array of symbols for each 'level' in the config
   #
   #  config.action_controller.session_store = :cookie
   #
-  #becomes
+  # becomes
   #
   #  [:action_controller, :session_store]
   def get_rails_config exp
@@ -120,18 +120,18 @@ class Railroader::Rails2ConfigProcessor < Railroader::BasicProcessor
   end
 end
 
-#This is necessary to replace block variable so we can track config settings
+# This is necessary to replace block variable so we can track config settings
 class Railroader::ConfigAliasProcessor < Railroader::AliasProcessor
 
   RAILS_INIT = Sexp.new(:colon2, Sexp.new(:const, :Rails), :Initializer)
 
-  #Look for a call to 
+  # Look for a call to
   #
   #  Rails::Initializer.run do |config|
   #    ...
   #  end
   #
-  #and replace config with RAILS_CONFIG
+  # and replace config with RAILS_CONFIG
   def process_iter exp
     target = exp.block_call.target
     method = exp.block_call.method

data/lib/railroader/processors/lib/rails2_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::Rails2RoutesProcessor < Railroader::BasicProcessor
   include Railroader::RouteHelper
 
@@ -12,22 +12,22 @@ class Railroader::Rails2RoutesProcessor < 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
     @file_name = "config/routes.rb"
   end
 
-  #Call this with parsed route file information.
+  # Call this with parsed route file information.
   #
-  #This method first calls RouteAliasProcessor#process_safely on the +exp+,
-  #so it does not modify the +exp+.
+  # This method first calls RouteAliasProcessor#process_safely on the +exp+,
+  # so it does not modify the +exp+.
   def process_routes exp
     process Railroader::RouteAliasProcessor.new.process_safely(exp, nil, @file_name)
   end
 
-  #Looking for mapping of routes
+  # Looking for mapping of routes
   def process_call exp
     target = exp.target
 
@@ -40,8 +40,8 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Process a map.something call
-  #based on the method used
+  # Process a map.something call
+  # based on the method used
   def process_map exp
     args = exp.args
 
@@ -59,8 +59,8 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Look for map calls that take a block.
-  #Otherwise, just do the default processing.
+  # Look for map calls that take a block.
+  # Otherwise, just do the default processing.
   def process_iter exp
     target = exp.block_call.target
 
@@ -81,9 +81,9 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Process
+  # Process
   # map.resources :x, :controller => :y, :member => ...
-  #etc.
+  # etc.
   def process_resources exp
     controller = check_for_controller_name exp
     if controller
@@ -100,8 +100,8 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Process all the options that might be in the hash passed to
-  #map.resource, et al.
+  # Process all the options that might be in the hash passed to
+  # map.resource, et al.
   def process_resource_options exp
     if exp.nil? and @with_options
       exp = @with_options
@@ -115,12 +115,12 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
       when :controller, :requirements, :singular, :path_prefix, :as,
         :path_names, :shallow, :name_prefix, :member_path, :nested_member_path,
         :belongs_to, :conditions, :active_scaffold
-        #should be able to skip
+        # should be able to skip
       when :collection, :member, :new
         process_collection value
       when :has_one
         save_controller = current_controller
-        process_resource value[1..-1] #Verify this is proper behavior
+        process_resource value[1..-1] # Verify this is proper behavior
         self.current_controller = save_controller
       when :has_many
         save_controller = current_controller
@@ -136,7 +136,7 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Process route option :only => ...
+  # Process route option :only => ...
   def process_option_only exp
     routes = @tracker.routes[@current_controller]
     [:index, :new, :create, :show, :edit, :update, :destroy].each do |r|
@@ -150,7 +150,7 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Process route option :except => ...
+  # Process route option :except => ...
   def process_option_except exp
     return unless exp.node_type == :array
     routes = @tracker.routes[@current_controller]
@@ -177,7 +177,7 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Process
+  # Process
   # map.connect '/something', :controller => 'blah', :action => 'whatever'
   def process_connect exp
     return if exp.empty?
@@ -185,7 +185,7 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     controller = check_for_controller_name exp
     self.current_controller = controller if controller
 
-    #Check for default route
+    # Check for default route
     if string? exp.first
       if exp.first.value == ":controller/:action/:id"
         @tracker.routes[:allow_all_actions] = exp.first
@@ -195,11 +195,11 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
       end
     end
 
-    #This -seems- redundant, but people might connect actions
-    #to a controller which already allows them all
+    # This -seems- redundant, but people might connect actions
+    # to a controller which already allows them all
     return if @tracker.routes[@current_controller].is_a? Array and @tracker.routes[@current_controller][0] == :allow_all_actions
 
-    exp.last.each_with_index do |e,i|
+    exp.last.each_with_index do |e, i|
       if symbol? e and e.value == :action
         action = exp.last[i + 1]
 
@@ -221,7 +221,7 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
 
     self.current_controller = check_for_controller_name exp.block_call.args
 
-    #process block
+    # process block
     process exp.block
 
     @with_options = nil
@@ -252,7 +252,7 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
     process_connect exp
   end
 
-  #Process collection option
+  # Process collection option
   # :collection => { :some_action => :http_actions }
   def process_collection exp
     return unless exp.node_type == :hash
@@ -265,10 +265,10 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
 
   private
 
-  #Checks an argument list for a hash that has a key :controller.
-  #If it does, returns the value.
+  # Checks an argument list for a hash that has a key :controller.
+  # If it does, returns the value.
   #
-  #Otherwise, returns nil.
+  # Otherwise, returns nil.
   def check_for_controller_name args
     args.each do |a|
       if hash? a and value = hash_access(a, :controller)
@@ -280,13 +280,13 @@ class Railroader::Rails2RoutesProcessor < Railroader::BasicProcessor
   end
 end
 
-#This is for a really specific case where a hash is used as arguments
-#to one of the map methods.
+# This is for a really specific case where a hash is used as arguments
+# to one of the map methods.
 class Railroader::RouteAliasProcessor < Railroader::AliasProcessor
 
-  #This replaces
+  # This replaces
   # { :some => :hash }.keys
-  #with
+  # with
   # [:some]
   def process_call exp
     process_default exp
@@ -294,14 +294,14 @@ class Railroader::RouteAliasProcessor < Railroader::AliasProcessor
     if hash? exp.target and exp.method == :keys
       keys = get_keys exp.target
       exp.clear
-      keys.each_with_index do |e,i|
+      keys.each_with_index do |e, i|
         exp[i] = e
       end
     end
     exp
   end
 
-  #Returns an array Sexp containing the keys from the hash
+  # Returns an array Sexp containing the keys from the hash
   def get_keys hash
     keys = Sexp.new(:array)
     hash_iterate(hash) do |key, _value|

data/lib/railroader/processors/lib/rails3_config_processor.rb

@@ -1,20 +1,20 @@
 
 require 'railroader/processors/lib/basic_processor'
 
-#Processes configuration. Results are put in tracker.config.
+# Processes configuration. Results are put in tracker.config.
 #
-#Configuration of Rails via Rails::Initializer are stored in tracker.config.rails.
-#For example:
+# Configuration of Rails via Rails::Initializer are stored in tracker.config.rails.
+# For example:
 #
 #  MyApp::Application.configure do
 #    config.active_record.whitelist_attributes = true
 #  end
 #
-#will be stored in
+# will be stored in
 #
 #  tracker.config.rails[:active_record][:whitelist_attributes]
 #
-#Values for tracker.config.rails will still be Sexps.
+# Values for tracker.config.rails will still be Sexps.
 class Railroader::Rails3ConfigProcessor < Railroader::BasicProcessor
   RAILS_CONFIG = Sexp.new(:call, nil, :config)
 
@@ -23,14 +23,14 @@ class Railroader::Rails3ConfigProcessor < Railroader::BasicProcessor
     @inside_config = false
   end
 
-  #Use this method to process configuration file
+  # Use this method to process configuration file
   def process_config src, file_name
     @file_name = file_name
     res = Railroader::AliasProcessor.new(@tracker).process_safely(src, nil, @file_name)
     process res
   end
 
-  #Look for MyApp::Application.configure do ... end
+  # Look for MyApp::Application.configure do ... end
   def process_iter exp
     call = exp.block_call
 
@@ -46,7 +46,7 @@ class Railroader::Rails3ConfigProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Look for class Application < Rails::Application
+  # Look for class Application < Rails::Application
   def process_class exp
     if exp.class_name == :Application
       @inside_config = true
@@ -57,15 +57,15 @@ class Railroader::Rails3ConfigProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Look for configuration settings
+  # Look for configuration settings
   def process_attrasgn exp
     return exp unless @inside_config
 
     if exp.target == RAILS_CONFIG
-      #Get rid of '=' at end
+      # Get rid of '=' at end
       attribute = exp.method.to_s[0..-2].to_sym
       if exp.args.length > 1
-        #Multiple arguments?...not sure if this will ever happen
+        # Multiple arguments?...not sure if this will ever happen
         @tracker.config.rails[attribute] = exp.args
       else
         @tracker.config.rails[attribute] = exp.first_arg
@@ -92,7 +92,7 @@ class Railroader::Rails3ConfigProcessor < Railroader::BasicProcessor
     exp
   end
 
-  #Check if an expression includes a call to set Rails config
+  # Check if an expression includes a call to set Rails config
   def include_rails_config? exp
     target = exp.target
     if call? target
@@ -108,11 +108,11 @@ class Railroader::Rails3ConfigProcessor < Railroader::BasicProcessor
     end
   end
 
-  #Returns an array of symbols for each 'level' in the config
+  # Returns an array of symbols for each 'level' in the config
   #
   #  config.action_controller.session_store = :cookie
   #
-  #becomes
+  # becomes
   #
   #  [:action_controller, :session_store]
   def get_rails_config exp