test-prof 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf66f80707806f1378f3164e1376e6ee8fe5c3472d0704ef865de4939852283
-  data.tar.gz: 472ea3dde66363470b5e62995548760359f5ecd358b84099d12d9a622b36063d
+  metadata.gz: 19888b286ec85650d1d6c24c8d92ad1643e46cc506c2f9ce5e65c2f787f43949
+  data.tar.gz: ad6477b9980cd68782ceb2c2b138b9f01a3248f09ebf23e60acbe77e3124fc63
 SHA512:
-  metadata.gz: 4c21d8cae35943af31f72617a20b11d653ade888ba264c510dbe1fc365052a3ed7c7e04a7516b967a4f47dcb2442754a0d4e60053c385ae859963b666d239f9e
-  data.tar.gz: 7615a8bdb3d087c254333c265ffd759d13b51e76c6913d8e38a6856bdc036303f096ef2f2fb83c1b867024a87fe4989635105361103e85d7e1f4b14c0ae584bd
+  metadata.gz: 3da02b7d11494242e30360c10c2f69123e2c43f1b3e3ebd6edea567f4f298bb572daa726d8520d524602cb5b5ce2a6b8d68d59ad21238d9d6c1060b4d2132bf4
+  data.tar.gz: 9b5831c47845a4c4337898b5e1a58f495e60bca3e1726813b30469162544b77f715f4f0a07d901026d991304d65077abe16ae3d61c990d8fe136937e3cd4ceb3

data/CHANGELOG.md

@@ -2,6 +2,41 @@
 
 ## master (unreleased)
 
+## 0.10.0 (2019-08-19)
+
+- Use RSpec example ID instead of full description for RubyProf/Stackprof report names. ([@palkan][])
+
+  For more complex scenarios feel free to use your own report name generator:
+
+  ```ruby
+  # for RubyProf
+  TestProf::RubyProf::Listener.report_name_generator = ->(example) { "..." }
+  # for Stackprof
+  TestProf::StackProf::Listener.report_name_generator = ->(example) { "..." }
+  ```
+
+- Support arrays in `let_it_be` with modifiers. ([@palkan][])
+
+  ```ruby
+  # Now you can use modifiers with arrays
+  let_it_be(:posts, reload: true) { create_pair(:post) }
+  ```
+
+- Refactor `let_it_be` modifiers and allow adding custom modifiers. ([@palkan][])
+
+  ```ruby
+  TestProf::LetItBe.config.register_modifier :reload do |record, val|
+    # ignore when `reload: false`
+    next record unless val
+    # ignore non-ActiveRecord objects
+    next record unless record.is_a?(::ActiveRecord::Base)
+    record.reload
+  end
+  ```
+
+- Print warning when `ActiveRecordSharedConnection` is used in the version of Rails
+supporting `lock_threads` (5.1+). ([@palkan][])
+
 ## 0.9.0 (2019-05-14)
 
 - Add threshold and custom event support to FactoryDoctor. ([@palkan][])

data/README.md

@@ -21,26 +21,35 @@ TestProf toolbox aims to help you identify bottlenecks in your test suite. It co
 
 - ActiveSupport-backed profilers
 
