sbSchemaParser::sbSchemaParser.pl Perl Code Documentation

The sbSchemaParser.pl Perl script parses YAML schema definitions written in JSON Schema which use the standard GA4GH SchemaBlocks {S}[B] structure, into

The output files are generated relative to the script path. This assumes a directory structure, in which the different repositories are contained in the same root (i.e. organization) directory, and the script itself is inside a first order directory in one of the repositories. The specific names of all of the directories can be modified in config.yaml:

this-organization
  |
  |-- tools
  |     |
  |     |-- sbSchemaParser
  |     |     |
  |           |-- sbSchemaParser.pl # this file
  |           |-- config.yaml       # in- and output path definitions
  |
  |-- sb-external-schemas-name      # example for (1 or 1+) schema repositories
  |     |
  |     |-- source
  |     |     |
  |     |     |-- v1.0.1            # versioned representation of the donor code
  |     |
  |     |-- schemas
  |     |     |
  |     |     |-- Schema.yaml
  |     |     |-- OtherSchema.yaml
  |     |     |-- ...
  |     |
  |     |-- working
  |     |     |-- SomethingNew.yaml     
  |     |     |-- ...
  |     |     
  |     |-- generated               # config.yaml -> "out_dirnames"
  |           |
  |           |-- doc
  |           |     |-- Schema.md
  |           |     |-- OtherSchema.md
  |           |     |-- ...
  |           |
  |           |-- json
  |           |     |    
  |           |     |-- current
  |           |     |     |-- Schema.json
  |           |     |     |-- ...
  |           |     |    
  |           |     |-- v0.0.1
  |           |     |     |-- Schema.json
  |           |     |     |-- ...
  |           |     |    
  |           |     |-- v... 
  |           |
  |           |-- examples
  |   
  |-- (webdocs.repo)                # web repository (Jekyll based)
        |
        |-- (webdocs.jekylldir)
        |     |
        |     |-- Schema.md
        |     |-- ...
        |
        |-- (webdocs.schemadir)
              |
              |     |-- Schema.json
              |     |-- ...
              |    
              |-- v0.0.1
              |     |-- Schema.json
              |     |-- ...
              |    
              |-- v...

Usage

The sbSchemaParser.pl script has to be run in a local version of the repository structure. In principle, any relative directory locations should be possible if specified in the config.yaml defaults file, though a reasonable approach is to use a “organization -> projects” structure as above.

The script is executed with

perl sbSchemaParser.pl

The only current option is to provide a “-filter” argument against the schema file names; e.g. perl sbSchemaParser.pl -filter Age will only process schemas with “Age” in their file name.

Processing Schema Source Directories

The script parses through the associated source repositories which are required to reside inside a unified root (git_root_dir). The names of the (one or several) repositories and their schema file source directories (one or several per repository) are specified in the config.yaml file.

The class name is derived from the file’s “$id” value, assuming a canonical path structure with the class name post-pended with a version:

"$id": https://schemablocks.org/schemas/sb-phenopackets/Phenopacket/v0.0.1

Processing is skipped if the class name does contain other than word / dot / dash characters, or if a filter had been provided and the class name does not match.

The documentation is extracted from the YAML schema file and formatted into markdown content, producing

A rudimentary CURIE to URL expansion is performed for prefixes defined in the configuration file. An example would be the linking of an ORCID id to its web address.

Paths for output files are created based on the values (e.g. out_dirnames provided in the configuration file.

The web files for the Jekyll / GH-pages processing receive a prefix, to ensure that auto-generated and normal pages can co-exist. The permalink parameter provided in the YAML header of the Jekyll file provides a “nice” and stable name for the generated HTML page (independent of the original file name).

Deparsing of the class “$id”

The class “$id” values are assumed to have a specific structure, where

Example
"$id": https://schemablocks.org/schemas/sb-beacon/BeaconVariant/v1.0.1

The property overview is followed by the listing of the properties, including descriptions and examples.

Jekyll File Header

A version of the Markdown inline documentation is added to the Github (or alternative), Jekyll based website source tree.

The page will only be generated into an HTML page if it contains a specific header written in YAML.

The _create_jekyll_header function will pre-pend such a header to the Markdown page, including some file specific parameters such as the permalink address of the page.

Hacking the “$ref is a solitary attribute” problem

In the current JSON Schema specification there is a problem with “$ref”-type attribute types: If a reference is given, additional attributes of the property (examples, description) are being ignored. This isn’t very helpful, since information specific to the property’s instantiation will not be displayed.

This behaviour can be alleviated by wrapping the $ref and other attributes with an allof statement (which is interpolated in the following, to expose the attributes). We’ll hope for a more elegant solution …

Helper _remap_allof

This function remaps the list of property attributes required from using a ‘$ref’ property definition to a standard object, which is then processed for documentation in the usual way.

TODO:

Helper Subroutines

_expand_CURIEs

This function expands prefixes in identifiers, based on the parameters provided in config.yml. This is thought as a helper for some script/website specific linking, not as a general CURIE expansion utility.

2020-01-16