test-prof 0.4.9 → 0.5.0.pre1

data/lib/test_prof/tag_prof/result.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module TestProf
+  module TagProf # :nodoc:
+    # Object holding all the stats for tags
+    class Result
+      attr_reader :tag, :data, :events
+
+      def initialize(tag, events = [])
+        @tag = tag
+        @events = events
+
+        @data = Hash.new do |h, k|
+          h[k] = { value: k, count: 0, time: 0.0 }
+          h[k].merge!(Hash[events.map { |event| [event, 0.0] }]) unless
+            events.empty?
+          h[k]
+        end
+      end
+
+      def track(tag, time:, events: {})
+        data[tag][:count] += 1
+        data[tag][:time] += time
+        events.each do |k, v|
+          data[tag][k] += v
+        end
+      end
+
+      def to_json
+        {
+          tag: tag,
+          data: data.values,
+          events: events
+        }.to_json
+      end
+    end
+  end
+end

data/lib/test_prof/tag_prof/rspec.rb

@@ -1,14 +1,9 @@
 # frozen_string_literal: true
 
-require "test_prof/ext/float_duration"
-require "test_prof/ext/string_strip_heredoc"
-
 module TestProf
   module TagProf
     class RSpecListener # :nodoc:
       include Logging
-      using FloatDuration
-      using StringStripHeredoc
 
       NOTIFICATIONS = %i[
         example_started
@@ -16,58 +11,58 @@ module TestProf
         example_passed
       ].freeze
 
+      attr_reader :result, :printer
+
       def initialize
-        @tag = ENV['TAG_PROF'].to_sym
-        @tags = Hash.new { |h, k| h[k] = { val: k, count: 0, time: 0.0 } }
+        @printer = ENV['TAG_PROF_FORMAT'] == 'html' ? Printers::HTML : Printers::Simple
+
+        @result =
+          if ENV['TAG_PROF_EVENT'].nil?
+            Result.new ENV['TAG_PROF'].to_sym
+          else
+            require "test_prof/event_prof"
+
+            @events_profiler = EventProf.build(ENV['TAG_PROF_EVENT'])
 
-        log :info, "TagProf enabled (#{@tag})"
+            Result.new ENV['TAG_PROF'].to_sym, @events_profiler.events
+          end
+
+        log :info, "TagProf enabled (#{result.tag})"
       end
 
       def example_started(_notification)
         @ts = TestProf.now
+        # enable event profiling
+        @events_profiler.group_started(true) if @events_profiler
       end
 
       def example_finished(notification)
-        tag = notification.example.metadata.fetch(@tag, :__unknown__)
+        tag = notification.example.metadata.fetch(result.tag, :__unknown__)
+
+        result.track(tag, time: TestProf.now - @ts, events: fetch_events_data)
 
-        @tags[tag][:count] += 1
-        @tags[tag][:time] += (TestProf.now - @ts)
+        # reset and disable event profilers
+        @events_profiler.group_started(nil) if @events_profiler
       end
 
       # NOTE: RSpec < 3.4.0 doesn't have example_finished event
       alias example_passed example_finished
       alias example_failed example_finished
 
-      def print
-        msgs = []
-
-        msgs <<
-          <<-MSG.strip_heredoc
-            TagProf report for #{@tag}
-          MSG
-
-        msgs << format(
-          "%15s  %12s  %6s  %6s  %6s  %12s",
-          @tag,
-          'time', 'total', '%total', '%time', 'avg'
-        )
-
-        msgs << ""
+      def report
+        printer.dump(result)
+      end
 
-        total = @tags.values.inject(0) { |acc, v| acc + v[:count] }
-        total_time = @tags.values.inject(0) { |acc, v| acc + v[:time] }
+      private
 
-        @tags.values.sort_by { |v| -v[:time] }.each do |tag|
-          msgs << format(
-            "%15s  %12s  %6d  %6.2f  %6.2f  %12s",
-            tag[:val], tag[:time].duration, tag[:count],
-            100 * tag[:count].to_f / total,
-            100 * tag[:time] / total_time,
-            (tag[:time] / tag[:count]).duration
-          )
-        end
+      def fetch_events_data
+        return {} unless @events_profiler
 
