govuk_schemas 3.3.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 345030ceca3637693cb97b1f7ae278a95998880a
-  data.tar.gz: 4b2bfb4865a81442d7ec8c18acbf83b394c2a58e
+SHA256:
+  metadata.gz: 3b1010c2e3fc4d2b11f832cb7fc987d93bc31e911847ec6d18231e47a29a605f
+  data.tar.gz: 1c7c41a441859658c3f2e53ba4399374227120611150d14ca9a0d0f850e24c15
 SHA512:
-  metadata.gz: 41557290549c44945a885bfaea6ad72cba73fef4050a9a7d1c23f89fa56a13925a598580362dfee42ff7b066664b2e018173234b4c7b120ad5dc567741e7140c
-  data.tar.gz: 5af51d7f613812c5385f4294195dcf7fcc3184abdd85c78051d47c6654e3a7a1b0e155e84d51619cab0f15dce6d78607736f96dd4c239c118b4dd0d235f3389c
+  metadata.gz: 44e53cbd69991f6882e7d9a371257bef45fc100c75f945048e8700fdb9c17c9a69727219206e7ce720b5007c5412d7139472d370f856cc46fc1387453432f09b
+  data.tar.gz: 8ad00bb818a94cb75c5ae2d0e99ab754a204655a966a11c4acbed2e937c3015794a2847c9c5b6eb8567d2f724893c03a98fe2252c14b2499cc8d9a93b7b2e26b

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    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/.rubocop.yml

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

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.6.6

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+# 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))
+
+# 4.1.1
+
+* Fix RandomSchemaGenerator.new always returning equivalent generators ([#60](https://github.com/alphagov/govuk_schemas/pull/60))
+
+# 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
+
+* Bump the required Ruby version to >= 2.6.x.
+
+# 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`.
+
 # 3.3.0
 
 * Support generating objects with an `oneOf` property.

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in govuk_schemas.gemspec
 gemspec

data/Jenkinsfile

@@ -2,50 +2,8 @@
 
 library("govuk")
 
-REPOSITORY = 'govuk_schemas'
-
 node {
-
-  try {
-    stage('Checkout') {
-      checkout scm
-    }
-
-    stage('Clean') {
-      govuk.cleanupGit()
-      govuk.mergeMasterBranch()
-    }
-
-    stage("Set up content schema dependency") {
-      govuk.contentSchemaDependency()
-    }
-
-    stage('Bundle') {
-      echo 'Bundling'
-      sh("bundle install --path ${JENKINS_HOME}/bundles/${JOB_NAME}")
-    }
-
-    stage('Linter') {
-      govuk.rubyLinter()
-    }
-
-    stage('Tests') {
-      govuk.setEnvar('RAILS_ENV', 'test')
-      govuk.runTests('spec')
-    }
-
-    if(env.BRANCH_NAME == "master") {
-      stage('Publish Gem') {
-        govuk.publishGem(REPOSITORY, env.BRANCH_NAME)
-      }
-    }
-
-  } catch (e) {
-    currentBuild.result = 'FAILED'
-    step([$class: 'Mailer',
-          notifyEveryUnstableBuild: true,
-          recipients: 'govuk-ci-notifications@digital.cabinet-office.gov.uk',
-          sendToIndividuals: true])
-    throw e
-  }
+  govuk.buildProject(
+    rubyLintDiff: false,
+  )
 }

data/govuk_schemas.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'govuk_schemas/version'
+require "govuk_schemas/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "govuk_schemas"
@@ -17,16 +16,16 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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"
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "govuk-lint", "~> 3.11"
+  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 "yard", "~> 0.8"
 
-  spec.required_ruby_version = ">= 2.3.1"
+  spec.required_ruby_version = ">= 2.6"
 end

data/lib/govuk_schemas.rb

@@ -1,6 +1,5 @@
 require "govuk_schemas/version"
 require "govuk_schemas/schema"
-require "govuk_schemas/utils"
 require "govuk_schemas/random_example"
 require "govuk_schemas/document_types"
 require "govuk_schemas/example"
@@ -10,6 +9,6 @@ module GovukSchemas
   CONTENT_SCHEMA_DIR = ENV["GOVUK_CONTENT_SCHEMAS_PATH"] || "../govuk-content-schemas"
 
   # @private
-  class InvalidContentGenerated < Exception
+  class InvalidContentGenerated < RuntimeError
   end
 end

data/lib/govuk_schemas/random_content_generator.rb

@@ -0,0 +1,128 @@
+module GovukSchemas
+  # @private
+  class RandomContentGenerator
+    WORDS = %w[Lorem ipsum dolor sit amet consectetur adipiscing elit. Ut suscipit at mauris non bibendum. Ut ac massa est. Aenean tempor imperdiet leo vel interdum. Nam sagittis cursus sem ultricies scelerisque. Quisque porttitor risus vel risus finibus eu sollicitudin nisl aliquet. Sed sed lectus ac dolor molestie interdum. Nam molestie pellentesque purus ac vestibulum. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse non tempor eros. Mauris eu orci hendrerit volutpat lorem in tristique libero. Duis a nibh nibh.].freeze
+
+    def initialize(random: Random.new)
+      @random = random
+    end
+
+    def string_for_type(type)
+      if type == "date-time"
+        time
+      elsif type == "uri"
+        uri
+      else
+        raise "Unknown attribute type `#{type}`"
+      end
+    end
+
+    def time
+      arbitrary_time = Time.new(2012, 2, 1)
+      (arbitrary_time + @random.rand(0..500_000_000)).iso8601
+    end
+
+    # TODO: make this more random with query string, optional anchor.
+    def uri
+      "http://example.com#{base_path}#{anchor}"
+    end
+
+    def base_path
+      "/" + @random.rand(1..5).times.map { uuid }.join("/")
+    end
+
+    def govuk_subdomain_url
+      subdomain = @random.rand(2..4).times.map {
+        ("a".."z").to_a.sample(@random.rand(3..8), random: @random).join
+      }.join(".")
+      "https://#{subdomain}.gov.uk#{base_path}"
+    end
+
+    def string(minimum_chars = nil, maximum_chars = nil)
+      minimum_chars ||= 0
+      maximum_chars ||= 100
+      WORDS.sample(@random.rand(minimum_chars..maximum_chars), random: @random).join(" ")
+    end
+
+    def bool
+      @random.rand(2) == 1
+    end
+
+    def anchor
+      "##{hex}"
+    end
+
+    def random_identifier(separator:)
+      WORDS.sample(@random.rand(1..10), random: @random)
+        .join("-")
+        .gsub(/[^a-z0-9\-_]+/i, "-")
+        .gsub("-", separator)
+    end
+
+    def uuid
+      # matches uuid regex e.g. e058aad7-ce86-5181-8801-4ddcb3c8f27c
+      # /^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$/
+      "#{hex(8)}-#{hex(4)}-1#{hex(3)}-a#{hex(3)}-#{hex(12)}"
+    end
+
+    def hex(length = 10)
+      length.times.map { bool ? random_letter : random_number }.join("")
+    end
+
+    def string_for_regex(pattern)
+      case pattern.to_s
+      when "^(placeholder|placeholder_.+)$"
+        ["placeholder", "placeholder_#{WORDS.sample(random: @random)}"].sample(random: @random)
+      when "^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
+        uuid
+      when "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?$"
+        base_path
+      when "^[1-9][0-9]{3}[-/](0[1-9]|1[0-2])[-/](0[1-9]|[12][0-9]|3[0-1])$"
+        Date.today.iso8601
+      when "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
+        Date.today.iso8601
+      when "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
+        Time.now.strftime("%H:%m")
+      when "^#.+$"
+        anchor
+      when "[a-z-]"
+        random_identifier(separator: "-")
+      when "^[a-z_]+$"
+        random_identifier(separator: "_")
+      when "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?$"
+        base_path
+      when "^https://([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[A-Za-z0-9])?\\.)+campaign\\.gov\\.uk(/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?)?$"
+        govuk_subdomain_url
+      when "^https://([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[A-Za-z0-9])?\\.)*gov\\.uk(/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?)?$"
+        govuk_subdomain_url
+      when '[a-z0-9\-_]'
+        "#{hex}-#{hex}"
+      else
+        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.
+
+          To fix this:
+
+          - Add your regex to `lib/govuk_schemas/random.rb`
+        DOC
+      end
+    end
+
+  private
+
+    def random_letter
+      letters = ("a".."f").to_a
+      letters[@random.rand(0..letters.count - 1)]
+    end
+
+    def random_number
+      numbers = ("0".."9").to_a
+      numbers[@random.rand(0..numbers.count - 1)]
+    end
+  end
+end

data/lib/govuk_schemas/random_example.rb

@@ -1,5 +1,4 @@
-require "govuk_schemas/random"
-require "govuk_schemas/random_item_generator"
+require "govuk_schemas/random_schema_generator"
 require "json-schema"
 require "json"
 
@@ -24,11 +23,17 @@ module GovukSchemas
     #     schema = GovukSchemas::Schema.find(frontend_schema: "detailed_guide")
     #     GovukSchemas::RandomExample.new(schema: schema).payload
     #
+    # Example with seed (for consistent results):
+    #
+    #     schema = GovukSchemas::Schema.find(frontend_schema: "detailed_guide")
+    #     GovukSchemas::RandomExample.new(schema: schema, seed: 777).payload
+    #     GovukSchemas::RandomExample.new(schema: schema, seed: 777).payload # returns same as above
+    #
     # @param [Hash] schema A JSON schema.
     # @return [GovukSchemas::RandomExample]
-    def initialize(schema:)
+    def initialize(schema:, seed: nil)
       @schema = schema
-      @random_generator = RandomItemGenerator.new(schema: schema)
+      @random_generator = RandomSchemaGenerator.new(schema: schema, seed: seed)
     end
 
     # Returns a new `GovukSchemas::RandomExample` object.

data/lib/govuk_schemas/{random_item_generator.rb → random_schema_generator.rb}

@@ -1,7 +1,7 @@
-require "govuk_schemas/random"
+require "govuk_schemas/random_content_generator"
 
 module GovukSchemas
-  # The RandomItemGenerator takes a JSON schema and outputs a random hash that
+  # The RandomSchemaGenerator takes a JSON schema and outputs a random hash that
   # is valid against said schema.
   #
   # The "randomness" here is quote relative, it's particularly tailored to the
@@ -9,9 +9,11 @@ module GovukSchemas
   # hundred characters to keep the resulting items small.
   #
   # @private
-  class RandomItemGenerator
-    def initialize(schema:)
+  class RandomSchemaGenerator
+    def initialize(schema:, seed: nil)
       @schema = schema
+      @random = Random.new(seed || Random.new_seed)
+      @generator = RandomContentGenerator.new(random: @random)
     end
 
     def payload
@@ -24,45 +26,45 @@ module GovukSchemas
       # TODO: #/definitions/nested_headers are recursively nested and can cause
       # infinite loops. We need to add something that detects and prevents the
       # loop. In the meantime return a valid value.
-      if props['$ref'] == "#/definitions/nested_headers"
+      if props["$ref"] == "#/definitions/nested_headers"
         return [{ "text" => "1", "level" => 1, "id" => "ABC" }]
       end
 
       # JSON schemas can have "pointers". We use this to extract defintions and
       # reduce duplication. To make the schema easily parsable we inline the
       # reference here.
-      if props['$ref']
-        props.merge!(lookup_json_pointer(props['$ref']))
+      if props["$ref"]
+        props.merge!(lookup_json_pointer(props["$ref"]))
       end
 
       # Attributes with `enum` specified often omit the `type` from
       # their definition. It's most likely a string.
-      type = props['type'] || "string"
+      type = props["type"] || "string"
 
       # Except when it has properties, because it's defintely an object then.
-      if props['properties']
+      if props["properties"]
         type = "object"
       end
 
       # Make sure that we choose a type when there are more than one specified.
-      type = Array(type).sample
+      type = Array(type).sample(random: @random)
 
-      if props['anyOf']
-        generate_value(props['anyOf'].sample)
-      elsif props['oneOf'] && type != 'object'
+      if props["anyOf"]
+        generate_value(props["anyOf"].sample(random: @random))
+      elsif props["oneOf"] && type != "object"
         # FIXME: Generating valid data for a `oneOf` schema is quite interesting.
         # 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 verify that the data generated below doesn't
         # validate against the other schemas in `props['oneOf']`.
-        generate_value(props['oneOf'].sample)
-      elsif props['allOf']
-        props['allOf'].each_with_object({}) do |subschema, hash|
+        generate_value(props["oneOf"].sample(random: @random))
+      elsif props["allOf"]
+        props["allOf"].each_with_object({}) do |subschema, hash|
           val = generate_value(subschema)
           hash.merge(val)
         end
-      elsif props['enum']
-        props['enum'].sample
+      elsif props["enum"]
+        props["enum"].sample(random: @random)
       elsif type == "null"
         nil
       elsif type == "object"
@@ -70,11 +72,11 @@ module GovukSchemas
       elsif type == "array"
         generate_random_array(props)
       elsif type == "boolean"
-        Random.bool
+        @generator.bool
       elsif type == "integer"
-        min = props['minimum'] || 0
-        max = props['maximum'] || 10
-        rand(min..max)
+        min = props["minimum"] || 0
+        max = props["maximum"] || 10
+        @random.rand(min..max)
       elsif type == "string"
         generate_random_string(props)
       else
@@ -85,56 +87,71 @@ module GovukSchemas
     def generate_random_object(subschema)
       document = {}
 
-      one_of_sample = subschema.fetch('oneOf', []).sample || {}
+      one_of_sample = subschema.fetch("oneOf", []).sample(random: @random) || {}
 
-      (subschema['properties'] || {}).each do |attribute_name, attribute_properties|
+      (subschema["properties"] || {}).each do |attribute_name, attribute_properties|
         # TODO: When the schema contains `subschema['minProperties']` we always
         # 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 = Random.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'] \
-
-        if 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
-        end
+        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"] \
+
+        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
       end
 
       document
     end
 
     def generate_random_array(props)
-      min = props['minItems'] || 0
-      max = props['maxItems'] || 10
-      num_items = rand(min..max)
-
-      num_items.times.map do
+      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
+
+      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)
       if props["format"]
-        Random.string_for_type(props['format'])
+        @generator.string_for_type(props["format"])
       elsif props["pattern"]
-        Random.string_for_regex(props['pattern'])
+        @generator.string_for_regex(props["pattern"])
       else
-        Random.string(props['minLength'], props['maxLength'])
+        @generator.string(props["minLength"], props["maxLength"])
       end
     end
 
     # Look up a "pointer" like "#/definitions/title" in the schema.
     def lookup_json_pointer(ref)
-      elements = ref.split('/')
+      elements = ref.split("/")
       elements.shift
       @schema.dig(*elements) || raise("Definition `#{ref}` not found in the schema")
     end

data/lib/govuk_schemas/rspec_matchers.rb

@@ -1,26 +1,16 @@
 module GovukSchemas
   module RSpecMatchers
-    RSpec::Matchers.define :be_valid_against_schema do |schema_name|
-      match do |item|
-        schema = Schema.find(publisher_schema: schema_name)
-        validator = JSON::Validator.fully_validate(schema, item)
-        validator.empty?
-      end
-
-      failure_message do |actual|
-        ValidationErrorMessage.new(schema_name, "schema", actual).message
-      end
-    end
-
-    RSpec::Matchers.define :be_valid_against_links_schema do |schema_name|
-      match do |item|
-        schema = Schema.find(links_schema: schema_name)
-        validator = JSON::Validator.fully_validate(schema, item)
-        validator.empty?
-      end
-
-      failure_message do |actual|
-        ValidationErrorMessage.new(schema_name, "links", actual).message
+    %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?
+        end
+
+        failure_message do |actual|
+          ValidationErrorMessage.new(schema_name, "schema", actual).message
+        end
       end
     end
   end
@@ -36,14 +26,14 @@ module GovukSchemas
     end
 
     def message
-      <<~doc
-      expected the payload to be valid against the '#{schema_name}' schema:
+      <<~DOC
+        expected the payload to be valid against the '#{schema_name}' schema:
 
-      #{formatted_payload}
+        #{formatted_payload}
 
-      Validation errors:
-      #{errors}
-      doc
+        Validation errors:
+        #{errors}
+      DOC
     end
 
   private
@@ -56,6 +46,7 @@ module GovukSchemas
 
     def formatted_payload
       return payload if payload.is_a?(String)
+
       JSON.pretty_generate(payload)
     end
 

data/lib/govuk_schemas/schema.rb

@@ -19,11 +19,10 @@ module GovukSchemas
     #
     # @param schema_type [String] The type: frontend, publisher, notification or links
     # @return [Array<Hash>] List of JSON schemas as hashes
-    def self.all(schema_type: '*')
+    def self.all(schema_type: "*")
       schema_type = "publisher_v2" if schema_type == "publisher"
-      Dir.glob("#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/*/#{schema_type}/*.json").reduce({}) do |hash, file_path|
+      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))
-        hash
       end
     end
 

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.8.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.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: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: govuk-lint
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -117,12 +118,11 @@ files:
 - lib/govuk_schemas.rb
 - lib/govuk_schemas/document_types.rb
 - lib/govuk_schemas/example.rb
