Module: Stepford::FactoryGirl

Defined in:
lib/stepford/factory_girl.rb

Overview

A proxy for FactoryGirl that automatically recursively creates/builds/stubbed factories for null=false and/or presence validated associations.

Lets you specify method name and arguments/options to factory girl for associations.

e.g. if the following is required:

  • Bar has a required association called house_special which uses the :beer factory, and we have a block we want to send into it

  • Beer has specials that you want to build as a list of 3 using the :tuesday_special_offer factory

then you could set that up like this:

Stepford::FactoryGirl.create_list(:bar, with_factory_options: {
  house_special: [:create, :beer, {blk: ->(beer) do; beer.bubbles.create(attributes_for(:bubbles)); end}],
  specials: [:build_list, :tuesday_special_offer, 3]
}) do
  # the block you would send to FactoryGirl.create_list(:foo) would go here
end

Constant Summary collapse

OPTIONS = 
[
  :debug,
  :stop_circular_refs
]
[]

Class Method Summary collapse

Class Method Details

.build(*args, &block) ⇒ Object 



129
 
# File 'lib/stepford/factory_girl.rb', line 129

def build(*args, &block); handle_factory_girl_method(:build, *args, &block); end

.build_list(*args, &block) ⇒ Object 



130
 
# File 'lib/stepford/factory_girl.rb', line 130

def build_list(*args, &block); handle_factory_girl_method(:build_list, *args, &block); end

.build_stubbed(*args, &block) ⇒ Object 



131
 
# File 'lib/stepford/factory_girl.rb', line 131

def build_stubbed(*args, &block); handle_factory_girl_method(:build_stubbed, *args, &block); end

.configure(&blk) ⇒ Object 



29
 
# File 'lib/stepford/factory_girl.rb', line 29

def configure(&blk); class_eval(&blk); end

.create(*args, &block) ⇒ Object

switched to this from method_missing to avoid method trying to handle mistaken calls



127
 
# File 'lib/stepford/factory_girl.rb', line 127

def create(*args, &block); handle_factory_girl_method(:create, *args, &block); end

.create_list(*args, &block) ⇒ Object 



128
 
# File 'lib/stepford/factory_girl.rb', line 128

def create_list(*args, &block); handle_factory_girl_method(:create_list, *args, &block); end

.debugargs(args) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/stepford/factory_girl.rb', line 165

def debugargs(args)
  args.each do |arg|
    if arg.is_a?(Hash)
      print "{"
      print arg.keys.collect{|key|"#{key} = (#{arg[key].class.name})"}.join(', ')
      print "}"
    else
      print "#{arg.inspect},"
    end
  end
end

.deep_dup(o) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/stepford/factory_girl.rb', line 135

def deep_dup(o)
  result = nil
  if o.is_a?(Hash)
    result = {}
    o.keys.each do |key|
      result[deep_dup(key)] = deep_dup(o[key])
    end
  elsif o.is_a?(Array)
    result = []
    o.each do |value|
      result << deep_dup(value)
    end
  elsif [NilClass,FalseClass,TrueClass,Symbol,Numeric,Class,Module].any?{|c|o.is_a?(c)}
    result = o
  elsif o.is_a?(BigDecimal)
    # ActiveSupport v3.2.8 checks duplicable? for BigDecimal by testing it, so we'll just try to dup the value itself
    result = o
    begin
      result = o.dup
    rescue TypeError
      # can't dup
    end
  elsif o.is_a?(Object)
    result = o.dup
  else
    result = o
  end
  result
end

.handle_factory_girl_method(m, *args, &block) ⇒ Object 



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
118
119
120
121
122
123
124
 
# File 'lib/stepford/factory_girl.rb', line 31

