publishing_platform_schemas 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88231446d780966954fa7df80621e314cb2d885e187402b7d68e8ee2d10513e2
-  data.tar.gz: 33fd84d51fab3235f9f5089153939493a7c4a66eca9553a8288e77e55bd3cd74
+  metadata.gz: 0b9908506b494629e6db1c0e9f7913926bb57d7e7bba972b9cca8f688ee48a3f
+  data.tar.gz: ae8b12485e1e19ad35971943ca96b50b4703b43d6e16aebcfbb904fa2ab670f9
 SHA512:
-  metadata.gz: 2d0f1ebc0dc699816e80c3fadf1a88678f5f44b9c0963b8e2c3e797adb908bc1f3f9a5a96ea4a6982cbe5bb2ff83daf8c3b9c57f56ea1ace47f1f51fd172b74f
-  data.tar.gz: 6671a6f2e8996641695e7b48b76f658180e9945986e81a90ed32c6f92e0352a0e25ac26daac258e1edb7136b51023a5e48e99010d7b930265275db653191718c
+  metadata.gz: 12f1ac7e89d3353f4f83a1f95629022c19328ac7d8942dd95914d7447ef3b2832b1ec89351f12e05300a1bd70698c4b823de8b9c69775957ba58b2c7c6fb9ab4
+  data.tar.gz: c8da8abc17516ec011c1fa469080b6955513b1b0cc36bbba3a28ac16cbbe40c09851b7573b7e1fa234913869c17960d0972c107887f29de6959113ba12c8c6c6

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:  
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.2, 3.3]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Clone content-schemas
+        uses: actions/checkout@v4
+        with:
+          repository: publishing-platform/publishing-api
+          ref: main
+          path: tmp/publishing-api 
+          token: ${{ secrets.PUBLISHING_PLATFORM_CI_GITHUB_API_TOKEN }}     
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+        env:
+          PUBLISHING_PLATFORM_CONTENT_SCHEMAS_PATH: tmp/publishing-api/content_schemas      
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: publishing-platform/publishing-platform-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.PUBLISHING_PLATFORM_RUBYGEMS_API_KEY }}      

data/.ruby-version

@@ -0,0 +1 @@
+3.2.4

data/Rakefile

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

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.0"
+  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)

data/publishing_platform_schemas.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Gem to work with the Publishing Platform content schemas"
   spec.description = "Gem to work with the Publishing Platform content schemas"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir = "exe"
@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
   # This should be kept in sync with the json-schema version of publishing-api.
   spec.add_dependency "json-schema", ">= 2.8", "< 4.4"
 
+  spec.add_development_dependency "climate_control"
   spec.add_development_dependency "publishing_platform_rubocop"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_schemas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -30,6 +29,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: publishing_platform_rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -44,16 +57,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem to work with the Publishing Platform content schemas
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -61,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
@@ -76,15 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Gem to work with the Publishing Platform content schemas
 test_files: []

data/.github/workflows/main.yml

@@ -1,27 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - master
-
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        ruby:
-          - '3.1.2'
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake