govuk_schemas 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ae3fcbab8090c1fc21b77822f02f3d13ad1e6b7
-  data.tar.gz: e417e9c8d4ee30225e1e55c9852af054692f1c45
+  metadata.gz: 1e3774ac312636e52ae77ba38deab3b6f1e749cf
+  data.tar.gz: 43ab66a728f531e8881da0daf96ec0327b42baf5
 SHA512:
-  metadata.gz: 5e87fd5bc7f3c42d7e6cf1193361a9056b6da54d14c7579173ffa3c4b94ea04c932194fe597a84930dcced18c893032dee84834afad9b20e14b8a2cf147b5ed1
-  data.tar.gz: e803c13e394c7778836a8c87c416de4a38d81f75ab79d44659b1caf0adc4bff314ee2986f59b4e8e9480ea43543aadd9e567b6f30d538d9e9775a61c20332f16
+  metadata.gz: 231ae75cf41f46f6417a365b1b9bf39bad8fdf49cc65e3dec554371cd6dcbb92b6f47db3e3c1615c14d535c91ae37ad8511790ac72cc08560683b59b9022c72c
+  data.tar.gz: 772c6a9f27ca821ac05d2a5eae881b9be999b25649c6143efe56507c88156f47b900031ef69617390f0726ad5f32dcab0fbf841d112c8cba62d2f1f5c693572c

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.2.0
+
+* Add RSpec test helpers
+* Add `customise_and_validate` to bring the functionality to remove fields from a payload which has been generated as a random example
+
 # 2.1.1
 
 * Support for a new regex in GOV.UK content schemas

data/README.md

@@ -17,7 +17,7 @@ gem "govuk_schemas", "~> VERSION"
 
 ## Usage
 
-[Read the documentation!](https://alphagov.github.io/govuk_schemas_gem/frames.html)
+[Read the documentation!](https://alphagov.github.io/govuk_schemas/frames.html)
 
 ## Running the test suite
 

data/lib/govuk_schemas/random_example.rb

@@ -34,41 +34,23 @@ module GovukSchemas
       GovukSchemas::RandomExample.new(schema: schema)
     end
 
-    # Return a hash with a random content item
-    #
-    # Example:
-    #
-    #     GovukSchemas::RandomExample.for_schema("detailed_guide", schema_type: "frontend").payload
-    #     # => {"base_path"=>"/e42dd28e", "title"=>"dolor est...", "publishing_app"=>"elit"...}
-    #
-    # @return [Hash] A content item
-    def payload
-      item = @random_generator.payload
-      errors = validation_errors_for(item)
-
-      if errors.any?
-        raise InvalidContentGenerated, error_message(item, errors)
-      end
-
-      item
-    end
-
-    # Return a content item merged with a hash. If the resulting content item
-    # isn't valid against the schema an error will be raised.
+    # Return a content item merged with a hash and with the excluded fields removed.
+    # If the resulting content item isn't valid against the schema an error will be raised.
     #
     # Example:
     #
     #      random = GovukSchemas::RandomExample.for_schema("detailed_guide", schema_type: "frontend")
-    #      random.merge_and_validate(base_path: "/foo")
+    #      random.customise_and_validate({base_path: "/foo"}, ["withdrawn_notice"])
     #      # => {"base_path"=>"/e42dd28e", "title"=>"dolor est...", "publishing_app"=>"elit"...}
     #
     # @param [Hash] hash The hash to merge the random content with
+    # @param [Array] array The array containing fields to exclude
     # @return [Hash] A content item
     # @raise [GovukSchemas::InvalidContentGenerated]
-    def merge_and_validate(user_defined_values)
+    def customise_and_validate(user_defined_values = {}, fields_to_exclude = [])
       random_payload = @random_generator.payload
       item_merged_with_user_input = random_payload.merge(Utils.stringify_keys(user_defined_values))
-
+      item_merged_with_user_input.reject! { |k| fields_to_exclude.include?(k) }
       errors = validation_errors_for(item_merged_with_user_input)
       if errors.any?
 
@@ -86,6 +68,18 @@ module GovukSchemas
       item_merged_with_user_input
     end
 
+    # Return a hash with a random content item
+    #
+    # Example:
+    #
+    #     GovukSchemas::RandomExample.for_schema("detailed_guide", schema_type: "frontend").payload
+    #     # => {"base_path"=>"/e42dd28e", "title"=>"dolor est...", "publishing_app"=>"elit"...}
+    #
+    # @return [Hash] A content item
+    # Support backwards compatibility
+    alias :payload :customise_and_validate
+    alias :merge_and_validate :customise_and_validate
+
   private
 
     def validation_errors_for(item)

data/lib/govuk_schemas/rspec_matchers.rb

@@ -0,0 +1,65 @@
+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
+      end
+    end
+  end
+
+  class ValidationErrorMessage
+    attr_reader :schema_name, :type, :payload
+
+    def initialize(schema_name, type, payload)
+      @schema_name = schema_name
+      @type = type
+      @payload = payload
+    end
+
+    def message
+      <<~doc
+      expected the payload to be valid against the '#{schema_name}' schema:
+
+      #{formatted_payload}
+
+      Validation errors:
+      #{errors}
+      doc
+    end
+
+  private
+
+    def errors
+      schema = Schema.find(publisher_schema: schema_name)
+      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)
+    end
+
+    def humanized_error(message)
+      message.gsub("The property '#/'", "The item")
+    end
+  end
+end

data/lib/govuk_schemas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -135,6 +135,7 @@ files:
 - lib/govuk_schemas/random.rb
 - lib/govuk_schemas/random_example.rb
 - lib/govuk_schemas/random_item_generator.rb
+- lib/govuk_schemas/rspec_matchers.rb
 - lib/govuk_schemas/schema.rb
 - lib/govuk_schemas/utils.rb
 - lib/govuk_schemas/version.rb