test-prof 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13127b82bf827a56e15c8d060ff5a8e5be791e16deea31e899d88ecd7b76bb38
-  data.tar.gz: 1ae017bc058b3017355c75fd871c17aad9ec3649f7b982af062d606b93d9fe2c
+  metadata.gz: 9571b8fb7edc3bb1f92d9a6db079791a97c3cbeb11a29763ddc3e9f88bd5780a
+  data.tar.gz: 4011afa256c8a5f250a6a62e9745ed254f5fe020a366e3b3e4c0a91afb227d68
 SHA512:
-  metadata.gz: b272b01aca1fb3bf9328fcd97fc148f5f329acf66650337071568aff6e20e1f3f95c066295df4777a7bd401976879bdddb3ff43fb2ce5093bca261fe65c07a94
-  data.tar.gz: 309644b36e328286ea52705196daa99e8af2f5237cf27f33ffa0091961f642eb29da73bcf48cb05e51896e3bfe9d709a1c08cbc1cfcd9abae1b429674a98fb2b
+  metadata.gz: 9008e4dbd6131efde863a100447d0658663cfbea0486e3043664ddadff097f652230ddb162ee85893883eaf49c54ddeba806ba30563199857848466786e91d34
+  data.tar.gz: f86145f0d6539f6de7b3cedd315583d977df01e7e64ff22c8300bbc7f29bfd946e9f738d3b3388696c3344a8ab9e444371993e90b79f204cacf06846d314b930

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+## 1.2.3 (2023-09-11)
+
+- Minor fixes and dependecies upgrades.
+
 ## 1.2.2 (2023-06-27)
 
 - Ignore inaccessible connection pools in `before_all`. ([@bf4][])

data/lib/test_prof/any_fixture/dump/sqlite.rb

@@ -18,7 +18,7 @@ module TestProf
         end
 
         def compile_sql(sql, binds)
-          sql.gsub(/\?/) { binds.shift.gsub("\n", "' || char(10) || '") }
+          sql.gsub("?") { binds.shift.gsub("\n", "' || char(10) || '") }
         end
 
         def import(path)

data/lib/test_prof/any_fixture.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof"
+require "test_prof/core"
 require "test_prof/ext/float_duration"
 require "test_prof/any_fixture/dump"
 

data/lib/test_prof/before_all.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof"
+require "test_prof/core"
 
 module TestProf
   # `before_all` helper configuration