-        log :info, msgs.join("\n")
+        Hash[
+          @events_profiler.profilers.map do |profiler|
+            [profiler.event, profiler.time]
+          end
+        ]
       end
     end
   end
@@ -76,14 +71,22 @@ end
 # Register TagProf listener
 TestProf.activate('TAG_PROF') do
   RSpec.configure do |config|
-    listener = TestProf::TagProf::RSpecListener.new
+    listener = nil
 
     config.before(:suite) do
+      listener = TestProf::TagProf::RSpecListener.new
       config.reporter.register_listener(
         listener, *TestProf::TagProf::RSpecListener::NOTIFICATIONS
       )
     end
 
-    config.after(:suite) { listener.print }
+    config.after(:suite) { listener.report unless listener.nil? }
   end
 end
+
+# Activate custom events
+TestProf.activate('TAG_PROF_EVENT') do
+  require "test_prof/event_prof"
+
+  TestProf::EventProf::CustomEvents.activate_all(ENV['TAG_PROF_EVENT'])
+end

data/lib/test_prof/utils/html_builder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "json"
+
+module TestProf
+  module Utils
+    # Generates static HTML reports with injected data
+    module HTMLBuilder
+      class << self
+        def generate(data:, template:, output:)
+          template = File.read(TestProf.asset_path(template))
+          template.sub! '/**REPORT-DATA**/', data.to_json
+
+          outpath = TestProf.artifact_path(output)
+          File.write(outpath, template)
+          outpath
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.4.9".freeze
+  VERSION = "0.5.0.pre1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0.pre1
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.56.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.56.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,6 @@ files:
 - README.md
 - assets/flamegraph.demo.html
 - assets/flamegraph.template.html
-- assets/logo.svg
 - assets/src/d3-tip.js
 - assets/src/d3-tip.min.js
 - assets/src/d3.flameGraph.css
@@ -117,28 +116,15 @@ files:
 - assets/src/d3.flameGraph.min.css
 - assets/src/d3.flameGraph.min.js
 - assets/src/d3.v4.min.js
-- assets/testprof.png
-- guides/.rubocop.yml
-- guides/any_fixture.md
-- guides/before_all.md
-- guides/event_prof.md
-- guides/factory_default.md
-- guides/factory_doctor.md
-- guides/factory_prof.md
-- guides/let_it_be.md
-- guides/rspec_dissect.md
-- guides/rspec_stamp.md
-- guides/rubocop.md
-- guides/ruby_prof.md
-- guides/stack_prof.md
-- guides/tag_prof.md
-- guides/tests_sampling.md
+- assets/tagprof.demo.html
+- assets/tagprof.template.html
 - lib/minitest/base_reporter.rb
 - lib/minitest/event_prof_formatter.rb
 - lib/minitest/test_prof_plugin.rb
 - lib/test-prof.rb
 - lib/test_prof.rb
 - lib/test_prof/any_fixture.rb
+- lib/test_prof/any_fixture/dsl.rb
 - lib/test_prof/cops/rspec/aggregate_failures.rb
 - lib/test_prof/event_prof.rb
 - lib/test_prof/event_prof/custom_events.rb
@@ -147,12 +133,15 @@ files:
 - lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb
 - lib/test_prof/event_prof/instrumentations/active_support.rb
 - lib/test_prof/event_prof/minitest.rb
+- lib/test_prof/event_prof/profiler.rb
 - lib/test_prof/event_prof/rspec.rb
 - lib/test_prof/ext/active_record_3.rb
 - lib/test_prof/ext/array_bsearch_index.rb
 - lib/test_prof/ext/float_duration.rb
 - lib/test_prof/ext/string_strip_heredoc.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
 - lib/test_prof/factory_bot.rb
 - lib/test_prof/factory_default.rb
 - lib/test_prof/factory_default/factory_bot_patch.rb
@@ -168,9 +157,12 @@ files:
 - lib/test_prof/factory_prof/printers/flamegraph.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
