factory_bot_any_instance 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbfb3943f763eedc5f4e94964b7c7d74f6d48248
+  data.tar.gz: abfb9a0e35ccde3230d0003b9b6465025c4678da
+SHA512:
+  metadata.gz: 35cb55dbc5937bf3adfcb74f4a0b2b210ab558b76a571c4092bdc046f82986cc1d4bf0b492116923f0afdaa970154efa6565b67cadd8bb9e441f352a6a3b5d09
+  data.tar.gz: 771d32bf3fbcc19432766da947eef54b98ba4b3484c8b721a1a7aebd09fac3b2bf9d9af2f52219a3053fe8e14979fd97b119912bab6e125982dea7a82d156bd7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/HISTORY.md

@@ -0,0 +1,3 @@
+### 1.0.0
+
+* Initial release

data/MIT_LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Brian Durand
+
+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,123 @@
+This gem provides helper methods to [FactoryBot](https://github.com/thoughtbot/factory_bot) to support memoization and reuse of factory created instances.
+
+The goal is to clean up test code and speed up performance where your tests use models that have required associations but where those associations are not themselves referenced in the tests.
+
+### Example
+
+For instance, suppose you have factories for a BlogPost model which has many Comments and each comment requires an associated User:
+
+```ruby
+FactoryBot.define do
+  factory :blog_post_ do
+    title "Test Post"
+    ...
+  end
+  
+  factory :comment do
+    body "Test comment"
+    blog_post
+    user
+  end
+  
+  factory :user do
+    name "Test User"
+    ...
+  end
+end
+```
+
+Now if you need 30 comments for a blog post in your test:
+
+```ruby
+  post = create(:blog_post)
+  create_list(:comment, :blog_post => post)
+```
+
+However, this will create 30 unique User records which could be expensive if the User record has it's own required associations or performs several callbacks. A simple solution is to provide a single User record for all the Comments:
+
+```ruby
+  post = create(:blog_post)
+  user = create(:user)
+  create_list(:comment, :blog_post => post, :user => user)
+```
+
+This gem provides an extension to the FactoryBot DSL so that you can accomplish the same thing at the factory level. This can help keep your test code clean since you don't have to declare additional variables that aren't relevant to the test.
+
+```ruby
+  post = create(:blog_post)
+  create_list(:comment, :blog_post => post, :user => any(:user))
+```
+
+The `any` method will return an object using the specified factory with default attributes. On the first invocation of `any` it will create the object; on subsequent calls it will return the same object.
+
+You can also use the `any` method in your factory definitions so that the factory will re-use an associated record by default. This can make your tests much cleaner when the models get more complicated with layers of required associations. It can also help speed up a test suite that's already been written and gotten slower without having to rewrite every test case.
+
+```ruby
+FactoryBot.define do
+  factory :comment do
+    body "Test comment"
+    blog_post
+    user { any(:user) }
+  end
+end
+```
+
+Note that you must include the `any` call inside a block in your factory so that it will only get evaluated at runtime. Be careful with this method, though, because it could slow down your test suite if you make use of the `build` method because the `any` defined objects will be inserted into the database.
+
+### Cleaning Up
+
+You *MUST* cleanup the instantiated instances between tests or you will have random artifacts spanning them. Most test suites clear the database between runs so these artifacts will also be completely invalid. To do this you must call the `clear_instances` method. You can set up your test suite to do this before every test.
+
+#### RSpec
+
+Add this to your `spec_helper.rb` file:
+
+```ruby
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+  config.before do
+    clear_instances
+  end
+end
+```
+
+#### Minitest::Spec
+
+Add this to your `test_helper.rb` file:
+
+```ruby
+class Minitest::Spec
+  include FactoryBot::Syntax::Methods
+  
+  before do
+    clear_instances
+  end
+end
+```
+
+#### ActiveSupport::TestCase
+
+Add this to your `test_helper.rb` file:
+
+```ruby
+class ActiveSupport::TestCase
+  include FactoryBot::Syntax::Methods
+  
+  setup do
+    clear_instances
+  end
+end
+```
+
+#### Minitest::Unit
+
+Call `FactoryBot.clear_instances` in the setup method on all your test classes.
+
+### Helper Methods
+
+All of these examples assume you've included `FactoryBot::Syntax::Methods` in your test helper. This gem adds the `any` and `clear_instances` methods to those helpers. If you don't include the helper methods, you must call `FactoryBot.any` and `FactoryBot.clear_instances` instead.
+
+### Parallelizing
+
+This code is not compatible with multithreaded test runners. It will work fine with multi process test runners.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/factory_bot_any_instance.gemspec

@@ -0,0 +1,24 @@
+# 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          = "factory_bot_any_instance"
+  spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).chomp
+  spec.authors       = ["Brian Durand"]
+  spec.email         = ["bbdurand@gmail.com"]
+  spec.summary       = "Adds helper methods to FactoryBot to memoize instances to speed up test suite"
+  spec.description   = "Adds helper methods to FactoryBot to memoize instances to speed up test suite."
+  spec.homepage      = "https://github.com/bdurand/factory_bot_any_instance"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>=2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/factory_bot_any_instance.rb

