slow_factory_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b22e8ede1da987ee803cdb2cd2efaaec13cc30c
+  data.tar.gz: f564caedce2c84631564990b4a7093a4fee40941
+SHA512:
+  metadata.gz: ccaddfbf454c5763b0ca1ad6079af5dec3304ca816c70886a5191602d5e173d5cf3cfb7e0e3abc56e1355388883d4009d7ffc16d33c36dfe201aa6e42d0f632f
+  data.tar.gz: a898b29430ef3f9660254f87a42886ecabf52c1400f179ae7848ad513298a4dd3d5a123f0bc44987417553e1dfccc1dd7cdfa1dc8a8d2dde6caf9ba7cd16bd5f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 mrageh
+
+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,93 @@
+# SlowFactoryFormatter https://codeship.com/projects/118608/status?branch=master
+
+This gem is a custom RSpec formatter that allows you to generate a table of
+slow factories when you run your tests.
+
+My naive definition of a slow factory is any factory that takes more then half
+a second to setup or any factory that creates or builds more then five instances
+of itself.
+
+## Why use SlowFactoryFormatter
+
+[FactoryGirl](https://github.com/thoughtbot/factory_girl) allows you to quickly
+and painlessly setup factories that you can use in your tests. The problem with
+[FactoryGirl](https://github.com/thoughtbot/factory_girl) is that it makes it
+very easy to write your factories in such a way that a valid factory can end up
+creating or building a big tree of objects. When you try to use a factory that
+sets up a lot of objects in a simple test case, you'll end up slowing down your
+test suite, unaware of just how many objects are being setup in the background.
+
+This can quickly increase the time it takes a test suite to run and as a team
+grows it can really start to slow the time it takes your build to run.
+
+I've seen projects where one of the main causes of a slow build is the number of
+factories being setup in each example group.
+
+The main benefit of using SlowFactoryFormatter is that it will help you identify
+the number of objects being setup, when you run a test.
+
+## Installation
+
+This gem is intended to be used on a Rails project and you will need to have
+FactoryGirl, RSpec version 3.4 or later and ActiveSupport version 4 or
+later in your project.
+
+To use this gem with a Rails project add this line to your Gemfile:
+
+```ruby
+group :test do
+  gem 'slow_factory_formatter'
+end
+```
+
+And then run:
+
+    `$ bundle`
+
+Or install it yourself as:
+
+    `$ gem install slow_factory_formatter`
+
+## Usage
+
+You can either use this gem when running `rspec` command:
+
+```
+rspec spec/models/user_spec --format SlowFactoryFormatter
+```
+
+```
++------------------------------+--------+-------+---------------+----------------------+
+|                                    Slow Factories                                    |
++------------------------------+--------+-------+---------------+----------------------+
+| Factory Name                 | Create | Build | Build Stubbed | Total Time (in secs) |
++------------------------------+--------+-------+---------------+----------------------+
+| user                         | 67     | 2     | 16            | 4.48                 |
+| product                      | 45     | 0     | 2             | 1.16                 |
+| order                        | 97     | 0     | 0             | 3.66                 |
+| admin                        | 49     | 12    | 1             | 3.02                 |
+| project                      | 33     | 40    | 34            | 4.33                 |
+| customer                     | 88     | 43    | 2             | 6.16                 |
+| manager                      | 12     | 23    | 0             | 1.10                 |
++------------------------------+--------+-------+---------------+----------------------+
+```
+
+Or if you want to use it every time you run a test in your project, you can add
+it to `.rspec` file in the root of your project directory:
+
+```
+--format SlowFactoryFormatter
+```
+
+This will make SlowFactoryFormatter your default formatter and you'll see a
+table similar to the one above of slow factories whenever you run a test, unless
+you have no slow factories.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrageh/slow_factory_formatter.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slow_factory_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/slow_factory_formatter.rb

@@ -0,0 +1,8 @@
+module RSpec
+  lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  $LOAD_PATH << lib unless $LOAD_PATH.include?(lib)
+
+  if defined?(::RSpec::Core) && ::RSpec::Core::Version::STRING >= '3.0.0'
+    require "slow_factory_formatter/slow_factory_formatter"
+  end
+end

data/lib/slow_factory_formatter/factories_table.rb

@@ -0,0 +1,63 @@
+class FactoriesTable
+  attr_reader :factories
+
+  def initialize
+    @factories = {}
+  end
+
+  def add_factory(start:, finish:, payload:)
+    execution_time_in_seconds = finish - start
+
+    factory_name = payload[:name]
+    strategy_name = payload[:strategy]
+
+    factories[factory_name] ||= Hash.new { |factory, strategy| factory[strategy] = Hash.new(0) }
+    factories[factory_name][strategy_name][:occurences] += 1
+    factories[factory_name][strategy_name][:time_in_seconds] += execution_time_in_seconds
+  end
+
+  def display_slow_factories
+    remove_fast_factories
+
+    if factories.any?
+      populate_table
+      puts table
+    end
+  end
+
+  private
+
+  attr_reader :table
+
+  def remove_fast_factories
+    factories.select! do |factory_name, data|
+      data.any? { |strategy_name, prop| prop[:occurences] > 5 || prop[:time_in_seconds] > 0.5 }
+    end
+  end
+
+  def populate_table
+    table_headings = ['Factory Name', 'Create', 'Build', 'Build Stubbed', 'Total Time (in secs)']
+    @table = Terminal::Table.new(
+      title: "Slow Factories",
+      headings: table_headings
+    )
+
+    factories.each do |factory_name, data|
+      populate_row(factory_name, data)
+    end
+  end
+
+  def populate_row(factory_name, data)
+    row = []
+    row << factory_name
+
+    [:create, :build, :build_stubbed].map do |strategy|
+      row << data[strategy][:occurences]
+    end
+
+    time_in_seconds = data.inject(0) { |acc, (_, prop)| acc += prop[:time_in_seconds] }
+
+    row << time_in_seconds.round(2)
+    table << row
+  end
+end

data/lib/slow_factory_formatter/slow_factory_formatter.rb

@@ -0,0 +1,30 @@
+require "terminal-table"
+require "rspec/core"
+require "rspec/core/formatters/documentation_formatter"
+require_relative "factories_table"
+
+class SlowFactoryFormatter < RSpec::Core::Formatters::DocumentationFormatter
+  RSpec::Core::Formatters.register self, :start, :dump_summary
+
+  def initialize(output)
+    @factories_table ||= FactoriesTable.new
+    super
+  end
+
+  def start(notification)
+    ActiveSupport::Notifications.subscribe("factory_girl.run_factory") do |_, start, finish, id, payload|
+      factories_table.add_factory(start: start, finish: finish, payload: payload)
+    end
+
+    super
+  end
+
+  def dump_summary(notification)
+    factories_table.display_slow_factories
+    super
+  end
+
+  private
+
+  attr_reader :factories_table
+end

data/slow_factory_formatter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "slow_factory_formatter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["mrageh"]
+  spec.email         = ["adam@mrageh.com"]
+
+  spec.summary       = %q{Generate a table that contains the slowest factories}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/mrageh/slow_factory_formatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rspec-core", "~> 3.4"
+  spec.add_runtime_dependency "terminal-table", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: slow_factory_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mrageh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Generate a table that contains the slowest factories
+email:
+- adam@mrageh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slow_factory_formatter.rb
+- lib/slow_factory_formatter/factories_table.rb
+- lib/slow_factory_formatter/slow_factory_formatter.rb
+- slow_factory_formatter.gemspec
+homepage: https://github.com/mrageh/slow_factory_formatter
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Generate a table that contains the slowest factories
+test_files: []