+- lib/test_prof/recipes/active_record_shared_connection.rb
+- lib/test_prof/recipes/logging.rb
 - lib/test_prof/recipes/minitest/sample.rb
 - lib/test_prof/recipes/rspec/any_fixture.rb
 - lib/test_prof/recipes/rspec/before_all.rb
+- lib/test_prof/recipes/rspec/factory_all_stub.rb
 - lib/test_prof/recipes/rspec/factory_default.rb
 - lib/test_prof/recipes/rspec/let_it_be.rb
 - lib/test_prof/recipes/rspec/sample.rb
@@ -185,8 +177,12 @@ files:
 - lib/test_prof/stack_prof.rb
 - lib/test_prof/stack_prof/rspec.rb
 - lib/test_prof/tag_prof.rb
+- lib/test_prof/tag_prof/printers/html.rb
+- lib/test_prof/tag_prof/printers/simple.rb
+- lib/test_prof/tag_prof/result.rb
 - lib/test_prof/tag_prof/rspec.rb
 - lib/test_prof/utils.rb
+- lib/test_prof/utils/html_builder.rb
 - lib/test_prof/utils/sized_ordered_set.rb
 - lib/test_prof/version.rb
 homepage: http://github.com/palkan/test-prof
@@ -204,12 +200,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools

data/assets/logo.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 86 100"><defs><linearGradient id="a" x1="43" y1="100" x2="43" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#b5afbf"/><stop offset="1" stop-color="#dbd1d6"/></linearGradient><linearGradient id="b" x1="16" y1="87" x2="16" y2="73" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#a99ea7"/><stop offset=".6" stop-color="#c8b8c1"/></linearGradient><linearGradient id="c" x1="14" y1="75" x2="14" y2="79" xlink:href="#linear-gradient-2"/><linearGradient id="d" x1="34" x2="34" xlink:href="#linear-gradient-2"/><linearGradient id="e" x1="36" y1="79" x2="36" y2="83" xlink:href="#linear-gradient-2"/></defs><rect fill="url(#a)" width="86" height="100" rx="13" ry="13"/><rect fill="#fef7f9" x="1" y="1" width="84" height="94" rx="12" ry="12"/><path fill="#fff" d="M73 1H13A12 12 0 0 0 1 13v1A12 12 0 0 1 13 2h60a12 12 0 0 1 12 12v-1A12 12 0 0 0 73 1z"/><rect fill="#7e628f" x="9" y="9" width="68" height="58" rx="4" ry="4"/><path fill="#675077" d="M73 9H13a4 4 0 0 0-4 4v1a4 4 0 0 1 4-4h60a4 4 0 0 1 4 4v-1a4 4 0 0 0-4-4z"/><rect fill="#d84b9d" x="51" y="73" width="26" height="14" rx="4" ry="4"/><rect fill="#f159b0" x="51" y="73" width="26" height="12" rx="4" ry="4"/><path fill="#fc7acb" d="M73 84H55a4 4 0 0 1-4-4v1a4 4 0 0 0 4 4h18a4 4 0 0 0 4-4v-1a4 4 0 0 1-4 4z"/><circle fill="url(#b)" cx="16" cy="80" r="7"/><circle fill="#dec7d4" cx="16" cy="79" r="6"/><path fill="#f9edf4" d="M16 74a6 6 0 0 1 6 5.5V79a6 6 0 0 0-12 0v.5a6 6 0 0 1 6-5.5z"/><circle fill="url(#c)" cx="14" cy="77" r="2"/><circle fill="url(#d)" cx="34" cy="80" r="7"/><circle fill="#dec7d4" cx="34" cy="79" r="6"/><path fill="#f9edf4" d="M34 74a6 6 0 0 1 6 5.5V79a6 6 0 0 0-12 0v.5a6 6 0 0 1 6-5.5z"/><circle fill="url(#e)" cx="36" cy="81" r="2"/><path fill="#9072a0" d="M27 60.8A11.8 11.8 0 1 1 38.8 49 11.8 11.8 0 0 1 27 60.8zm0-20a8.2 8.2 0 1 0 8.2 8.2 8.2 8.2 0 0 0-8.2-8.2z"/><path fill="#fe5bb7" d="M37 51a2 2 0 0 1-2-2 8 8 0 0 0-8-8 2 2 0 0 1 0-4 12 12 0 0 1 12 12 2 2 0 0 1-2 2z"/><path fill="#9072a0" d="M59 60.8A11.8 11.8 0 1 1 70.8 49 11.8 11.8 0 0 1 59 60.8zm0-20a8.2 8.2 0 1 0 8.2 8.2 8.2 8.2 0 0 0-8.2-8.2z"/><path fill="#5bd3e8" d="M59 61a12 12 0 0 1-12-12 2 2 0 0 1 4 0 8 8 0 1 0 8-8 2 2 0 0 1 0-4 12 12 0 0 1 0 24z"/><path fill="#ffae43" d="M70 17.5l-11 11-4-5-7.8 8.8-11-21.2L26 25.7l-4-4-8 10.7-5-8V28l5 7.8 8-11.3 4 4L36 15l10.8 20.8 8.2-9.2 4 5 11-11 7 8.5v-3l-7-8.4z"/></svg>

