Contents

module PublishingPlatformSchemas
  class Schema
    # Find a schema by name
    #
    # @param schema [Hash] Type => Name of the schema/format:
    # @example
    #
    #   PublishingPlatformSchemas::Schema.find(links_schema: "detailed_guide")
    #   PublishingPlatformSchemas::Schema.find(frontend_schema: "detailed_guide")
    #   PublishingPlatformSchemas::Schema.find(publisher_schema: "detailed_guide")
    #   PublishingPlatformSchemas::Schema.find(notification_schema: "detailed_guide")
    # @return [Hash] the JSON schema as a hash
    def self.find(schema)
      file_path = "#{PublishingPlatformSchemas.content_schema_dir}/dist/formats/#{location_for_schema_name(schema)}"
      JSON.parse(File.read(file_path))
    end

    # Return all schemas in a hash, keyed by schema name
    #
    # @param schema_type [String] The type: frontend, publisher, notification or links
    # @return [Array<Hash>] List of JSON schemas as hashes
    def self.all(schema_type: "*")
      schema_type = "publisher" if schema_type == "publisher"
      Dir.glob("#{PublishingPlatformSchemas.content_schema_dir}/dist/formats/*/#{schema_type}/*.json").each_with_object({}) do |file_path, hash|
        hash[file_path] = JSON.parse(File.read(file_path))
      end
    end

    # Return all schema names
    #
    # @return [Array] all the schema names
    def self.schema_names
      Dir.glob("#{PublishingPlatformSchemas.content_schema_dir}/dist/formats/*").map do |directory|
        File.basename(directory)
      end
    end

    # @private
    def self.location_for_schema_name(schema)
      type, schema_name = schema.to_a.flatten
      {
        links_schema: "#{schema_name}/publisher/links.json",
        frontend_schema: "#{schema_name}/frontend/schema.json",
        publisher_schema: "#{schema_name}/publisher/schema.json",
      }[type]
    end

    private_class_method :location_for_schema_name
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
publishing_platform_schemas-0.1.1	lib/publishing_platform_schemas/schema.rb
publishing_platform_schemas-0.1.0	lib/publishing_platform_schemas/schema.rb