module Bullet
Experimental RBS support (using type sampling data from the type_fusion project).
# sig/bullet.rbs module Bullet def counter_cache_enable?: () -> true def debug: (String title, String message) -> nil def enable?: () -> true def n_plus_one_query_enable?: () -> true def stacktrace_excludes: () -> Array[] def start?: () -> true def unused_eager_loading_enable?: () -> true end
def add_safelist(options)
def add_safelist(options) reset_safelist @safelist[options[:type]][options[:class_name]] ||= [] @safelist[options[:type]][options[:class_name]] << options[:association].to_sym end
def app_root
def app_root @app_root ||= (defined?(::Rails.root) && !::Rails.root.nil? ? Rails.root.to_s : Dir.pwd).to_s end
def build_request_uri(env)
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
def bullet_logger=(active)
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
def clear_safelist
def clear_safelist @safelist = nil end
def console_enabled?
def console_enabled? UniformNotifier.active_notifiers.include?(UniformNotifier::JavascriptConsole) end
def counter_cache_enable?
Experimental RBS support (using type sampling data from the type_fusion project).
def counter_cache_enable?: () -> true
This signature was generated using 1 sample from 1 application.
def counter_cache_enable? enable? && !!@counter_cache_enable end
def debug(title, message)
Experimental RBS support (using type sampling data from the type_fusion project).
def debug: (String title, String message) -> nil
This signature was generated using 41 samples from 1 application.
def debug(title, message) puts "[Bullet][#{title}] #{message}" if ENV['BULLET_DEBUG'] == 'true' end
def delete_safelist(options)
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
def enable=(enable)
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
def enable?
Experimental RBS support (using type sampling data from the type_fusion project).
def enable?: () -> true
This signature was generated using 50 samples from 1 application.
def enable? !!@enable end
def end_request
def end_request Thread.current[:bullet_start] = nil Thread.current[:bullet_notification_collector] = nil Thread.current[:bullet_object_associations] = nil Thread.current[:bullet_call_object_associations] = nil Thread.current[:bullet_possible_objects] = nil Thread.current[:bullet_impossible_objects] = nil Thread.current[:bullet_inversed_objects] = nil Thread.current[:bullet_eager_loadings] = nil Thread.current[:bullet_counter_possible_objects] = nil Thread.current[:bullet_counter_impossible_objects] = nil end
def footer_info
def footer_info info = [] notification_collector.collection.each { |notification| info << notification.short_notice } info end
def for_each_active_notifier_with_notification
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
def gather_inline_notifications
def gather_inline_notifications responses = [] for_each_active_notifier_with_notification { |notification| responses << notification.notify_inline } responses.join("\n") end
def get_safelist_associations(type, class_name)
def get_safelist_associations(type, class_name) Array.wrap(@safelist[type][class_name]) end
def inject_into_page?
def inject_into_page? return false if defined?(@skip_html_injection) && @skip_html_injection console_enabled? || add_footer end
def n_plus_one_query_enable?
Experimental RBS support (using type sampling data from the type_fusion project).
def n_plus_one_query_enable?: () -> true
This signature was generated using 16 samples from 1 application.
def n_plus_one_query_enable? enable? && !!@n_plus_one_query_enable end
def notification?
def notification? return unless start? Bullet::Detector::UnusedEagerLoading.check_unused_preload_associations notification_collector.notifications_present? end
def notification_collector
def notification_collector Thread.current[:bullet_notification_collector] end
def perform_out_of_channel_notifications(env = {})
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
def profile
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
def raise=(should_raise)
def raise=(should_raise) UniformNotifier.raise = (should_raise ? Notification::UnoptimizedQueryError : false) end
def reset_safelist
def reset_safelist @safelist ||= { n_plus_one_query: {}, unused_eager_loading: {}, counter_cache: {} } end
def stacktrace_excludes
Experimental RBS support (using type sampling data from the type_fusion project).
def stacktrace_excludes: () ->
This signature was generated using 3 samples from 1 application.
def stacktrace_excludes @stacktrace_excludes ||= [] end
def stacktrace_includes
def stacktrace_includes @stacktrace_includes ||= [] end
def start?
Experimental RBS support (using type sampling data from the type_fusion project).
def start?: () -> true
This signature was generated using 21 samples from 1 application.
def start? enable? && Thread.current[:bullet_start] end
def start_request
def start_request Thread.current[:bullet_start] = true Thread.current[:bullet_notification_collector] = Bullet::NotificationCollector.new Thread.current[:bullet_object_associations] = Bullet::Registry::Base.new Thread.current[:bullet_call_object_associations] = Bullet::Registry::Base.new Thread.current[:bullet_possible_objects] = Bullet::Registry::Object.new Thread.current[:bullet_impossible_objects] = Bullet::Registry::Object.new Thread.current[:bullet_inversed_objects] = Bullet::Registry::Base.new Thread.current[:bullet_eager_loadings] = Bullet::Registry::Association.new Thread.current[:bullet_call_stacks] = Bullet::Registry::CallStack.new Thread.current[:bullet_counter_possible_objects] ||= Bullet::Registry::Object.new Thread.current[:bullet_counter_impossible_objects] ||= Bullet::Registry::Object.new end
def text_notifications
def text_notifications info = [] notification_collector.collection.each do |notification| info << notification.notification_data.values.compact.join("\n") end info end
def unused_eager_loading_enable?
Experimental RBS support (using type sampling data from the type_fusion project).
def unused_eager_loading_enable?: () -> true
This signature was generated using 2 samples from 1 application.
def unused_eager_loading_enable? enable? && !!@unused_eager_loading_enable end
def warnings
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