Merge pull request #115 from alphagov/fix-modifying-hash

Fix incorrect error for invalid customised payload

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 5.0.2
+
+* Fix issue where customised schema validation message was incorrect for a modified payload
+
 # 5.0.1
 
 * Improve speed of random schema generation for customised content items

lib/govuk_schemas/random_example.rb

@@ -93,7 +93,8 @@ def payload(&block)
   private
 
     def customise_payload(payload)
-      original_payload = payload
+      # Use Marshal to create a deep dup of the payload so the original can be mutated
+      original_payload = Marshal.load(Marshal.dump(payload))
       customised_payload = yield(payload)
       customised_errors = validation_errors_for(customised_payload)
 

lib/govuk_schemas/version.rb

@@ -1,4 +1,4 @@
 module GovukSchemas
   # @private
-  VERSION = "5.0.1".freeze
+  VERSION = "5.0.2".freeze
 end

spec/lib/random_example_spec.rb

@@ -62,6 +62,17 @@
         }.to raise_error(GovukSchemas::InvalidContentGenerated, /The item was valid before being customised/)
       end
 
+      it "raises when modifying the hash directly creates an invalid content item" do
+        schema = GovukSchemas::Schema.random_schema(schema_type: "frontend")
+
+        expect {
+          GovukSchemas::RandomExample.new(schema:).payload do |hash|
+            hash["base_path"] = nil
+            hash
+          end
+        }.to raise_error(GovukSchemas::InvalidContentGenerated, /The item was valid before being customised/)
+      end
+
       it "raises if the non-customised content item was invalid" do
         generator = instance_double(GovukSchemas::RandomSchemaGenerator, payload: {})
         allow(GovukSchemas::RandomSchemaGenerator).to receive(:new).and_return(generator)