active-profiling 0.1.2 → 2.0

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-04-15 15:03:39 UTC using RuboCop version 1.63.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/active-profiling.rb'

data/FUNDING.yml

@@ -0,0 +1,2 @@
+github:
+  - dark-panda

data/Gemfile

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
 
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rdoc", "~> 3.12"
-gem "rake", "~> 10.0"
-
-if File.exists?('Gemfile.local')
-  instance_eval File.read('Gemfile.local')
-end
+gem 'rake'
+gem 'rdoc'
+gem 'rubocop', require: false
 
+instance_eval File.read('Gemfile.local') if File.exist?('Gemfile.local')

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2017 J Smith <dark.panda@gmail.com>
+Copyright (c) 2012-2024 J Smith <dark.panda@gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -1,5 +1,4 @@
-
-# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'rubygems/package_task'
@@ -7,7 +6,7 @@ require 'rake/testtask'
 require 'rdoc/task'
 require 'bundler/gem_tasks'
 
-$:.push File.expand_path(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.push File.expand_path(File.dirname(__FILE__), 'lib')
 
 version = ActiveProfiling::VERSION
 
@@ -25,4 +24,3 @@ Rake::RDocTask.new do |t|
   t.rdoc_dir = 'doc'
   t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb')
 end
-

data/active-profiling.gemspec

@@ -1,26 +1,29 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require File.expand_path('../lib/active-profiling/version', __FILE__)
+require File.expand_path('lib/active-profiling/version', __dir__)
 
 Gem::Specification.new do |s|
-  s.name = "active-profiling"
+  s.name = 'active-profiling'
   s.version = ActiveProfiling::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["J Smith"]
-  s.description = "A Rails profiling suite."
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = '>= 3.0'
+
+  s.authors = ['J Smith']
+  s.description = 'A Rails profiling suite.'
   s.summary = s.description
-  s.email = "dark.panda@gmail.com"
-  s.license = "MIT"
+  s.email = 'dark.panda@gmail.com'
+  s.license = 'MIT'
   s.extra_rdoc_files = [
-    "README.rdoc"
+    'README.rdoc'
   ]
-  s.files = `git ls-files`.split($\)
+  s.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   s.executables = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  s.test_files = s.files.grep(%r{^(test|spec|features)/})
-  s.homepage = "http://github.com/dark-panda/active-profiling"
-  s.require_paths = ["lib"]
+  s.homepage = 'https://github.com/dark-panda/active-profiling'
+  s.require_paths = ['lib']
 
-  s.add_dependency("rails", [">= 3.0"])
+  s.add_dependency('rails', ['>= 6.0'])
+  s.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end
-

data/lib/active-profiling/action_controller/action_profiling.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActionController
   module ActionProfiling
@@ -13,25 +14,21 @@ module ActionController
         :around_filter
       end
 
-      send around_filter_method, :action_profiler, :if => proc {
+      send around_filter_method, :action_profiler, if: proc {
         Rails.application.config.active_profiling.profiler.enabled && ActiveProfiling.ruby_prof?
       }
 
-      send around_filter_method, :action_gc_statistics, :if => proc {
+      send around_filter_method, :action_gc_statistics, if: proc {
         Rails.application.config.active_profiling.gc_statistics.enabled && ActiveProfiling.gc_statistics?
       }
     end
 
-    def action_profiler(*args)
-      ruby_profiler(:name => "#{controller_name}.#{action_name}") do
-        yield
-      end
+    def action_profiler(*, &block)
+      ruby_profiler(name: "#{controller_name}.#{action_name}", &block)
     end
 
-    def action_gc_statistics(*args)
-      gc_statistics do
-        yield
-      end
+    def action_gc_statistics(*, &block)
+      gc_statistics(&block)
     end
   end
 

data/lib/active-profiling/action_controller/log_subscriber.rb

@@ -1,49 +1,48 @@
+# frozen_string_literal: true
 
 module ActiveProfiling::ActionController
   class LogSubscriber < ActiveSupport::LogSubscriber
     def profiler_output(event)
-      return unless logger &&
-        logger.send("#{config.profiler.log_level}?")
+      return unless logger&.send("#{config.profiler.log_level}?")
 
-      report = self.indent(event.payload[:profiler_output])
+      report = indent(event.payload[:profiler_output])
       title = event.payload[:title]
 
       logger.send(
         config.profiler.log_level,
-        "#{color("Profiler Output: #{title}", YELLOW, true)}\n#{report}"
+        "#{color("Profiler Output: #{title}", YELLOW, bold: true)}\n#{report}"
       )
     end
 
     def profiler_output_to_file(event)
-      return unless logger &&
-        logger.send("#{config.profiler.log_level}?")
+      return unless logger&.send("#{config.profiler.log_level}?")
 
       logger.send(
         config.profiler.log_level,
-        color("Wrote profiling information to #{event.payload[:file_name]}", YELLOW, true)
+        color("Wrote profiling information to #{event.payload[:file_name]}", YELLOW, bold: true)
       )
     end
 
     def gc_statistics(event)
-      return unless logger &&
-        logger.send("#{config.gc_statistics.log_level}?")
+      return unless logger&.send("#{config.gc_statistics.log_level}?")
 
-      unless event.payload[:report].blank?
-        title = event.payload[:title]
-        report = self.indent(event.payload[:report])
+      return if event.payload[:report].blank?
 
-        logger.send(
-          config.gc_statistics.log_level,
-          "#{color("GC Statistics: #{title}", YELLOW, true)}\n#{report}"
-        )
-      end
+      title = event.payload[:title]
+      report = indent(event.payload[:report])
+
+      logger.send(
+        config.gc_statistics.log_level,
+        "#{color("GC Statistics: #{title}", YELLOW, bold: true)}\n#{report}"
+      )
     end
 
     def logger
       ::Rails.logger
     end
 
-    protected
+    private
+
       def config
         Rails.application.config.active_profiling
       end

data/lib/active-profiling/action_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'active-profiling/action_controller/action_profiling'
 require 'active-profiling/action_controller/log_subscriber'

data/lib/active-profiling/active_record/backtrace_log_subscriber.rb

@@ -1,33 +1,36 @@
+# frozen_string_literal: true
 
 module ActiveProfiling::ActiveRecord
   class BacktraceLogSubscriber < ::ActiveSupport::LogSubscriber
     def sql(event)
-      return unless config.enabled &&
-        config.log_level &&
-        logger &&
-        logger.send("#{config.log_level}?")
+      return unless skip_backtrace?
 
       payload = event.payload
 
-      return if 'SCHEMA' == payload[:name]
+      return if payload[:name] == 'SCHEMA'
 
       backtrace = event.send(:caller).collect { |line|
-        if line_match(line)
-          "    #{line}"
-        end
+        "    #{line}" if line_match(line)
       }.compact
 
-      unless backtrace.empty?
-        name = color(payload[:name], YELLOW, true)
-        logger.send(config.log_level, "  #{name}\n#{backtrace.join("\n")}")
-      end
+      return if backtrace.empty?
+
+      name = color(payload[:name], YELLOW, true)
+      logger.send(config.log_level, "  #{name}\n#{backtrace.join("\n")}")
     end
 
     def logger
       ::ActiveRecord::Base.logger
     end
 
-    protected
+    private
+
+      def skip_backtrace?
+        config.enabled &&
+          config.log_level &&
+          logger&.send("#{config.log_level}?")
+      end
+
       def config
         Rails.application.config.active_profiling.active_record.backtrace_logger
       end
@@ -39,4 +42,3 @@ module ActiveProfiling::ActiveRecord
 end
 
 ActiveProfiling::ActiveRecord::BacktraceLogSubscriber.attach_to :active_record
-

data/lib/active-profiling/active_record.rb

@@ -1,3 +1,3 @@
+# frozen_string_literal: true
 
 require 'active-profiling/active_record/backtrace_log_subscriber'
-

data/lib/active-profiling/gc_statistics.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveProfiling
   module GCStatistics
@@ -6,7 +7,7 @@ module ActiveProfiling
     if defined?(GC::Profiler)
       def gc_statistics_report(options = {})
         options = {
-          :disable_gc => false
+          disable_gc: false
         }.merge(options)
 
         GC.disable if options[:disable_gc]
@@ -15,14 +16,11 @@ module ActiveProfiling
 
         retval = yield
 
-        if options[:disable_gc]
-          GC.enable
-        end
+        GC.enable if options[:disable_gc]
 
         result = GC::Profiler.result
 
-        return [ retval, result ]
-
+        [retval, result]
       ensure
         GC.enable if options[:disable_gc]
         GC::Profiler.disable
@@ -31,7 +29,7 @@ module ActiveProfiling
     elsif GC.respond_to?(:enable_stats)
       def gc_statistics_report(options = {})
         options = {
-          :disable_gc => false
+          disable_gc: false
         }.merge(options)
 
         GC.disable if options[:disable_gc]
@@ -47,18 +45,17 @@ module ActiveProfiling
           "Time (ms): #{GC.time / 1000.0}"
         ].join("\n")
 
-        return [ retval, result ]
-
+        [retval, result]
       ensure
         GC.enable if options[:disable_gc]
         GC.disable_stats
         GC.clear_stats
       end
     else
-      $stderr.puts "NOTICE: this version of Ruby cannot report on GC statistics."
+      $stderr.warn 'NOTICE: this version of Ruby cannot report on GC statistics.'
 
-      def gc_statistics_report(*args)
-        [ yield, nil ]
+      def gc_statistics_report(*)
+        [yield, nil]
       end
     end
 
@@ -85,21 +82,19 @@ module ActiveProfiling
     # with the GC statistics patch found here:
     #
     # http://blog.pluron.com/2008/02/memory-profilin.html
-    def gc_statistics(*args)
+    def gc_statistics(*args, &block)
       options = Rails.application.config.active_profiling.gc_statistics.merge(args.extract_options!)
 
-      result, gc_report = gc_statistics_report(options) do
-        yield
-      end
+      result, gc_report = gc_statistics_report(options, &block)
 
       ActiveSupport::Notifications.instrument('gc_statistics.active_profiling', {
-        :report => gc_report,
-        :title => options[:title] || args.first
+        report: gc_report,
+        title: options[:title] || args.first
       })
 
       result
     end
   end
 
-  self.extend(GCStatistics)
+  extend(GCStatistics)
 end

data/lib/active-profiling/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module ActiveProfiling
   class Railtie < Rails::Railtie
@@ -43,23 +44,23 @@ module ActiveProfiling
     #       :print_file => true
     #     }
     DEFAULT_PROFILER_OPTIONS = {
-      :enabled => false,
+      enabled: false,
 
-      :measure_mode => :process_time,
+      measure_mode: :process_time,
 
-      :disable_gc => true,
+      disable_gc: true,
 
-      :printer => :graph,
+      printer: :graph,
 
-      :call_tree_prefix => 'callgrind.out.',
+      call_tree_prefix: 'callgrind.out.',
 
-      :output => nil,
+      output: nil,
 
-      :log_level => :info,
+      log_level: :info,
 
-      :printer_options => {
-        :min_percent => 1,
-        :print_file => true
+      printer_options: {
+        min_percent: 1,
+        print_file: true
       }
     }.freeze
 
@@ -77,11 +78,11 @@ module ActiveProfiling
     #   whenever you need to and see results as you go.
     # * +:log_level+ - The log level to spit the GC statistics to.
     DEFAULT_GC_STATISTICS_OPTIONS = {
-      :enabled => false,
+      enabled: false,
 
-      :disable_gc => false,
+      disable_gc: false,
 
-      :log_level => :info
+      log_level: :info
     }.freeze
 
     # These settings are the default values used for the ActiveRecord
@@ -98,11 +99,11 @@ module ActiveProfiling
     #   /^#{Rails.root}(?!(\/vendor\/rails|\/\.bundle))/ so that only lines
     #   in your application code are logged.
     DEFAULT_AR_BACKTRACE_LOGGER_OPTIONS = {
-      :enabled => false,
+      enabled: false,
 
-      :verbose => false,
+      verbose: false,
 
-      :log_level => :debug
+      log_level: :debug
     }.freeze
 
     config.active_profiling = ActiveSupport::OrderedOptions.new
@@ -111,13 +112,13 @@ module ActiveProfiling
     config.active_profiling.active_record = ActiveSupport::OrderedOptions.new
     config.active_profiling.active_record.backtrace_logger = ActiveSupport::OrderedOptions.new
 
-    initializer "active_profiling.set_profiling_config" do |app|
+    initializer 'active_profiling.set_profiling_config' do |app|
       options = app.config.active_profiling
 
       options.profiler.reverse_merge!(DEFAULT_PROFILER_OPTIONS)
       options.gc_statistics.reverse_merge!(DEFAULT_GC_STATISTICS_OPTIONS)
       options.active_record.backtrace_logger.reverse_merge!(DEFAULT_AR_BACKTRACE_LOGGER_OPTIONS)
-      options.active_record.backtrace_logger[:matcher] ||= /^#{Rails.root}(?!(\/vendor\/rails|\/\.bundle))/
+      options.active_record.backtrace_logger[:matcher] ||= %r{#{Rails.root}(?!(/vendor/rails|/\.bundle))}
     end
   end
 end