govuk_schemas 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46784ff30a78aee2321e3defb7e2b31ea6eb751c96ddec7ba2ebe695a42b29a
-  data.tar.gz: 3f6d24f1c5afb4f175d9157f84ced30b20e475b76958c7128872c179aa7bb62d
+  metadata.gz: b7843ee3adf4523d3d0a0a8c722f5ae3175edaf3a4d1ee248a4fdafee9b596cf
+  data.tar.gz: b04e4942d146c69782e5b0e70f2d441e0f4aa6822afa054ad78d77cd40aaab7f
 SHA512:
-  metadata.gz: c2d875e00eaf8440b82c7a9173dbf23a708aabb49157bd960c7c7a94e715ba6429b43864f6b168b2e8fe1c3daa8743a76e6662f02fdf0db86e59e5af585b7b1d
-  data.tar.gz: 166c8ecb0f9f850e682eba2181ba6187321428fcee4f9dd1e707a6791ee8b5da3d422aef3c404d5d8a175d3601c0fc6388bb8c995dd72c6353a3628886a0ea81
+  metadata.gz: 14d5fb78761952ed355573bfd62c5cef13d2b723011a7bad969c5cf43926231e8a02af778aadcc514e73af3137703fa950b11264b90ac5111192c252f567f1f6
+  data.tar.gz: 6e13df6f72f725fc504fb4151ca849dd2faeeae26c7d0c3f16f923ce3eec218293d3f66642d9237634c9666c481731f018b47df739ec8719929c82c1429b47dc

data/.github/dependabot.yml

@@ -4,14 +4,3 @@ 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

data/.github/workflows/ci.yml

@@ -11,19 +11,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - name: Clone govuk-content-schemas
+      - name: Clone content-schemas
         uses: actions/checkout@v2
         with:
-          repository: alphagov/govuk-content-schemas
+          repository: alphagov/publishing-api
           ref: deployed-to-production
-          path: tmp/govuk-content-schemas
+          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.

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 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))
+
 # 4.4.0
 
 * Adds support for applications that use Minitest by adding an `AssertMatchers` module ([#66](https://github.com/alphagov/govuk_schemas/pull/66))

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,7 +16,7 @@ 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

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,9 +18,10 @@ 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", "< 3.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"

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
@@ -101,7 +102,7 @@ module GovukSchemas
         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.
+          This propably means you've introduced a new regex 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.

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

@@ -1,11 +1,12 @@
 module GovukSchemas
   class Validator
-    attr_reader :schema_name, :type, :payload
+    attr_reader :schema_name, :type
+    attr_accessor :payload
 
     def initialize(schema_name, type, payload)
       @schema_name = schema_name
       @type = type
-      @payload = payload
+      @payload = ensure_json(payload)
     end
 
     def valid?
@@ -27,14 +28,12 @@ module GovukSchemas
 
     def errors
       schema = Schema.find("#{type}_schema": schema_name)
-      validator = JSON::Validator.fully_validate(schema, payload.to_json)
-      validator.map { |message| "- " + humanized_error(message) }.join("\n")
+      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)
+      JSON.pretty_generate(JSON.parse(payload))
     end
 
     def humanized_error(message)
@@ -42,5 +41,11 @@ module GovukSchemas
              .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.4.0".freeze
+  VERSION = "4.5.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,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-11-23 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'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.18
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas