FactoryBotCache

factory_bot_cache supports to define complicated object with factory_bot

Installation

Add this line to your application's Gemfile:

gem 'factory_bot_cache'

And then execute:

$ bundle

Or install it yourself as:

$ gem install factory_bot_cache

Background

If you have some factories with factory_bot_rails like this:

FactoryBot.define do
  factory :foo do
    name "FOO"
  end

  factory :bar do
    name: "BAR"
    association :foo, factory: :foo
  end

  factory :baz do
    name: "BAZ"
    association :foo, factory: :foo
  end
end

When you call FactoryBot.create(:bar) and FactoryBot.create(:baz) to get bar and baz, FactoryBot creates 2 foo objects. If your application cares about identity of foo, this is a big problem. FactoryBot recommends to create them with foo attribute. But it seems too difficult to pass a lot of attributes for complicated models.

Usage

At first, place the following code into spec/rails_helper.rb or somewhere:

  config.before(:each) do
    FactoryBotCache.clear
  end

Second, define factories with identifier and FactoryBotCache :

FactoryBot.define do
  factory :foo_1 do
    name "FOO"
  end

  factory :bar_1 do
    name: "BAR"
    foo { FactoryBotCache.of(:foo)[1] }
  end

  factory :baz_1 do
    name: "BAZ"
    foo { FactoryBotCache.of(:foo)[1] }
  end
end

The factory name referenced by FactoryBotCache must be [base_name]_[identifier]. identifier doesn't require to be id nor Integer. You can use any object to identify.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/akm/factory_bot_cache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the FactoryBotCache project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.