govuk_schemas 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cd756005e490eac69ddd8f7024ae3260afe6299e0d9009b395ad005b5fe8e9
-  data.tar.gz: abe105f133efc4f087bdace725d8f76ca1808b01f291dcb76379d1bd70aaa9b3
+  metadata.gz: 11fe25fadfae015a3a24eaf4abd396e618821351ce046f5102e3d25f8e2c1b1c
+  data.tar.gz: 3ec36c9783619553fbf7a8cafc92af1f6e7788bfb2c7b7b1146c0269a1cf5227
 SHA512:
-  metadata.gz: 7470680c0017977714ad1f99ae51b2302b8849e06be64ed5dfc27cfcb6f63c501ed4b8f44fe4f58162601053b5e0744f05eb9694215329d64cc05037ca045fd0
-  data.tar.gz: c0f18d2f243992f9fb3ba73090a39449b70ebdc4e45480d96da6b096584e4f3cd2f5b6786a71eb482d76e577167c738ba09debda7e6782a3890bb0b7d6cdaa38
+  metadata.gz: 51c8478cc3b921d0d6f97911f890705634acb7d4fca3d61cee5e3547b2e1ce82e69ac4fbb6df2a7224b3f7710b7a981df4006ec3d3474a8a980254da55af8a85
+  data.tar.gz: 14676e6b674e0cf8fbb0957ff9865dbfb91085ea49cffca3156dd15c2616eb15f7b2657679f6508ae28216cbbc95e5356e77f48d0b18f140656eb90a082b8ae1

data/.github/workflows/ci.yml

@@ -11,17 +11,6 @@ on:
         type: string
 
 jobs:
-  snyk-security:
-    name: SNYK security analysis
-    uses: alphagov/govuk-infrastructure/.github/workflows/snyk-security.yml@main
-    with:
-      skip_sca: true
-    secrets: inherit
-    permissions:
-      contents: read
-      security-events: write
-      actions: read
-  
   codeql-sast:
     name: CodeQL SAST scan
     uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main

data/.govuk_dependabot_merger.yml

@@ -1,6 +1,7 @@
-api_version: 1
-auto_merge:
-  - dependency: rubocop-govuk
-    allowed_semver_bumps:
-      - patch
-      - minor
+api_version: 2
+defaults:
+  allowed_semver_bumps:
+    - patch
+    - minor
+  auto_merge: true
+  update_external_dependencies: true

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 5.0.1
+
+* Improve speed of random schema generation for customised content items
+
 # 5.0.0
 
 * BREAKING: Drop support for Ruby 3.0. The minimum required Ruby version is now 3.1.4.

data/govuk_schemas.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "rubocop-govuk", "4.16.1"
+  spec.add_development_dependency "rubocop-govuk", "4.17.1"
 
   spec.required_ruby_version = ">= 3.1.4"
 end

data/lib/govuk_schemas/random_example.rb

@@ -29,7 +29,8 @@ module GovukSchemas
     #     GovukSchemas::RandomExample.new(schema: schema, seed: 777).payload
     #     GovukSchemas::RandomExample.new(schema: schema, seed: 777).payload # returns same as above
     #
-    # @param [Hash] schema A JSON schema.
+    # @param [Hash]         schema  A JSON schema.
+    # @param [Integer, nil] seed    A random number seed for deterministic results
     # @return [GovukSchemas::RandomExample]
     def initialize(schema:, seed: nil)
       @schema = schema
@@ -54,8 +55,6 @@ module GovukSchemas
     # @param [Block] the base payload is passed inton the block, with the block result then becoming
     #   the new payload. The new payload is then validated. (optional)
     # @return [GovukSchemas::RandomExample]
-    # @param [Block] the base payload is passed inton the block, with the block result then becoming
-    #   the new payload. The new payload is then validated. (optional)
     def self.for_schema(schema_key_value, &block)
       schema = GovukSchemas::Schema.find(schema_key_value)
       GovukSchemas::RandomExample.new(schema:).payload(&block)
@@ -80,24 +79,40 @@ module GovukSchemas
     #   the new payload. The new payload is then validated. (optional)
     # @return [Hash] A content item
     # @raise [GovukSchemas::InvalidContentGenerated]
-    def payload
+    def payload(&block)
       payload = @random_generator.payload
-      # ensure the base payload is valid
+
+      return customise_payload(payload, &block) if block
+
       errors = validation_errors_for(payload)
       raise InvalidContentGenerated, error_message(payload, errors) if errors.any?
 
-      if block_given?
-        payload = yield(payload)
-        # check the payload again after customisation
-        errors = validation_errors_for(payload)
-        raise InvalidContentGenerated, error_message(payload, errors, customised: true) if errors.any?
-      end
-
       payload
     end
 
   private
 
+    def customise_payload(payload)
+      original_payload = payload
+      customised_payload = yield(payload)
+      customised_errors = validation_errors_for(customised_payload)
+
+      if customised_errors.any?
+        # Check if the original payload had errors and report those over
+        # any from customisation. This is not done prior to generating the
+        # customised payload because validation is time expensive and we
+        # want to avoid it if possible.
+        original_errors = validation_errors_for(original_payload)
+        errors = original_errors.any? ? original_errors : customised_errors
+        payload = original_errors.any? ? original_payload : customised_payload
+        message = error_message(payload, errors, customised: original_errors.empty?)
+
+        raise InvalidContentGenerated, message
+      end
+
+      customised_payload
+    end
+
     def validation_errors_for(item)
       JSON::Validator.fully_validate(@schema, item, errors_as_objects: true)
     end

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.17.1
 description: Gem to generate test data based on GOV.UK content schemas
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.10
 signing_key: 
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas