File: factory_bot.rb

package info (click to toggle)
ruby-factory-bot 6.5.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,492 kB
  • sloc: ruby: 9,242; makefile: 6; sh: 4
file content (117 lines) | stat: -rw-r--r-- 4,244 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
require "set"
require "active_support"
require "active_support/core_ext/module/delegation"
require "active_support/core_ext/module/attribute_accessors"
require "active_support/deprecation"
require "active_support/notifications"

require "factory_bot/internal"
require "factory_bot/definition_hierarchy"
require "factory_bot/configuration"
require "factory_bot/errors"
require "factory_bot/factory_runner"
require "factory_bot/strategy_syntax_method_registrar"
require "factory_bot/strategy"
require "factory_bot/registry"
require "factory_bot/null_factory"
require "factory_bot/null_object"
require "factory_bot/evaluation"
require "factory_bot/factory"
require "factory_bot/attribute_assigner"
require "factory_bot/evaluator"
require "factory_bot/evaluator_class_definer"
require "factory_bot/attribute"
require "factory_bot/callback"
require "factory_bot/callbacks_observer"
require "factory_bot/declaration_list"
require "factory_bot/declaration"
require "factory_bot/sequence"
require "factory_bot/attribute_list"
require "factory_bot/trait"
require "factory_bot/enum"
require "factory_bot/aliases"
require "factory_bot/definition"
require "factory_bot/definition_proxy"
require "factory_bot/syntax"
require "factory_bot/syntax_runner"
require "factory_bot/find_definitions"
require "factory_bot/reload"
require "factory_bot/decorator"
require "factory_bot/decorator/attribute_hash"
require "factory_bot/decorator/disallows_duplicates_registry"
require "factory_bot/decorator/invocation_tracker"
require "factory_bot/decorator/new_constructor"
require "factory_bot/uri_manager"
require "factory_bot/linter"
require "factory_bot/version"

module FactoryBot
  Deprecation = ActiveSupport::Deprecation.new("7.0", "factory_bot")

  mattr_accessor :use_parent_strategy, instance_accessor: false
  self.use_parent_strategy = true

  mattr_accessor :automatically_define_enum_traits, instance_accessor: false
  self.automatically_define_enum_traits = true

  mattr_accessor :sequence_setting_timeout, instance_accessor: false
  self.sequence_setting_timeout = 3

  # Look for errors in factories and (optionally) their traits.
  # Parameters:
  # factories - which factories to lint; omit for all factories
  # options:
  #   traits: true - to lint traits as well as factories
  #   strategy: :create - to specify the strategy for linting
  #   verbose: true - to include full backtraces for each linting error
  def self.lint(*args)
    options = args.extract_options!
    factories_to_lint = args[0] || FactoryBot.factories
    Linter.new(factories_to_lint, **options).lint!
  end

  # Set the starting value for ids when using the build_stubbed strategy
  #
  # @param [Integer] starting_id The new starting id value.
  def self.build_stubbed_starting_id=(starting_id)
    Strategy::Stub.next_id = starting_id - 1
  end

  class << self
    # @!method rewind_sequence(*uri_parts)
    #   Rewind an individual global or inline sequence.
    #
    #   @param [Array<Symbol>, String] uri_parts The components of the sequence URI.
    #
    #   @example Rewinding a sequence by its URI parts
    #     rewind_sequence(:factory_name, :trait_name, :sequence_name)
    #
    #   @example Rewinding a sequence by its URI string
    #     rewind_sequence("factory_name/trait_name/sequence_name")
    #
    # @!method set_sequence(*uri_parts, value)
    #   Set the sequence to a specific value, providing the new value is within
    #   the sequence set.
    #
    #   @param [Array<Symbol>, String] uri_parts The components of the sequence URI.
    #   @param [Object] value The new value for the sequence. This must be a value that is
    #     within the sequence definition. For example, you cannot set
    #     a String sequence to an Integer value.
    #
    #   @example
    #     set_sequence(:factory_name, :trait_name, :sequence_name, 450)
    #   @example
    #     set_sequence([:factory_name, :trait_name, :sequence_name], 450)
    #   @example
    #     set_sequence("factory_name/trait_name/sequence_name", 450)
    delegate :factories,
      :register_strategy,
      :rewind_sequences,
      :rewind_sequence,
      :set_sequence,
      :strategy_by_name,
      to: Internal
  end
end

FactoryBot::Internal.register_default_strategies