govuk_schemas 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dfa122dda29dbe6408145d997c35a0d59694bebe06e94e804123eeeb8c69949
-  data.tar.gz: 20378d4689077b168d2b7c9ea16198996c3064229f097593923f41739dc4b51f
+  metadata.gz: 5588184b2f2aac015bf79217e0311d165ab849fea5ef83ba4d0ce683b300ad46
+  data.tar.gz: 16b97e02ee44db9130f44cc96ef7796a5e5eb087567a0f353cbbe3d33dad2938
 SHA512:
-  metadata.gz: c5458746961ae35f261806c9f83a995ad696fceb591345642520704d8e12616a142092464dfe7abca40ab7299343216c1c3bdcf61cf12519b84f53d2380d8783
-  data.tar.gz: '09272215f8debc39696724c6ff775ea94ecf56776da71d85ec5b92a47bd74abb5bed7b151ea7e18691303697259fc7616cd6f2b4630c59b073e9bb0022b7da5c'
+  metadata.gz: 18dd2ba2f2fcd59f0b45c6583aa7a78c8ea2599303bff5c4d787aef5a4d22f3631dafaab75830564068317e777e15b96c0ad9d3b8e5ac2b92bed9cfd1cd2746a
+  data.tar.gz: 4d00b406e14eb8f044d13a27e8d1a120efca36d3e4e96df59869cf9666985cbd642a335239ab2a66ec7baba79077c19a425165f6476c547db1d4699155a8d560

data/.github/workflows/actionlint.yml

@@ -6,7 +6,7 @@ jobs:
   actionlint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           show-progress: false
       - uses: alphagov/govuk-infrastructure/.github/actions/actionlint@main

data/.github/workflows/ci.yml

@@ -1,3 +1,5 @@
+name: CI
+
 on:
   push:
     branches:
@@ -20,20 +22,20 @@ jobs:
   dependency-review:
     name: Dependency Review scan
     uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
-  
+
   # This matrix job runs the test suite against multiple Ruby versions
   test_matrix:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [3.2, 3.3]
+        ruby: [3.2, 3.3, 3.4]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           ref: ${{ inputs.ref || github.ref }}
       - name: Clone content-schemas
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           repository: alphagov/publishing-api
           ref: main
@@ -54,12 +56,3 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - run: echo "All matrix tests have passed 🚀"
-
-  publish:
-    needs: test
-    if: ${{ github.ref == 'refs/heads/main' }}
-    permissions:
-      contents: write
-    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
-    secrets:
-      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+    branches: [main]
+
+jobs:
+  publish:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.ruby-version

@@ -1 +1 @@
-3.3.7
+3.2.8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 6.1.0
+
+* Introduce a "one of everything" strategy for RandomSchemaGenerator https://github.com/alphagov/govuk_schemas/pull/168
+
 ## 6.0.0
 
 * BREAKING: Drop support for Ruby 3.1 [PR](https://github.com/alphagov/govuk_schemas/pull/141)

data/govuk_schemas.gemspec

@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faker", ">= 3.4.1", "< 3.6.0"
   # This should be kept in sync with the json-schema version of publishing-api.
-  spec.add_dependency "json-schema", ">= 2.8", "< 5.2"
+  spec.add_dependency "json-schema", ">= 2.8", "< 6.1"
 
   spec.add_development_dependency "climate_control"
   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", "5.1.1"
+  spec.add_development_dependency "rubocop-govuk", "5.1.20"
 
   spec.required_ruby_version = ">= 3.2"
 end

data/lib/govuk_schemas/random_example.rb

@@ -31,10 +31,11 @@ module GovukSchemas
     #
     # @param [Hash]         schema  A JSON schema.
     # @param [Integer, nil] seed    A random number seed for deterministic results
+    # @param [Symbol] strategy    The generation strategy for RandomSchemaGenerator to use
     # @return [GovukSchemas::RandomExample]
-    def initialize(schema:, seed: nil)
+    def initialize(schema:, seed: nil, strategy: nil)
       @schema = schema
-      @random_generator = RandomSchemaGenerator.new(schema:, seed:)
+      @random_generator = RandomSchemaGenerator.new(schema:, seed:, strategy:)
     end
 
     # Returns a new `GovukSchemas::RandomExample` object.
@@ -52,12 +53,14 @@ module GovukSchemas
     #      # => {"base_path"=>"Test base path", "title"=>"dolor est...", "publishing_app"=>"elit"...}
     #
     # @param schema_key_value [Hash]
+    # @param [Integer] seed The seed for RandomSchemaGenerator's random functions
+    # @param [Symbol] strategy The generation strategy for RandomSchemaGenerator to use
     # @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]
-    def self.for_schema(schema_key_value, &block)
+    def self.for_schema(seed: nil, strategy: nil, **schema_key_value, &block)
       schema = GovukSchemas::Schema.find(schema_key_value)
-      GovukSchemas::RandomExample.new(schema:).payload(&block)
+      GovukSchemas::RandomExample.new(schema:, seed:, strategy:).payload(&block)
     end
 
     # Return a content item merged with a hash and with the excluded fields removed.

data/lib/govuk_schemas/random_schema_generator.rb

@@ -10,10 +10,17 @@ module GovukSchemas
   #
   # @private
   class RandomSchemaGenerator
-    def initialize(schema:, seed: nil)
+    DEFAULT_MIN_ITEMS = 0
+    DEFAULT_MAX_ITEMS = 10
+
+    ONE_OF_EVERYTHING_STRATEGY = :one_of_everything
+    TOTALLY_RANDOM_STRATEGY = :totally_random
+
+    def initialize(schema:, seed: nil, strategy: nil)
       @schema = schema
       @random = Random.new(seed || Random.new_seed)
       @generator = RandomContentGenerator.new(random: @random)
+      @strategy = strategy || TOTALLY_RANDOM_STRATEGY
     end
 
     def payload
@@ -22,6 +29,10 @@ module GovukSchemas
 
   private
 
+    def one_of_everything_strategy?
+      @strategy == ONE_OF_EVERYTHING_STRATEGY
+    end
+
     def generate_value(props)
       # TODO: #/definitions/nested_headers are recursively nested and can cause
       # infinite loops. We need to add something that detects and prevents the
@@ -94,11 +105,12 @@ module GovukSchemas
         # populate all of the keys in the hash. This isn't quite random, but I
         # haven't found a nice way yet to ensure there's at least n elements in
         # the hash.
-        should_generate_value = @generator.bool \
-          || subschema["required"].to_a.include?(attribute_name) \
-          || (one_of_sample["required"] || {}).to_a.include?(attribute_name) \
-          || (one_of_sample["properties"] || {}).keys.include?(attribute_name) \
-          || subschema["minProperties"] \
+        should_generate_value = one_of_everything_strategy? ||
+          @generator.bool ||
+          subschema["required"].to_a.include?(attribute_name) ||
+          (one_of_sample["required"] || {}).to_a.include?(attribute_name) ||
+          (one_of_sample["properties"] || {}).keys.include?(attribute_name) ||
+          subschema["minProperties"]
 
         next unless should_generate_value
 
@@ -109,9 +121,25 @@ module GovukSchemas
       document
     end
 
+    def min_items_for_array(array_properties)
+      if one_of_everything_strategy?
+        1
+      else
+        array_properties["minItems"] || DEFAULT_MIN_ITEMS
+      end
+    end
+
+    def max_items_for_array(array_properties)
+      if one_of_everything_strategy?
+        1
+      else
+        array_properties["maxItems"] || DEFAULT_MAX_ITEMS
+      end
+    end
+
     def generate_random_array(props)
-      min = props["minItems"] || 0
-      max = props["maxItems"] || 10
+      min = min_items_for_array(props)
+      max = max_items_for_array(props)
       unique = props["uniqueItems"] == true
       num_items = @random.rand(min..max)
       items = []

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 bindir: exe
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
@@ -38,7 +38,7 @@ dependencies:
         version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -48,7 +48,7 @@ dependencies:
         version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -111,14 +111,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: 5.1.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: 5.1.20
 description: Gem to generate test data based on GOV.UK content schemas
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -130,6 +130,7 @@ files:
 - ".github/workflows/actionlint.yml"
 - ".github/workflows/autorelease.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".govuk_dependabot_merger.yml"
 - ".rspec"
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas
 test_files: []