factory_bot_caching 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee2c7389016a2ff8603325c873649be7baa588db
+  data.tar.gz: cd543e1d54989b97354ae0fdea132ed57011336f
+SHA512:
+  metadata.gz: 05cb3f44986e110e32f4c4e782c4e6ae44b90e19a71ca28bdc6b4a5988c76cad7cbcac9df1224b88c4cf005959bd2fb33e2e5c46df96b9c2a2993004962d4ab6
+  data.tar.gz: 5ca8331d76fe754905ad7954dc458ad0d9eeed19a28df9f132595152e5ceaa9f484e1ce086bb86143759b1642879cadd34602b9fc9258a3bcc5a12b6657e0a7e

data/.circleci/config.yml

@@ -0,0 +1,68 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1
+         environment:
+          PGHOST: 127.0.0.1
+          PGUSER: circleci_postgres
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+       - image: circleci/postgres:9.4
+         environment: # environment variables for database
+           POSTGRES_USER: circleci_postgres
+           POSTGRES_DB: circleci_postgres
+           POSTGRES_PASSWORD: ""
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile" }}-{{ checksum "factory_bot_caching.gemspec" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}-{{ checksum "factory_bot_caching.gemspec" }}
+
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://localhost:5432 -timeout 1m
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+/.bundle/
+.ruby-version
+.ruby-gemset
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require 'spec_helper'

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2018-07-27
+### Added
+
+- First release
+- Support for caching FactoryGirl factories when using ActiveRecord with Postgresql
+- User defined cache keys
+- Customizable cache timeout

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 tim.mertens@avant.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_caching.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 Avant
+
+Author Tim Mertens
+
+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,147 @@
+# FactoryBotCaching
+
+FactoryBotCaching is a gem which implements a caching layer for FactoryGirl with Rails/ActiveRecord.
+
+Factory Caching enables you to leverage the flexibility of factories with some of the performance benefits
+of fixtures. 
+
+## FactoryGirl / FactoryBot Support
+
+* `FactoryBotCaching` `~> 1.0.0` currently only offers built-in support for the `FactoryGirl` gem/namespace.
+* Support for the newer `FactoryBot` namespace is expected in version 2 or earlier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'factory_bot_caching', :group => :test
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install factory_bot_caching
+
+## Usage
+
+### Configuration
+
+FactoryBotCaching is disabled by default.  To enable it, add a configuration block like the following to your test 
+setup file(s) to enable caching and configure any other options as desired:
+
+```ruby
+# rails_helper.rb 
+require 'factory_bot_caching'
+
+FactoryBotCaching.configure do |config|
+  config.enable_factory_caching # Defaults to factory caching disabled.
+  config.cache_timeout = 300 # Optional. Defaults to 900 seconds
+  config.custom_cache_key = Proc.new { ::I18n.locale } # Optional. Defaults to nil / no custom caching layer.
+end
+```
+
+#### Configuration Options:
+
+##### enable_factory_caching
+
+Turns factory caching on.
+
+##### disable_factory_caching
+
+Disables factory caching.
+
+##### cache_timeout
+
+The amount of time in seconds after creation that a cached factory record is considered valid to be returned from 
+the cache. Defaults to 900 seconds (15 minutes).
+
+##### custom_cache_key
+
+The `custom_cache_key` is a Proc that can be executed to generate a value or list/hash of values to use as a custom
+ cache key for cached records.  By default, no custom caching layer is used.
+ 
+For example, if you have factories which behave differently across locales, you may want to use a `custom_cache_key` which
+adds a caching layer on top of the value returned by `::I18n.locale`.
+
+```ruby
+Proc.new { ::I18n.locale }
+```
+
+This prevents records created in the 'en-GB' locale from being returned in tests run in 'en-US' locale.
+
+NOTE: It is not necessary to add a custom cache key for time or date.  Changes in date and time by libraries such as
+`TimeCop` are already handled automatically by the built in caching layers and the `cache_timeout` value.
+
+### Setup/Teardown Hooks
+
+In addition to configuring/enabling Factory Caching, it is necessary to configure hooks in your test suite to initialize
+at the start of testing and reset cache counters after each test.
+ 
+### RSpec
+
+#### Disable Trasactional Fixtures
+
+For factory caching to work correctly, you must ensure that the `rspec-rails` `use_transactional_fixtures` setting is disabled:
+
+```ruby
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+end
+```
+
+To run tests inside of transactions, we recommend using [DatabaseCleaner](https://rubygems.org/gems/database_cleaner) instead.
+
+#### Enable Factory Caching
+
+`FactoryBotCaching` provides a setup script for RSpec. This adds the necessary test hooks to an RSpec test suite to set 
+up and tear down factory caching in your test suite.
+
+In your test setup after requiring FactoryGirl:
+
+```ruby
+# rails_helper.rb
+require 'factory_bot_caching/rspec'
+```
+
+It also adds a metadata filter to exclude specific tests from caching if they always require new records to be created:
+
+```ruby
+RSpec.describe "factory caching metadata" do
+  it "runs with caching disabled", :no_factory_caching do
+    expect(FactoryBotCaching.enabled?).to be false
+  end
+  
+  it "runs with caching disabled" do
+    expect(FactoryBotCaching.enabled?).to be true
+  end
+end
+```
+
+### Other Test Frameworks
+
+To use Factory Bot Caching in other test frameworks, see `lib/factory_bot_caching/rspec.rb` for the necessary callbacks
+that must be run to use caching.
+
+Specifically, you must call `FactoryBotCaching.initialize` before running any tests, and 
+`FactoryBotCaching::CacheManager.instance.reset_cache_counter` after each test.
+
+Pull requests to add support for other test frameworks are welcome! 
+
+## 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/avantoss/factory_bot_caching. 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.
+
+## Roadmap
+
+### v2.0
+* Support FactoryBot

data/Rakefile

@@ -0,0 +1,30 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2017-2018 Avant
+#
+# Author Tim Mertens
+#
+# 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.
+
+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_caching"
+
+# 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_caching.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/factory_bot_caching/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "factory_bot_caching"
+  spec.version       = FactoryBotCaching::VERSION
+  spec.authors       = ["Tim Mertens"]
+  spec.email         = ["tim.mertens@filmchicago.org"]
+  spec.summary       = "A caching mechanism for test suites using Factory Bot/Factory Girl with ActiveRecord."
+  spec.description   = %q{The factory_bot_caching gem provides a caching mechanism for Factory Bot/Factory Girl to significantly reduce test suite runtimes in factory heavy test suites.}
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/avantoss/factory_bot_caching"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "factory_girl", "~> 4.4"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "activerecord", "~> 4.0"
+  spec.add_development_dependency "activesupport", "~> 4.0"
+  spec.add_development_dependency "database_cleaner", "~> 1.0"
+  spec.add_development_dependency "pg", "~> 0.18"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec_junit_formatter"
+end