publishing_platform_schemas 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8316073ac789d764c1f29489aea360d74f3b657f58eb501e57994306b38c5fe9
-  data.tar.gz: 0b7aaccb03710ac2d67ab4dbb5960835f614d5aebc2312eac28faa800512c12b
+  metadata.gz: 755a92ec42192fb7a5b02beea49d15893f45fa79c1cb64a30da56eb8e635fa7e
+  data.tar.gz: 778ba197d377bd32b434821a0283cbef9245803e3ad964650a51eb487c848d94
 SHA512:
-  metadata.gz: e8518793ce8cb1b579474a408cc1c8308f18fc18021769c2eb6364330cc2892a4275b96eb3ff1cdc3c6991fdc8d8a1e0ad1e0f3ead74f3f777e14e270f36f0a1
-  data.tar.gz: 549f68aa69f26c2a66e3b036b15597510ee24804ce021452aa7a96b011e7e5a467e689521d9505005be8fddaf6e0ae6e8f906a8183cafa639fe520ee188f9ecd
+  metadata.gz: 1e76d0bf70f0711d91cc7b1313157567dd8f6b0f4118cd453f56f0f488c8013335c64cd737648276d3ab9ec3a89afe8d140a7c7ebbf9a9efa1b317b79077e671
+  data.tar.gz: b5baf59cbb570a6d6276193aafb71534aa6265787691b83f890aeb5bab2b1dc6672142a7aec26402c4e74c76be17d3b5b7a7db186fb1c4bc2c4e05137a4b287b

data/lib/publishing_platform_schemas/example.rb

@@ -0,0 +1,38 @@
+module PublishingPlatformSchemas
+  class Example
+    # Find all examples for a schema
+    #
+    # @param schema_name [String] like "detailed_guide", "policy" or "publication"
+    # @return [Array] array of example content items
+    def self.find_all(schema_name)
+      Dir.glob("#{examples_path(schema_name)}/*.json").map do |filename|
+        json = File.read(filename)
+        JSON.parse(json)
+      end
+    end
+
+    # Find an example by name
+    #
+    # @param schema_name [String] like "detailed_guide", "policy" or "publication"
+    # @param example_name [String] the name of the example JSON file
+    # @return [Hash] the example content item
+    def self.find(schema_name, example_name:)
+      json = File.read("#{examples_path(schema_name)}/#{example_name}.json")
+      JSON.parse(json)
+    end
+
+    # Examples are changing location in schemas, this allows this utility
+    # to work with both locations
+    #
+    # @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 = "#{PublishingPlatformSchemas.content_schema_dir}/examples"
+      if Dir.exist?(examples_dir)
+        "#{examples_dir}/#{schema_name}/frontend"
+      else
+        "#{PublishingPlatformSchemas.content_schema_dir}/formats/#{schema_name}/frontend/examples"
+      end
+    end
+  end
+end

data/lib/publishing_platform_schemas/rspec_matchers.rb

@@ -0,0 +1,16 @@
+require "publishing_platform_schemas/validator"
+
+module PublishingPlatformSchemas
+  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|
+          @validator = PublishingPlatformSchemas::Validator.new(schema_name, schema_type, item)
+          @validator.valid?
+        end
+
+        failure_message { @validator.error_message }
+      end
+    end
+  end
+end

data/lib/publishing_platform_schemas/validator.rb

@@ -0,0 +1,53 @@
+require "json-schema"
+
+module PublishingPlatformSchemas
+  class Validator
+    attr_reader :schema_name, :type
+    attr_accessor :payload
+
+    def initialize(schema_name, type, payload)
+      @schema_name = schema_name
+      @type = type
+      @payload = ensure_json(payload)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def error_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("#{type}_schema": schema_name)
+      validator = JSON::Validator.fully_validate(schema, payload)
+      validator.map { |message| "- #{humanized_error(message)}" }.join("\n")
+    end
+
+    def formatted_payload
+      JSON.pretty_generate(JSON.parse(payload))
+    end
+
+    def humanized_error(message)
+      message.gsub("The property '#/'", "The item")
+             .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/publishing_platform_schemas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformSchemas
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/publishing_platform_schemas.rb

@@ -2,6 +2,7 @@
 
 require_relative "publishing_platform_schemas/version"
 require_relative "publishing_platform_schemas/schema"
+require_relative "publishing_platform_schemas/example"
 
 module PublishingPlatformSchemas
   def self.content_schema_dir=(path_to_schemas)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_schemas
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -73,7 +72,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem to work with the Publishing Platform content schemas
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -91,14 +89,15 @@ files:
 - bin/console
 - bin/setup
 - lib/publishing_platform_schemas.rb
+- lib/publishing_platform_schemas/example.rb
+- lib/publishing_platform_schemas/rspec_matchers.rb
 - lib/publishing_platform_schemas/schema.rb
+- lib/publishing_platform_schemas/validator.rb
 - lib/publishing_platform_schemas/version.rb
 - publishing_platform_schemas.gemspec
-homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Gem to work with the Publishing Platform content schemas
 test_files: []