factory_bot_instruments 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34d9d7992c8e4bcb920d0b65a79e03e6abbc3c91d700dc04078ce44528f871d2
+  data.tar.gz: 9fd18c2bc11f0f139718e6f03200a08e5c4d44dfa7b7ce68824d9594bec3c3f6
+SHA512:
+  metadata.gz: 29927122dcafce132d9b6513ef29d1b431e4adbe1182f5c671d65a25dfbf0ca3e1843e74a3f39b0b98caa7ee1893da35927bd551e720a481b29cc0dee8d8144d
+  data.tar.gz: e6a079d7ff7b4b2fede7ff86d40f058f6c32ddfbf3bb1deb863d989a2b7f929ec9b0e3b524bb3e8e2625649902816b805ac83eaa82e80f5450ca884a244a32bd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at igor@renderedtext.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Igor Šarčević
+
+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,165 @@
+# Factory Bot Instruments
+
+[![Build Status](https://semaphoreci.com/api/v1/shiroyasha/factory_girl_instruments/branches/master/badge.svg)](https://semaphoreci.com/shiroyasha/factory_girl_instruments)
+[![Gem Version](https://badge.fury.io/rb/factory_girl_instruments.svg)](https://badge.fury.io/rb/factory_girl_instruments)
+
+Instruments for benchmarking, tracing, and debugging
+[Factory Bot](https://github.com/thoughtbot/factory_bot) models.
+
+Table of content:
+
+- [Setup](#setup)
+- [Benchmark one Factory](#benchmarking-one-factory-bot-model)
+- [Benchmark all Factories](#benchmarking-all-factory-bot-models)
+- [Trace Factory Bot calls](#tracing-factory-bot-calls)
+
+## Purpose of this gem
+
+Factory Bot is probably the base of your Rails test suite, but how deeply you
+understand the models and the associations that are created in your tests?
+
+Factory Bot Instruments help in these three aspects:
+
+1. Slow test suites: Factory Bot is used for the bulk of tests in Rails. Even a
+   small performance improvement in one of your factories can dramatically
+   improve the speed of your overall test suite.
+
+   Hint: Run `FactoryBot.benchmark_all`.
+
+2. Deeper understanding of the database state: By tracing factory bot and SQL
+   calls you can get a deeper understanding of what is actually created in your
+   tests, helping you to debug the issues faster.
+
+   Hint: Run `FactoryBot.trace { FactoryBot.create(:user) }`.
+
+3. Find issues with missconfigured factories: When a factory is properly set up
+   it is a bliss to work with it. However, if there is a hidden deep in the
+   association chain debugging the created model can be a hellish experience.
+
+   Hint: Run `FactoryBot.trace { FactoryBot.create(:user) }` and observe the
+   chain of calls.
+
+## Install
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'factory_bot_instruments'
+```
+
+and run `bundle install` from your shell.
+
+To install the gem manually from your shell, run:
+
+``` ruby
+gem install factory_bot_instruments
+```
+
+## Documentation
+
+### Benchmarking one Factory Bot model
+
+If you have a `user` factory, you can benchmark it with:
+
+``` ruby
+FactoryBot.benchmark(:user)
+```
+
+By default, the `FactoryBot.create(<model>)` is called. You can pass `:method`
+to override this:
+
+``` ruby
+FactoryBot.benchmark(:user, :method => :build_stubbed)
+```
+
+The above snippet will call `FactoryBot.build_stubbed(:user)`.
+
+### Benchmarking all Factory Bot models
+
+To collect benchmarking information from all Factory Bot models:
+
+``` ruby
+FactoryBot.benchmark_all
+```
+
+To skip a factory, pass the `:except` options:
+
+``` ruby
+FactoryBot.benchmark_all(:except => [:user])
+```
+
+By default, benchmarks for `FactoryBot.create(<model>)`,
+`FactoryBot.build(<model>)`, `FactoryBot.build_stubbed(<model>)` are
+collected. You can override this by passing an array of methods:
+
+``` ruby
+FactoryBot.benchmark_all(:methods => [:create]) # benchmark only :create
+```
+
+### Tracing Factory Bot calls
+
+To trace factory Bot actions, wrap your call in the `FactoryBot.trace` method:
+
+``` ruby
+FactoryBot.trace do
+  FactoryBot.create(:comment)
+end
+```
+
+The above snippet will output the following tree:
+
+``` txt
+┌ (start) create :comment
+|  ┌ (start) create :user
+|  |  (0.1ms)  begin transaction
+|  |  (0.4ms)  INSERT INTO "users" ("name", "username") VALUES (?, ?)  [["name", "Peter Parker"], ["username", "spiderman"]]
+|  |  (2.3ms)  commit transaction
+|  └ (finish) create :user [0.010s]
+|  ┌ (start) create :article
+|  |  ┌ (start) create :user
+|  |  |  (0.1ms)  begin transaction
+|  |  |  (0.3ms)  INSERT INTO "users" ("name", "username") VALUES (?, ?)  [["name", "Peter Parker"], ["username", "spiderman"]]
+|  |  |  (1.8ms)  commit transaction
+|  |  └ (finish) create :user [0.007s]
+|  |  (0.1ms)  begin transaction
+|  |  (0.2ms)  INSERT INTO "articles" ("title", "content", "user_id") VALUES (?, ?, ?)  [["title", "New Article"], ["content", "article content"], ["user_id", "121"]]
+|  |  (1.5ms)  commit transaction
+|  └ (finish) create :article [0.021s]
+|  (0.1ms)  begin transaction
+|  (0.2ms)  INSERT INTO "comments" ("content", "user_id", "article_id") VALUES (?, ?, ?)  [["content", "First!"], ["user_id", "120"], ["article_id", "61"]]
+|  (1.5ms)  commit transaction
+└ (finish) create :comment [0.046s]
+```
+
+To trace without SQL logs, use the following:
+
+``` ruby
+FactoryBot.trace(sql: false) do
+  FactoryBot.create(:comment)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/shiroyasha/factory_girl_instruments. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code
+of conduct.
+
+## 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 "factory_bot_instruments"
+
+# 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(__FILE__)

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/factory_bot_instruments.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'factory_bot_instruments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "factory_bot_instruments"
+  spec.version       = FactoryBotInstruments::VERSION
+  spec.authors       = ["Igor Šarčević"]
+  spec.email         = ["igor@renderedtext.com"]
+
+  spec.summary       = %q{Instruments for Factory Bot}
+  spec.description   = %q{Instruments for Factory Bot}
+  spec.homepage      = "https://github.com/shiroyasha/factory_girl_instruments"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "factory_bot", "~> 4.5"
+  spec.add_dependency "activerecord", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/factory_bot_instruments.rb

@@ -0,0 +1,22 @@
+require "factory_bot_instruments/version"
+
+require "factory_bot"
+require "active_record"
+
+require_relative "factory_bot_instruments/benchmarking"
+require_relative "factory_bot_instruments/tracing"
+
+FactoryBot.extend(FactoryBotInstruments::Benchmarking)
+FactoryBot.extend(FactoryBotInstruments::Tracing)
+
+module FactoryBotInstruments
+
+  def self.benchmark_report(options = {})
+    options = { :progress => true }.merge(options)
+
+    FactoryBot.benchmark_all(options).each do |benchmark|
+      puts benchmark
+    end
+  end
+
+end

data/lib/factory_bot_instruments/benchmarking.rb

@@ -0,0 +1,41 @@
+module FactoryBotInstruments
+  module Benchmarking
+    def benchmark_all(
+      except: [],
+      methods: [:create, :build, :build_stubbed],
+      progress: false)
+
+      factories = FactoryBot.factories.map(&:name) - except
+
+      report = factories.map do |factory|
+        puts "Processing #{factory}" if progress
+
+        methods.map do |method|
+          benchmark(factory, :method => method)
+        end
+      end
+
+      report.flatten.sort_by(&:duration)
+    end
+
+    def benchmark(factory, method: :create)
+      start = Time.now
+
+      ActiveRecord::Base.transaction do
+        FactoryBot.public_send(method, factory)
+
+        raise ActiveRecord::Rollback
+      end
+
+      Benchmark.new(factory, method, Time.now - start)
+    end
+  end
+
+  Benchmark = Struct.new(:factory, :method, :duration) do
+    def to_s
+      formated_duration = format("%5.3fs", duration)
+
+      "#{formated_duration}: FactoryBot.#{method}(:#{factory})"
+    end
+  end
+end

data/lib/factory_bot_instruments/tracing.rb

@@ -0,0 +1,84 @@
+$FACTORY_BOT_INSTRUMENTS_TRACING = false
+$FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH = 0
+
+# monkey patch Factory#run
+module FactoryBot
+  class Factory
+    alias_method :original_run, :run
+
+    def run(build_strategy, overrides, &block)
+      if $FACTORY_BOT_INSTRUMENTS_TRACING
+        depth     = "|  " * $FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH
+        signature = "#{build_strategy} \e[32m:#{@name}\e[0m"
+        start     = Time.now
+
+        puts "#{depth}┌ (start) #{signature}"
+        $FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH += 1
+      end
+
+      result = original_run(build_strategy, overrides, &block)
+
+      if $FACTORY_BOT_INSTRUMENTS_TRACING
+        duration = format("%4.3fs", Time.now - start)
+        puts "#{depth}└ (finish) #{signature} [#{duration}]"
+
+        $FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH -= 1
+      end
+
+      result
+    end
+  end
+end
+
+module FactoryBotInstruments
+  module TracingHelpers
+    def self.uncolorize(string)
+      string.gsub(/\033\[\d+m/, "")
+    end
+
+    def self.sql_tracer(active)
+      return yield unless active
+
+      begin
+        stdout_log = Logger.new($stdout)
+
+        stdout_log.formatter = proc do |severity, datetime, progname, msg|
+          depth = "|  " * ($FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH - 1)
+
+          msg = FactoryBotInstruments::TracingHelpers.uncolorize(msg)
+          msg = msg.strip
+          msg = msg.gsub(/^SQL /, "") # remove SQL prefix
+
+          "#{depth}|  \e[36m#{msg}\e[0m\n"
+        end
+
+        standard_logger = ActiveRecord::Base.logger
+        ActiveRecord::Base.logger = stdout_log
+
+        yield
+      ensure
+        ActiveRecord::Base.logger = standard_logger
+      end
+    end
+  end
+
+  module Tracing
+    def trace(sql: true)
+      result = nil
+
+      begin
+        $FACTORY_BOT_INSTRUMENTS_TRACING = true
+        $FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH = 0
+
+        FactoryBotInstruments::TracingHelpers.sql_tracer(sql) do
+          result = yield
+        end
+      ensure
+        $FACTORY_BOT_INSTRUMENTS_TRACING = false
+        $FACTORY_BOT_INSTRUMENTS_TRACING_DEPTH = 0
+      end
+
+      result
+    end
+  end
+end

data/lib/factory_bot_instruments/version.rb

@@ -0,0 +1,3 @@
+module FactoryBotInstruments
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: factory_bot_instruments
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Igor Šarčević
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Instruments for Factory Bot
+email:
+- igor@renderedtext.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- factory_bot_instruments.gemspec
+- lib/factory_bot_instruments.rb
+- lib/factory_bot_instruments/benchmarking.rb
+- lib/factory_bot_instruments/tracing.rb
+- lib/factory_bot_instruments/version.rb
+homepage: https://github.com/shiroyasha/factory_girl_instruments
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Instruments for Factory Bot
+test_files: []