test-prof 0.1.0.beta1 → 0.1.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dade264c0a95b5d29d16cf67204c97bf2276f42
-  data.tar.gz: 3c46d6ebefc369568047b25b61d6ec1e7bc25e4b
+  metadata.gz: c9b58b9e9898a5b72c42700bfc0751c31639aefc
+  data.tar.gz: 4bf4799f92e06e8e9b3c000fe08659171cd2293d
 SHA512:
-  metadata.gz: 6d2ceb09c815692c055b4b89619316957b1ecf3317203723ec96a347c0c6c9ab26484769b646e1b553a285505b64ae16421e5d88fa8524dc751eb01645bb9000
-  data.tar.gz: 5896bf29c21a9e4fde69bc6def001530c23340b1b7be4bb7ee4d8207d09770c3053e98d0017cd127b930a2e96134edff454a9be71c5fc3c874af5516edf00edb
+  metadata.gz: 50f89b1bce0e4c45bb00aacaff4cfb6f1e1f8f2875cc0fc38f2317244c662b24f8b56788bb1980221b5ca6987753b3b190a3b9e671de958f5a581a1616ca0fe7
+  data.tar.gz: ed479e4104b92b159a7872fc7dbb85e6b69308c954dade0ca2cb7d044bc60ef11f483e905cb569ceaa0b686a7b07bbc49de841f3424f3b4535f01acc9f985167

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

@@ -55,9 +55,7 @@ Checkout our guides for each specific tool:
 
 - [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_)
 
@@ -92,12 +90,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/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
 

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

data/lib/test_prof/ruby_prof.rb

@@ -110,8 +110,11 @@ module TestProf
       private
 
       def build_path(name, printer)
