module Bullet

Constants

DETECTORS
VERSION

Attributes

always_append_html_body[RW]
counter_cache_enable[W]
n_plus_one_query_enable[W]
orm_patches_applied[RW]
safelist[R]
skip_html_injection[W]
skip_http_headers[RW]
skip_user_in_notification[RW]
stacktrace_excludes[W]
stacktrace_includes[W]
unused_eager_loading_enable[W]

Public Class Methods

add_safelist(options) click to toggle source
# File lib/bullet.rb, line 111
def add_safelist(options)
  reset_safelist
  @safelist[options[:type]][options[:class_name]] ||= []
  @safelist[options[:type]][options[:class_name]] << options[:association].to_sym
end
app_root() click to toggle source

Rails.root might be nil if ‘railties` is a dependency on a project that does not use Rails

# File lib/bullet.rb, line 87
def app_root
  @app_root ||= (defined?(::Rails.root) && !::Rails.root.nil? ? Rails.root.to_s : Dir.pwd).to_s
end
bullet_logger=(active) click to toggle source
# File lib/bullet.rb, line 136
def bullet_logger=(active)
  if active
    require 'fileutils'
    FileUtils.mkdir_p(app_root + '/log')
    bullet_log_file = File.open("#{app_root}/log/bullet.log", 'a+')
    bullet_log_file.sync = true
    UniformNotifier.customized_logger = bullet_log_file
  end
end
clear_safelist() click to toggle source
# File lib/bullet.rb, line 132
def clear_safelist
  @safelist = nil
end
console_enabled?() click to toggle source
# File lib/bullet.rb, line 257
def console_enabled?
  UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole)
end
counter_cache_enable?() click to toggle source
# File lib/bullet.rb, line 99
def counter_cache_enable?
  enable? && !!@counter_cache_enable
end
debug(title, message) click to toggle source
# File lib/bullet.rb, line 146
def debug(title, message)
  puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true'
end
delete_safelist(options) click to toggle source
# File lib/bullet.rb, line 117
def delete_safelist(options)
  reset_safelist
  @safelist[options[:type]][options[:class_name]] ||= []
  @safelist[options[:type]][options[:class_name]].delete(options[:association].to_sym)
  @safelist[options[:type]].delete_if { |_key, val| val.empty? }
end
enable=(enable) click to toggle source
# File lib/bullet.rb, line 65
def enable=(enable)
  @enable = @n_plus_one_query_enable = @unused_eager_loading_enable = @counter_cache_enable = enable

  if enable?
    reset_safelist
    unless orm_patches_applied
      self.orm_patches_applied = true
      Bullet::Mongoid.enable if mongoid?
      Bullet::ActiveRecord.enable if active_record?
    end
  end
end
Also aliased as: enabled=
enable?() click to toggle source
# File lib/bullet.rb, line 80
def enable?
  !!@enable
end
Also aliased as: enabled?
enabled=(enable)
Alias for: enable=
enabled?()
Alias for: enable?
end_request() click to toggle source
# File lib/bullet.rb, line 171
def end_request
  Thread.current.thread_variable_set(:bullet_start, nil)
  Thread.current.thread_variable_set(:bullet_notification_collector, nil)

  Thread.current.thread_variable_set(:bullet_object_associations, nil)
  Thread.current.thread_variable_set(:bullet_call_object_associations, nil)
  Thread.current.thread_variable_set(:bullet_possible_objects, nil)
  Thread.current.thread_variable_set(:bullet_impossible_objects, nil)
  Thread.current.thread_variable_set(:bullet_inversed_objects, nil)
  Thread.current.thread_variable_set(:bullet_eager_loadings, nil)

  Thread.current.thread_variable_set(:bullet_counter_possible_objects, nil)
  Thread.current.thread_variable_set(:bullet_counter_impossible_objects, nil)
end
gather_inline_notifications() click to toggle source
# File lib/bullet.rb, line 201
def gather_inline_notifications
  responses = []
  for_each_active_notifier_with_notification { |notification| responses << notification.notify_inline }
  responses.join("\n")
end
get_safelist_associations(type, class_name) click to toggle source
# File lib/bullet.rb, line 124
def get_safelist_associations(type, class_name)
  Array.wrap(@safelist[type][class_name])
end
inject_into_page?() click to toggle source
# File lib/bullet.rb, line 261
def inject_into_page?
  return false if defined?(@skip_html_injection) && @skip_html_injection

  console_enabled? || add_footer
end
n_plus_one_query_enable?() click to toggle source
# File lib/bullet.rb, line 91
def n_plus_one_query_enable?
  enable? && !!@n_plus_one_query_enable
end
notification?() click to toggle source
# File lib/bullet.rb, line 194
def notification?
  return unless start?

  Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations
  notification_collector.notifications_present?
end
notification_collector() click to toggle source
# File lib/bullet.rb, line 190
def notification_collector
  Thread.current.thread_variable_get(:bullet_notification_collector)
end
perform_out_of_channel_notifications(env = {}) click to toggle source
# File lib/bullet.rb, line 207
def perform_out_of_channel_notifications(env = {})
  request_uri = build_request_uri(env)
  for_each_active_notifier_with_notification do |notification|
    notification.url = request_uri
    notification.notify_out_of_channel
  end
end
profile() { || ... } click to toggle source
# File lib/bullet.rb, line 237
def profile
  return_value = nil

  if Bullet.enable?
    begin
      Bullet.start_request

      return_value = yield

      Bullet.perform_out_of_channel_notifications if Bullet.notification?
    ensure
      Bullet.end_request
    end
  else
    return_value = yield
  end

  return_value
end
raise=(should_raise) click to toggle source
# File lib/bullet.rb, line 55
def raise=(should_raise)
  UniformNotifier.raise = (should_raise ? Notification::UnoptimizedQueryError : false)
end
reset_safelist() click to toggle source
# File lib/bullet.rb, line 128
def reset_safelist
  @safelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} }
end
stacktrace_excludes() click to toggle source
# File lib/bullet.rb, line 107
def stacktrace_excludes
  @stacktrace_excludes ||= []
end
stacktrace_includes() click to toggle source
# File lib/bullet.rb, line 103
def stacktrace_includes
  @stacktrace_includes ||= []
end
start?() click to toggle source
# File lib/bullet.rb, line 186
def start?
  enable? && Thread.current.thread_variable_get(:bullet_start)
end
start_request() click to toggle source
# File lib/bullet.rb, line 150
def start_request
  Thread.current.thread_variable_set(:bullet_start, true)
  Thread.current.thread_variable_set(:bullet_notification_collector, Bullet::NotificationCollector.new)

  Thread.current.thread_variable_set(:bullet_object_associations, Bullet::Registry::Base.new)
  Thread.current.thread_variable_set(:bullet_call_object_associations, Bullet::Registry::Base.new)
  Thread.current.thread_variable_set(:bullet_possible_objects, Bullet::Registry::Object.new)
  Thread.current.thread_variable_set(:bullet_impossible_objects, Bullet::Registry::Object.new)
  Thread.current.thread_variable_set(:bullet_inversed_objects, Bullet::Registry::Base.new)
  Thread.current.thread_variable_set(:bullet_eager_loadings, Bullet::Registry::Association.new)
  Thread.current.thread_variable_set(:bullet_call_stacks, Bullet::Registry::CallStack.new)

  unless Thread.current.thread_variable_get(:bullet_counter_possible_objects)
    Thread.current.thread_variable_set(:bullet_counter_possible_objects, Bullet::Registry::Object.new)
  end

  unless Thread.current.thread_variable_get(:bullet_counter_impossible_objects)
    Thread.current.thread_variable_set(:bullet_counter_impossible_objects, Bullet::Registry::Object.new)
  end
end
text_notifications() click to toggle source
# File lib/bullet.rb, line 221
def text_notifications
  info = []
  notification_collector.collection.each do |notification|
    info << notification.notification_data.values.compact.join("\n")
  end
  info
end
unused_eager_loading_enable?() click to toggle source
# File lib/bullet.rb, line 95
def unused_eager_loading_enable?
  enable? && !!@unused_eager_loading_enable
end
warnings() click to toggle source
# File lib/bullet.rb, line 229
def warnings
  notification_collector.collection.each_with_object({}) do |notification, warnings|
    warning_type = notification.class.to_s.split(':').last.tableize
    warnings[warning_type] ||= []
    warnings[warning_type] << notification
  end
end

Private Class Methods

build_request_uri(env) click to toggle source
# File lib/bullet.rb, line 278
def build_request_uri(env)
  return "#{env['REQUEST_METHOD']} #{env['REQUEST_URI']}" if env['REQUEST_URI']

  if env['QUERY_STRING'].present?
    "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}?#{env['QUERY_STRING']}"
  else
    "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
  end
end
for_each_active_notifier_with_notification() { |notification| ... } click to toggle source
# File lib/bullet.rb, line 269
def for_each_active_notifier_with_notification
  UniformNotifier.active_notifiers.each do |notifier|
    notification_collector.collection.each do |notification|
      notification.notifier = notifier
      yield notification
    end
  end
end