File Coverage

blib/lib/SBOM/CycloneDX/Enum.pm

Criterion	Covered	Total	%
statement	90	90	100.0
branch	3	4	75.0
condition			n/a
subroutine	30	30	100.0
pod	1	1	100.0
total	124	125	99.2

package SBOM::CycloneDX::Enum;

use 5.010001;
use strict;
use warnings;
use utf8;

require SBOM::CycloneDX::Schema;
require SBOM::CycloneDX::Util;

use SBOM::CycloneDX::Enum::CommonExtensionName;
use SBOM::CycloneDX::Enum::ComponentType;
use SBOM::CycloneDX::Enum::CryptoAssetType;
use SBOM::CycloneDX::Enum::CryptoCertificationLevel;
use SBOM::CycloneDX::Enum::CryptoFunction;
use SBOM::CycloneDX::Enum::CryptoImplementationPlatform;
use SBOM::CycloneDX::Enum::CryptoMode;
use SBOM::CycloneDX::Enum::CryptoPadding;
use SBOM::CycloneDX::Enum::CryptoPrimitive;
use SBOM::CycloneDX::Enum::ExternalReferenceType;
use SBOM::CycloneDX::Enum::HashAlgorithm;
use SBOM::CycloneDX::Enum::ImpactAnalysisJustification;
use SBOM::CycloneDX::Enum::ImpactAnalysisState;
use SBOM::CycloneDX::Enum::LicenseType;
use SBOM::CycloneDX::Enum::LifecyclePhase;
use SBOM::CycloneDX::Enum::PatentAssertionType;
use SBOM::CycloneDX::Enum::PatentLegalStatus;
use SBOM::CycloneDX::Enum::ProtocolType;
use SBOM::CycloneDX::Enum::RelatedCryptoMaterialState;
use SBOM::CycloneDX::Enum::RelatedCryptoMaterialType;
use SBOM::CycloneDX::Enum::TlpClassification;

use Cpanel::JSON::XS qw(decode_json);

use Exporter 'import';

our @EXPORT_OK = qw(
    COMMON_EXTENSION_NAME
    COMPONENT_TYPE
    CRYPTO_ASSET_TYPE
    CRYPTO_CERTIFICATION_LEVEL
    CRYPTO_FUNCTION
    CRYPTO_IMPLEMENTATION_PLATFORM
    CRYPTO_MODE
    CRYPTO_PADDING
    CRYPTO_PRIMITIVE
    EXTERNAL_REFERENCE_TYPE
    HASH_ALGORITHM
    IMPACT_ANALYSIS_JUSTIFICATION
    IMPACT_ANALYSIS_STATE
    LICENSE_TYPE
    LIFECYCLE_PHASE
    PATENT_ASSERTION_TYPE
    PATENT_LEGAL_STATUS
    PROTOCOL_TYPE
    RELATED_CRYPTO_MATERIAL_STATE
    RELATED_CRYPTO_MATERIAL_TYPE
    TLP_CLASSIFICATION
);

state @SPDX_LICENSES;

unless (@SPDX_LICENSES) {
    my $spdx_json_schema_file = SBOM::CycloneDX::Schema::schema_file('spdx.schema.json');
    my $spdx_json_schema      = decode_json(SBOM::CycloneDX::Util::file_read($spdx_json_schema_file));

    @SPDX_LICENSES = @{$spdx_json_schema->{enum}};
}

use constant SPDX_LICENSES => \@SPDX_LICENSES;

use constant {
    COMMON_EXTENSION_NAME          => 'SBOM::CycloneDX::Enum::CommonExtensionName',
    COMPONENT_TYPE                 => 'SBOM::CycloneDX::Enum::ComponentType',
    CRYPTO_ASSET_TYPE              => 'SBOM::CycloneDX::Enum::CryptoAssetType',
    CRYPTO_CERTIFICATION_LEVEL     => 'SBOM::CycloneDX::Enum::CryptoCertificationLevel',
    CRYPTO_FUNCTION                => 'SBOM::CycloneDX::Enum::CryptoFunction',
    CRYPTO_IMPLEMENTATION_PLATFORM => 'SBOM::CycloneDX::Enum::CryptoImplementationPlatform',
    CRYPTO_MODE                    => 'SBOM::CycloneDX::Enum::CryptoMode',
    CRYPTO_PADDING                 => 'SBOM::CycloneDX::Enum::CryptoPadding',
    CRYPTO_PRIMITIVE               => 'SBOM::CycloneDX::Enum::CryptoPrimitive',
    EXTERNAL_REFERENCE_TYPE        => 'SBOM::CycloneDX::Enum::ExternalReferenceType',
    HASH_ALGORITHM                 => 'SBOM::CycloneDX::Enum::HashAlgorithm',
    IMPACT_ANALYSIS_JUSTIFICATION  => 'SBOM::CycloneDX::Enum::ImpactAnalysisJustification',
    IMPACT_ANALYSIS_STATE          => 'SBOM::CycloneDX::Enum::ImpactAnalysisState',
    LICENSE_TYPE                   => 'SBOM::CycloneDX::Enum::LicenseType',
    LIFECYCLE_PHASE                => 'SBOM::CycloneDX::Enum::LifecyclePhase',
    PATENT_ASSERTION_TYPE          => 'SBOM::CycloneDX::Enum::PatentAssertionType',
    PATENT_LEGAL_STATUS            => 'SBOM::CycloneDX::Enum::PatentLegalStatus',
    PROTOCOL_TYPE                  => 'SBOM::CycloneDX::Enum::ProtocolType',
    RELATED_CRYPTO_MATERIAL_STATE  => 'SBOM::CycloneDX::Enum::RelatedCryptoMaterialState',
    RELATED_CRYPTO_MATERIAL_TYPE   => 'SBOM::CycloneDX::Enum::RelatedCryptoMaterialType',
    TLP_CLASSIFICATION             => 'SBOM::CycloneDX::Enum::TlpClassification',
};

sub values {
    my ($class, $enum) = @_;

    if (my $ref = $class->can($enum)) {
        my @values = ($ref->())->values();
        return wantarray ? @values : \@values;
    }
}

1;

=encoding utf-8

=head1 NAME

SBOM::CycloneDX::Enum - Enumeration

=head1 SYNOPSIS

    use SBOM::CycloneDX::Enum qw(COMPONENT_TYPE);

    $bom->component( type => COMPONENT_TYPE->APPLICATION );


    use SBOM::CycloneDX::Enum::ComponentType qw(:all);

    $bom->component( type => APPLICATION );


    use SBOM::CycloneDX::Enum::ComponentType;

    $bom->component( type => SBOM::CycloneDX::Enum::ComponentType->APPLICATION );


    use SBOM::CycloneDX::Enum;

    say $_ for (@{ SBOM::CycloneDX::Enum->SPDX_LICENSES });


    say $_ for (@{ SBOM::CycloneDX::Enum->values('EXTERNAL_REFERENCE_TYPE') });

=head1 DESCRIPTION

L is internal class used by L.


=head1 METHODS

=over

=item SBOM::CycloneDX::Enum->values( $CONSTANT )

Return the provided C Enum values.

=back

=head1 CONSTANTS

=over

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C , L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=item * C, L

=back

=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L.
You will be notified automatically of any progress on your issue.

=head2 Source Code

This is open source software.  The code repository is available for
public review and contribution under the terms of the license.

L

    git clone https://github.com/giterlizzi/perl-SBOM-CycloneDX.git


=head1 AUTHOR

=over 4

=item * Giuseppe Di Terlizzi

=back


=head1 LICENSE AND COPYRIGHT

This software is copyright (c) 2025-2026 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut