Hyrax::Forms::PcdmCollectionForm#prepopulate! fails on shared spec.

[jeremyf]

tl;dr Hyrax::Forms::PcdmCollectionForm changes on prepoluate but does not test it, and the collection generator creates a form that inherits from Hyrax::Forms::PcdmCollectionForm and tests (and fails) that the #prepopulate! method does not change the form.

Error demonstration:

• ☑️ Demonstrate error for #6702 #6703

On 715f599 (HEAD of main of of writing this issue), when I adjust the Hyrax::Forms::PcdmCollectionForm spec to use the it_behaves_like 'a Valkyrie::ChangeSet I get the following failed spec:

1) Hyrax::Forms::PcdmCollectionForm behaves like a Valkyrie::ChangeSet #prepopulate! doesn't make it look changed
   Failure/Error: DEFAULT_FAILURE_NOTIFIER = lambda { |failure, _opts| raise failure }
       expected `#<Hyrax::Forms::PcdmCollectionForm:0x0000ffff700c79a0 @fields={"human_readable_type"=>"Collection", "...rs:0x0000ffff71b06000 @base=#<Hyrax::Forms::PcdmCollectionForm:0x0000ffff700c79a0 ...>, @errors=[]>>.changed?` to be falsey, got true
     Shared Example Group: "a Valkyrie::ChangeSet" called from ./spec/forms/hyrax/forms/pcdm_collection_form_spec.rb:8
     # /app/bundle/ruby/3.2.0/gems/valkyrie-3.1.1/lib/valkyrie/specs/shared_specs/change_set.rb:48:in `block (3 levels) in <top (required)>'
     # /app/bundle/ruby/3.2.0/gems/webmock-3.19.1/lib/webmock/rspec.rb:39:in `block (2 levels) in <top (required)>'

The spec is as follows:

describe "#prepopulate!" do
  it "doesn't make it look changed" do
    expect(change_set).not_to be_changed
    change_set.prepopulate!
    expect(change_set).not_to be_changed
  end
end

When we dig a bit deeper, there are three properties that have pre-populators:

• :version
• :banner_info
• :logo_info

And in the above RSpec example, when we ask the change_set what has changed after #prepopulate!, we get the following: {"version"=>true, "banner_info"=>true, "logo_info"=>true}

This is problematic for a few reasons. First Valkyrie does not account for pre-populators. And more vexing, the generator for a collection form and resource has the following (first the form and then the spec):

# frozen_string_literal: true

# Generated via
#  `rails generate hyrax:collection_resource <%= class_name %>`
class <%= class_name %>Form < Hyrax::Forms::PcdmCollectionForm
  include Hyrax::FormFields(:<%= file_name %>)
end

# frozen_string_literal: true

# Generated via
#  `rails generate hyrax:collection_resource <%= class_name %>`
require 'rails_helper'
require 'valkyrie/specs/shared_specs'

RSpec.describe <%= class_name %>Form do
  let(:change_set) { described_class.new(resource: resource) }
  let(:resource)   { <%= class_name %>.new }

  it_behaves_like 'a Valkyrie::ChangeSet'
end