test-prof 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86d1d3c075151f50c0348a112d3789d2bde10207
-  data.tar.gz: e7ef747dcaa5c057d795dc75872a8b1cfd3ffa77
+  metadata.gz: 96ef8d4c37db3d7b4f3524eb9cf68d6633a4190e
+  data.tar.gz: 71d465796a527f2ed0a0f6e9b965f2b0cd5c5f6f
 SHA512:
-  metadata.gz: 0e3ca219b5466e96bf1b4dc789e42d1ccfca926d982a872071cb0b16eae037c2d12fdd1c75182cb381855c9e9213246595d35423ae27c41f3fe3cddfaad53235
-  data.tar.gz: f3eed314608897bf77fc044f07f7037e66d43aa5a6105d4be881c934e49c770de8b1817c2a1a6fd67a1d2675f1cb8d513136c9d84097183f74a87b0b8437c1a6
+  metadata.gz: 7a9e26f087b6d8ecc45730ddb146faa22a9621e3067eaad03f2592a9835ce9a11f0705dd4e3ef346a00c126710f10f78fc930dd44f2899c607c2fe89d0d4de7d
+  data.tar.gz: d90751192e854fcd2269c4a8bb0464c47f1ae7589b51b020da7c39a4a973d8aa8a494274a7895aedc1af32485f18f9dbd515e6db8018e974958fd7858fd7dfe4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## master branch
+
+- [#46](https://github.com/palkan/test-prof/pull/46) Support FactoryBot, which is [former FactoryGirl](https://github.com/thoughtbot/factory_bot/pull/1051), 
+  while maintaining compatibility with latter. ([@Shkrt][])
+
 ## 0.4.2
 
 - Fix bug with multiple `before_all` within one group. ([@palkan][])

data/guides/factory_default.md

@@ -2,6 +2,8 @@
 
 _Factory Default_ aims to help you cope with _factory cascades_ (see [FactoryProf](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)) by reusing associated records.
 
+**NOTE**. Only works with FactoryGirl/FactoryBot.
+
 It can be very useful when you're working on a typical SaaS application (or other hierarchical data).
 
 Consider an example. Assume we have the following factories:
@@ -82,7 +84,7 @@ describe "PATCH #update" do
 end
 ```
 
-*NOTE*. This feature introduces a bit of _magic_ to your tests, so use it with caution ('cause tests should be human-readable first). Good idea is to use defaults for top-level entities only (such as tenants in multi-tenancy apps).
+**NOTE**. This feature introduces a bit of _magic_ to your tests, so use it with caution ('cause tests should be human-readable first). Good idea is to use defaults for top-level entities only (such as tenants in multi-tenancy apps).
 
 ## Instructions
 
@@ -92,18 +94,18 @@ In your `spec_helper.rb`:
 require "test_prof/recipes/rspec/factory_default"
 ```
 
-This adds two new methods to FactoryGirl:
+This adds two new methods to FactoryBot:
 
-- `FactoryGirl#set_factory_default(factory, object)` – use the `object` as default for associations built with `factory`
+- `FactoryBot#set_factory_default(factory, object)` – use the `object` as default for associations built with `factory`
 
 Example:
 
 ```ruby
 let(:user) { create(:user) }
 
-before { FactoryGirl.set_factory_default(:user, user) }
+before { FactoryBot.set_factory_default(:user, user) }
 ```
 
-- `FactoryGirl#create_default(factory, *args)` – is a shortcut for `create` + `set_factory_default`.
+- `FactoryBot#create_default(factory, *args)` – is a shortcut for `create` + `set_factory_default`.
 
-*NOTE*. Defaults are cleaned up after each example.
+**NOTE**. Defaults are cleaned up after each example.

data/guides/factory_doctor.md

@@ -55,7 +55,7 @@ end
 
 ## Instructions
 
-Currently, FactoryDoctor works only with FactoryGirl.
+Currently, FactoryDoctor works only with FactoryGirl/FactoryBot.
 
 ## RSpec
 

data/guides/factory_prof.md

@@ -16,12 +16,12 @@ Example output:
 
 It shows both the total number of the factory runs and the number of _top-level_ runs, i.e. not during another factory invocation (e.g. when using associations.)
 
-**NOTE**: FactoryProf only tracks the database-persisted factories. In case of FactoryGirl these are the factories
+**NOTE**: FactoryProf only tracks the database-persisted factories. In case of FactoryGirl/FactoryBot these are the factories
 provided by using `create` strategy. In case of Fabrication - objects that created using `create` method.
 
 ## Instructions
 
-FactoryProf can be used with FactoryGirl or Fabrication - application can be bundled with both gems at the same time.
+FactoryProf can be used with FactoryGirl/FactoryBot or Fabrication - application can be bundled with both gems at the same time.
 
 To activate FactoryProf use `FPROF` environment variable:
 

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "test_prof/ext/string_strip_heredoc"
+require "test_prof/factory_bot"
 
 using TestProf::StringStripHeredoc
 
@@ -18,7 +19,7 @@ module TestProf::EventProf::CustomEvents
     class << self
       def setup!
         @depth = 0
-        FactoryGirl::FactoryRunner.prepend RunnerPatch
+        TestProf::FactoryBot::FactoryRunner.prepend RunnerPatch
       end
 
       def track(factory)
@@ -44,14 +45,15 @@ module TestProf::EventProf::CustomEvents
 end
 
 TestProf.activate('EVENT_PROF', 'factory.create') do
-  if TestProf.require(
-    'factory_girl',
-    <<-MSG.strip_heredoc
-      Failed to load FactoryGirl.
-
-      Make sure that "factory_girl" gem is in your Gemfile.
-    MSG
-  )
+  if defined? TestProf::FactoryBot
     TestProf::EventProf::CustomEvents::FactoryCreate.setup!
+  else
+    TestProf.log(:error,
+                 <<-MSG.strip_heredoc
+                   Failed to load factory_bot / factory_girl.
+
+                   Make sure that any of them is in your Gemfile.
+                 MSG
+                )
   end
 end

data/lib/test_prof/factory_bot.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TestProf # :nodoc: all
+  FACTORY_GIRL_NAMES = { 'factory_bot' => '::FactoryBot', 'factory_girl' => '::FactoryGirl' }.freeze
+
+  FACTORY_GIRL_NAMES.find do |name, cname|
+    TestProf.require(name) do
+      TestProf::FactoryBot = Object.const_get(cname)
+    end
+  end
+end

data/lib/test_prof/factory_default.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof/factory_default/factory_girl_patch"
+require "test_prof/factory_default/factory_bot_patch"
 
 module TestProf
   # FactoryDefault allows use to re-use associated objects
@@ -10,7 +10,7 @@ module TestProf
       def create_default(name, *args, &block)
         set_factory_default(
           name,
-          FactoryGirl.create(name, *args, &block)
+          TestProf::FactoryBot.create(name, *args, &block)
         )
       end
 
@@ -21,11 +21,11 @@ module TestProf
 
     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
+        TestProf::FactoryBot::Syntax::Methods.include DefaultSyntax
+        TestProf::FactoryBot.extend DefaultSyntax
+        TestProf::FactoryBot::Strategy::Create.prepend StrategyExt
+        TestProf::FactoryBot::Strategy::Build.prepend StrategyExt
+        TestProf::FactoryBot::Strategy::Stub.prepend StrategyExt
 
         @store = {}
       end

data/lib/test_prof/factory_default/{factory_girl_patch.rb → factory_bot_patch.rb}

@@ -3,7 +3,7 @@
 module TestProf
   module FactoryDefault # :nodoc: all
     module RunnerExt
-      refine FactoryGirl::FactoryRunner do
+      refine TestProf::FactoryBot::FactoryRunner do
         def name
           @name
         end

data/lib/test_prof/factory_doctor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "test_prof/factory_doctor/factory_girl_patch"
+require "test_prof/factory_doctor/factory_bot_patch"
 
 module TestProf
   # FactoryDoctor is a tool that helps you identify
@@ -49,9 +49,9 @@ module TestProf
 
         log :info, "FactoryDoctor enabled"
 
-        # Monkey-patch FactoryGirl
-        ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch) if
-          defined?(::FactoryGirl)
+        # Monkey-patch FactoryBot / FactoryGirl
+        TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
+          defined?(TestProf::FactoryBot)
 
         subscribe!
 

