govuk_schemas 4.4.1 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad5834f6042340a4e2749eca28ebe9da5f3c7d4020aa8c80d4139b66b3cabf40
-  data.tar.gz: 9d3f754aeeb7e3628a5ee853d60c33c9cfd52c5440e874ab2e7ecdbd0ffd58f6
+  metadata.gz: b56e593e5917f8ddee82d27bb4e446b485cd42d7e8fdd1efb7490ffd2c644f70
+  data.tar.gz: 4f4af57bb338fdf2f28d17094c3d2c027eafc550a5dac0053754aa1026821d44
 SHA512:
-  metadata.gz: 3d1fa913598d9058f76c7406878043ad564bd1c443840af54e37a13130890a653abb9ab9725aa85368c449cb610782affc5d89a63e82e76255b130066217a779
-  data.tar.gz: d8e9fb819a1f85d3e287377382a1777688becbd2d18be394d7dc6b551f16e5dd1b31ded118c6b469c3240c6483660493c05fed1e6ffcf81648a9a68b15e21522
+  metadata.gz: e1293b1587fca1140157c6d774b5d26fb1a1fdb6365ad47b5582ac8178fa3bcef85dfe97b2c64ca597cf2aa6f1a44b25fdc663ad39bf510072338edee8a1be02
+  data.tar.gz: d9d84be3bdeff138ba5424561b488bec0c5c722abd25e2463b5b3eca7ef90c53b8a89c14b8faacef3b07588a213bbbd4367a8dfe761829da9c7bf1ad4e2a4faa

data/.github/dependabot.yml

@@ -4,14 +4,7 @@ updates:
     directory: /
     schedule:
       interval: daily
-    allow:
-      # Internal gems
-      - dependency-name: "govuk*"
-        dependency-type: direct
-      - dependency-name: rubocop-govuk
-        dependency-type: direct
-      # Framework gems
-      - dependency-name: rake
-        dependency-type: direct
-      - dependency-name: rspec
-        dependency-type: direct
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: daily

data/.github/workflows/ci.yml

@@ -1,4 +1,14 @@
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: 'The branch, tag or SHA to checkout'
+        default: main
+        type: string
 
 jobs:
   # This matrix job runs the test suite against multiple Ruby versions
@@ -7,23 +17,25 @@ jobs:
       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 ]
+        ruby: ['3.0', 3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Clone govuk-content-schemas
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
-          repository: alphagov/govuk-content-schemas
-          ref: deployed-to-production
-          path: tmp/govuk-content-schemas
+          ref: ${{ inputs.ref || github.ref }}
+      - name: Clone content-schemas
+        uses: actions/checkout@v3
+        with:
+          repository: alphagov/publishing-api
+          ref: main
+          path: tmp/publishing-api
       - 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
+          GOVUK_CONTENT_SCHEMAS_PATH: tmp/publishing-api/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.
@@ -39,6 +51,6 @@ jobs:
     if: ${{ github.ref == 'refs/heads/main' }}
     permissions:
       contents: write
-    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yaml@main
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
     secrets:
       GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.gitignore

@@ -1,7 +1,5 @@
 /.bundle/
-/.yardoc
 /Gemfile.lock
-/_yardoc/
 /coverage/
 /doc/
 /pkg/

data/.rubocop.yml

@@ -1,6 +1,3 @@
 inherit_gem:
   rubocop-govuk:
     - config/default.yml
-
-AllCops:
-  TargetRubyVersion: 2.6

data/.ruby-version

@@ -1 +1 @@
-2.7.6
+3.0.5

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 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
+
+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
 
 * Fix `Validator` module to handle JSON or other object types being passed as the payload ([#68](https://github.com/alphagov/govuk_schemas/pull/68))

data/README.md

@@ -1,6 +1,6 @@
 # GOV.UK Schemas
 
-Gem to work with the [govuk-content-schemas](https://github.com/alphagov/govuk-content-schemas).
+Gem to work with the [schemas in publishing api](https://github.com/alphagov/publishing-api/tree/main/content_schemas).
 
 ## Installation
 
@@ -16,18 +16,12 @@ gem "govuk_schemas", "~> VERSION"
 
 ## Running the test suite
 
-Make sure you have `govuk-content-schemas` cloned in a sibling directory:
+Make sure you have `publishing-api` cloned in a sibling directory:
 
 ```
 bundle exec rake
 ```
 
-### Documentation
-
-To run a Yard server locally to preview documentation, run:
-
-    $ bundle exec yard server --reload
-
 ## License
 
-The gem is available as open source under the terms of the [MIT License](LICENSE.md).
+The gem is available as open source under the terms of the [MIT License](LICENCE).

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
 
-task default: [:spec]
+task default: %i[lint spec]

data/govuk_schemas.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  # This should be kept in sync with the json-schema version of govuk-content-schemas.
-  spec.add_dependency "json-schema", "~> 2.8.0"
+  # This should be kept in sync with the json-schema version of publishing-api.
+  spec.add_dependency "json-schema", ">= 2.8", "< 4.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.0"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "rubocop-govuk", "4.10.0"
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 3.0"
 end

data/lib/govuk_schemas/document_types.rb

@@ -3,7 +3,7 @@ module GovukSchemas
     # Return all of the document types on GOV.UK
     def self.valid_document_types
       @valid_document_types ||= begin
-        filename = "#{GovukSchemas::CONTENT_SCHEMA_DIR}/lib/govuk_content_schemas/allowed_document_types.yml"
+        filename = "#{GovukSchemas.content_schema_dir}/allowed_document_types.yml"
         YAML.load_file(filename)
       end
     end

data/lib/govuk_schemas/example.rb

@@ -27,11 +27,11 @@ module GovukSchemas
     # @param schema_name [String] like "detailed_guide", "policy" or "publication"
     # @return [String] the path to use for examples
     def self.examples_path(schema_name)
-      examples_dir = "#{GovukSchemas::CONTENT_SCHEMA_DIR}/examples"
+      examples_dir = "#{GovukSchemas.content_schema_dir}/examples"
       if Dir.exist?(examples_dir)
         "#{examples_dir}/#{schema_name}/frontend"
       else
-        "#{GovukSchemas::CONTENT_SCHEMA_DIR}/formats/#{schema_name}/frontend/examples"
+        "#{GovukSchemas.content_schema_dir}/formats/#{schema_name}/frontend/examples"
       end
     end
   end

data/lib/govuk_schemas/random_content_generator.rb

@@ -8,9 +8,10 @@ module GovukSchemas
     end
 
     def string_for_type(type)
-      if type == "date-time"
+      case type
+      when "date-time"
         time
-      elsif type == "uri"
+      when "uri"
         uri
       else
         raise "Unknown attribute type `#{type}`"
@@ -28,7 +29,7 @@ module GovukSchemas
     end
 
     def base_path
-      "/" + @random.rand(1..5).times.map { uuid }.join("/")
+      "/#{@random.rand(1..5).times.map { uuid }.join('/')}"
     end
 
     def govuk_subdomain_url
@@ -83,6 +84,8 @@ module GovukSchemas
         Date.today.iso8601
       when "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
         Time.now.strftime("%H:%m")
+      when "^[1-9][0-9]{3}$"
+        rand(1000...9999).to_s
       when "^#.+$"
         anchor
       when "[a-z-]"
@@ -98,17 +101,16 @@ module GovukSchemas
       when '[a-z0-9\-_]'
         "#{hex}-#{hex}"
       else
-        raise <<-DOC
+        raise <<~DOC
           Don't know how to generate random string for pattern #{pattern.inspect}
 
-          This propably means you've introduced a new regex in  govuk-content-schemas.
-          Because it's very hard to generate a valid string from a regex alone,
-          we have to specify a method to generate random data for each regex in
-          the schemas.
+          This probably means you've introduced a new regex in to a content
+          schema in Publishing API. Because it's very hard to generate a valid
+          string from a regex alone, we have to specify a method to generate
+          random data for each regex in the schemas.
 
-          To fix this:
-
-          - Add your regex to `lib/govuk_schemas/random.rb`
+          This can be fixed by adding your regex to `lib/govuk_schemas/random_content_generator.rb`
+          in https://github.com/alphagov/govuk_schemas
         DOC
       end
     end

data/lib/govuk_schemas/random_example.rb

@@ -9,7 +9,7 @@ module GovukSchemas
   #
   # - The gem doesn't support `patternProperties` yet. On GOV.UK we [use this in
   # the expanded frontend
-  # links](https://github.com/alphagov/govuk-content-schemas/blob/bdd97d18c7a9318e66f332f0748a410fddab1141/formats/frontend_links_definition.json#L67-L71).
+  # links](https://github.com/alphagov/publishing-api/blob/a8039d430e44c86c3f54a69569f07ad48a4fc912/content_schemas/formats/shared/definitions/frontend_links.jsonnet#L118-L121).
   # - It's complicated to generate random data for `oneOf` properties. According
   # to the JSON Schema spec a `oneOf` schema is only valid if the data is valid
   # against *only one* of the clauses. To do this properly, we'd have to make
@@ -90,7 +90,7 @@ module GovukSchemas
         payload = yield(payload)
         # check the payload again after customisation
         errors = validation_errors_for(payload)
-        raise InvalidContentGenerated, error_message(payload, errors, true) if errors.any?
+        raise InvalidContentGenerated, error_message(payload, errors, customised: true) if errors.any?
       end
 
       payload
@@ -102,7 +102,7 @@ module GovukSchemas
       JSON::Validator.fully_validate(@schema, item, errors_as_objects: true)
     end
 
-    def error_message(item, errors, customised = false)
+    def error_message(item, errors, customised: false)
       details = <<~ERR
         Generated payload:
         --------------------------

data/lib/govuk_schemas/random_schema_generator.rb

@@ -103,11 +103,7 @@ module GovukSchemas
         next unless should_generate_value
 
         one_of_properties = (one_of_sample["properties"] || {})[attribute_name]
-        document[attribute_name] = if one_of_properties
-                                     generate_value(one_of_properties)
-                                   else
-                                     generate_value(attribute_properties)
-                                   end
+        document[attribute_name] = generate_value(one_of_properties || attribute_properties)
       end
 
       document
@@ -129,6 +125,7 @@ module GovukSchemas
         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
 

data/lib/govuk_schemas/rspec_matchers.rb

@@ -2,7 +2,6 @@ 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|
@@ -10,10 +9,7 @@ module GovukSchemas
           @validator.valid?
         end
 
-
-        failure_message do |actual|
-          @validator.error_message
-        end
+        failure_message { @validator.error_message }
       end
     end
   end

data/lib/govuk_schemas/schema.rb

@@ -11,7 +11,7 @@ module GovukSchemas
     #   GovukSchemas::Schema.find(notification_schema: "detailed_guide")
     # @return [Hash] the JSON schema as a hash
     def self.find(schema)
-      file_path = "#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/#{location_for_schema_name(schema)}"
+      file_path = "#{GovukSchemas.content_schema_dir}/dist/formats/#{location_for_schema_name(schema)}"
       JSON.parse(File.read(file_path))
     end
 
@@ -21,7 +21,7 @@ module GovukSchemas
     # @return [Array<Hash>] List of JSON schemas as hashes
     def self.all(schema_type: "*")
       schema_type = "publisher_v2" if schema_type == "publisher"
-      Dir.glob("#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/*/#{schema_type}/*.json").each_with_object({}) do |file_path, hash|
+      Dir.glob("#{GovukSchemas.content_schema_dir}/dist/formats/*/#{schema_type}/*.json").each_with_object({}) do |file_path, hash|
         hash[file_path] = JSON.parse(File.read(file_path))
       end
     end
@@ -38,7 +38,7 @@ module GovukSchemas
     #
     # @return [Array] all the schema names
     def self.schema_names
-      Dir.glob("#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/*").map do |directory|
+      Dir.glob("#{GovukSchemas.content_schema_dir}/dist/formats/*").map do |directory|
         File.basename(directory)
       end
     end

data/lib/govuk_schemas/validator.rb

@@ -29,7 +29,7 @@ module GovukSchemas
     def errors
       schema = Schema.find("#{type}_schema": schema_name)
       validator = JSON::Validator.fully_validate(schema, payload)
-      validator.map { |message| "- " + humanized_error(message) }.join("\n")
+      validator.map { |message| "- #{humanized_error(message)}" }.join("\n")
     end
 
     def formatted_payload
@@ -38,7 +38,7 @@ module GovukSchemas
 
     def humanized_error(message)
       message.gsub("The property '#/'", "The item")
-             .gsub(/in schema [0-9a-f\-]+/, "")
+             .gsub(/in schema [0-9a-f-]+/, "")
              .strip
     end
 

data/lib/govuk_schemas/version.rb

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

data/lib/govuk_schemas.rb

@@ -5,8 +5,13 @@ require "govuk_schemas/document_types"
 require "govuk_schemas/example"
 
 module GovukSchemas
-  # @private
-  CONTENT_SCHEMA_DIR = ENV["GOVUK_CONTENT_SCHEMAS_PATH"] || "../govuk-content-schemas"
+  def self.content_schema_dir=(path_to_schemas)
+    @content_schema_dir = path_to_schemas
+  end
+
+  def self.content_schema_dir
+    @content_schema_dir ||= ENV.fetch("GOVUK_CONTENT_SCHEMAS_PATH", "../publishing-api/content_schemas")
+  end
 
   # @private
   class InvalidContentGenerated < RuntimeError

metadata

@@ -1,31 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,61 +45,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-govuk
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 4.10.0
 description: Gem to generate test data based on GOV.UK content schemas
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -110,7 +116,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- LICENSE.md
+- LICENCE
 - README.md
 - Rakefile
 - bin/console
@@ -138,14 +144,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas