NAME
SBOM::Raku - Raku specific SBOM functionality
SYNOPSIS
use SBOM::Raku;
say sbom("META6.json").JSON;
# {
# "bomFormat": "CycloneDX",
# "specVersion": "1.6",
# "version": 1,
# "metadata": {
# "timestamp": "2025-07-22T18:39:29.458604+02:00",
# ...
DESCRIPTION
The SBOM::Raku distribution provides logic for the creation and maintenance of SBOM (Software Bill Of Materials) files in the Raku Programming Language context.
SELECTIVE IMPORTING
use SBOM::Raku <component>; # only import "component"
By default all utility functions are exported. But you can limit this to the functions you actually need by specifying the names in the use statement.
To prevent name collisions and/or import any subroutine with a more memorable name, one can use the "original-name:known-as" syntax. A semi-colon in a specified string indicates the name by which the subroutine is known in this distribution, followed by the name with which it will be known in the lexical context in which the use command is executed.
use String::Utils <component:comp>; # import "component" as "comp"
say comp |%args;
Apart from the subroutines provided by the SBOM::Raku distribution, it also possible to import the following subroutines from other packages, but which are used internally by SBOM::Raku:
SUBROUTINES
authors
dd authors(from-json "META6.json".IO.slurp);
# (SBOM::Contact.new(|Map.new((:name("Jane Doe")))),)
The authors subroutine returns a List with SBOM::Contact objects for the authors of the JSON hash from a META6.json file.
component
say component("META6.json").JSON;
# {
# "type": "library",
# "mime-type": "text/plain",
# ...
my %meta-json = ...;
my $component = component(%meta-json);
The component subroutine returns a SBOM::Component for the given arguments.
The arguments can be either an IO::Path object (or a string that can be coerced to an IO::Path) to a file that contains Raku module meta information (usually called META6.json). Or a hash with arguments (in the META6.json format) to build an SBOM::Component object with.
component-hash
my %args := component-hash("META6.json");
# ... perform tweaks
my $component = SBOM::Component.new(|%args);
The component-hash subroutine returns a hash in the format needed to create an SBOM::Component object with, from a META6.json file (or a hash of that representation).
It's main intended use is to be able to tweak the arguments prior to making an SBOM::Component object.
licenses
dd licenses(from-json "META6.json".IO.slurp);
# (SBOM::License.new(|Map.new((:license(Map.new((:id("Artistic-2.0"))))))),)
The licenses subroutine returns a List with SBOM::License objects for the license(s) of the JSON hash from a META6.json file.
say metadata("META6.json").JSON;
# {
# "timestamp": "2025-07-22T18:52:04.686316+02:00",
# "lifecycles": [
# {
# "phase": "build"
# ...
my %meta-json = ...;
my $metadata = metadata(%meta-json);
The metadata subroutine returns a SBOM::Metadata for the given arguments.
The arguments can be either an IO::Path object (or a string that can be coerced to an IO::Path) to a file that contains Raku module meta information (usually called META6.json). Or a hash with arguments (in the META6.json format) to build an SBOM::Metadata object with.
my %args := metadata-hash("META6.json");
# ... perform tweaks
my $metadata = SBOM::Metadata.new(|%args);
The metadata-hash subroutine returns a hash in the format needed to create an SBOM::Metadata object with, from a META6.json file (or a hash of that representation).
It's main intended use is to be able to tweak the arguments prior to making an SBOM::Metadata object.
sbom
say sbom("META6.json").JSON;
# {
# "bomFormat": "CycloneDX",
# "specVersion": "1.6",
# "version": 1,
# "metadata": {
# "timestamp": "2025-07-22T18:53:59.841267+02:00",
# ...
my %meta-json = ...;
my $sbom = sbom(%meta-json);
The sbom subroutine returns a SBOM::CycloneDX for the given arguments.
The arguments can be either an IO::Path object (or a string that can be coerced to an IO::Path) to a file that contains Raku module meta information (usually called META6.json). Or a hash with arguments (in the META6.json format) to build an SBOM::CycloneDX object with.
sbom-hash
my %args := sbom-hash("META6.json");
# ... perform tweaks
my $sbom = SBOM::CycloneDX.new(|%args);
The sbom-hash subroutine returns a hash in the format needed to create an SBOM::CycloneDX object with, from a META6.json file (or a hash of that representation).
It's main intended use is to be able to tweak the arguments prior to making an SBOM::CycloneDX object.
AUTHOR
Elizabeth Mattijsen liz@raku.rocks
COPYRIGHT AND LICENSE
Copyright 2025 Elizabeth Mattijsen
This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.