govuk_schemas 5.0.1 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11fe25fadfae015a3a24eaf4abd396e618821351ce046f5102e3d25f8e2c1b1c
-  data.tar.gz: 3ec36c9783619553fbf7a8cafc92af1f6e7788bfb2c7b7b1146c0269a1cf5227
+  metadata.gz: cb7171db237b01bb19991d1675d3d150731997d20fa4fb2f28c7b0868e0f723f
+  data.tar.gz: 90872e26de2b1ccc70b1b4e3ade137eaeb6a3221bfa0cf65c69d6c81ae045c44
 SHA512:
-  metadata.gz: 51c8478cc3b921d0d6f97911f890705634acb7d4fca3d61cee5e3547b2e1ce82e69ac4fbb6df2a7224b3f7710b7a981df4006ec3d3474a8a980254da55af8a85
-  data.tar.gz: 14676e6b674e0cf8fbb0957ff9865dbfb91085ea49cffca3156dd15c2616eb15f7b2657679f6508ae28216cbbc95e5356e77f48d0b18f140656eb90a082b8ae1
+  metadata.gz: 8789569b6d515a80312e5aae98f33c68d7ec1972f487d8e7eb599d1b7a0cb4bd4b77d9cc9e952df9a149e2d5a32e5794a6de3f974411ec491ccc2a05d9527c37
+  data.tar.gz: ff677fa7341044673cca7573fd14e07bf2de126b163c09c2c3d576850a6b52c7ee4206c1d2d4439db7339e2c9e8ff2191c687c3338d21f967033c275d5092cd8

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 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
+
+* Fix issue where customised schema validation message was incorrect for a modified payload
+
 # 5.0.1
 
 * Improve speed of random schema generation for customised content items

data/govuk_schemas.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json-schema", ">= 2.8", "< 4.4"
 
   spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "faker", "~> 3.4.1"
   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.17.1"
+  spec.add_development_dependency "rubocop-govuk", "4.18.0"
 
   spec.required_ruby_version = ">= 3.1.4"
 end

data/lib/govuk_schemas/random_content_generator.rb

@@ -1,3 +1,5 @@
+require "faker"
+
 module GovukSchemas
   # @private
   class RandomContentGenerator
@@ -5,6 +7,7 @@ module GovukSchemas
 
     def initialize(random: Random.new)
       @random = random
+      Faker::Config.random = @random
     end
 
     def string_for_type(type)
@@ -13,8 +16,20 @@ module GovukSchemas
         time
       when "uri"
         uri
+      when "email"
+        Faker::Internet.email
       else
-        raise "Unknown attribute type `#{type}`"
+        raise <<~DOC
+           Unsupported JSON schema type `#{type}`
+
+           Supported formats are:
+             - date-time
+             - uri
+             - email
+
+           This can be fixed by adding a type to the `string_for_type` method in
+          `lib/govuk_schemas/random_content_generator.rb` in https://github.com/alphagov/govuk_schemas
+        DOC
       end
     end
 
@@ -25,7 +40,7 @@ module GovukSchemas
 
     # TODO: make this more random with query string, optional anchor.
     def uri
-      "http://example.com#{base_path}#{anchor}"
+      "#{Faker::Internet.url(path: base_path)}#{anchor}"
     end
 
     def base_path
@@ -33,10 +48,8 @@ module GovukSchemas
     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}"
+      host = Faker::Internet.domain_name(subdomain: true, domain: "gov.uk")
+      Faker::Internet.url(host:, path: base_path)
     end
 
     def string(minimum_chars = nil, maximum_chars = nil)

data/lib/govuk_schemas/random_example.rb

@@ -93,7 +93,8 @@ module GovukSchemas
   private
 
     def customise_payload(payload)
-      original_payload = payload
+      # Use Marshal to create a deep dup of the payload so the original can be mutated
+      original_payload = Marshal.load(Marshal.dump(payload))
       customised_payload = yield(payload)
       customised_errors = validation_errors_for(customised_payload)
 

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.3
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +106,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.17.1
+        version: 4.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.17.1
+        version: 4.18.0
 description: Gem to generate test data based on GOV.UK content schemas
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -152,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.14
 signing_key: 
 specification_version: 4
 summary: Gem to generate test data based on GOV.UK content schemas