-- lib/govuk_schemas/random.rb
+- lib/govuk_schemas/random_content_generator.rb
 - lib/govuk_schemas/random_example.rb
-- lib/govuk_schemas/random_item_generator.rb
+- lib/govuk_schemas/random_schema_generator.rb
 - lib/govuk_schemas/rspec_matchers.rb
 - lib/govuk_schemas/schema.rb
-- lib/govuk_schemas/utils.rb
 - lib/govuk_schemas/version.rb
 homepage: https://github.com/alphagov/govuk_schemas_gem
 licenses:
@@ -136,15 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas

data/lib/govuk_schemas/random.rb

@@ -1,101 +0,0 @@
-require 'securerandom'
-
-module GovukSchemas
-  # @private
-  module Random
-    class << self
-      WORDS = %w[Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut suscipit at mauris non bibendum. Ut ac massa est. Aenean tempor imperdiet leo vel interdum. Nam sagittis cursus sem ultricies scelerisque. Quisque porttitor risus vel risus finibus, eu sollicitudin nisl aliquet. Sed sed lectus ac dolor molestie interdum. Nam molestie pellentesque purus ac vestibulum. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Suspendisse non tempor eros. Mauris eu orci hendrerit, volutpat lorem in, tristique libero. Duis a nibh nibh.].freeze
-
-      def string_for_type(type)
-        if type == 'date-time'
-          time
-        elsif type == 'uri'
-          uri
-        else
-          raise "Unknown attribute type `#{type}`"
-        end
-      end
-
-      def time
-        seconds_ago = rand(10_000_000) - 5_000_000
-        (Time.now + seconds_ago).iso8601
-      end
-
-      # TODO: make this more random with query string, optional anchor.
-      def uri
-        "http://example.com#{base_path}#{anchor}"
-      end
-
-      def base_path
-        "/" + rand(1..5).times.map { SecureRandom.uuid }.join('/')
-      end
-
-      def govuk_subdomain_url
-        subdomain = rand(2..4).times.map {
-          ('a'..'z').to_a.sample(rand(3..8)).join
-        }.join('.')
-        "https://#{subdomain}.gov.uk#{base_path}"
-      end
-
-      def string(minimum_chars = nil, maximum_chars = nil)
-        minimum_chars = minimum_chars || 0
-        maximum_chars = maximum_chars || 100
-        WORDS.sample(rand(minimum_chars..maximum_chars)).join(' ')
-      end
-
-      def bool
-        rand(2) == 1
-      end
-
-      def anchor
-        "##{SecureRandom.hex}"
-      end
-
-      def random_identifier(separator:)
-        Utils.parameterize(WORDS.sample(rand(1..10)).join('-')).gsub('-', separator)
-      end
-
-      def string_for_regex(pattern)
-        case pattern.to_s
-        when '^(placeholder|placeholder_.+)$'
-          ['placeholder', "placeholder_#{WORDS.sample}"].sample
-        when '^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$'
-          SecureRandom.uuid
-        when "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?$"
-          base_path
-        when "^[1-9][0-9]{3}[-/](0[1-9]|1[0-2])[-/](0[1-9]|[12][0-9]|3[0-1])$"
-          Date.today.iso8601
-        when "^[1-9][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[0-1])$"
-          Date.today.iso8601
-        when "^#.+$"
-          anchor
-        when "[a-z-]"
-          random_identifier(separator: '-')
-        when "^[a-z_]+$"
-          random_identifier(separator: '_')
-        when "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?$"
-          base_path
-        when "^https://([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[A-Za-z0-9])?\\.)+campaign\\.gov\\.uk(/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?)?$"
-          govuk_subdomain_url
-        when "^https://([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[A-Za-z0-9])?\\.)*gov\\.uk(/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?)?$"
-          govuk_subdomain_url
-        when '[a-z0-9\-_]'
-          "#{SecureRandom.hex}-#{SecureRandom.hex}"
-        else
-          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.
-
-            To fix this:
-
-            - Add your regex to `lib/govuk_schemas/random.rb`
-          doc
-        end
-      end
-    end
-  end
-end

data/lib/govuk_schemas/utils.rb

@@ -1,16 +0,0 @@
-module GovukSchemas
-  # @private
-  module Utils
-    def self.stringify_keys(hash)
-      new_hash = {}
-      hash.each do |k, v|
-        new_hash[k.to_s] = v
-      end
-      new_hash
-    end
-
-    def self.parameterize(string)
-      string.gsub(/[^a-z0-9\-_]+/i, '-')
-    end
-  end
-end