data/lib/test_prof/core.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "logger"
+
+require "test_prof/logging"
+require "test_prof/utils"
+
+# Ruby applications tests profiling tools.
+#
+# Contains tools to analyze factories usage, integrate with Ruby profilers,
+# profile your examples using ActiveSupport notifications (if any) and
+# statically analyze your code with custom RuboCop cops.
+#
+# Example usage:
+#
+#   require 'test_prof'
+#
+#   # Activate a tool by providing environment variable, e.g.
+#   TEST_RUBY_PROF=1 rspec ...
+#
+#   # or manually in your code
+#   TestProf::RubyProf.run
+#
+# See other modules for more examples.
+module TestProf
+  class << self
+    include Logging
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    # Returns true if we're inside RSpec
+    def rspec?
+      defined?(RSpec::Core)
+    end
+
+    # Returns true if we're inside Minitest
+    def minitest?
+      defined?(Minitest)
+    end
+
+    # Returns true if Spring is used and not disabled
+    def spring?
+      # See https://github.com/rails/spring/blob/577cf01f232bb6dbd0ade7df2df2ac209697e741/lib/spring/binstub.rb
+      disabled = ENV["DISABLE_SPRING"]
+      defined?(::Spring::Application) && (disabled.nil? || disabled.empty? || disabled == "0")
+    end
+
+    # Returns the current process time
+    def now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    # Require gem and shows a custom
+    # message if it fails to load
+    def require(gem_name, msg = nil)
+      Kernel.require gem_name
+      block_given? ? yield : true
+    rescue LoadError
+      log(:error, msg) if msg
+      false
+    end
+
+    # Run block only if provided env var is present and
+    # equal to the provided value (if any).
+    # Contains workaround for applications using Spring.
+    def activate(env_var, val = nil)
+      if spring?
+        notify_spring_detected
+        ::Spring.after_fork do
+          activate!(env_var, val) do
+            notify_spring_activate env_var
+            yield
+          end
+        end
+      else
+        activate!(env_var, val) { yield }
+      end
+    end
+
+    # Return absolute path to asset
+    def asset_path(filename)
+      ::File.expand_path(filename, ::File.join(::File.dirname(__FILE__), "..", "..", "assets"))
+    end
+
+    # Return a path to store artifact
+    def artifact_path(filename)
+      create_artifact_dir
+
+      with_timestamps(
+        ::File.join(
+          config.output_dir,
+          with_report_suffix(
+            filename
+          )
+        )
+      )
+    end
+
+    def create_artifact_dir
+      FileUtils.mkdir_p(config.output_dir)[0]
+    end
+
+    private
+
+    def activate!(env_var, val)
+      yield if ENV[env_var] && (val.nil? || val === ENV[env_var])
+    end
+
+    def with_timestamps(path)
+      return path unless config.timestamps?
+      timestamps = "-#{now.to_i}"
+      "#{path.sub(/\.\w+$/, "")}#{timestamps}#{::File.extname(path)}"
+    end
+
+    def with_report_suffix(path)
+      return path if config.report_suffix.nil?
+
+      "#{path.sub(/\.\w+$/, "")}-#{config.report_suffix}#{::File.extname(path)}"
+    end
+
+    def notify_spring_detected
+      return if instance_variable_defined?(:@spring_notified)
+      log :info, "Spring detected"
+      @spring_notified = true
+    end
+
+    def notify_spring_activate(env_var)
+      log :info, "Activating #{env_var} with `Spring.after_fork`"
+    end
+  end
+
+  # TestProf configuration
+  class Configuration
+    attr_accessor :output, # IO to write logs
+      :color, # Whether to colorize output or not
+      :output_dir, # Directory to store artifacts
+      :timestamps, # Whether to use timestamped names for artifacts,
+      :report_suffix # Custom suffix for reports/artifacts
+
+    def initialize
+      @output = $stdout
+      @color = true
+      @output_dir = "tmp/test_prof"
+      @timestamps = false
+      @report_suffix = ENV["TEST_PROF_REPORT"]
+    end
+
+    def color?
+      color == true && output.is_a?(IO) && output.tty?
+    end
+
+    def timestamps?
+      timestamps == true
+    end
+
+    def logger
+      @logger ||= Logger.new(output, formatter: Logging::Formatter.new)
+    end
+  end
+end

data/lib/test_prof/factory_all_stub.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof"
+require "test_prof/core"
 require "test_prof/factory_bot"
 require "test_prof/factory_all_stub/factory_bot_patch"
 

data/lib/test_prof/factory_default.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof"
+require "test_prof/core"
 require "test_prof/factory_bot"
 require "test_prof/factory_default/factory_bot_patch"
 require "test_prof/ext/float_duration"

data/lib/test_prof/recipes/logging.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof"
+require "test_prof/core"
 
 module TestProf
   module Rails

data/lib/test_prof/recipes/minitest/sample.rb

@@ -6,9 +6,9 @@ module TestProf
     # Do not add these classes to resulted sample
     CORE_RUNNABLES = [
       Minitest::Test,
-      Minitest::Unit::TestCase,
+      defined?(Minitest::Unit::TestCase) ? Minitest::Unit::TestCase : nil,
       Minitest::Spec
-    ].freeze
+    ].compact.freeze
 
     class << self
       def suites

data/lib/test_prof/recipes/rspec/let_it_be.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof"
+require "test_prof/core"
 require "test_prof/recipes/rspec/before_all"
 
 module TestProf

data/lib/test_prof/ruby_prof.rb

