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.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/brakeman/app_tree.rb', line 57

def initialize(root, init_options = {})
  @root = root
  @project_root_path = Pathname.new(@root)
  @skip_files = init_options[:skip_files]
  @only_files = init_options[:only_files]
  @additional_libs_path = init_options[:additional_libs_path] || []
  @engine_paths = init_options[:engine_paths] || []
  @absolute_engine_paths = @engine_paths.select { |path| path.start_with?(File::SEPARATOR) }
  @relative_engine_paths = @engine_paths - @absolute_engine_paths
  @skip_vendor = init_options[:skip_vendor]
  @gemspec = nil
  @root_search_pattern = nil
end

Instance Attribute Details

#root ⇒ Object (readonly)

Returns the value of attribute root.



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

def root
  @root
end

Class Method Details

.from_options(options) ⇒ Object 



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

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]
  init_options[:engine_paths] = options[:engine_paths]
  init_options[:skip_vendor] = options[:skip_vendor]
  new(root, init_options)
end

Instance Method Details

#controller_paths ⇒ Object 



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

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

#exists?(path) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
96
97
98
99
 
# File 'lib/brakeman/app_tree.rb', line 93

def exists?(path)
  if path.is_a? Brakeman::FilePath
    path.exists?
  else
    File.exist?(File.join(@root, path))
  end
end

#expand_path(path) ⇒ Object

Should only be used by Brakeman::FilePath. Use AppTree#file_path(path).absolute instead.



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

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

#file_path(path) ⇒ Object

Create a new Brakeman::FilePath



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

def file_path(path)
  Brakeman::FilePath.from_app_tree(self, path)
end

#gemspec ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/brakeman/app_tree.rb', line 133

def gemspec
  return @gemspec unless @gemspec.nil?

  gemspecs =  Dir.glob(File.join(@root, "*.gemspec"))

  if gemspecs.length > 1 or gemspecs.empty?
    @gemspec = false
  else
    @gemspec = file_path(File.basename(gemspecs.first))
  end
end

#initializer_paths ⇒ Object 



105
106
107
 
# File 'lib/brakeman/app_tree.rb', line 105

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

#layout_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'lib/brakeman/app_tree.rb', line 122

def layout_exists?(name)
  !Dir.glob("#{root_search_pattern}app/views/layouts/#{name}.html.{erb,haml,slim}").empty?
end

#lib_paths ⇒ Object 



126
127
128
129
130
131
 
# File 'lib/brakeman/app_tree.rb', line 126

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

#model_paths ⇒ Object 



113
114
115
 
# File 'lib/brakeman/app_tree.rb', line 113

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

#relative_path(path) ⇒ Object

Should only be used by Brakeman::FilePath Use AppTree#file_path(path).relative instead.



84
85
86
87
88
89
90
91
 
# File 'lib/brakeman/app_tree.rb', line 84

def relative_path(path)
  pname = Pathname.new path
  if path and not path.empty? and pname.absolute?
    pname.relative_path_from(Pathname.new(self.root)).to_s
  else
    path
  end
end

#ruby_file_paths ⇒ Object 



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

def ruby_file_paths
  find_paths(".").uniq
end

#template_paths ⇒ Object 



117
118
119
120
 
# File 'lib/brakeman/app_tree.rb', line 117

def template_paths
  @template_paths ||= find_paths(".", "*.{#{VIEW_EXTENSIONS}}") +
    find_paths("**", "*.{erb,haml,slim}").reject { |path| File.basename(path).count(".") > 1 }
end