def handle_factory_girl_method(m, *args, &block)
  @@breadcrumbs << [args[0]] if ::Stepford::FactoryGirl.debug?
  #puts "#{'  ' * @@indent}handling Stepford::FactoryGirl.#{m}(#{args.inspect})" if ::Stepford::FactoryGirl.debug?
  puts "#{@@breadcrumbs.join('>')} start" if ::Stepford::FactoryGirl.debug?

  if args && args.size > 0
    # call Stepford::FactoryGirl.* on any not null associations recursively
    model_sym = args[0].to_sym
    model_class = args[0].to_s.camelize.constantize

    args = args.dup # need local version because we'll be dup'ing the options hash to add things to set prior to create/build
    options = args.last
    if options.is_a?(Hash)
      # keep them separate
      orig_options = options
      options = deep_dup(options)
      args[(args.size - 1)] = options # need to set the dup'd options
    else
      # keep them separate
      orig_options = {}
      options = {}
      args << options # need to add options to set associations
    end

    if ::Stepford::FactoryGirl.debug?
      print "#{@@breadcrumbs.join('>')} args="
      debugargs(args)
      puts
    end

    options[:with_factory_options] = {} unless options[:with_factory_options]
    with_factory_options = options[:with_factory_options]

    model_class.reflections.each do |association_name, reflection|
      assc_sym = reflection.name.to_sym
      next if options[assc_sym] || options[reflection.foreign_key.to_sym] # || reflection.macro != :belongs_to
      
      clas_sym = reflection.class_name.underscore.to_sym
      has_presence_validator = model_class.validators_on(assc_sym).collect{|v|v.class}.include?(::ActiveModel::Validations::PresenceValidator)
      required = reflection.foreign_key ? (has_presence_validator || model_class.columns.any?{|c| !c.null && c.name.to_sym == reflection.foreign_key.to_sym}) : false
      orig_method_args_and_options = with_factory_options ? (with_factory_options[[clas_sym, assc_sym]] || with_factory_options[clas_sym]) : nil
      
      has_presence_validator = model_class.validators_on(assc_sym).collect{|v|v.class}.include?(ActiveModel::Validations::PresenceValidator)
      required = false
      if reflection.macro == :belongs_to
        # note: supports composite_primary_keys gem which stores primary_key as an array
        foreign_key_is_also_primary_key = Array.wrap(model_class.primary_key).collect{|pk|pk.to_sym}.include?(reflection.foreign_key.to_sym)
        is_not_null_fkey_that_is_not_primary_key = model_class.columns.any?{|c| !c.null && c.name.to_sym == reflection.foreign_key.to_sym && !foreign_key_is_also_primary_key}
        required = is_not_null_fkey_that_is_not_primary_key || has_presence_validator
      else
        # no nullable metadata on column if no foreign key in this table. we'd figure out the null requirement on the column if inspecting the child model
        required = has_presence_validator
      end

      if required
        @@breadcrumbs << ["a:#{assc_sym}"] if ::Stepford::FactoryGirl.debug?
        if orig_method_args_and_options
          method_args_and_options = orig_method_args_and_options.dup
          method_options = args.last
          blk = method_options.is_a?(Hash) ? method_args_and_options.delete(:blk) : nil
          if blk
            #puts "#{'  ' * @@indent}FactoryGirl.__send__(#{method_args_and_options.inspect}, &blk)" if ::Stepford::FactoryGirl.debug?
            options[assc_sym] = ::FactoryGirl.__send__(*method_args_and_options, &blk)
          else
            #puts "#{'  ' * @@indent}FactoryGirl.__send__(#{method_args_and_options.inspect})" if ::Stepford::FactoryGirl.debug?
            options[assc_sym] = ::FactoryGirl.__send__(*method_args_and_options)
          end
        else
          if reflection.macro == :has_many
            options[assc_sym] = ::Stepford::FactoryGirl.create_list(clas_sym, 2, orig_options)               
          else
            options[assc_sym] = ::Stepford::FactoryGirl.create(clas_sym, orig_options)
          end
        end
        @@breadcrumbs.pop if ::Stepford::FactoryGirl.debug?
      end
    end
  end

  # clean-up before sending to FactoryGirl
  (args.last).delete(:with_factory_options) if args.last.is_a?(Hash)

  if ::Stepford::FactoryGirl.debug?
    puts "#{@@breadcrumbs.join('>')} end"
    puts
    print "#{@@breadcrumbs.join('>')} FactoryGirl.#{m}("
    debugargs(args)
    puts ")"
    puts
    @@breadcrumbs.pop
  end

  ::FactoryGirl.__send__(m, *args, &block)
end

.method_missing(m, *args, &block) ⇒ Object

pass everything else to FactoryGirl to try to handle (can’t reflect in current version to find what it handles)



133
 
# File 'lib/stepford/factory_girl.rb', line 133

def method_missing(m, *args, &block); ::FactoryGirl.__send__(m, *args, &block); end