data/guides/.rubocop.yml

@@ -1 +0,0 @@
-# Leave it blank to use default Rubocop config in guides

data/guides/any_fixture.md

@@ -1,114 +0,0 @@
-# Any Fixture
-
-Fixtures are the great way to increase your test suite performance, but for the large project, they are very hard to maintain.
-
-We propose a more general approach to lazy-generate the _global_ state for your test suite – AnyFixture.
-
-With AnyFixture you can use any block of code for data generation, and it will take care of cleaning it out at the end of the run.
-
-Consider an example:
-
-```ruby
-# The best way to use AnyFixture is through RSpec shared contexts
-RSpec.shared_context 'account', account: true do
-  # You should call AnyFixture outside of transaction to re-use the same
-  # data between examples
-  before(:all) do
-    # The provided name ("account") should be unique.
-    @account = TestProf::AnyFixture.register(:account) do
-      # Do anything here, AnyFixture keeps track of affected DB tables
-      # For example, you can use factories here
-      FactoryGirl.create(:account)
-
-      # or with Fabrication
-      Fabricate(:account)
-
-      # or with plain old AR
-      Account.create!(name: 'test')
-    end
-  end
-
-  let(:account) { @account }
-
-  # Or hard-reload object if there is chance of in-place modification
-  let(:account) { Account.find(@account.id) }
-end
-
-# Then in your tests
-
-# Active this fixture using a tag
-describe UsersController, :account do
-  # ...
-end
-
-# This test also uses the same account record,
-# no double-creation
-describe PostsController, :account do
-  # ...
-end
-```
-
-## Instructions
-
-In your `spec_helper.rb`:
-
-```ruby
-require 'test_prof/recipes/rspec/any_fixture'
-```
-
-Now you can use `TestProf::AnyFixture` in your tests.
-
-## Caveats
-
-`AnyFixture` cleans tables in the reverse order as compared to the order they were populated. That
-means when you register a fixture which references a not-yet-registered table, a
-foreign-key violation error *might* occur (if any). An example is worth more than 1000
-words:
-
-```ruby
-class Author < ApplicationRecord
-  has_many :articles
-end
-
-class Article < ApplicationRecord
-  belongs_to :author
-end
-```
-
-And the shared contexts:
-
-```ruby
-RSpec.shared_context 'author' do
-  before(:all) do
-    @author = TestProf::AnyFixture.register(:author) do
-      FactoryGirl.create(:account)
-    end
-  end
-
-  let(:author) { @author }
-end
-
-RSpec.shared_context 'article' do
-  before(:all) do
-    # outside of AnyFixture, we don't know about its dependent tables
-    author = FactoryGirl.create(:author)
-
-    @article = TestProf::AnyFixture.register(:article) do
-      FactoryGirl.create(:article, author: author)
-    end
-  end
-
-  let(:article) { @article }
-end
-```
-
-Then in some example:
-
-```ruby
-# This one adds only the 'articles' table to the list of affected tables
-include_context 'article'
-# And this one adds the 'authors' table
-include_context 'author'
-```
-
-Now we have the following affected tables list: `['articles', 'authors']`. At the end of the suite, the 'authors' table is cleaned first which leads to a foreign-key violation error.