test-prof 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e482ddcaca18180a0606f53fd51871ba132e4a5
-  data.tar.gz: cb321462168846d649df3237117451926a18398a
+  metadata.gz: 5c0da7ccf787bf83ee5ed43d069256d1183682ae
+  data.tar.gz: 44fd06ab01a79c6b499e4f9c36caaf56623df65c
 SHA512:
-  metadata.gz: a0d9c32fb4241f02f5d6fa3234543fca96abffbc5f968a7e67f9e23da8f41dea1990992e82c8e54cc46feb2af2c0ceac1d1a2ef7055a6784359bef67d97c485d
-  data.tar.gz: ad8a9004ee118da1fc8c9d2d32b290e8632ce0db0ac26803d2372fddf9efc898b28dd432f77ba89043a335724f2cddc9598742bca228486eb85e8ccea835437e
+  metadata.gz: 87ad75af611a473079d57cbe82d30a4c1a54eeb8d61a94190c72761c87ebad47bca6169b98f2fd84eda549c63dfce4d2dd9d11214a86a26ccebbec83895f53d4
+  data.tar.gz: 1cf076dc20db11b302d646ca8caf7379916b536ab24e42500cdb4378cbbc5cc74ba22411c8a15f024227023cc3bb8830c67d15e4e012ebc3099905470af17a5c

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change log
 
-## master
+## 0.2.4
+
+- EventProf: Fix regression bug with examples profiling. ([@palkan][])
+
+There was a bug when an event occurs before the example has started (e.g. in `before(:context)` hook).
+
+## 0.2.3
+
+- Minor improvements. ([@palkan][])
 
 ## 0.2.2
 

data/guides/event_prof.md

@@ -55,6 +55,8 @@ TestProf::EventProf.configure do |config|
 end
 ```
 
+Or provide the `EVENT_PROF_EXAMPLES=1` env variable.
+
 Another useful configuration parameter – `rank_by`. It's responsible for sorting stats – 
 either by the time spent in the event or by the number of occurrences:
 

data/guides/ruby_prof.md

@@ -9,7 +9,7 @@ Install `ruby-prof` gem (>= 0.16):
 ```ruby
 # Gemfile
 group :development, :test do
-  gem 'ruby-prof', require: false
+  gem 'ruby-prof', '>= 0.16.0', require: false
 end
 ```
 

data/guides/stack_prof.md

@@ -4,12 +4,12 @@
 
 ## Instructions
 
-Install 'stackprof' gem (>= 0.2.7):
+Install 'stackprof' gem (>= 0.2.9):
 
 ```ruby
 # Gemfile
 group :development, :test do