data/lib/test_prof/factory_doctor/{factory_girl_patch.rb → factory_bot_patch.rb}

@@ -3,7 +3,7 @@
 module TestProf
   module FactoryDoctor
     # Wrap #run method with FactoryDoctor tracking
-    module FactoryGirlPatch
+    module FactoryBotPatch
       def run(strategy = @strategy)
         FactoryDoctor.within_factory(strategy) { super }
       end

data/lib/test_prof/factory_prof.rb

@@ -2,14 +2,14 @@
 
 require "test_prof/factory_prof/printers/simple"
 require "test_prof/factory_prof/printers/flamegraph"
-require "test_prof/factory_prof/factory_builders/factory_girl"
+require "test_prof/factory_prof/factory_builders/factory_bot"
 require "test_prof/factory_prof/factory_builders/fabrication"
 
 module TestProf
   # FactoryProf collects "factory stacks" that can be used to build
   # flamegraphs or detect most popular factories
   module FactoryProf
-    FACTORY_BUILDERS = [FactoryBuilders::FactoryGirl,
+    FACTORY_BUILDERS = [FactoryBuilders::FactoryBot,
                         FactoryBuilders::Fabrication].freeze
 
     # FactoryProf configuration

data/lib/test_prof/factory_prof/{factory_girl_patch.rb → factory_bot_patch.rb}

@@ -3,9 +3,9 @@
 module TestProf
   module FactoryProf
     # Wrap #run method with FactoryProf tracking
-    module FactoryGirlPatch
+    module FactoryBotPatch
       def run(strategy = @strategy)
-        FactoryBuilders::FactoryGirl.track(strategy, @name) { super }
+        FactoryBuilders::FactoryBot.track(strategy, @name) { super }
       end
     end
   end

data/lib/test_prof/factory_prof/factory_builders/{factory_girl.rb → factory_bot.rb}

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require "test_prof/factory_prof/factory_girl_patch"
+require "test_prof/factory_prof/factory_bot_patch"
+require "test_prof/factory_bot"
 
 module TestProf
   module FactoryProf
     module FactoryBuilders
       # implementation of #patch and #track methods
       # to provide unified interface for all factory-building gems
-      class FactoryGirl
-        # Monkey-patch FactoryGirl
+      class FactoryBot
+        # Monkey-patch FactoryBot / FactoryGirl
         def self.patch
-          TestProf.require 'factory_girl' do
-            ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch)
-          end
+          TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
+            defined? TestProf::FactoryBot
         end
 
         def self.track(strategy, factory, &block)

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.4.2".freeze
+  VERSION = "0.4.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-23 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,17 +136,18 @@ files:
 - 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_bot.rb
 - lib/test_prof/factory_default.rb
-- lib/test_prof/factory_default/factory_girl_patch.rb
+- lib/test_prof/factory_default/factory_bot_patch.rb
 - lib/test_prof/factory_doctor.rb
-- lib/test_prof/factory_doctor/factory_girl_patch.rb
+- lib/test_prof/factory_doctor/factory_bot_patch.rb
 - lib/test_prof/factory_doctor/minitest.rb
 - lib/test_prof/factory_doctor/rspec.rb
 - lib/test_prof/factory_prof.rb
 - lib/test_prof/factory_prof/fabrication_patch.rb
+- lib/test_prof/factory_prof/factory_bot_patch.rb
 - lib/test_prof/factory_prof/factory_builders/fabrication.rb
-- lib/test_prof/factory_prof/factory_builders/factory_girl.rb
-- lib/test_prof/factory_prof/factory_girl_patch.rb
+- lib/test_prof/factory_prof/factory_builders/factory_bot.rb
 - lib/test_prof/factory_prof/printers/flamegraph.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb