Improve user feedback if defining static association with a block

[grekko]

Problem this feature will solve

Given:

FactoryBot.define do
  user(factory: :author) { association(:author, role: role) }
end

DefinitionProxy#method_missing will declare the association and ignore any given block-argument.

Desired solution

DefinitionProxy#method_missing could warn users (this is just demo code :)):

def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
  association_options = args.first

  if association_options.nil?
    __declare_attribute__(name, block)
  elsif __valid_association_options?(association_options)
    Kernel.puts 'warn: Dynamically provided attributes are ignored if `factory`-key is set.' if block
    association(name, association_options)
  else
    raise NoMethodError.new(<<~MSG)
      undefined method '#{name}' in '#{@definition.name}' factory
      Did you mean? '#{name} { #{association_options.inspect} }'
    MSG
  end
end

[composerinteralia]

Nice idea. What if we forward the block along:

elsif __valid_association_options?(association_options)
-  association(name, association_options)
+  association(name, association_options, &block)

So we can get the error already defined in the association method:

factory_bot/lib/factory_bot/definition_proxy.rb

Lines 152 to 156 in 9071398

	if block_given?
	raise AssociationDefinitionError.new(
	"Unexpected block passed to '#{name}' association "\
	"in '#{@definition.name}' factory"
	)

That's technically a breaking change, so we may need to wait until factory_bot 7.

[grekko]

So we can get the error already defined in the association method:

That look pretty clean to me 🤔 if you are interested, I could create a PR.

[composerinteralia]

Yeah, that would be great. Thanks!

[sharvy]

@composerinteralia I see grekko closed the PR. Was this feature implemented already?
As I want to give it a try, is this still a good first issue? :)

[tisba]

@sharvy I'm also tracking this issue. I think it was not implemented, see #1518 (comment).

[grekko]

Hello 👋🏽

I see grekko closed the PR. Was this feature implemented already?

Yeah, I think I've prematurely cleaned up 🧹 the forked repository.

@sharvy I restored the fork and created a new PR which contains the proposed changes. see #1579