test-prof 0.1.0.pre5 → 0.1.0

data/lib/test_prof/cops/rspec/aggregate_failures.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Rejects and auto-corrects the usage of one-liners examples in favour of
+      # :aggregate_failures feature.
+      #
+      # Example:
+      #
+      #  # bad
+      #  it { is_expected.to be_success }
+      #  it { is_expected.to have_header('X-TOTAL-PAGES', 10) }
+      #  it { is_expected.to have_header('X-NEXT-PAGE', 2) }
+      #
+      #  # good
+      #  it "returns the second page", :aggregate_failures do
+      #    is_expected.to be_success
+      #    is_expected.to have_header('X-TOTAL-PAGES', 10)
+      #    is_expected.to have_header('X-NEXT-PAGE', 2)
+      #  end
+      #
+      class AggregateFailures < RuboCop::Cop::Cop
+        # From https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/language.rb
+        GROUP_BLOCKS = %i[
+          describe context feature example_group
+          xdescribe xcontext xfeature
+          fdescribe fcontext ffeature
+        ].freeze
+
+        EXAMPLE_BLOCKS = %i[
+          it specify example scenario its
+          fit fspecify fexample fscenario focus
+          xit xspecify xexample xscenario ski
+          pending
+        ].freeze
+
+        def on_block(node)
+          method, _args, body = *node
+          return unless body&.begin_type?
+
+          _receiver, method_name, _object = *method
+          return unless GROUP_BLOCKS.include?(method_name)
+
+          return if check_node(body)
+
+          add_offense(
+            node,
+            :expression,
+            'Use :aggregate_failures instead of several one-liners.'
+          )
+        end
+
+        def autocorrect(node)
+          _method, _args, body = *node
+          iter = body.children.each
+
+          first_example = loop do
+            child = iter.next
+            break child if oneliner?(child)
+          end
+
+          base_indent = " " * first_example.source_range.column
+
+          replacements = [
+            header_from(first_example),
+            body_from(first_example, base_indent)
+          ]
+
+          last_example = nil
+
+          loop do
+            child = iter.next
+            break unless oneliner?(child)
+            last_example = child
+            replacements << body_from(child, base_indent)
+          end
+
+          replacements << "#{base_indent}end"
+
+          range = first_example.source_range.begin.join(
+            last_example.source_range.end
+          )
+
+          replacement = replacements.join("\n")
+
+          lambda do |corrector|
+            corrector.replace(range, replacement)
+          end
+        end
+
+        private
+
+        def check_node(node)
+          offenders = 0
+
+          node.children.each do |child|
+            if oneliner?(child)
+              offenders += 1
+            elsif example_node?(child)
+              break if offenders > 1
+              offenders = 0
+            end
+          end
+
+          offenders < 2
+        end
+
+        def oneliner?(node)
+          node&.block_type? &&
+            (node.source.lines.size == 1) &&
+            example_node?(node)
+        end
+
+        def example_node?(node)
+          method, _args, _body = *node
+          _receiver, method_name, _object = *method
+          EXAMPLE_BLOCKS.include?(method_name)
+        end
+
+        def header_from(node)
+          method, _args, _body = *node
+          _receiver, method_name, _object = *method
+          %(#{method_name} "works", :aggregate_failures do)
+        end
+
+        def body_from(node, base_indent = '')
+          _method, _args, body = *node
+          "#{base_indent}#{indent}#{body.source}"
+        end
+
+        def indent
+          @indent ||= " " * (config.for_cop('IndentationWidth')['Width'] || 2)
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/event_prof/custom_events.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require "test_prof/event_prof/custom_events/factory_create" if ENV['EVENT_PROF'] == "factory.create"
-require "test_prof/event_prof/custom_events/sidekiq_inline" if ENV['EVENT_PROF'] == "sidekiq.inline"
-require "test_prof/event_prof/custom_events/sidekiq_jobs" if ENV['EVENT_PROF'] == "sidekiq.jobs"
+require "test_prof/event_prof/custom_events/factory_create"
+require "test_prof/event_prof/custom_events/sidekiq_inline"
+require "test_prof/event_prof/custom_events/sidekiq_jobs"

data/lib/test_prof/event_prof/custom_events/factory_create.rb

@@ -39,13 +39,15 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-if TestProf.require(
-  'factory_girl',
-  <<~MSG
-    Failed to load FactoryGirl.
+TestProf.activate('EVENT_PROF', 'factory.create') do
+  if TestProf.require(
+    'factory_girl',
+    <<~MSG
+      Failed to load FactoryGirl.
 
-    Make sure that "factory_girl" gem is in your Gemfile.
-  MSG
-)
-  TestProf::EventProf::CustomEvents::FactoryCreate.setup!
+      Make sure that "factory_girl" gem is in your Gemfile.
+    MSG
+  )
+    TestProf::EventProf::CustomEvents::FactoryCreate.setup!
+  end
 end

data/lib/test_prof/event_prof/custom_events/sidekiq_inline.rb

@@ -36,13 +36,15 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-if TestProf.require(
-  'sidekiq/testing',
-  <<~MSG
-    Failed to load Sidekiq.
+TestProf.activate('EVENT_PROF', 'sidekiq.inline') do
+  if TestProf.require(
+    'sidekiq/testing',
+    <<~MSG
+      Failed to load Sidekiq.
 
-    Make sure that "sidekiq" gem is in your Gemfile.
-  MSG
-)
-  TestProf::EventProf::CustomEvents::SidekiqInline.setup!
+      Make sure that "sidekiq" gem is in your Gemfile.
+    MSG
+  )
+    TestProf::EventProf::CustomEvents::SidekiqInline.setup!
+  end
 end

data/lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb

@@ -23,16 +23,18 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-if TestProf.require(
-  'sidekiq/testing',
-  <<~MSG
-    Failed to load Sidekiq.
+TestProf.activate('EVENT_PROF', 'sidekiq.jobs') do
+  if TestProf.require(
+    'sidekiq/testing',
+    <<~MSG
+      Failed to load Sidekiq.
 
-    Make sure that "sidekiq" gem is in your Gemfile.
-  MSG
-)
-  TestProf::EventProf::CustomEvents::SidekiqJobs.setup!
-  TestProf::EventProf.configure do |config|
-    config.rank_by = :count
+      Make sure that "sidekiq" gem is in your Gemfile.
+    MSG
+  )
+    TestProf::EventProf::CustomEvents::SidekiqJobs.setup!
+    TestProf::EventProf.configure do |config|
+      config.rank_by = :count
+    end
   end
 end

data/lib/test_prof/event_prof/rspec.rb

@@ -87,7 +87,11 @@ TestProf.activate('EVENT_PROF') do
   RSpec.configure do |config|
     listener = TestProf::EventProf::RSpecListener.new
 
-    config.reporter.register_listener(listener, *TestProf::EventProf::RSpecListener::NOTIFICATIONS)
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::EventProf::RSpecListener::NOTIFICATIONS
+      )
+    end
 
     config.after(:suite) { listener.print }
   end

data/lib/test_prof/factory_default.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_default/factory_girl_patch"
+
+module TestProf
+  # FactoryDefault allows use to re-use associated objects
+  # in factories implicilty
+  module FactoryDefault
+    module DefaultSyntax # :nodoc:
+      def create_default(name, *args, &block)
+        set_factory_default(
+          name,
+          FactoryGirl.create(name, *args, &block)
+        )
+      end
+
+      def set_factory_default(name, obj)
+        FactoryDefault.register(name, obj)
+      end
+    end
+
+    class << self
+      def init
+        FactoryGirl::Syntax::Methods.include DefaultSyntax
+        FactoryGirl.extend DefaultSyntax
+        FactoryGirl::Strategy::Create.prepend StrategyExt
+        FactoryGirl::Strategy::Build.prepend StrategyExt
+        FactoryGirl::Strategy::Stub.prepend StrategyExt
+
+        @store = {}
+      end
+
+      def register(name, obj)
+        store[name] = obj
+      end
+
+      def get(name)
+        store[name]
+      end
+
+      def exists?(name)
+        store.key?(name)
+      end
+
+      def remove(name)
+        store.delete(name)
+      end
+
+      def reset
+        @store.clear
+      end
+
+      private
+
+      attr_reader :store
+    end
+  end
+end

data/lib/test_prof/factory_default/factory_girl_patch.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TestProf
+  module FactoryDefault # :nodoc: all
+    module RunnerExt
+      refine FactoryGirl::FactoryRunner do
+        def name
+          @name
+        end
+      end
+    end
+
+    using RunnerExt
+
+    module StrategyExt
+      def association(runner)
+        return super unless FactoryDefault.exists?(runner.name)
+        FactoryDefault.get(runner.name)
+      end
+    end
+  end
+end

data/lib/test_prof/factory_doctor.rb

@@ -3,8 +3,8 @@
 require "test_prof/factory_doctor/factory_girl_patch"
 
 module TestProf