+- RSpec and minitest [helpers](https://test-prof.evilmartians.io/#/?id=recipes) to write faster tests
+
 - RuboCop cops
 
 - etc.
 
-Of course, we have some [solutions](https://test-prof.evilmartians.io/#/?id=recipes) for common performance issues too, bundled into the gem.
-
-[![](./docs/assets/images/coggle.png)](http://bit.ly/test-prof-map)
-
 📑 [Documentation](https://test-prof.evilmartians.io)
 
-Supported Ruby versions:
-
-- Ruby (MRI) >= 2.4.0 (**NOTE:** for Ruby 2.2 use TestProf < 0.7.0 or Ruby 2.3 use TestProf ~> 0.7.0)
+<p align="center">
+  <a href="http://bit.ly/test-prof-map">
+    <img src="./docs/assets/images/coggle.png" alt="TestProf map" width="738">
+  </a>
+</p>
 
-- JRuby >= 9.1.0.0 (**NOTE:** refinements-dependent features might require 9.2.7+)
+<p align="center">
+  <a href="https://evilmartians.com/?utm_source=test-prof">
+    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg"
+         alt="Sponsored by Evil Martians" width="236" height="54">
+  </a>
+</p>
 
-Supported RSpec version (for RSpec features only): >= 3.5.0 (for older RSpec versions use TestProf < 0.8.0).
+## Who uses TestProf
 
-<a href="https://evilmartians.com/">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+- [Discourse](https://github.com/discourse/discourse) reduced [~27% of their test suite time](https://twitter.com/samsaffron/status/1125602558024699904)
+- [Gitlab](https://gitlab.com/gitlab-org/gitlab-ce) reduced [39% of their API tests time](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14370)
+- [CodeTriage](https://github.com/codetriage/codetriage)
+- [Dev.to](https://github.com/thepracticaldev/dev.to)
+- [Open Project](https://github.com/opf/openproject)
+- [...and others](https://github.com/palkan/test-prof/issues/73)
 
 ## Resources
 
@@ -70,6 +79,14 @@ end
 
 And that's it)
 
+Supported Ruby versions:
+
+- Ruby (MRI) >= 2.4.0 (**NOTE:** for Ruby 2.2 use TestProf < 0.7.0 or Ruby 2.3 use TestProf ~> 0.7.0)
+
+- JRuby >= 9.1.0.0 (**NOTE:** refinements-dependent features might require 9.2.7+)
+
+Supported RSpec version (for RSpec features only): >= 3.5.0 (for older RSpec versions use TestProf < 0.8.0).
+
 ## Usage
 
 Check out our [docs][].

data/lib/minitest/test_prof_plugin.rb

@@ -7,11 +7,11 @@ module Minitest # :nodoc:
   module TestProf # :nodoc:
     def self.configure_options(options = {})
       options.tap do |opts|
-        opts[:event]        = ENV["EVENT_PROF"] if ENV["EVENT_PROF"]
-        opts[:rank_by]      = ENV["EVENT_PROF_RANK"].to_sym if ENV["EVENT_PROF_RANK"]
-        opts[:top_count]    = ENV["EVENT_PROF_TOP"].to_i if ENV["EVENT_PROF_TOP"]
-        opts[:per_example]  = true if ENV["EVENT_PROF_EXAMPLES"]
-        opts[:fdoc]         = true if ENV["FDOC"]
+        opts[:event] = ENV["EVENT_PROF"] if ENV["EVENT_PROF"]
+        opts[:rank_by] = ENV["EVENT_PROF_RANK"].to_sym if ENV["EVENT_PROF_RANK"]
+        opts[:top_count] = ENV["EVENT_PROF_TOP"].to_i if ENV["EVENT_PROF_TOP"]
+        opts[:per_example] = true if ENV["EVENT_PROF_EXAMPLES"]
+        opts[:fdoc] = true if ENV["FDOC"]
       end
     end
   end

data/lib/test_prof.rb

@@ -130,9 +130,9 @@ module TestProf
 
   # TestProf configuration
   class Configuration
-    attr_accessor :output,       # IO to write output messages.
-                  :color,        # Whether to colorize output or not
-                  :output_dir,   # Directory to store artifacts
+    attr_accessor :output, # IO to write output messages.
+                  :color, # Whether to colorize output or not
+                  :output_dir, # Directory to store artifacts
                   :timestamps, # Whethere to use timestamped names for artifacts,
                   :report_suffix # Custom suffix for reports/artifacts
 

data/lib/test_prof/ext/string_parameterize.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module TestProf
+  # Extend String with #parameterize method
+  module StringParameterize
+    refine String do
+      # Replaces special characters in a string with dashes.
+      def parameterize(separator: "-", preserve_case: false)
+        gsub(/[^a-z0-9\-_]+/i, separator).tap do |str|
+          str.downcase! unless preserve_case
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/factory_doctor.rb

@@ -146,7 +146,7 @@ module TestProf
       def subscribe!
         ::ActiveSupport::Notifications.subscribe(config.event) do |_name, _start, _finish, _id, query|
           next if ignore? || !running? || within_factory?
-          next if query[:sql] =~ IGNORED_QUERIES_PATTERN
+          next if IGNORED_QUERIES_PATTERN.match?(query[:sql])
           @queries_count += 1
         end
       end

data/lib/test_prof/recipes/active_record_shared_connection.rb

@@ -65,6 +65,13 @@ module TestProf
 end
 
 ActiveSupport.on_load(:active_record) do
+  if ::ActiveRecord::Base.connection.pool.respond_to?(:lock_thread=)
+    TestProf.log :warn, "You activated ActiveRecordSharedConnection patch for the Rails version,\n" \
+                        "which has a built-in support for the same functionality.\n" \
+                        "Consider removing it, 'cause this could result in unexpected behaviour.\n\n" \
+                        "Read more in the docs: https://test-prof.evilmartians.io/#/active_record_shared_connection"
+  end
+
   TestProf::ActiveRecordSharedConnection.enable!
   ActiveRecord::Base.singleton_class.prepend TestProf::ActiveRecordSharedConnection::Ext
 end

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

@@ -4,6 +4,15 @@ require "test_prof"
 require_relative "./before_all"
 
 module TestProf
+  # Add `#map` to Object as an alias for `then` to use in modifiers
+  using(Module.new do
+    refine Object do
+      def map
+        yield self
+      end
+    end
+  end)
+
   # Just like `let`, but persist the result for the whole group.
   # NOTE: Experimental and magical, for more control use `before_all`.
   module LetItBe
@@ -16,6 +25,12 @@ module TestProf
       def alias_to(name, **default_args)
         LetItBe.define_let_it_be_alias(name, **default_args)
       end
+
+      def register_modifier(key, &block)
+        raise ArgumentError, "Modifier #{key} is already defined for let_it_be" if LetItBe.modifiers.key?(key)
+
+        LetItBe.modifiers[key] = block
+      end
     end
 
     class << self
@@ -27,6 +42,24 @@ module TestProf
         yield config
       end
 
+      def modifiers
+        @modifiers ||= {}
+      end
+
+      def wrap_with_modifiers(mods, &block)
+        validate_modifiers! mods
+
+        return block if mods.empty?
+
+        -> {
+          instance_eval(&block).map do |record|
+            mods.inject(record) do |rec, (k, v)|
+              LetItBe.modifiers.fetch(k).call(rec, v)
+            end
+          end
+        }
+      end
+
       def module_for(group)
         modules[group] ||= begin
           Module.new.tap { |mod| group.prepend(mod) }
@@ -38,6 +71,14 @@ module TestProf
       def modules
         @modules ||= {}
       end
+
+      def validate_modifiers!(mods)
+        unknown = mods.keys - modifiers.keys
+        return if unknown.empty?
+
+        raise ArgumentError, "Unknown let_it_be modifiers were used: #{unknown.join(", ")}. " \
+                             "Available modifiers are: #{modifiers.keys.join(", ")}"
+      end
     end
     # Use uniq prefix for instance variables to avoid collisions
     # We want to use the power of Ruby's unicode support)
@@ -64,24 +105,9 @@ module TestProf
       define_let_it_be_methods(identifier, **options)
     end
 
-    def define_let_it_be_methods(identifier, reload: false, refind: false)
-      let_accessor = -> { instance_variable_get(:"#{PREFIX}#{identifier}") }
-
-      if reload
-        let_accessor = lambda do
-          record = instance_variable_get(:"#{PREFIX}#{identifier}")
-          next unless record.is_a?(::ActiveRecord::Base)
-          record.reload
-        end
-      end
-
-      if refind
-        let_accessor = lambda do
-          record = instance_variable_get(:"#{PREFIX}#{identifier}")
-          next unless record.is_a?(::ActiveRecord::Base)
-
-          record.class.find(record.send(record.class.primary_key))
-        end
+    def define_let_it_be_methods(identifier, **modifiers)
+      let_accessor = LetItBe.wrap_with_modifiers(modifiers) do
+        instance_variable_get(:"#{PREFIX}#{identifier}")
       end
 
       LetItBe.module_for(self).module_eval do
@@ -101,4 +127,21 @@ module TestProf
   end
 end
 
+require "test_prof/ext/active_record_refind"
+using TestProf::Ext::ActiveRecordRefind
+
+TestProf::LetItBe.configure do |config|
+  config.register_modifier :reload do |record, val|
+    next record unless val
+    next record unless record.is_a?(::ActiveRecord::Base)
+    record.reload
+  end
+
+  config.register_modifier :refind do |record, val|
+    next record unless val
+    next record unless record.is_a?(::ActiveRecord::Base)
+    record.refind
+  end
+end
+
 RSpec::Core::ExampleGroup.extend TestProf::LetItBe

data/lib/test_prof/ruby_prof/rspec.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
+require "test_prof/utils/rspec"
+
 module TestProf
   module RubyProf
     # Reporter for RSpec to profile specific examples with RubyProf
     class Listener # :nodoc:
+      class << self
+        attr_accessor :report_name_generator
+      end
+
+      self.report_name_generator = Utils::RSpec.method(:example_to_filename)
+
       NOTIFICATIONS = %i[
         example_started
         example_finished
@@ -18,7 +26,7 @@ module TestProf
       def example_finished(notification)
         return unless profile?(notification.example)
         notification.example.metadata[:rprof_report]&.dump(
-          notification.example.full_description.parameterize
+          self.class.report_name_generator.call(notification.example)
         )
       end
 

data/lib/test_prof/stack_prof/rspec.rb

@@ -1,9 +1,17 @@
 # frozen_string_literal: true
 
+require "test_prof/utils/rspec"
+
 module TestProf
   module StackProf
     # Reporter for RSpec to profile specific examples with StackProf
     class Listener # :nodoc:
+      class << self
+        attr_accessor :report_name_generator
+      end
+
+      self.report_name_generator = Utils::RSpec.method(:example_to_filename)
+
       NOTIFICATIONS = %i[
         example_started
         example_finished
@@ -19,7 +27,7 @@ module TestProf
         return unless notification.example.metadata[:sprof_report] == false
 
         TestProf::StackProf.dump(
-          notification.example.full_description.parameterize
+          self.class.report_name_generator.call(notification.example)
         )
       end
 

data/lib/test_prof/utils/rspec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+unless "".respond_to?(:parameterize)
+  require "test_prof/ext/string_parameterize"
+  using TestProf::StringParameterize
+end
+
+module TestProf
+  module Utils
+    module RSpec
+      class << self
+        def example_to_filename(example)
+          ::RSpec::Core::Metadata.id_from(example.metadata).parameterize
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.39
+        version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.39
+        version: 0.1.0
 description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
   to analyze factories usage, integrate with Ruby profilers,\n    profile your examples
   using ActiveSupport notifications (if any) and\n    statically analyze your code
@@ -158,6 +158,7 @@ files:
 - lib/test_prof/ext/array_bsearch_index.rb
 - lib/test_prof/ext/factory_bot_strategy.rb
 - lib/test_prof/ext/float_duration.rb
+- lib/test_prof/ext/string_parameterize.rb
 - lib/test_prof/ext/string_truncate.rb
 - lib/test_prof/factory_all_stub.rb
 - lib/test_prof/factory_all_stub/factory_bot_patch.rb
@@ -209,6 +210,7 @@ files:
 - lib/test_prof/tag_prof/rspec.rb
 - lib/test_prof/utils.rb
 - lib/test_prof/utils/html_builder.rb
+- lib/test_prof/utils/rspec.rb
 - lib/test_prof/utils/sized_ordered_set.rb
 - lib/test_prof/version.rb
 homepage: http://github.com/palkan/test-prof
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools