govuk_schemas 5.0.4 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dd91e9517ca0bd0ff1f983378aadc0f2cba54f12706b90649105c1e2ffadb64
-  data.tar.gz: 41d7ad98aecd4d2e4dd875e3c538edc881415f259b4ea48ed5bffbf345b9422f
+  metadata.gz: 5588184b2f2aac015bf79217e0311d165ab849fea5ef83ba4d0ce683b300ad46
+  data.tar.gz: 16b97e02ee44db9130f44cc96ef7796a5e5eb087567a0f353cbbe3d33dad2938
 SHA512:
-  metadata.gz: 0a4fd9a1aebf731f35d4763031e9578b40d365cb6b97102328a9f7945275d2ce4d1ccb1d16b4a77d6f5702b9005cf5d77592fe76cf542ce669421d1512c3143f
-  data.tar.gz: 964968fa54d8849052e6d53b141786f07f6b819df891ea81d493c9b75e988a80f0855e2cd8ea6973336dc98a2038b70b446c1e70873bca998385e1cad8c451ed
+  metadata.gz: 18dd2ba2f2fcd59f0b45c6583aa7a78c8ea2599303bff5c4d787aef5a4d22f3631dafaab75830564068317e777e15b96c0ad9d3b8e5ac2b92bed9cfd1cd2746a
+  data.tar.gz: 4d00b406e14eb8f044d13a27e8d1a120efca36d3e4e96df59869cf9666985cbd642a335239ab2a66ec7baba79077c19a425165f6476c547db1d4699155a8d560

data/.github/workflows/actionlint.yml

@@ -0,0 +1,12 @@
+name: Lint GitHub Actions
+on:
+  push:
+    paths: ['.github/**']
+jobs:
+  actionlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          show-progress: false
+      - uses: alphagov/govuk-infrastructure/.github/actions/actionlint@main

data/.github/workflows/autorelease.yml

@@ -0,0 +1,10 @@
+on:
+  workflow_dispatch: {}
+  schedule:
+    - cron: '30 10 * * 1-5' # 10:30am UTC, Mon-Fri.
+
+jobs:
+  autorelease:
+    uses: alphagov/govuk-infrastructure/.github/workflows/autorelease-rubygem.yml@main
+    secrets:
+      GH_TOKEN: ${{ secrets.GOVUK_CI_GITHUB_API_TOKEN }}

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.1, 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.1.4
+3.2.8

data/CHANGELOG.md

@@ -1,128 +1,135 @@
-# 5.0.4
+# Changelog
 
-* Ensure `Faker` is added as a non-development dependency 
+## 6.1.0
 
-# 5.0.3
+* 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)
+
+## 5.0.4
+
+* Ensure `Faker` is added as a non-development dependency
+
+## 5.0.3
 
 * Add support for `email` string types
 * Use `Faker` gem to generate emails and URLs
 * Improve error messages when an unknown type is given in `GovukSchemas::RandomContentGenerator#string_for_type`
 
-# 5.0.2
+## 5.0.2
 
 * Fix issue where customised schema validation message was incorrect for a modified payload
 
-# 5.0.1
+## 5.0.1
 
 * Improve speed of random schema generation for customised content items
 
-# 5.0.0
+## 5.0.0
 
 * BREAKING: Drop support for Ruby 3.0. The minimum required Ruby version is now 3.1.4.
 * Add support for Ruby 3.3.
 * Add support for `json-schema` 3.3.
 
-# 4.7.0
+## 4.7.0
 
 * Update `json-schema` dependency.
 
-# 4.6.0
+## 4.6.0
 
 * Drop support for Ruby 2.7.
 * Fix guidance on fixing a regex issue to reference correct filename.
 * Add support for `^[1-9][0-9]{3}$` regex to resolve exceptions randomly generating specialist_documents.
 
-# 4.5.0
+## 4.5.0
 
-General support for content schemas in publishing api:
-* Update default content schemas url to point to publishing api rather than govuk-content-schemas. This is because we are merging schemas into publishing api.
-* Update path of allowed_document_types.yml to reflect new location in publishing api, allowing us to remove a symlink.
-* Introduce a setter method for manually configuring the path to schemas, outside of an env variable
+* General support for content schemas in Publishing API:
+  * Update default content schemas url to point to publishing api rather than govuk-content-schemas. This is because we are merging schemas into publishing api.
+  * Update path of allowed_document_types.yml to reflect new location in publishing api, allowing us to remove a symlink.
+  * Introduce a setter method for manually configuring the path to schemas, outside of an env variable
 
-# 4.4.1
+## 4.4.1
 
 * Fix `Validator` module to handle JSON or other object types being passed as the payload ([#68](https://github.com/alphagov/govuk_schemas/pull/68))
 
-# 4.4.0
+## 4.4.0
 
 * Adds support for applications that use Minitest by adding an `AssertMatchers` module ([#66](https://github.com/alphagov/govuk_schemas/pull/66))
 
-# 4.3.0
+## 4.3.0
 
 * Generate unique items for arrays with the "uniqueItems" property. ([#63](https://github.com/alphagov/govuk_schemas/pull/63))
 
-# 4.2.0
+## 4.2.0
 
 * Add support for generating random HH:MM time strings that match a regex. ([#62](https://github.com/alphagov/govuk_schemas/pull/62))
 
-# 4.1.1
+## 4.1.1
 
 * Fix RandomSchemaGenerator.new always returning equivalent generators ([#60](https://github.com/alphagov/govuk_schemas/pull/60))
 
-# 4.1.0
+## 4.1.0
 
 * Add `seed` parameter to `GovukSchemas::RandomExample` to make the random behaviour deterministic. Given the same seed, the same randomised outputs will be returned ([#56](https://github.com/alphagov/govuk_schemas/pull/56)).
 
-# 4.0.1
+## 4.0.1
 
 * Bump the required Ruby version to >= 2.6.x.
 
-# 4.0.0
+## 4.0.0
 
-* Change RSpec::Matchers, rename `be_valid_against_schema` to
-  `be_valid_against_publisher_schema` and add
-  `be_valid_against_frontend_schema` plus
-  `be_valid_against_notification_schema`.
+* Change RSpec::Matchers, rename `be_valid_against_schema` to `be_valid_against_publisher_schema` and add `be_valid_against_frontend_schema` plus `be_valid_against_notification_schema`.
 
-# 3.3.0
+## 3.3.0
 
 * Support generating objects with an `oneOf` property.
 
-# 3.2.0
+## 3.2.0
 
 * Add `GovukSchemas::DocumentTypes.valid_document_types` (PR #48)
 
-# 3.1.0
+## 3.1.0
 
 * Update json-schema dependency
 
-# 3.0.1
+## 3.0.1
 
-* change order of output when validation errors occur during random example generation
+* Change order of output when validation errors occur during random example generation
 
-# 3.0.0
+## 3.0.0
 
 * Move to block based customisation of randomly generated payloads. This removes the existing methods: `customise_and_validate` and `merge_and_validate`. In addition `GovukSchemas::RandomExample.for_schema(schema)` now returns the payload hash directly.
 
-# 2.3.0
+## 2.3.0
 
 * Allow looking up examples to work with schemas stored in `formats/{format}/{schema_type}/examples/` and `examples/{format}/{schema_type}/` to allow schema examples to move.
 
-# 2.2.0
+## 2.2.0
 
 * Add RSpec test helpers
 * Add `customise_and_validate` to bring the functionality to remove fields from a payload which has been generated as a random example
 
-# 2.1.1
+## 2.1.1
 
 * Support for a new regex in GOV.UK content schemas
 
-# 2.1.0
+## 2.1.0
 
 * Add `Schema.schema_names` to return all schema names
 * Add functionality to work with examples
 
-# 2.0.0
+## 2.0.0
 
 * Change GovukSchemas::Schema.find to take { links_schema: 'detailded_guide' }
 * Add regex for lowercase-underscore strings
 
-# 1.0.0
+## 1.0.0
 
 * Add regex for GOV.UK campaign URLs
 * Improve error messages
 
-# 0.2.0
+## 0.2.0
 
 * Add a new regex for the new application validation in the schema
 * Add documentation for the gem
@@ -130,6 +137,6 @@ General support for content schemas in publishing api:
 * Now tests all available schema (a problem with specialist docs has been solved)
 * Drops active-support dependency, pins json-schema dependency
 
-# 0.1.0
+## 0.1.0
 
 * First release. Allows random content generation.

data/govuk_schemas.gemspec

@@ -18,15 +18,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency "faker", "~> 3.4.1"
+  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", "< 4.4"
+  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", "4.18.0"
+  spec.add_development_dependency "rubocop-govuk", "5.1.20"
 
-  spec.required_ruby_version = ">= 3.1.4"
+  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 = "5.0.4".freeze
+  VERSION = "6.1.0".freeze
 end

metadata

@@ -1,29 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 6.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +38,7 @@ dependencies:
         version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +48,7 @@ dependencies:
         version: '2.8'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +111,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: 5.1.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: 5.1.20
 description: Gem to generate test data based on GOV.UK content schemas
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -122,7 +127,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/actionlint.yml"
+- ".github/workflows/autorelease.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".govuk_dependabot_merger.yml"
 - ".rspec"
@@ -151,7 +159,6 @@ homepage: https://github.com/alphagov/govuk_schemas_gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.4
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
-signing_key: 
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas
 test_files: []