-  # FactoryDoctor is a tool that helps you identify such _bad_ tests,
-  # i.e. tests that perform unnecessary database queries.
+  # FactoryDoctor is a tool that helps you identify
+  # tests that perform unnecessary database queries.
   module FactoryDoctor
     class Result # :nodoc:
       attr_reader :count, :time, :queries_count
@@ -81,14 +81,16 @@ module TestProf
       def within_factory(strategy)
         return yield if ignore? || !running? || (strategy != :create)
 
-        ts = Time.now if @depth.zero?
-        @depth += 1
-        @count += 1
-        yield
-      ensure
-        @depth -= 1
+        begin
+          ts = Time.now if @depth.zero?
+          @depth += 1
+          @count += 1
+          yield
+        ensure
+          @depth -= 1
 
-        @time += (Time.now - ts) if @depth.zero?
+          @time += (Time.now - ts) if @depth.zero?
+        end
       end
 
       private

data/lib/test_prof/factory_doctor/rspec.rb

@@ -83,9 +83,11 @@ TestProf.activate('FDOC') do
   RSpec.configure do |config|
     listener = TestProf::FactoryDoctor::RSpecListener.new
 
-    config.reporter.register_listener(
-      listener, *TestProf::FactoryDoctor::RSpecListener::NOTIFICATIONS
-    )
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::FactoryDoctor::RSpecListener::NOTIFICATIONS
+      )
+    end
 
     config.after(:suite) { listener.print }
   end

data/lib/test_prof/factory_prof.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_prof/factory_girl_patch"
+require "test_prof/factory_prof/printers/simple"
+require "test_prof/factory_prof/printers/flamegraph"
+
+module TestProf
+  # FactoryProf collects "factory stacks" that can be used to build
+  # flamegraphs or detect most popular factories
+  module FactoryProf
+    # FactoryProf configuration
+    class Configuration
+      attr_accessor :mode
+
+      def initialize
+        @mode = ENV['FPROF'] == 'flamegraph' ? :flamegraph : :simple
+      end
+
+      # Whether we want to generate flamegraphs
+      def flamegraph?
+        @mode == :flamegraph
+      end
+    end
+
+    class Result # :nodoc:
+      attr_reader :stacks, :raw_stats
+
+      def initialize(stacks, raw_stats)
+        @stacks = stacks
+        @raw_stats = raw_stats
+      end
+
+      # Returns sorted stats
+      def stats
+        return @stats if instance_variable_defined?(:@stats)
+
+        @stats = @raw_stats.values
+                           .sort_by { |el| -el[:total] }
+      end
+
+      def total
+        return @total if instance_variable_defined?(:@total)
+        @total = @raw_stats.values.sum { |v| v[:total] }
+      end
+
+      private
+
+      def sorted_stats(key)
+        @raw_stats.values
+                  .map { |el| [el[:name], el[key]] }
+                  .sort_by { |el| -el[1] }
+      end
+    end
+
+    class << self
+      include TestProf::Logging
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      # Patch factory lib, init vars
+      def init
+        @running = false
+
+        log :info, "FactoryProf enabled (#{config.mode} mode)"
+
+        # Monkey-patch FactoryGirl
+        ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch) if
+          defined?(::FactoryGirl)
+      end
+
+      # Inits FactoryProf and setups at exit hook,
+      # then runs
+      def run
+        init
+
+        printer = config.flamegraph? ? Printers::Flamegraph : Printers::Simple
+
+        at_exit { printer.dump(result) }
+
+        start
+      end
+
+      def start
+        reset!
+        @running = true
+      end
+
+      def stop
+        @running = false
+      end
+
+      def result
+        Result.new(@stacks, @stats)
+      end
+
+      def track(strategy, factory)
+        return yield if !running? || (strategy != :create)
+        begin
+          @depth += 1
+          @current_stack << factory if config.flamegraph?
+          @stats[factory][:total] += 1
+          @stats[factory][:top_level] += 1 if @depth == 1
+          yield
+        ensure
+          @depth -= 1
+          flush_stack if @depth.zero?
+        end
+      end
+
+      private
+
+      def reset!
+        @stacks = [] if config.flamegraph?
+        @depth = 0
+        @stats = Hash.new { |h, k| h[k] = { name: k, total: 0, top_level: 0 } }
+        flush_stack
+      end
+
+      def flush_stack
+        return unless config.flamegraph?
+        @stacks << @current_stack unless @current_stack.nil? || @current_stack.empty?
+        @current_stack = []
+      end
+
+      def running?
+        @running == true
+      end
+    end
+  end
+end
+
+TestProf.activate('FPROF') do
+  TestProf::FactoryProf.run
+end