govuk_schemas 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0284fbbf0aea21ee8b9dd454dc8934f9c9da9b0b
-  data.tar.gz: e0555905e01eeb2dada139cb1f43f4030d5bc6ae
+  metadata.gz: 6f0717cb5ebb1dc03c12f035a91dcf2f45558e27
+  data.tar.gz: 6ed611cdea54b588141d7c031aaed8e568c46a2a
 SHA512:
-  metadata.gz: 9c4f413d705359a75802147e74a7cd2c58d122f8ae16d8dc464259ac63394f7260709f7c3fec1a8eff490f4552d31d8c63abfdb5b778522c38a1d21e6f8ed05a
-  data.tar.gz: d949094bfa6c8a7ac8894daa1a58a6fffee3520b193099c8742ccc3c20a5cb70f133919e1bed5f4cab692c49f4c307c7a3bd85c9a452733d4f09f7032bb4c71d
+  metadata.gz: 0280cc2e9eaaa76c79442c1ad3fa8bf33cac8c13f4028c8cada49b53f4d2b81a12330be014c5720994e343a45c9658a646cf13e67884b1b0b1b1d6b6f8a12a15
+  data.tar.gz: feb12a918c28c94a0c1f7ac88a12371be71d8ce4784a0eabd382498cbecc7d1f5ba8709c721cd6280d788f177e83b96e440c88c1114429a1cd954d2166c6e246

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.0
+
+* Add regex for GOV.UK campaign URLs
+* Improve error messages
+
 # 0.2.0
 
 * Add a new regex for the new application validation in the schema

data/lib/govuk_schemas/random.rb

@@ -28,6 +28,11 @@ module GovukSchemas
         "/" + rand(1..5).times.map { SecureRandom.uuid }.join('/')
       end
 
+      def govuk_campaign_url
+        subdomain = rand(1..5).times.map { ('a'..'z').to_a.sample(rand(1..5)).join }.join('.')
+        "https://#{subdomain}.campaign.gov.uk#{base_path}"
+      end
+
       def string(minimum_chars = nil, maximum_chars = nil)
         minimum_chars = minimum_chars || 0
         maximum_chars = maximum_chars || 100
@@ -60,10 +65,23 @@ module GovukSchemas
           Utils.parameterize(WORDS.sample(rand(1..10)).join('-'))
         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_campaign_url
         when '[a-z0-9\-_]'
           "#{SecureRandom.hex}-#{SecureRandom.hex}"
         else
-          raise "Regex pattern not found: #{pattern.inspect}"
+          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

data/lib/govuk_schemas/random_example.rb

@@ -69,7 +69,7 @@ module GovukSchemas
       errors = validation_errors_for(item)
 
       if errors.any?
-        raise InvalidContentGenerated, error_message_custom(item, errors)
+        raise InvalidContentGenerated, error_message_custom(item, hash, errors)
       end
 
       item
@@ -83,13 +83,13 @@ module GovukSchemas
 
     def error_message(item, errors)
       <<err
-An invalid content item was generated by `RandomExample`. This probably
-means that either you've merged the content item with invalid values, or there's
-a bug in the generator that causes it to output invalid values. Below you'll find
-the generated payload, the validation errors and the schema that was used.
-Together these should be sufficient to debug the issue.
+An invalid content item was generated.
 
-Errors:
+This probably means there's a bug in the generator that causes it to output
+invalid values. Below you'll find the generated payload, the validation errors
+and the schema that was used.
+
+Validation errors:
 --------------------------
 
 #{JSON.pretty_generate(errors)}
@@ -98,33 +98,29 @@ Generated payload:
 --------------------------
 
 #{JSON.pretty_generate([item])}
-
-Schema:
---------------------------
-
-#{JSON.pretty_generate(@schema)}
 err
     end
 
-    def error_message_custom(item, errors)
+    def error_message_custom(item, custom_values, errors)
+      error_messages = errors.map { |e| "- #{e[:message]}\n" }.join
+
       <<err
-An invalid content item was generated by `RandomExample`. This probably
-means you've merged the content item with invalid values.
+The content item you are trying to generate is invalid against the schema.
 
-Errors:
+Validation errors:
 --------------------------
 
-#{JSON.pretty_generate(errors)}
+#{error_messages}
 
-Generated payload:
+Custom values provided:
 --------------------------
 
-#{JSON.pretty_generate([item])}
+#{JSON.pretty_generate(custom_values)}
 
-Schema:
+Generated payload:
 --------------------------
 
-#{JSON.pretty_generate(@schema)}
+#{JSON.pretty_generate([item])}
 err
     end
   end

data/lib/govuk_schemas/random_item_generator.rb

@@ -123,7 +123,7 @@ module GovukSchemas
     def lookup_json_pointer(ref)
       elements = ref.split('/')
       elements.shift
-      @schema.dig(*elements)
+      @schema.dig(*elements) || raise("Definition `#{ref}` not found in the schema")
     end
   end
 end

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema