publishing_platform_schemas 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8316073ac789d764c1f29489aea360d74f3b657f58eb501e57994306b38c5fe9
-  data.tar.gz: 0b7aaccb03710ac2d67ab4dbb5960835f614d5aebc2312eac28faa800512c12b
+  metadata.gz: 0b9908506b494629e6db1c0e9f7913926bb57d7e7bba972b9cca8f688ee48a3f
+  data.tar.gz: ae8b12485e1e19ad35971943ca96b50b4703b43d6e16aebcfbb904fa2ab670f9
 SHA512:
-  metadata.gz: e8518793ce8cb1b579474a408cc1c8308f18fc18021769c2eb6364330cc2892a4275b96eb3ff1cdc3c6991fdc8d8a1e0ad1e0f3ead74f3f777e14e270f36f0a1
-  data.tar.gz: 549f68aa69f26c2a66e3b036b15597510ee24804ce021452aa7a96b011e7e5a467e689521d9505005be8fddaf6e0ae6e8f906a8183cafa639fe520ee188f9ecd
+  metadata.gz: 12f1ac7e89d3353f4f83a1f95629022c19328ac7d8942dd95914d7447ef3b2832b1ec89351f12e05300a1bd70698c4b823de8b9c69775957ba58b2c7c6fb9ab4
+  data.tar.gz: c8da8abc17516ec011c1fa469080b6955513b1b0cc36bbba3a28ac16cbbe40c09851b7573b7e1fa234913869c17960d0972c107887f29de6959113ba12c8c6c6

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformSchemas
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 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.1.2
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-29 00:00:00.000000000 Z
+date: 2025-04-03 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,13 @@ files:
 - bin/console
 - bin/setup
 - lib/publishing_platform_schemas.rb
+- lib/publishing_platform_schemas/example.rb
 - lib/publishing_platform_schemas/schema.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 +110,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.6
 specification_version: 4
 summary: Gem to work with the Publishing Platform content schemas
 test_files: []