factory_girl_test_monitor 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8d49e4f70dca393d3048626971505a26a5d8dbf
+  data.tar.gz: 46f025e7dea3110429013b8a948eb3ae48e1af3d
+SHA512:
+  metadata.gz: f76cf332b6f67cebb47fbde94cc955757a17421f2ffd88cbf4224706d2c8bacc6a548c759a13ef1c050583e2710056c33a19db1c1a148d845906a3853d16c0b4
+  data.tar.gz: 26da9ec9601cd26bbca9b56a19e0d47d9844e612d355cb7c8d389bc027ffcaed61b2fa37d2810faf28a691e71177f74c2fbefebd3ebff3828aee8907d0197782

data/README.md

@@ -0,0 +1,46 @@
+## FactoryGirl Test Monitor
+
+Monitors FactoryGirl strategy invocations (e.g. build, create, etc.) per test with ActiveSupport Instrumentation as described in FactoryGirl's getting started doc in order to output the strategy invocations.
+
+Tries to automatically integrate with MiniTest and/or RSpec.
+
+Has a configurable threshold for strategy invocations before printing a warning message.
+
+This may be very helpful if you are getting "SystemStackError:   stack level too deep" errors caused by factory_girl factories. Those are not always trivial to track down without having more info about strategy invocations.
+
+Depending on your reporter, etc. might look something like this in your test output:
+
+    FactoryGirlTestMonitor.strategy_invocation_max of 199 was exceeded: {:customer=>{:create=>1}, :contact=>{:create=>1}, :project=>{:create=>216}}
+    ...
+      SystemStackError:   stack level too deep
+      /path/to/activesupport.../lib/active_support/notifications/instrumenter.rb:23
+
+There you can see that the project factory is involved in 216 creates, which was more in this case than the intended number.
+
+### Setup
+
+In your ActiveRecord/Rails 3.1+ project, add this to your Gemfile in your test group:
+
+    gem 'factory_girl_test_monitor'
+
+Then run:
+
+    bundle install
+
+### Configuration
+
+By default the max strategy invocations is 199. To reconfigure can do this in an initializer:
+
+    FactoryGirlTestMonitor.strategy_invocation_max = 199
+
+### Debug
+
+To track down why support is not being added for minitest or rspec:
+
+    FactoryGirlTestMonitor.debug = true
+
+### License
+
+Copyright (c) 2013 Gary S. Weaver, released under the [MIT license][lic].
+
+[lic]: http://github.com/garysweaver/factory_girl_test_monitor/blob/master/LICENSE

data/lib/factory_girl_test_monitor.rb

@@ -0,0 +1,94 @@
+require 'factory_girl'
+require 'active_support/notifications'
+
+module FactoryGirlTestMonitor
+  class << self
+    attr_accessor :strategy_invocation_max, :debug
+  end
+end
+
+FactoryGirlTestMonitor.strategy_invocation_max = 199
+
+# MiniTest support
+begin
+  require 'minitest/unit'
+
+  module FactoryGirlTestMonitor
+    module MiniTestFactoryStrategyInvocationCollector
+      def before_setup
+        @factory_girl_run_factories = {}
+        @factory_girl_max_invocations = 0
+        ActiveSupport::Notifications.subscribe("factory_girl.run_factory") do |name, start, finish, id, payload|
+          factory_name = payload[:name]
+          strategy_name = payload[:strategy]
+          @factory_girl_run_factories[factory_name] ||= {}
+          @factory_girl_run_factories[factory_name][strategy_name] ||= 0
+          @factory_girl_run_factories[factory_name][strategy_name] += 1
+          this_num = @factory_girl_run_factories[factory_name][strategy_name]
+          @factory_girl_max_invocations = [@factory_girl_max_invocations, @factory_girl_run_factories[factory_name][strategy_name]].max
+        end
+        super if defined?(super)
+      end
+    end
+  end
+
+  class MiniTest::Unit::TestCase
+    include ::FactoryGirlTestMonitor::MiniTestFactoryStrategyInvocationCollector
+  end
+
+  if defined? Minitest::Test
+    class Minitest::Test
+      alias_method :run_with_factory_girl_test_monitor, :run
+
+      def run
+        run_with_factory_girl_test_monitor
+      ensure
+        puts "\nFactoryGirlTestMonitor.strategy_invocation_max of #{FactoryGirlTestMonitor.strategy_invocation_max} was exceeded: #{@factory_girl_run_factories.inspect}" if defined?(@factory_girl_run_factories) && @factory_girl_max_invocations > FactoryGirlTestMonitor.strategy_invocation_max
+      end
+    end
+  else
+    class MiniTest::Unit::TestCase
+      alias_method :run_with_factory_girl_test_monitor, :run
+
+      def run(runner)
+        run_with_factory_girl_test_monitor(runner)
+      ensure
+        puts "\nFactoryGirlTestMonitor.strategy_invocation_max of #{FactoryGirlTestMonitor.strategy_invocation_max} was exceeded: #{@factory_girl_run_factories.inspect}" if defined?(@factory_girl_run_factories) && @factory_girl_max_invocations > FactoryGirlTestMonitor.strategy_invocation_max
+      end
+    end
+  end
+
+rescue LoadError, NameError => e
+  if FactoryGirlTestMonitor.debug
+    puts "FactoryGirlTestMonitor debug: Attempt to add MiniTest support failed: {e.message}\n  #{e.backtrace.join("  \n")}"
+  end
+end
+
+# RSpec support
+begin
+  require 'rspec/expectations'
+  RSpec.configure do |config|
+    config.around(:each) do |t|
+      @factory_girl_run_factories = {}
+      @factory_girl_max_invocations = 0
+      ActiveSupport::Notifications.subscribe("factory_girl.run_factory") do |name, start, finish, id, payload|
+        factory_name = payload[:name]
+        strategy_name = payload[:strategy]
+        @factory_girl_run_factories[factory_name] ||= {}
+        @factory_girl_run_factories[factory_name][strategy_name] ||= 0
+        @factory_girl_run_factories[factory_name][strategy_name] += 1
+        this_num = @factory_girl_run_factories[factory_name][strategy_name]
+        @factory_girl_max_invocations = [@factory_girl_max_invocations, @factory_girl_run_factories[factory_name][strategy_name]].max
+      end
+      begin
+        t.run
+      ensure
+        puts "\nFactoryGirlTestMonitor.strategy_invocation_max of #{FactoryGirlTestMonitor.strategy_invocation_max} was exceeded: #{@factory_girl_run_factories.inspect}" if defined?(@factory_girl_run_factories) && @factory_girl_max_invocations > FactoryGirlTestMonitor.strategy_invocation_max
+      end
+    end
+  end
+rescue LoadError, NameError => e
+  if FactoryGirlTestMonitor.debug
+    puts "FactoryGirlTestMonitor debug: Attempt to add RSpec support failed: {e.message}\n  #{e.backtrace.join("  \n")}"
+  end
+end

data/lib/factory_girl_test_monitor/version.rb

@@ -0,0 +1,3 @@
+module FactoryGirlTestMonitor
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: factory_girl_test_monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+description: Monitors FactoryGirl strategy invocations (e.g. build, create, etc.)
+  per test with ActiveSupport Instrumentation as described in FactoryGirl's getting
+  started doc in order to output the strategy invocations.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/factory_girl_test_monitor.rb
+- lib/factory_girl_test_monitor/version.rb
+homepage: https://github.com/garysweaver/factory_girl_test_monitor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Help diagnose stack too deep errors related to factory_girl factories in
+  minitest/rspec tests automatically.
+test_files: []