@@ -53,7 +53,7 @@ module TestProf
       def initialize
         @printer = ENV["TEST_RUBY_PROF"].to_sym if PRINTERS.key?(ENV["TEST_RUBY_PROF"])
         @printer ||= ENV.fetch("TEST_RUBY_PROF_PRINTER", :flat).to_sym
-        @mode = ENV.fetch("TEST_RUBY_PROF_MODE", :wall).to_sym
+        @mode = ENV.fetch("TEST_RUBY_PROF_MODE", :wall).to_s
         @min_percent = 1
         @include_threads = false
         @exclude_common_methods = true
@@ -84,6 +84,22 @@ module TestProf
 
         [type, ::RubyProf.const_get(PRINTERS[type])]
       end
+
+      # Based on deprecated https://github.com/ruby-prof/ruby-prof/blob/fd3a5236a459586c5ca7ce4de506c1835129516a/lib/ruby-prof.rb#L36
+      def ruby_prof_mode
+        case mode
+        when "wall", "wall_time"
+          ::RubyProf::WALL_TIME
+        when "allocations"
+          ::RubyProf::ALLOCATIONS
+        when "memory"
+          ::RubyProf::MEMORY
+        when "process", "process_time"
+          ::RubyProf::PROCESS_TIME
+        else
+          ::RubyProf::WALL_TIME
+        end
+      end
     end
 
     # Wrapper over RubyProf profiler and printer
@@ -166,7 +182,7 @@ module TestProf
           log :warn, <<~MSG
             RubyProf is activated globally, you cannot generate per-example report.
 
-            Make sure you haven's set the TEST_RUBY_PROF environmental variable.
+            Make sure you haven't set the TEST_RUBY_PROF environmental variable.
           MSG
           return
         end
@@ -177,6 +193,7 @@ module TestProf
 
         options[:include_threads] = [Thread.current] unless
           config.include_threads?
+        options[:measure_mode] = config.ruby_prof_mode
 
         profiler = ::RubyProf::Profile.new(options)
         profiler.exclude_common_methods! if config.exclude_common_methods?
@@ -206,7 +223,6 @@ module TestProf
 
       def init_ruby_prof
         return @initialized if instance_variable_defined?(:@initialized)