-  gem 'stackprof', require: false
+  gem 'stackprof', '>= 0.2.9', require: false
 end
 ```
 

data/lib/test_prof.rb

@@ -3,6 +3,7 @@
 require "fileutils"
 require "test_prof/version"
 require "test_prof/logging"
+require "test_prof/utils"
 
 # Ruby applications tests profiling tools.
 #
@@ -48,7 +49,7 @@ module TestProf
     # message if it fails to load
     def require(gem_name, msg)
       Kernel.require gem_name
-      true
+      block_given? ? yield : true
     rescue LoadError
       log :error, msg
       false

data/lib/test_prof/event_prof.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "test_prof/event_prof/instrumentations/active_support"
+require "test_prof/utils/sized_ordered_set"
 
 module TestProf
   # EventProf profiles your tests and suites against custom events,
@@ -19,6 +20,8 @@ module TestProf
   #  TestProf::EventProf.configure do |config|
   #    config.per_example = true
   #  end
+  #
+  # Or provide the EVENT_PROF_EXAMPLES=1 env variable.
   module EventProf
     # EventProf configuration
     class Configuration
@@ -34,7 +37,7 @@ module TestProf
         @event = ENV['EVENT_PROF']
         @instrumenter = :active_support
         @top_count = (ENV['EVENT_PROF_TOP'] || 5).to_i
-        @per_example = false
+        @per_example = ENV['EVENT_PROF_EXAMPLES'] == '1'
         @rank_by = (ENV['EVENT_PROF_RANK'] || :time).to_sym
       end
 
@@ -82,13 +85,16 @@ module TestProf
 
         instrumenter.subscribe(event) { |time| track(time) }
 
-        @groups = Hash.new { |h, k| h[k] = { id: k } }
-        @examples = Hash.new { |h, k| h[k] = { id: k } }
+        @groups = Utils::SizedOrderedSet.new(
+          top_count, sort_by: rank_by
+        )
+
+        @examples = Utils::SizedOrderedSet.new(
+          top_count, sort_by: rank_by
+        )
 
         @total_count = 0
         @total_time = 0.0
-
-        reset!
       end
 
       def track(time)
@@ -99,41 +105,47 @@ module TestProf
         @time += time
         @count += 1
 
-        @example_time += time if config.per_example?
-        @example_count += 1 if config.per_example?
+        return if @current_example.nil?
+
+        @example_time += time
+        @example_count += 1
       end
 
       def group_started(id)
-        reset!
+        reset_group!
         @current_group = id
       end
 
       def group_finished(id)
-        @groups[id][:time] = @time
-        @groups[id][:count] = @count
-        @groups[id][:examples] = @total_examples
+        data = { id: id, time: @time, count: @count, examples: @total_examples }
+
+        @groups << data unless data[rank_by].zero?
+
         @current_group = nil
       end
 
-      def example_started(_id)
+      def example_started(id)
+        return unless config.per_example?
         reset_example!
+        @current_example = id
       end
 
       def example_finished(id)
         @total_examples += 1
         return unless config.per_example?
 
-        @examples[id][:time] = @example_time
-        @examples[id][:count] = @example_count
+        data = { id: id, time: @example_time, count: @example_count }
+        @examples << data unless data[rank_by].zero?
+        @current_example = nil
       end
 
       def results
         {
-          groups: fetch_top(@groups.values)
+          groups: @groups.to_a
         }.tap do |data|
           next unless config.per_example?
 
-          data[:examples] = fetch_top(@examples.values)
+          data[:examples] = @examples.to_a
         end
       end
 
@@ -147,21 +159,14 @@ module TestProf
 
       private
 
-      def fetch_top(arr)
-        arr.reject { |el| el[rank_by].zero? }
-           .sort_by { |el| -el[rank_by] }
-           .take(top_count)
-      end
-
       def config
         EventProf.config
       end
 
-      def reset!
+      def reset_group!
         @time = 0.0
         @count = 0
         @total_examples = 0
-        reset_example!
       end
 
       def reset_example!

data/lib/test_prof/event_prof/rspec.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "test_prof/ext/float_duration"
+require "test_prof/ext/string_truncate"
 
 module TestProf
   module EventProf
     class RSpecListener # :nodoc:
       include Logging
       using FloatDuration
+      using StringTruncate
 
       NOTIFICATIONS = %i[
         example_group_started
@@ -59,7 +61,7 @@ module TestProf
 
           msgs <<
             <<~GROUP
-              #{description} (#{location}) – #{group[:time].duration} (#{group[:count]} / #{group[:examples]})
+              #{description.truncate} (#{location}) – #{group[:time].duration} (#{group[:count]} / #{group[:examples]})
             GROUP
         end
 
@@ -71,7 +73,7 @@ module TestProf
             location = example[:id].metadata[:location]
             msgs <<
               <<~GROUP
-                #{description} (#{location}) – #{example[:time].duration} (#{example[:count]})
+                #{description.truncate} (#{location}) – #{example[:time].duration} (#{example[:count]})
               GROUP
           end
         end

data/lib/test_prof/ext/float_duration.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# Add #duration method to floats
 module TestProf
   # Extend Float with #duration method
   module FloatDuration

data/lib/test_prof/ext/string_truncate.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module TestProf
+  # Extend String with #truncate method
+  module StringTruncate
+    refine String do
+      # Truncate to the specified limit
+      # by replacing middle part with dots
+      def truncate(limit = 30)
+        return self unless size > limit
+
+        head = ((limit - 3) / 2)
+        tail = head + 3 - limit
+
+        "#{self[0..(head - 1)]}...#{self[tail..-1]}"
+      end
+    end
+  end
+end

data/lib/test_prof/ruby_prof.rb

@@ -175,9 +175,20 @@ module TestProf
           <<~MSG
             Please, install 'ruby-prof' first:
                # Gemfile
-              gem 'ruby-prof', require: false
+              gem 'ruby-prof', '>= 0.16.0', require: false
           MSG
-        )
+        ) { check_ruby_prof_version }
+      end
+
+      def check_ruby_prof_version
+        if Utils.verify_gem_version('ruby-prof', at_least: '0.16.0')
+          true
+        else
+          log :error, <<~MGS
+            Please, upgrade 'ruby-prof' to version >= 0.16.0.
+          MGS
+          false
+        end
       end
     end
   end

data/lib/test_prof/stack_prof.rb

@@ -114,9 +114,20 @@ module TestProf
           <<~MSG
             Please, install 'stackprof' first:
                # Gemfile
-              gem 'stackprof', require: false
+              gem 'stackprof', '>= 0.2.9', require: false
           MSG
-        )
+        ) { check_stack_prof_version }
+      end
+
+      def check_stack_prof_version
+        if Utils.verify_gem_version('stackprof', at_least: '0.2.9')
+          true
+        else
+          log :error, <<~MGS
+            Please, upgrade 'stackprof' to version >= 0.2.9.
+          MGS
+          false
+        end
       end
     end
   end

data/lib/test_prof/utils.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Utils # :nodoc:
+    class << self
+      # Verify that loaded gem has correct version
+      def verify_gem_version(gem_name, at_least: nil, at_most: nil)
+        raise ArgumentError, "Please, provide `at_least` or `at_most` argument" if
+          at_least.nil? && at_most.nil?
+
+        version = Gem.loaded_specs[gem_name].version
+
+        (at_least.nil? || Gem::Version.new(at_least) <= version) &&
+          (at_most.nil? || Gem::Version.new(at_most) >= version)
+      end
+    end
+  end
+end

data/lib/test_prof/utils/sized_ordered_set.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Utils
+    # Ordered set with capacity
+    class SizedOrderedSet
+      include Enumerable
+
+      def initialize(max_size, sort_by: nil)
+        @max_size = max_size
+        @comparator =
+          if block_given?
+            Proc.new
+          elsif !sort_by.nil?
+            ->(x, y) { x[sort_by] >= y[sort_by] }
+          else
+            ->(x, y) { x >= y }
+          end
+        @data = []
+      end
+
+      def <<(item)
+        return if data.size == max_size &&
+                  comparator.call(data.last, item)
+
+        # Find an index of a smaller element
+        index = data.bsearch_index { |x| !comparator.call(x, item) }
+
+        if index.nil?
+          data << item
+        else
+          data.insert(index, item)
+        end
+
+        data.pop if data.size > max_size
+        data.size
+      end
+
+      def each
+        data.each
+      end
+
+      def size
+        data.size
+      end
+
+      def to_a
+        data
+      end
+
+      private
+
+      attr_reader :max_size, :data, :comparator
+    end
+  end
+end

data/lib/test_prof/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,7 @@ files:
 - lib/test_prof/event_prof/minitest.rb
 - lib/test_prof/event_prof/rspec.rb
 - lib/test_prof/ext/float_duration.rb
+- lib/test_prof/ext/string_truncate.rb
 - lib/test_prof/factory_default.rb
 - lib/test_prof/factory_default/factory_girl_patch.rb
 - lib/test_prof/factory_doctor.rb
@@ -167,6 +168,8 @@ files:
 - lib/test_prof/stack_prof/rspec.rb
 - lib/test_prof/tag_prof.rb
 - lib/test_prof/tag_prof/rspec.rb
+- lib/test_prof/utils.rb
+- lib/test_prof/utils/sized_ordered_set.rb
 - lib/test_prof/version.rb
 homepage: http://github.com/palkan/test-prof
 licenses: