Module Brakeman::Util
In: lib/brakeman/util.rb

This is a mixin containing utility methods.

Methods

array?   block?   call?   camelize   class_name   constant?   contains_class?   context_for   cookies?   false?   file_by_name   file_for   github_url   hash?   hash_access   hash_insert   hash_iterate   integer?   make_call   node_type?   number?   params?   pluralize   rails_version   regexp?   relative_path   request_env?   request_value?   result?   safe_literal   safe_literal?   safe_literal_target?   set_env_defaults   sexp?   string?   string_interp?   symbol?   template_path_to_name   true?   truncate_table   underscore  

Constants

QUERY_PARAMETERS = Sexp.new(:call, Sexp.new(:call, nil, :request), :query_parameters)
PATH_PARAMETERS = Sexp.new(:call, Sexp.new(:call, nil, :request), :path_parameters)
REQUEST_PARAMETERS = Sexp.new(:call, Sexp.new(:call, nil, :request), :request_parameters)
REQUEST_PARAMS = Sexp.new(:call, Sexp.new(:call, nil, :request), :parameters)
REQUEST_ENV = Sexp.new(:call, Sexp.new(:call, nil, :request), :env)
PARAMETERS = Sexp.new(:call, nil, :params)
COOKIES = Sexp.new(:call, nil, :cookies)
REQUEST_COOKIES = s(:call, s(:call, nil, :request), :cookies)
SESSION = Sexp.new(:call, nil, :session)
ALL_PARAMETERS = Set[PARAMETERS, QUERY_PARAMETERS, PATH_PARAMETERS, REQUEST_PARAMETERS, REQUEST_PARAMS]
ALL_COOKIES = Set[COOKIES, REQUEST_COOKIES]
SAFE_LITERAL = s(:lit, :BRAKEMAN_SAFE_LITERAL)
PARAMS_SEXP = Sexp.new(:params)   These are never modified
SESSION_SEXP = Sexp.new(:session)
COOKIES_SEXP = Sexp.new(:cookies)

Public Instance methods

array?(exp)

Check if exp represents an array: s(:array, […])

block?(exp)

Check if exp represents a block of code

call?(exp)

Check if exp represents a method call: s(:call, …)

camelize(lower_case_and_underscored_word)

Convert a string from "something_like_this" to "SomethingLikeThis"

Taken from ActiveSupport.

class_name(exp)

Returns a class name as a Symbol. If class name cannot be determined, returns exp.

contains_class?(exp)

Returns true if the given exp contains a :class node.

Useful for checking if a module is just a module or if it is a namespace.

context_for(app_tree, warning, tracker = nil)

Return array of lines surrounding the warning location from the original file.

false?(exp)

Check if exp represents a :false or :nil node

file_by_name(name, type, tracker = nil)

Attempt to determine path to context file based on the reported name in the warning.

For example, 

  file_by_name FileController #=> "/rails/root/app/controllers/file_controller.rb
file_for(warning, tracker = nil)

Return file name related to given warning. Uses +warning.file+ if it exists

hash?(exp)

Check if exp represents a hash: s(:hash, {…}) This also includes pseudo hashes params, session, and cookies.

hash_access(hash, key)

Get value from hash using key.

If key is a Symbol, it will be converted to a Sexp(:lit, key).

hash_insert(hash, key, value)

Insert value into Hash Sexp

hash_iterate(hash) {|hash[i], hash[i + 1]| ...}

Takes an Sexp like 

 (:hash, (:lit, :key), (:str, "value"))

and yields the key and value pairs to the given block.

For example: 

 h = Sexp.new(:hash, (:lit, :name), (:str, "bob"), (:lit, :name), (:str, "jane"))
 names = []
 hash_iterate(h) do |key, value|
   if symbol? key and key[1] == :name
     names << value[1]
   end
 end
 names #["bob"]
integer?(exp)

Check if exp represents an Integer: s(:lit, …)

node_type?(exp, *types)

Check if exp is a Sexp and the node type matches one of the given types.

number?(exp)

Check if exp represents a number: s(:lit, …)

params?(exp)

Check if exp is a params hash

pluralize(word)

stupid simple, used to delegate to ActiveSupport

regexp?(exp)

Check if exp represents a Regexp: s(:lit, /…/)

request_value?(exp)

Check if exp is params, cookies, or request_env

result?(exp)

Check if exp represents a result: s(:result, …)

set_env_defaults()

Adds params, session, and cookies to environment so they can be replaced by their respective Sexps.

sexp?(exp)

Check if exp is a Sexp.

string?(exp)

Check if exp represents a String: s(:str, "…")

symbol?(exp)

Check if exp represents a Symbol: s(:lit, :…)

template_path_to_name(path)

Convert path/filename to view name 

 views/test/something.html.erb -> test/something
true?(exp)

Check if exp represents a :true, :lit, or :string node

underscore(camel_cased_word)

Convert a string from "Something::LikeThis" to "something/like_this"

Taken from ActiveSupport.

[Validate]