-        ENV["RUBY_PROF_MEASURE_MODE"] = config.mode.to_s
         @initialized = TestProf.require(
           "ruby-prof",
           <<~MSG

data/lib/test_prof/stack_prof.rb

@@ -83,7 +83,7 @@ module TestProf
           log :warn, <<~MSG
             StackProf is activated globally, you cannot generate per-example report.
 
-            Make sure you haven's set the TEST_STACK_PROF environmental variable.
+            Make sure you haven't set the TEST_STACK_PROF environmental variable.
           MSG
           return false
         end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

data/lib/test_prof.rb

@@ -1,171 +1,7 @@
 # frozen_string_literal: true
 
-require "fileutils"
-require "logger"
-
 require "test_prof/version"
-require "test_prof/logging"
-require "test_prof/utils"
-
-# Ruby applications tests profiling tools.
-#
-# Contains tools to analyze factories usage, integrate with Ruby profilers,
-# profile your examples using ActiveSupport notifications (if any) and
-# statically analyze your code with custom RuboCop cops.
-#
-# Example usage:
-#
-#   require 'test_prof'
-#
-#   # Activate a tool by providing environment variable, e.g.
-#   TEST_RUBY_PROF=1 rspec ...
-#
-#   # or manually in your code
-#   TestProf::RubyProf.run
-#
-# See other modules for more examples.
-module TestProf
-  class << self
-    include Logging
-
-    def config
-      @config ||= Configuration.new
-    end
-
-    def configure
-      yield config
-    end
-
-    # Returns true if we're inside RSpec
-    def rspec?
-      defined?(RSpec::Core)
-    end
-
-    # Returns true if we're inside Minitest
-    def minitest?
-      defined?(Minitest)
-    end
-
-    # Returns true if Spring is used and not disabled
-    def spring?
-      # See https://github.com/rails/spring/blob/577cf01f232bb6dbd0ade7df2df2ac209697e741/lib/spring/binstub.rb
-      disabled = ENV["DISABLE_SPRING"]
-      defined?(::Spring::Application) && (disabled.nil? || disabled.empty? || disabled == "0")
-    end
-
-    # Returns the current process time
-    def now
-      Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    end
-
-    # Require gem and shows a custom
-    # message if it fails to load
-    def require(gem_name, msg = nil)
-      Kernel.require gem_name
-      block_given? ? yield : true
-    rescue LoadError
-      log(:error, msg) if msg
-      false
-    end
-
-    # Run block only if provided env var is present and
-    # equal to the provided value (if any).
-    # Contains workaround for applications using Spring.
-    def activate(env_var, val = nil)
-      if spring?
-        notify_spring_detected
-        ::Spring.after_fork do
-          activate!(env_var, val) do
-            notify_spring_activate env_var
-            yield
-          end
-        end
-      else
-        activate!(env_var, val) { yield }
-      end
-    end
-
-    # Return absolute path to asset
-    def asset_path(filename)
-      ::File.expand_path(filename, ::File.join(::File.dirname(__FILE__), "..", "assets"))
-    end
-
-    # Return a path to store artifact
-    def artifact_path(filename)
-      create_artifact_dir
-
-      with_timestamps(
-        ::File.join(
-          config.output_dir,
-          with_report_suffix(
-            filename
-          )
-        )
-      )
-    end
-
-    def create_artifact_dir
-      FileUtils.mkdir_p(config.output_dir)[0]
-    end
-
-    private
-
-    def activate!(env_var, val)
-      yield if ENV[env_var] && (val.nil? || val === ENV[env_var])
-    end
-
-    def with_timestamps(path)
-      return path unless config.timestamps?
-      timestamps = "-#{now.to_i}"
-      "#{path.sub(/\.\w+$/, "")}#{timestamps}#{::File.extname(path)}"
-    end
-
-    def with_report_suffix(path)
-      return path if config.report_suffix.nil?
-
-      "#{path.sub(/\.\w+$/, "")}-#{config.report_suffix}#{::File.extname(path)}"
-    end
-
-    def notify_spring_detected
-      return if instance_variable_defined?(:@spring_notified)
-      log :info, "Spring detected"
-      @spring_notified = true
-    end
-
-    def notify_spring_activate(env_var)
-      log :info, "Activating #{env_var} with `Spring.after_fork`"
-    end
-  end
-
-  # TestProf configuration
-  class Configuration
-    attr_accessor :output, # IO to write logs
-      :color, # Whether to colorize output or not
-      :output_dir, # Directory to store artifacts
-      :timestamps, # Whether to use timestamped names for artifacts,
-      :report_suffix # Custom suffix for reports/artifacts
-
-    def initialize
-      @output = $stdout
-      @color = true
-      @output_dir = "tmp/test_prof"
-      @timestamps = false
-      @report_suffix = ENV["TEST_PROF_REPORT"]
-    end
-
-    def color?
-      color == true && output.is_a?(IO) && output.tty?
-    end
-
-    def timestamps?
-      timestamps == true
-    end
-
-    def logger
-      @logger ||= Logger.new(output, formatter: Logging::Formatter.new)
-    end
-  end
-end
+require "test_prof/core"
 
 require "test_prof/ruby_prof"
 require "test_prof/stack_prof"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ files:
 - lib/test_prof/cops/rspec/aggregate_examples/metadata_helpers.rb
 - lib/test_prof/cops/rspec/aggregate_examples/node_matchers.rb
 - lib/test_prof/cops/rspec/language.rb
+- lib/test_prof/core.rb
 - lib/test_prof/event_prof.rb
 - lib/test_prof/event_prof/custom_events.rb
 - lib/test_prof/event_prof/custom_events/factory_create.rb