class Railroader::FindCall

Finds method calls matching the given target(s).

#-- This should be deprecated --#
#--  Do not use for new code  --#

Targets/methods can be:

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:

#To find any uses of this class: FindCall.new :FindCall, nil

#Find system calls without a target FindCall.new [], [:system, :exec, :syscall]

#Find all calls to length(), no matter the target FindCall.new nil, :length

#Find all calls to sub, sub!, gsub, or gsub! FindCall.new nil, /^g?sub!?$/

Public Class Methods

new(targets, methods, tracker, in_depth = false) click to toggle source
Calls superclass method Railroader::BasicProcessor::new
# File lib/railroader/processors/lib/find_call.rb, line 36
def initialize targets, methods, tracker, in_depth = false
  super tracker
  @calls = []
  @find_targets = targets
  @find_methods = methods
  @current_class = nil
  @current_method = nil
  @in_depth = in_depth
end

Public Instance Methods

matches() click to toggle source

Returns a list of results.

A result looks like:

s(:result, :ClassName, :method_name, s(:call, …))

or

s(:result, :template_name, s(:call, …))

# File lib/railroader/processors/lib/find_call.rb, line 55
def matches
  @calls
end
process_attrasgn(exp) click to toggle source

Process an assignment like a call

# File lib/railroader/processors/lib/find_call.rb, line 113
def process_attrasgn exp
  process_call exp
end
process_call(exp) click to toggle source

Look for matching calls and add them to results

# File lib/railroader/processors/lib/find_call.rb, line 83
def process_call exp
  target = get_target exp.target
  method = exp.method

  process_call_args exp

  if match(@find_targets, target) and match(@find_methods, method)

    if @current_template
      @calls << Sexp.new(:result, @current_template, exp).line(exp.line)
    else
      @calls << Sexp.new(:result, @current_module, @current_class, @current_method, exp).line(exp.line)
    end

  end

  # 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.
  if @in_depth and call? exp.target
    process exp.target
  end

  exp
end
process_defn(exp) click to toggle source

Process body of method

# File lib/railroader/processors/lib/find_call.rb, line 71
def process_defn exp
  process_all exp.body
end
Also aliased as: process_defs
process_defs(exp)
Alias for: process_defn
process_rlist(exp) click to toggle source

Process body of block

# File lib/railroader/processors/lib/find_call.rb, line 78
def process_rlist exp
  process_all exp
end
process_source(exp, klass = nil, method = nil, template = nil) click to toggle source

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.

# File lib/railroader/processors/lib/find_call.rb, line 63
def process_source exp, klass = nil, method = nil, template = nil
  @current_class = klass
  @current_method = method
  @current_template = template
  process exp
end

Private Instance Methods

get_target(exp) click to toggle source

Gets the target of a call as a Symbol if possible

# File lib/railroader/processors/lib/find_call.rb, line 121
def get_target exp
  if sexp? exp
    case exp.node_type
    when :ivar, :lvar, :const, :lit
      exp.value
    when :true, :false
      exp.node_type
    when :colon2
      class_name exp
    else
      exp
    end
  else
    exp
  end
end
is_instance_of?(item, klass) click to toggle source

Checks if item is an instance of klass by looking for Klass.new

# File lib/railroader/processors/lib/find_call.rb, line 172
def is_instance_of? item, klass
  if call? item
    if sexp? item.target
      item.method == :new and item.target.node_type == :const and item.target.value == klass
    else
      item.method == :new and item.target == klass
    end
  else
    false
  end
end
match(search_terms, item) click to toggle source

Checks if the search terms match the given item

# File lib/railroader/processors/lib/find_call.rb, line 139
def match search_terms, item
  case search_terms
  when Symbol
    if search_terms == item
      true
    elsif sexp? item
      is_instance_of? item, search_terms
    else
      false
    end
  when Sexp
    search_terms == item
  when Enumerable
    if search_terms.empty?
      item == nil
    else
      search_terms.each do |term|
        if match(term, item)
          return true
        end
      end
      false
    end
  when Regexp
    search_terms.match item.to_s
  when nil
    true
  else
    raise "Cannot match #{search_terms} and #{item}"
  end
end