factory_inspector 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

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

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm --create use 1.9.3@factory_inspector
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    factory_inspector (0.0.1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  factory_inspector!
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Kennedy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# FactoryInspector
+
+This very simple gem reports on how FactoryGirl factories 
+are being used during your test runs. This is useful in
+understanding where the time is going during your test
+runs - while FactoryGirl is useful, overuse can lead to
+serious slowdowns to a cascade of database writes when
+building a test object.
+
+This is a developer's tool; the Gem makes no effort to
+sanitize inputs or help you avoid making mistakes. It
+relies on the changes brought in with FactoryGirl 3.2:
+    http://robots.thoughtbot.com/post/21719164760/factorygirl-3-2-so-awesome-it-needs-to-be-released
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'factory_inspector'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install factory_inspector
+
+## Usage
+
+FactoryInspector's API is just two methods - `start_inspection` and `generate_report`. 
+
+Let's take a hypothetical `spec/spec_helper.rb` on a RSpec based
+project; the changes to use FactoryInspector would be:
+
+```ruby
+  require 'factory_inspector'
+
+  # From a project relative filename like 'log/filename.txt'
+  # generate the full path.
+  # TODO There must be simpler way to do this?
+  def get_project_path_for(filename)
+    "#{File.dirname(__FILE__)}/../#{filename}"
+  end
+
+  factory_inspector = FactoryInspector.new
+  RSpec.configure do |config|
+
+    config.before :suite do
+      factory_inspector.start_inspection
+    end
+
+    config.after :suite do
+      report_name = 'log/factory_inspector_report.txt'
+      report_path = get_project_path_for report_name 
+      factory_inspector.generate_report report_path
+      puts "Factory Inspector report in '#{report_name}'"
+    end
+  end
+```
+
+After the tests have run, the nominated log file will have output
+similar to this:
+
+```
+FACTORY INSPECTOR - 46 FACTORIES USED
+  FACTORY NAME                TOTAL  OVERALL   TIME PER  LONGEST   STRATEGIES
+                              CALLS  TIME (s)  CALL (s)  CALL (s)            
+  school_with_terms             1    0.4783    0.47827  0.4783      [:create]
+  school_with_terms_and_cla     5    2.3859    0.47718  0.5184      [:create]
+  school_leaver                 1    0.2581    0.25808  0.2581      [:create]
+  pre_enrolled_pupil            1    0.2570    0.25704  0.2570      [:create]
+  pupil_school_enrolment_fo     1    0.2008    0.20075  0.2008      [:build]
+  announcement                  5    0.8973    0.17946  0.2327      [:create]
+  sub_class_with_pupils         5    0.7961    0.15921  0.2163      [:create, :build]
+  etc
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/factory_inspector.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/factory_inspector/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Kennedy"]
+  gem.email         = ["david.kennedy@examtime.com"]
+  gem.description   = %q{This very simple gem generates reports on how FactoryGirl factories are being used in your test runs.}
+  gem.summary       = %q{Reports on how FactoryGirl is used in test runs.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "factory_inspector"
+  gem.require_paths = ["lib"]
+  gem.version       = FactoryInspector::VERSION
+
+  gem.add_dependency 'activesupport'
+
+  gem.add_development_dependency 'bundler', '>= 1.0.0'
+  gem.add_development_dependency 'rspec'
+end

data/lib/factory_inspector/report.rb

@@ -0,0 +1,50 @@
+module FactoryInspector
+
+  # Report on how a FactoryGirl Factory was used in a test run.
+  # Holds simple metrics and can be updated with new calls.
+  class Report
+
+    attr_reader :factory_name,
+                :calls,
+                :worst_time_in_seconds,
+                :total_time_in_seconds,
+                :strategies
+
+    def initialize(factory_name)
+      @factory_name = factory_name
+      @calls = 0
+      @worst_time_in_seconds = 0
+      @total_time_in_seconds = 0
+      @strategies = []
+    end
+
+    def time_per_call_in_seconds
+      return 0 if @calls == 0
+      @total_time_in_seconds / @calls
+    end
+
+    # Update this report with a new call
+    # * [time] The time taken, in seconds, to call the factory
+    # * [strategy] The strategy used by the factory
+    def update(time, strategy)
+      record_call
+      record_time time
+      if not @strategies.include? strategy
+        @strategies << strategy
+      end
+    end
+
+  private
+
+    def record_call
+      @calls += 1
+    end
+
+    def record_time(time)
+      @worst_time_in_seconds = time if time > @worst_time_in_seconds
+      @total_time_in_seconds += time
+    end
+
+  end
+
+end

data/lib/factory_inspector/version.rb

@@ -0,0 +1,3 @@
+module FactoryInspector
+  VERSION = "0.0.1"
+end

data/lib/factory_inspector.rb

@@ -0,0 +1,58 @@
+require 'factory_inspector/version'
+require 'factory_inspector/report'
+require 'active_support/notifications'
+
+module FactoryInspector
+
+  def self.new
+    Inspector.new
+  end
+
+  class Inspector
+
+    def start_inspection
+      @reports = {}
+      ActiveSupport::Notifications.subscribe('factory_girl.run_factory') do |name, start_time, finish_time, id, payload|
+        analyze(payload[:name], start_time, finish_time, payload[:strategy])
+      end
+    end
+
+    def generate_report(output_filename)
+      file = File.open(output_filename, 'w')
+
+      file.write "FACTORY INSPECTOR - #{@reports.values.size} FACTORIES USED\n"
+      file.write "  FACTORY NAME                TOTAL  OVERALL   TIME PER  LONGEST   STRATEGIES\n"
+      file.write "                              CALLS  TIME (s)  CALL (s)  CALL (s)            \n"
+      @reports.sort_by{ |name,report| report.time_per_call_in_seconds }.reverse.each do |report_name, report|
+        line = sprintf("  %-25.25s % 5.0d    %5.4f    %5.5f  %5.4f      %s\n",
+                     report.factory_name,
+                     report.calls,
+                     report.total_time_in_seconds,
+                     report.time_per_call_in_seconds,
+                     report.worst_time_in_seconds,
+                     report.strategies)
+        file.write(line)
+      end
+
+      file.close
+    end
+
+    # Callback for use by ActiveSupport::Notifications, not for end
+    # user use directly though it has to be public for ActiveSupport
+    # to see it.
+    #
+    # * [factory_name] Factory name
+    # * [start_time] The start time of the factory call
+    # * [finish_time] The finish time of the factory call
+    # * [strategy] The strategy used when calling the factory
+    #
+    def analyze(factory_name, start_time, finish_time, strategy)
+      if not @reports.has_key? factory_name
+        @reports[factory_name] = FactoryInspector::Report.new(factory_name)
+      end
+      @reports[factory_name].update(finish_time - start_time, strategy)
+    end
+
+  end
+
+end

data/spec/report_spec.rb

@@ -0,0 +1,63 @@
+require 'factory_inspector/report'
+
+describe FactoryInspector::Report do
+
+  let(:foo) { 'FooFactory' }
+
+  context 'on construction' do
+    before :all do
+      @report = FactoryInspector::Report.new(:foo)
+    end
+
+    it 'should be named for the factory' do
+      @report.factory_name.should == :foo
+    end
+
+    it 'should have recorded zero calls' do
+      @report.calls.should == 0
+    end
+
+    it 'should have a zero worst time' do
+      @report.worst_time_in_seconds.should == 0
+    end
+
+    it 'should have a zero total time' do
+      @report.total_time_in_seconds.should == 0
+    end
+
+    it 'should have recorded no strategies' do
+      @report.strategies.should be_empty
+    end
+
+    it 'should have a zero time-per-call' do
+      @report.time_per_call_in_seconds.should == 0
+    end
+  end
+
+  context "on update" do
+    before :all do
+      @report = FactoryInspector::Report.new(:foo)
+      @report.update(3, 'build')
+      @report.update(5, 'create')
+    end
+
+    it 'should have incremented the call count' do
+      @report.calls.should == 2
+    end
+
+    it 'should have recorded the total time' do
+      @report.total_time_in_seconds.should == 8
+    end
+
+    it 'should report the time per call' do
+      @report.total_time_in_seconds.should == 8
+      @report.calls.should == 2
+      @report.time_per_call_in_seconds.should == 4
+    end
+
+    it 'should report the strategies used' do
+      @report.strategies.should == ['build', 'create']
+    end
+  end
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: factory_inspector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Kennedy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This very simple gem generates reports on how FactoryGirl factories are
+  being used in your test runs.
+email:
+- david.kennedy@examtime.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- factory_inspector.gemspec
+- lib/factory_inspector.rb
+- lib/factory_inspector/report.rb
+- lib/factory_inspector/version.rb
+- spec/report_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Reports on how FactoryGirl is used in test runs.
+test_files:
+- spec/report_spec.rb