-        TestProf.artefact_path(
-          "ruby-prof-report-#{printer}-#{config.mode}-#{name}.html"
+        TestProf.with_timestamps(
+          File.join(
+            TestProf.config.output_dir,
+            "ruby-prof-report-#{printer}-#{config.mode}-#{name}.html"
+          )
         )
       end
 

data/lib/test_prof/stack_prof.rb

@@ -88,8 +88,11 @@ module TestProf
       private
 
       def build_path(name)
-        TestProf.artefact_path(
-          "stack-prof-report-#{config.mode}-#{name}.dump"
+        TestProf.with_timestamps(
+          File.join(
+            TestProf.config.output_dir,
+            "stack-prof-report-#{config.mode}-#{name}.dump"
+          )
         )
       end
 

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.1.0.beta1"
+  VERSION = "0.1.0.pre5"
 end

data/lib/test_prof.rb

@@ -52,27 +52,10 @@ module TestProf
       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 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
 
@@ -104,5 +87,4 @@ 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"

data/spec/integrations/any_fixture_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "AnyFixture" do
+  specify "it works" do
+    output = run_rspec('any_fixture')
+
+    expect(output).to include("3 examples, 0 failures")
+  end
+end

data/spec/integrations/before_all_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "BeforeAll" do
+  specify "it works" do
+    output = run_rspec('before_all')
+
+    expect(output).to include("3 examples, 0 failures")
+  end
+end

data/spec/integrations/event_prof_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "EventProf" do
+  specify "RSpec integration", :aggregate_failures do
+    output = run_rspec('event_prof', env: { 'EVENT_PROF' => 'test.event' })
+
+    expect(output).to include("EventProf results for test.event")
+    expect(output).to match(/Total time: 25:56\.\d{3}/)
+    expect(output).to include("Total events: 8")
+
+    expect(output).to include("Top 5 slowest suites (by time):")
+    expect(output).to include("Top 5 slowest tests (by time):")
+
+    expect(output).to include(
+      "Another something (./event_prof_fixture.rb:42) – 16:40.000 (1 / 2)\n"\
+      "Something (./event_prof_fixture.rb:21) – 09:16.100 (7 / 3)"
+    )
+
+    expect(output).to include(
+      "do very long (./event_prof_fixture.rb:47) – 16:40.000 (1)\n"\
+      "invokes twice (./event_prof_fixture.rb:27) – 06:20.000 (2)\n"\
+      "invokes many times (./event_prof_fixture.rb:33) – 02:16.000 (4)\n"\
+      "invokes once (./event_prof_fixture.rb:22) – 00:40.100 (1)"
+    )
+  end
+
+  specify "RSpec integration with rank by count", :aggregate_failures do
+    output = run_rspec(
+      'event_prof',
+      env: { 'EVENT_PROF' => 'test.event', 'EVENT_PROF_RANK' => 'count' }
+    )
+
+    expect(output).to include("EventProf results for test.event")
+    expect(output).to match(/Total time: 25:56\.\d{3}/)
+    expect(output).to include("Total events: 8")
+
+    expect(output).to include("Top 5 slowest suites (by count):")
+    expect(output).to include("Top 5 slowest tests (by count):")
+
+    expect(output).to include(
+      "Something (./event_prof_fixture.rb:21) – 09:16.100 (7 / 3)\n"\
+      "Another something (./event_prof_fixture.rb:42) – 16:40.000 (1 / 2)"
+    )
+
+    expect(output).to include(
+      "invokes many times (./event_prof_fixture.rb:33) – 02:16.000 (4)\n"\
+      "invokes twice (./event_prof_fixture.rb:27) – 06:20.000 (2)\n"\
+      "invokes once (./event_prof_fixture.rb:22) – 00:40.100 (1)\n"\
+      "do very long (./event_prof_fixture.rb:47) – 16:40.000 (1)"
+    )
+  end
+
+  context "CustomEvents" do
+    it "works with factory.create" do
+      output = run_rspec(
+        'event_prof_factory_create',
+        env: { 'EVENT_PROF' => 'factory.create' }
+      )
+
+      expect(output).to include("EventProf results for factory.create")
+      expect(output).to match(/Total time: \d{2}:\d{2}\.\d{3}/)
+      expect(output).to include("Total events: 3")
+
+      expect(output).to match(%r{Post \(./event_prof_factory_create_fixture.rb:7\) – \d{2}:\d{2}.\d{3} \(2 / 1\)})
+      expect(output).to match(%r{User \(./event_prof_factory_create_fixture.rb:16\) – \d{2}:\d{2}.\d{3} \(1 / 1\)})
+    end
+
+    it "works with sidekiq.inline" do
+      output = run_rspec(
+        'event_prof_sidekiq',
+        env: { 'EVENT_PROF' => 'sidekiq.inline' }
+      )
+
+      expect(output).to include("EventProf results for sidekiq.inline")
+      expect(output).to match(/Total time: \d{2}:\d{2}\.\d{3}/)
+      expect(output).to include("Total events: 3")
+
+      expect(output).to match(%r{SingleJob \(./event_prof_sidekiq_fixture.rb:27\) – \d{2}:\d{2}.\d{3} \(2 / 2\)})
+      expect(output).to match(%r{BatchJob \(./event_prof_sidekiq_fixture.rb:39\) – \d{2}:\d{2}.\d{3} \(1 / 2\)})
+    end
+
+    it "works with sidekiq.jobs" do
+      output = run_rspec(
+        'event_prof_sidekiq',
+        env: { 'EVENT_PROF' => 'sidekiq.jobs' }
+      )
+
+      expect(output).to include("EventProf results for sidekiq.jobs")
+      expect(output).to match(/Total time: \d{2}:\d{2}\.\d{3}/)
+      expect(output).to include("Total events: 6")
+
+      expect(output).to include("Top 5 slowest suites (by count):")
+
+      expect(output).to match(%r{SingleJob \(./event_prof_sidekiq_fixture.rb:27\) – \d{2}:\d{2}.\d{3} \(2 / 2\)})
+      expect(output).to match(%r{BatchJob \(./event_prof_sidekiq_fixture.rb:39\) – \d{2}:\d{2}.\d{3} \(4 / 2\)})
+    end
+  end
+end

data/spec/integrations/factory_doctor_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe "FactoryDoctor" do
+  specify "RSpec integration", :aggregate_failures do
+    output = run_rspec('factory_doctor', env: { 'FDOC' => '1' })
+
+    expect(output).to include("FactoryDoctor report")
+    expect(output).to include("Total (potentially) bad examples: 3")
+    expect(output).to match(/Total wasted time: \d{2}:\d{2}\.\d{3}/)
+
+    expect(output).to include("User (./factory_doctor_fixture.rb:7)")
+    expect(output).to include("generates random names (./factory_doctor_fixture.rb:10) – 2 records created")
+    expect(output).to include("validates name (./factory_doctor_fixture.rb:15) – 1 record created")
+    expect(output).to include("clones (./factory_doctor_fixture.rb:25) – 1 record created")
+    expect(output).not_to include("is ignored")
+    expect(output).not_to include("creates and reloads user")
+  end
+end

data/spec/integrations/fixtures/rspec/any_fixture_fixture.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require_relative "../../../support/transactional_context"
+require "test_prof/recipes/rspec/any_fixture"
+
+shared_context "user", user: true do
+  before(:all) do
+    @user = TestProf::AnyFixture.register(:user) do
+      FactoryGirl.create(:user)
+    end
+  end
+
+  let(:user) { User.find(@user.id) }
+end
+
+describe "User", :user do
+  it "creates user" do
+    user.name = ''
+    expect(user).not_to be_valid
+  end
+
+  context "with clean fixture", :transactional, :with_clean_fixture do
+    specify "no users" do
+      expect(User.count).to eq 0
+    end
+  end
+end
+
+describe "Post", :user do
+  let(:post) { FactoryGirl.create(:post, user: user) }
+
+  it "creates post with the same user" do
+    expect { post }.not_to change(User, :count)
+  end
+end

data/spec/integrations/fixtures/rspec/before_all_fixture.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require "test_prof/recipes/rspec/before_all"
+
+describe "User" do
+  context "with before_all" do
+    before_all do
+      @user = FactoryGirl.create(:user)
+    end
+
+    let(:user) { User.find(@user.id) }
+
+    it "validates name" do
+      user.name = ''
+      expect(user).not_to be_valid
+    end
+
+    it "clones" do
+      cloned = user.clone
+      cloned.save!
+      expect(cloned.reload.name).to include("(cloned)")
+    end
+  end
+
+  context "without before_all" do
+    specify "no users" do
+      expect(User.count).to eq 0
+    end
+  end
+end

data/spec/integrations/fixtures/rspec/event_prof_factory_create_fixture.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require "test-prof"
+
+describe "Post" do
+  let(:user) { FactoryGirl.create(:user) }
+
+  it "generates random names" do
+    user2 = FactoryGirl.create(:post).user
+    expect(user.name).not_to eq user2.name
+  end
+end
+
+describe "User" do
+  let(:user) { FactoryGirl.create(:user) }
+
+  it "validates name" do
+    user.name = ''
+    expect(user).not_to be_valid
+  end
+end

data/spec/integrations/fixtures/rspec/event_prof_fixture.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require "active_support"
+require "test-prof"
+
+TestProf::EventProf.configure do |config|
+  config.per_example = true
+end
+
+module Instrumenter
+  def self.notify(_event, time)
+    ActiveSupport::Notifications.publish(
+      'test.event',
+      0,
+      time
+    )
+  end
+end
+
+describe "Something" do
+  it "invokes once" do
+    Instrumenter.notify 'test.event', 40.1
+    expect(true).to eq true
+  end
+
+  it "invokes twice" do
+    Instrumenter.notify 'test.event', 140
+    Instrumenter.notify 'test.event', 240
+    expect(true).to eq true
+  end
+
+  it "invokes many times" do
+    Instrumenter.notify 'test.event', 14
+    Instrumenter.notify 'test.event', 40
+    Instrumenter.notify 'test.event', 42
+    Instrumenter.notify 'test.event', 40
+    expect(true).to eq true
+  end
+end
+
+describe "Another something" do
+  it "do nothing" do
+    expect(true).to eq true
+  end
+
+  it "do very long" do
+    Instrumenter.notify 'test.event', 1000
+    expect(true).to eq true
+  end
+end

data/spec/integrations/fixtures/rspec/event_prof_sidekiq_fixture.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require "active_support"
+require "sidekiq/testing"
+
+Sidekiq::Testing.inline!
+
+class SingleJob
+  include Sidekiq::Worker
+
+  def perform(*_args)
+    true
+  end
+end
+
+class BatchJob
+  include Sidekiq::Worker
+
+  def perform(count)
+    count.times { SingleJob.perform_async(true) }
+  end
+end
+
+require "test-prof"
+
+describe "SingleJob" do
+  it "invokes once" do
+    SingleJob.perform_async(1)
+    expect(true).to eq true
+  end
+
+  it "invokes twice" do
+    SingleJob.perform_async(2)
+    expect(true).to eq true
+  end
+end
+
+describe "BatchJob" do
+  it "invokes nested" do
+    BatchJob.perform_async(3)
+    expect(true).to eq true
+  end
+
+  context "when fake" do
+    it "is fake" do
+      Sidekiq::Testing.fake! do
+        BatchJob.perform_async(3)
+      end
+      expect(true).to eq true
+    end
+  end
+end

data/spec/integrations/fixtures/rspec/factory_doctor_fixture.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require_relative "../../../support/ar_models"
+require "test-prof"
+
+describe "User" do
+  let(:user) { FactoryGirl.create(:user) }
+
+  it "generates random names" do
+    user2 = FactoryGirl.create(:user)
+    expect(user.name).not_to eq user2.name
+  end
+
+  it "validates name" do
+    user.name = ''
+    expect(user).not_to be_valid
+  end
+
+  it "creates and reloads user" do
+    user = FactoryGirl.create(:user, name: 'John')
+    expect(User.find(user.id).name).to eq 'John'
+  end
+
+  it "clones" do
+    expect(user.clone.name).to include("(cloned)")
+  end
+
+  it "is ignored", :fd_ignore do
+    user.name = ''
+    expect(user).not_to be_valid
+  end
+end