test-prof 0.1.0.beta4 → 0.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bebeb0abae778ec18d0ec11538784b0255bd26d
-  data.tar.gz: '098fa4a951eba03ac7fcda3e6565ca01936dd182'
+  metadata.gz: 528abbfd18c27537ab52c1bf580c73b4327fdbbc
+  data.tar.gz: dfaaa8adc9c93ec2ba4e562cf57ec3f4807ae489
 SHA512:
-  metadata.gz: 1099d6a1805f71697cccbb555025bffba6589e87016e33d715a046368e20dda1d5d1b2df259792b144c2ba0e7f816f64e6dd745f14114b1bb4ee6446e2edbba2
-  data.tar.gz: 4212b16b0487b6a5c4853e855a07278778cc487f0b378148d4903e180d20a935e3110542bdaf553070f499ddce220a046366b2b18049ae598b6dc36e4a54e0dc
+  metadata.gz: db4e05c01a501eb9e9a50d8c4d1f857437ca7c14323c7a25e739736e1139c8201c87fbefcff91c84cf0932c475e9fc2f12006f3f7feb9d6d5068d23b492bdf61
+  data.tar.gz: 2ba7680b870ef1acf274cabb3fd0f4bdfc73558af1d3211e2808f2e99f7864c212212fce9c7ef6f68f78d55f7d5cba1ff44674273fdb6bedfce3c135c77af2d4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+    - 'tmp/**/*'
+    - 'Rakefile'
+    - 'Gemfile'
+    - '*.gemspec'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+
+Rails:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in test-prof.gemspec
+gemspec

data/README.md

@@ -31,8 +31,6 @@ See [Table of Contents](#table-of-contents) for more.
 
 - RubyConfBy, 2017, "Run Test Run" talk [[video](https://www.youtube.com/watch?v=q52n4p0wkIs), [slides](https://speakerdeck.com/palkan/rubyconfby-minsk-2017-run-test-run)]
 
-- [Tips to improve speed of your test suite](https://medium.com/appaloosa-store-engineering/tips-to-improve-speed-of-your-test-suite-8418b485205c) by [Benoit Tigeot](https://github.com/benoittgt)
-
 ## Installation
 
 Add `test-prof` gem to your application:
@@ -55,13 +53,9 @@ Checkout our guides for each specific tool:
 
 - [Instrumentation Profiler](https://github.com/palkan/test-prof/tree/master/guides/event_prof.md) (e.g. ActiveSupport notifications)
 
-- [Tag Profiler](https://github.com/palkan/test-prof/tree/master/guides/tag_prof.md)
-
 - [Factory Doctor](https://github.com/palkan/test-prof/tree/master/guides/factory_doctor.md)
 
-- [Factory Profiler](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)
-
-- [Rubocop Cops](https://github.com/palkan/test-prof/tree/master/guides/rubocop.md)
+- Factory Profiler
 
 ## Tips and Tricks (or _Recipes_)
 
@@ -71,12 +65,6 @@ We also want to share some small code tricks which can help you to improve your
 
 - [AnyFixture](https://github.com/palkan/test-prof/tree/master/guides/any_fixture.md)
 
-- [FactoryDefault](https://github.com/palkan/test-prof/tree/master/guides/factory_default.md)
-
-- [RSpec Stamp](https://github.com/palkan/test-prof/tree/master/guides/rspec_stamp.md)
-
-- [Tests Sampling](https://github.com/palkan/test-prof/tree/master/guides/tests_sampling.md)
-
 ## Configuration
 
 TestProf global configuration is used by most of the profilers:
@@ -100,12 +88,10 @@ Or TODO list:
 
 - Better Minitest integration (PRs welcome!)
 
-- Other data generation library support (e.g [Fabricator](http://fabricationgem.org/)). _Does anyone use something except from FactoryGirl?_
+- Other data generation library support (e.g [Fabricator](http://fabricationgem.org/))
 
 - Improve FactoryDoctor
 
-- Add more Rubocop cops (e.g. `CreateListLimit`)
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task :default => [:spec, :rubocop]

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  ruby:
+    version: 2.4.1
+
+database:
+  override:
+    - echo "Skipping DB section."
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.13.6

data/guides/any_fixture.md

@@ -18,7 +18,7 @@ RSpec.shared_context "account", account: true do
     @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)
+      create(:account)
 
       # or with Fabrication
       Fabricate(:account)

data/guides/ruby_prof.md

@@ -58,6 +58,4 @@ end
 
 By default, we use `CallStackPrinter`.
 
-Also, you can specify RubyProf mode (`wall`, `cpu`, etc) through `TEST_RUBY_PROF_MODE` env variable.
-
 See [ruby_prof.rb](https://github.com/palkan/test-prof/tree/master/lib/test_prof/ruby_prof.rb) for all available configuration options and their usage.

data/guides/stack_prof.md

@@ -1,6 +1,6 @@
 # Profiling with StackProf
 
-[StackProf](https://github.com/tmm1/stackprof) is a sampling call-stack profiler for ruby.
+[StackProf](https://github.com/ruby-prof/ruby-prof) is a sampling call-stack profiler for ruby.
 
 ## Instructions
 
@@ -40,8 +40,4 @@ end
 
 ### Configuration
 
-You can change StackProf mode (which is `wall` by default) through `TEST_STACK_PROF_MODE` env variable.
-
-If you want to generate flame graphs you should collect _raw_ data. Turn _raw_ collection on by passing `TEST_STACK_PROF_RAW=1`.
-
 See [stack_prof.rb](https://github.com/palkan/test-prof/tree/master/lib/test_prof/stack_prof.rb) for all available configuration options and their usage.

data/lib/test_prof.rb

@@ -42,42 +42,20 @@ module TestProf
       false
     end
 
-    # Run block only if provided env var is present and
-    # equal to the provided value (if any).
+    # Run block only if provided env var is present.
     # Contains workaround for applications using Spring.
-    def activate(env_var, val = nil)
-      if defined?(::Spring)
-        ::Spring.after_fork { activate!(env_var, val) { yield } }
+    def activate(env_var)
+      if defined?(::Spring) && !ENV['DISABLE_SPRING']
+        Spring.after_fork { yield if ENV[env_var] }
       else
-        activate!(env_var, val) { yield }
+        yield if ENV[env_var] 
       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 artefact
-    def artefact_path(filename)
-      with_timestamps(
-        ::File.join(
-          config.output_dir,
-          filename
-        )
-      )
-    end
-
-    private
-
-    def activate!(env_var, val)
-      yield if ENV[env_var] && (val.nil? || ENV[env_var] == val)
-    end
-
     def with_timestamps(path)
       return path unless config.timestamps?
       timestamps = "-#{Time.now.to_i}"
-      "#{path.sub(/\.\w+$/, '')}#{timestamps}#{::File.extname(path)}"
+      "#{path.sub(/\.\w+$/, '')}#{timestamps}#{File.extname(path)}"
     end
   end
 
@@ -109,6 +87,3 @@ require "test_prof/ruby_prof"
 require "test_prof/stack_prof"
 require "test_prof/event_prof"
 require "test_prof/factory_doctor"
-require "test_prof/factory_prof"
-require "test_prof/rspec_stamp"
-require "test_prof/tag_prof"

data/lib/test_prof/event_prof.rb

@@ -65,7 +65,9 @@ module TestProf
       def build
         Profiler.new(
           event: config.event,
-          instrumenter: config.resolve_instrumenter
+          instrumenter: config.resolve_instrumenter,
+          rank_by: config.rank_by,
+          top_count: config.top_count
         )
       end
     end
@@ -75,7 +77,7 @@ module TestProf
 
       attr_reader :event, :top_count, :rank_by, :total_count, :total_time
 
-      def initialize(event:, instrumenter:)
+      def initialize(event:, instrumenter:, rank_by:, top_count:)
         @event = event
 
         log :info, "EventProf enabled (#{@event})"

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"
-require "test_prof/event_prof/custom_events/sidekiq_inline"
-require "test_prof/event_prof/custom_events/sidekiq_jobs"
+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"

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TestProf::EventProf::CustomEvents
-  module FactoryCreate # :nodoc: all
+  module FactoryCreate
     module RunnerPatch
       def run(strategy = @strategy)
         return super unless strategy == :create
@@ -39,15 +39,13 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-TestProf.activate('EVENT_PROF', 'factory.create') do
-  if TestProf.require(
-    'factory_girl',
-    <<~MSG
-      Failed to load FactoryGirl.
+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!
-  end
+    Make sure that "factory_girl" gem is in your Gemfile.
+  MSG
+)
+  TestProf::EventProf::CustomEvents::FactoryCreate.setup!
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TestProf::EventProf::CustomEvents
-  module SidekiqInline # :nodoc: all
+  module SidekiqInline
     module ClientPatch
       def raw_push(*)
         return super unless Sidekiq::Testing.inline?
@@ -36,15 +36,13 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-TestProf.activate('EVENT_PROF', 'sidekiq.inline') do
-  if TestProf.require(
-    'sidekiq/testing',
-    <<~MSG
-      Failed to load Sidekiq.
+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!
-  end
+    Make sure that "sidekiq" gem is in your Gemfile.
+  MSG
+)
+  TestProf::EventProf::CustomEvents::SidekiqInline.setup!
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TestProf::EventProf::CustomEvents
-  module SidekiqJobs # :nodoc: all
+  module SidekiqJobs
     module ClientPatch
       def raw_push(*)
         return super unless Sidekiq::Testing.inline?
@@ -23,18 +23,16 @@ module TestProf::EventProf::CustomEvents
   end
 end
 
-TestProf.activate('EVENT_PROF', 'sidekiq.jobs') do
-  if TestProf.require(
-    'sidekiq/testing',
-    <<~MSG
-      Failed to load Sidekiq.
+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
-    end
+    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

data/lib/test_prof/event_prof/rspec.rb

@@ -87,11 +87,7 @@ TestProf.activate('EVENT_PROF') do
   RSpec.configure do |config|
     listener = TestProf::EventProf::RSpecListener.new
 
-    config.before(:suite) do
-      config.reporter.register_listener(
-        listener, *TestProf::EventProf::RSpecListener::NOTIFICATIONS
-      )
-    end
+    config.reporter.register_listener(listener, *TestProf::EventProf::RSpecListener::NOTIFICATIONS)
 
     config.after(:suite) { listener.print }
   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
-  # tests that perform unnecessary database queries.
+  # FactoryDoctor is a tool that helps you identify such _bad_ tests,
+  # i.e. tests that perform unnecessary database queries.
   module FactoryDoctor
     class Result # :nodoc:
       attr_reader :count, :time, :queries_count
@@ -81,16 +81,14 @@ module TestProf
       def within_factory(strategy)
         return yield if ignore? || !running? || (strategy != :create)
 
-        begin
-          ts = Time.now if @depth.zero?
-          @depth += 1
-          @count += 1
-          yield
-        ensure
-          @depth -= 1
+        ts = Time.now if @depth.zero?
+        @depth += 1
+        @count += 1
+        yield
+      ensure
+        @depth -= 1
 
-          @time += (Time.now - ts) if @depth.zero?
-        end
+        @time += (Time.now - ts) if @depth.zero?
       end
 
       private