Class: Brakeman::AppTree

Inherits:
Object
  • Object
show all
Defined in:
lib/brakeman/app_tree.rb

Constant Summary collapse

VIEW_EXTENSIONS = 
%w[html.erb html.haml rhtml js.erb html.slim].join(",")

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root, init_options = {}) ⇒ AppTree

Returns a new instance of AppTree.



54
55
56
57
58
59
 
# File 'lib/brakeman/app_tree.rb', line 54

def initialize(root, init_options = {})
  @root = root
  @skip_files = init_options[:skip_files]
  @only_files = init_options[:only_files]
  @additional_libs_path = init_options[:additional_libs_path] || []
end

Instance Attribute Details

#root ⇒ Object (readonly)

Returns the value of attribute root.



7
8
9
 
# File 'lib/brakeman/app_tree.rb', line 7

def root
  @root
end

Class Method Details

.from_options(options) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/brakeman/app_tree.rb', line 9

def self.from_options(options)
  root = File.expand_path options[:app_path]

  # Convert files into Regexp for matching
  init_options = {}
  if options[:skip_files]
    init_options[:skip_files] = regex_for_paths(options[:skip_files])
  end

  if options[:only_files]
    init_options[:only_files] = regex_for_paths(options[:only_files])
  end
  init_options[:additional_libs_path] = options[:additional_libs_path]
  new(root, init_options)
end

Instance Method Details

#controller_paths ⇒ Object 



90
91
92
 
# File 'lib/brakeman/app_tree.rb', line 90

def controller_paths
  @controller_paths ||= find_paths("app/**/controllers")
end

#exists?(path) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/brakeman/app_tree.rb', line 77

def exists?(path)
  File.exist?(File.join(@root, path))
end

#expand_path(path) ⇒ Object 



61
62
63
 
# File 'lib/brakeman/app_tree.rb', line 61

def expand_path(path)
  File.expand_path(path, @root)
end

#initializer_paths ⇒ Object 



86
87
88
 
# File 'lib/brakeman/app_tree.rb', line 86

def initializer_paths
  @initializer_paths ||= find_paths("config/initializers")
end

#layout_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
105
 
# File 'lib/brakeman/app_tree.rb', line 102

def layout_exists?(name)
  pattern = "#{@root}/{engines/*/,}app/views/layouts/#{name}.html.{erb,haml,slim}"
  !Dir.glob(pattern).empty?
end

#lib_paths ⇒ Object 



107
108
109
110
 
# File 'lib/brakeman/app_tree.rb', line 107

def lib_paths
  @lib_files ||= find_paths("lib").reject { |path| path.include? "/generators/" or path.include? "lib/tasks/" } +
                 find_additional_lib_paths
end

#model_paths ⇒ Object 



94
95
96
 
# File 'lib/brakeman/app_tree.rb', line 94

def model_paths
  @model_paths ||= find_paths("app/**/models")
end

#path_exists?(path) ⇒ Boolean

This is a pair for #read_path. Again, would like to kill these

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/brakeman/app_tree.rb', line 82

def path_exists?(path)
  File.exist?(path)
end

#read(path) ⇒ Object 



65
66
67
 
# File 'lib/brakeman/app_tree.rb', line 65

def read(path)
  File.read(File.join(@root, path))
end

#read_path(path) ⇒ Object

This variation requires full paths instead of paths based off the project root. I’d prefer to get all the code outside of AppTree using project-root based paths (e.g. app/models/user.rb) instead of full paths, but I suspect it’s an incompatible change.



73
74
75
 
# File 'lib/brakeman/app_tree.rb', line 73

def read_path(path)
  File.read(path)
end

#template_paths ⇒ Object 



98
99
100
 
# File 'lib/brakeman/app_tree.rb', line 98

def template_paths
  @template_paths ||= find_paths("app/**/views", "*.{#{VIEW_EXTENSIONS}}")
end