kotovalexarian-likes-github
/
thoughtbot--factory_bot
mirror of https://github.com/thoughtbot/factory_bot.git
1
0
Fork 0
Code Releases Activity

Traits documentation 

* Explicit traits
  * Implicit declaration
  * Override traits

Co-authored-by: Christina Entcheva <christina.entcheva@gmail.com>
Co-authored-by: Daniel Colson <danieljamescolson@gmail.com>
This commit is contained in:
Frida Casas 2020-05-15 17:05:00 -04:00
parent 08c55ffd24
commit 41f1f16cf3
1 changed files with 40 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/traits.md
View File

@ -1,4 +1,4 @@
Both traits & factories both have a `FactoryBot::Definition` (LINK) and hold
Traits & factories both have a `FactoryBot::Definition` (LINK) and hold
on to attributes. (LINK to documentation on how factories work under the
hood).
@ -18,6 +18,7 @@ your factory has the trait defined. If it does not, factory_bot will look for
it in the global registry, in `FactoryBot::Definition#trait_by_name` (LINK).
See example in the README here: ANCHOR
### Inline
The role of `FactoryBot::DefinitionProxy` (LINK) is to take the code you
wrote and turn it into factory_bot objects, then store those objects on the
@ -28,8 +29,44 @@ builds and registers the `FactoryBot::Trait` (LINK) object.
See example in the README here: ANCHOR
https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#defining-traits
## Compiling & aggregating traits
### WIP - Potential Glossary?
`@defined_traits` will hold all of the `FactoryBot::Trait` objects for that definition.
Global traits will exist within their own registry. (LINK ###GLOBAL)
`@base_traits` will hold all of the traits that are explicitly or implicitly defined as default traits.
`@additional_traits` will hold any override traits passed in at build time.
### Default traits
### Override traits
#### Explicit Traits
An example of explicit declarations can be found in the GETTING_STARTED guide #traits section.
Note where the :traits keyword argument is used in the first code example.
https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#traits
`FactoryBot::Definition` will be initialized with explicit traits, set to the `@base_traits` variable.
https://github.com/thoughtbot/factory_bot/blob/ae2fce1874260b2b2017379a142057670cc93bbe/lib/factory_bot/definition.rb#L13
#### Implicit Declaration
Implicit declarations can include defining associations, sequences or traits. [FactoryBot::Declaration::Implicit](https://github.com/thoughtbot/factory_bot/blob/master/lib/factory_bot/declaration/implicit.rb)
`FactoryBot::Factory#inherit_traits` will turn the implicit attribute into a default trait.
`FactoryBot::Factory#inherit_traits` adds more base traits to `@base_traits`.
https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#as-implicit-attributes-1
### Override traits
The Factory is cloned within `FactoryBot::Factory#with_traits` and override traits are applied in `@additional_traits`.
When the factory is cloned with the `#FactoryBot::Definition#initialize_copy`, some instance variables are cleared out.
Particularly `@defined_traits_by_name` will be reset and prior caching will be lost. This is something that can potentially
be computationally expensive when there are lots of traits.
https://github.com/thoughtbot/factory_bot/blob/ae2fce1874260b2b2017379a142057670cc93bbe/lib/factory_bot/factory_runner.rb#L16-L18
## Compiling & aggregating traits
<!-- TODO: `#compile` and `#aggregate_from_traits` -->
<!-- TODO: Parent and child factories and how they interact -->
<!-- TODO: Referring to parent/child trait and how they interact -->
<!-- Precedence order - if attributes are defined in multiple places which one does factory_bot prioritize? -->