presidentbeef/brakeman

View on GitHub
lib/brakeman/tracker/collection.rb

Summary

Maintainability
A
35 mins
Test Coverage
A
94%
require 'brakeman/util'
require 'brakeman/tracker/method_info'

module Brakeman
  class Collection
    include Brakeman::Util

    attr_reader :collection, :files, :includes, :name, :options, :parent, :src, :tracker

    def initialize name, parent, file_name, src, tracker
      @name = name
      @parent = parent
      @files = []
      @src = {}
      @includes = []
      @methods = { :public => {}, :private => {}, :protected => {} }
      @class_methods = {}
      @simple_methods = { :class => {}, instance: {} }
      @options = {}
      @tracker = tracker

      add_file file_name, src
    end

    def ancestor? parent, seen={}
      seen[self.name] = true

      if self.parent == parent or self.name == parent or seen[self.parent]
        true
      elsif parent_model = collection[self.parent]
        parent_model.ancestor? parent, seen
      else
        false
      end
    end

    def add_file file_name, src
      @files << file_name unless @files.include? file_name
      @src[file_name] = src
    end

    def add_include class_name
      @includes << class_name unless ancestor?(class_name)
    end

    def add_option name, exp
      @options[name] ||= []
      @options[name] << exp
    end

    def add_method visibility, name, src, file_name
      meth_info = Brakeman::MethodInfo.new(name, src, self, file_name)
      add_simple_method_maybe meth_info

      if src.node_type == :defs
        @class_methods[name] = meth_info

        # TODO fix this weirdness
        name = :"#{src[1]}.#{name}"
      end

      @methods[visibility][name] = meth_info
    end

    def each_method
      @methods.each do |_vis, meths|
        meths.each do |name, info|
          yield name, info
        end
      end
    end

    def get_method name, type = :instance
      case type
      when :class
        get_class_method name
      when :instance
        get_instance_method name
      else
        raise "Unexpected method type: #{type.inspect}"
      end
    end

    def get_instance_method name
      @methods.each do |_vis, meths|
        if meths[name]
          return meths[name]
        end
      end

      nil
    end

    def get_class_method name
      @class_methods[name]
    end

    def file
      @files.first
    end

    def top_line
      if sexp? @src[file]
        @src[file].line
      else
        @src.each_value do |source|
          if sexp? source
            return source.line
          end
        end
      end
    end

    def methods_public
      @methods[:public]
    end

    def get_simple_method_return_value type, name
      @simple_methods[type][name]
    end

    private

    def add_simple_method_maybe meth_info
      if meth_info.very_simple_method?
        add_simple_method meth_info
      end
    end

    def add_simple_method meth_info
      name = meth_info.name
      value = meth_info.return_value

      case meth_info.src.node_type
      when :defn
        @simple_methods[:instance][name] = value
      when :defs
        @simple_methods[:class][name] = value
      else
        raise "Expected sexp type: #{src.node_type}"
      end
    end
  end
end