govuk_schemas 4.2.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a44876dfefc37456d8e08d8ba63a9bd95c07425f12d44ca51aafdbbd01e513c
-  data.tar.gz: '0928c1cae2cf6eb2cf31adfb2eb2d4da30942178ac2e5b9bc2e3681aef3bce3b'
+  metadata.gz: ad5834f6042340a4e2749eca28ebe9da5f3c7d4020aa8c80d4139b66b3cabf40
+  data.tar.gz: 9d3f754aeeb7e3628a5ee853d60c33c9cfd52c5440e874ab2e7ecdbd0ffd58f6
 SHA512:
-  metadata.gz: 14265d1073c7a9b8efe6225d2f7e5508ea91fa4f25e04cb377afe09e9cd3423d98c3fcc319888773301e0f2e7e940b911c159cf83ee184f793f98d756d3909e3
-  data.tar.gz: b1dd19d78453ac71cae823c987c558f18bcca9f6295908cfb96e6b084a7a85d0543ff72da724fd2c8fa6cc700adbce39b200fcca14ad113333b00a8260b3cc77
+  metadata.gz: 3d1fa913598d9058f76c7406878043ad564bd1c443840af54e37a13130890a653abb9ab9725aa85368c449cb610782affc5d89a63e82e76255b130066217a779
+  data.tar.gz: d8e9fb819a1f85d3e287377382a1777688becbd2d18be394d7dc6b551f16e5dd1b31ded118c6b469c3240c6483660493c05fed1e6ffcf81648a9a68b15e21522

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+on: [push, pull_request]
+
+jobs:
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [ 2.7, '3.0', 3.1 ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Clone govuk-content-schemas
+        uses: actions/checkout@v2
+        with:
+          repository: alphagov/govuk-content-schemas
+          ref: deployed-to-production
+          path: tmp/govuk-content-schemas
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+        env:
+          GOVUK_CONTENT_SCHEMAS_PATH: tmp/govuk-content-schemas
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    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.yaml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.7.6

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 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
+
+* Adds support for applications that use Minitest by adding an `AssertMatchers` module ([#66](https://github.com/alphagov/govuk_schemas/pull/66))
+
+# 4.3.0
+
+* Generate unique items for arrays with the "uniqueItems" property. ([#63](https://github.com/alphagov/govuk_schemas/pull/63))
+
 # 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))

data/govuk_schemas.gemspec

@@ -24,7 +24,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", "~> 3.8"
+  spec.add_development_dependency "rubocop-govuk", "~> 4.0"
   spec.add_development_dependency "yard", "~> 0.8"
 
   spec.required_ruby_version = ">= 2.6"

data/lib/govuk_schemas/assert_matchers.rb

@@ -0,0 +1,28 @@
+require "govuk_schemas/validator"
+
+module GovukSchemas
+  module AssertMatchers
+    def assert_valid_against_publisher_schema(payload, schema_name)
+      assert_valid_against_schema(payload, schema_name, "publisher")
+    end
+
+    def assert_valid_against_links_schema(payload, schema_name)
+      assert_valid_against_schema(payload, schema_name, "links")
+    end
+
+    def assert_valid_against_frontend_schema(payload, schema_name)
+      assert_valid_against_schema(payload, schema_name, "frontend")
+    end
+
+    def assert_valid_against_notification_schema(payload, schema_name)
+      assert_valid_against_schema(payload, schema_name, "notification")
+    end
+
+  private
+
+    def assert_valid_against_schema(payload, schema_name, schema_type)
+      validator = GovukSchemas::Validator.new(schema_name, schema_type, payload)
+      assert validator.valid?, validator.error_message
+    end
+  end
+end

data/lib/govuk_schemas/random_schema_generator.rb

@@ -116,12 +116,27 @@ module GovukSchemas
     def generate_random_array(props)
       min = props["minItems"] || 0
       max = props["maxItems"] || 10
+      unique = props["uniqueItems"] == true
       num_items = @random.rand(min..max)
+      items = []
+      attempts = 0
+      max_attempts = num_items * 100
 
-      num_items.times.map do
+      until items.length == num_items
         # sometimes arrays don't have `items` specified, not sure if this is a bug
-        generate_value(props["items"] || {})
+        new_value = generate_value(props["items"] || {})
+
+        if unique && items.include?(new_value)
+          attempts += 1
+          raise "Failed to create a unique array item after #{max_attempts} attempts" if attempts >= max_attempts
+          next
+        end
+
+        attempts = 0
+        items << new_value
       end
+
+      items
     end
 
     def generate_random_string(props)

data/lib/govuk_schemas/rspec_matchers.rb

@@ -1,57 +1,20 @@
+require "govuk_schemas/validator"
+
 module GovukSchemas
   module RSpecMatchers
+
     %w[links frontend publisher notification].each do |schema_type|
       RSpec::Matchers.define "be_valid_against_#{schema_type}_schema".to_sym do |schema_name|
         match do |item|
-          schema = Schema.find(Hash["#{schema_type}_schema".to_sym, schema_name])
-          validator = JSON::Validator.fully_validate(schema, item)
-          validator.empty?
+          @validator = GovukSchemas::Validator.new(schema_name, schema_type, item)
+          @validator.valid?
         end
 
+
         failure_message do |actual|
-          ValidationErrorMessage.new(schema_name, "schema", actual).message
+          @validator.error_message
         end
       end
     end
   end
-
-  # @private
-  class ValidationErrorMessage
-    attr_reader :schema_name, :type, :payload
-
-    def initialize(schema_name, type, payload)
-      @schema_name = schema_name
-      @type = type
-      @payload = payload
-    end
-
-    def message
-      <<~DOC
-        expected the payload to be valid against the '#{schema_name}' schema:
-
-        #{formatted_payload}
-
-        Validation errors:
-        #{errors}
-      DOC
-    end
-
-  private
-
-    def errors
-      schema = Schema.find(publisher_schema: schema_name)
-      validator = JSON::Validator.fully_validate(schema, payload)
-      validator.map { |message| "- " + humanized_error(message) }.join("\n")
-    end
-
-    def formatted_payload
-      return payload if payload.is_a?(String)
-
-      JSON.pretty_generate(payload)
-    end
-
-    def humanized_error(message)
-      message.gsub("The property '#/'", "The item")
-    end
-  end
 end

data/lib/govuk_schemas/validator.rb

@@ -0,0 +1,51 @@
+module GovukSchemas
+  class Validator
+    attr_reader :schema_name, :type
+    attr_accessor :payload
+
+    def initialize(schema_name, type, payload)
+      @schema_name = schema_name
+      @type = type
+      @payload = ensure_json(payload)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def error_message
+      <<~DOC
+        expected the payload to be valid against the '#{schema_name}' schema:
+
+        #{formatted_payload}
+
+        Validation errors:
+        #{errors}
+      DOC
+    end
+
+  private
+
+    def errors
+      schema = Schema.find("#{type}_schema": schema_name)
+      validator = JSON::Validator.fully_validate(schema, payload)
+      validator.map { |message| "- " + humanized_error(message) }.join("\n")
+    end
+
+    def formatted_payload
+      JSON.pretty_generate(JSON.parse(payload))
+    end
+
+    def humanized_error(message)
+      message.gsub("The property '#/'", "The item")
+             .gsub(/in schema [0-9a-f\-]+/, "")
+             .strip
+    end
+
+    def ensure_json(payload)
+      return payload if payload.is_a?(String)
+
+      payload.to_json
+    end
+  end
+end

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.4.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -109,13 +110,13 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- Jenkinsfile
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - govuk_schemas.gemspec
 - lib/govuk_schemas.rb
+- lib/govuk_schemas/assert_matchers.rb
 - lib/govuk_schemas/document_types.rb
 - lib/govuk_schemas/example.rb
 - lib/govuk_schemas/random_content_generator.rb
@@ -123,6 +124,7 @@ files:
 - lib/govuk_schemas/random_schema_generator.rb
 - lib/govuk_schemas/rspec_matchers.rb
 - lib/govuk_schemas/schema.rb
+- lib/govuk_schemas/validator.rb
 - lib/govuk_schemas/version.rb
 homepage: https://github.com/alphagov/govuk_schemas_gem
 licenses:
@@ -143,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.18
 signing_key: 
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas

data/Jenkinsfile

@@ -1,9 +0,0 @@
-#!/usr/bin/env groovy
-
-library("govuk")
-
-node {
-  govuk.buildProject(
-    rubyLintDiff: false,
-  )
-}