@@ -0,0 +1,44 @@
+require 'factory_bot'
+require 'thread'
+
+# This module adds helper methods to FactoryBot to memoize instances created by factories.
+module FactoryBot::AnyInstance
+  
+  # Create or return an instance of the specified factory. If this method has been called
+  # previously with the same factory name, then the previously created instance will be returned.
+  # Otherwise a new instance will be created using all the default factory settings and stored
+  # until `clear_instances` is called.
+  def any(factory_name)
+    factory_name = factory_name.to_sym
+    instance = any_instances[factory_name]
+    unless instance
+      instance = FactoryBot.create(factory_name)
+      @any_instance_lock.synchronize do
+        @any_instances[factory_name] = instance
+      end
+    end
+    instance
+  end
+  
+  # Clear all the memoized instances. Instances are kept in a global namespace and
+  # must be cleared between test runs.
+  def clear_instances
+    if defined?(@any_instances) && @any_instances
+      @any_instances = {}
+    end
+  end
+  
+  private
+  
+  def any_instances
+    @any_instance_lock ||= Mutex.new
+    @any_instances ||= {}
+  end
+  
+end
+
+FactoryBot.extend(FactoryBot::AnyInstance)
+FactoryBot::Syntax::Methods.module_exec do
+  define_method(:any){|factory_name| FactoryBot.any(factory_name)}
+  define_method(:clear_instances){ FactoryBot.clear_instances}
+end

data/test/factory_bot_any_instance_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../test_helper.rb', __FILE__)
+
+FactoryBot.define do
+  factory :test, class: Test::Model do
+    name "Foo"
+  end
+  
+  factory :child, class: Test::Model do
+    name "Child"
+    parent { any(:test) }
+  end 
+end
+
+describe FactoryBot::AnyInstance do
+    
+  it "should not interfere with creating instances" do
+    instance_1 = create(:test)
+    instance_2 = create(:test)
+    assert instance_2.id > instance_1.id
+
+    any_instance_1 = any(:test)
+    assert any_instance_1.id > instance_2.id
+    
+    instance_3 = create(:test)
+    assert instance_3.id > any_instance_1.id
+    
+    any_instance_2 = any(:test)
+    assert any_instance_2.id == any_instance_1.id
+  end
+  
+  it "should clear memoized instances" do
+    any_instance_1 = any(:test)
+    any_instance_2 = any(:test)
+    assert any_instance_2.id == any_instance_1.id
+    
+    clear_instances
+    
+    any_instance_3 = any(:test)
+    any_instance_4 = any(:test)
+    assert any_instance_3.id == any_instance_4.id
+    assert any_instance_3.id != any_instance_2.id
+  end
+  
+  it "should reuse instances inside of factories" do
+    instance_1 = create(:child)
+    instance_2 = create(:child)
+    assert instance_1.parent.id == instance_2.parent.id
+  end
+  
+  it "should not interfered with the build method" do
+    instance = build(:child)
+    assert instance.attributes, {"id" => nil, "name" => "Child", "parent_id" => any(:test).id}
+  end
+  
+  it "should not interfered with the build method" do
+    assert attributes_for(:child), {"id" => nil, "name" => "Child", "parent_id" => any(:test).id}
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'minitest/autorun'
+require 'active_record'
+
+require File.expand_path("../../lib/factory_bot_any_instance.rb", __FILE__)
+
+ActiveRecord::Base.establish_connection("adapter" => "sqlite3", "database" => ":memory:")
+
+module Test
+  def self.create_tables
+    Model.connection.create_table(:models) do |t|
+      t.string :name
+      t.integer :parent_id
+    end unless Model.table_exists?
+  end
+  
+  def self.drop_tables
+    Model.connection.disconnect!
+  end
+  
+  class Model < ActiveRecord::Base
+    belongs_to :parent, :class_name => "Test::Model"
+  end
+end
+
+Test.create_tables
+
+Minitest.after_run do
+  Test.drop_tables
+end
+
+class Minitest::Spec
+  include FactoryBot::Syntax::Methods
+  
+  before do
+    clear_instances
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: factory_bot_any_instance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Adds helper methods to FactoryBot to memoize instances to speed up test
+  suite.
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- HISTORY.md
+- MIT_LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- factory_bot_any_instance.gemspec
+- lib/factory_bot_any_instance.rb
+- test/factory_bot_any_instance_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bdurand/factory_bot_any_instance
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Adds helper methods to FactoryBot to memoize instances to speed up test suite
+test_files:
+- test/factory_bot_any_instance_test.rb
+- test/test_helper.rb