CycloneDX/Component/Pedigree.pm

filter: Statementstmt 64.1% 34 / 53 Branchbran 0.0% 0 / 12 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 60.0% 9 / 15 Podpod 100% 1 / 1 totaltotal 54.3% 44 / 81 CC 7 SCAR 29.7
CC
7
Cov
52%
TO_JSON
56.0
__ANON__
2.0
__ANON__
2.0
CRAP 19.6
« CycloneDX/CryptoProperties/ProtocolProperties.pm ↑ Summary CycloneDX/Vulnerability/Analysis.pm »
1 package SBOM::CycloneDX::Component::Pedigree;
2  
3 1 ▶use 5.010001;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use utf8;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 1 ▶use SBOM::CycloneDX::List;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 1 ▶use Types::Standard qw(InstanceOf Str);
Subroutine BEGIN: called CC=1 SCAR=0.0
11 1 ▶use Types::TypeTiny qw(ArrayLike);
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 1 ▶use Moo;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 1 ▶use namespace::autoclean;
Subroutine BEGIN: called CC=1 SCAR=0.0
15  
16 1 extends 'SBOM::CycloneDX::Base';
17  
18 has ancestors => (
19 is => 'rw',
20 isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Component']],
21 0 ▶ default => sub { SBOM::CycloneDX::List->new }
Subroutine __ANON__: not called CC=1 SCAR=6.9
22 1 );
23  
24 has descendants => (
25 is => 'rw',
26 isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Component']],
27 0 ▶ default => sub { SBOM::CycloneDX::List->new }
Subroutine __ANON__: not called CC=1 SCAR=6.9
28 1 );
29  
30 has variants => (
31 is => 'rw',
32 isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Component']],
33 0 ▶ default => sub { SBOM::CycloneDX::List->new }
Subroutine __ANON__: not called CC=1 SCAR=6.9
34 1 );
35  
36 has commits => (
37 is => 'rw',
38 isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Component::Commit']],
39 0 ▶ default => sub { SBOM::CycloneDX::List->new }
Subroutine __ANON__: not called CC=1 SCAR=6.9
40 1 );
41  
42 has patches => (
43 is => 'rw',
44 isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Component::Patch']],
45 0 ▶ default => sub { SBOM::CycloneDX::List->new }
Subroutine __ANON__: not called CC=1 SCAR=6.9
46 1 );
47  
48 1 has notes => (is => 'rw', isa => Str);
49  
50 0 ▶sub TO_JSON {
Subroutine TO_JSON: not called CC=7 SCAR=40.3
Pod documented
51  
52 0 my $self = shift;
53  
54 0 my $json = {};
55  
56 0 ▶ $json->{ancestors} = $self->ancestors if @{$self->ancestors};
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->ancestors;} 0 0 0
57 0 ▶ $json->{descendants} = $self->descendants if @{$self->descendants};
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->descendants;} 0 0 0
58 0 ▶ $json->{variants} = $self->variants if @{$self->variants};
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->variants;} 0 0 0
59 0 ▶ $json->{commits} = $self->commits if @{$self->commits};
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->commits;} 0 0 0
60 0 ▶ $json->{patches} = $self->patches if @{$self->patches};
Branch: 1 branch
BranchTrueFalseTotal
if @{$self->patches;} 0 0 0
61 0 ▶ $json->{notes} = $self->notes if $self->notes;
Branch: 1 branch
BranchTrueFalseTotal
if $self->notes 0 0 0
62  
63 0 return $json;
64  
65 }
66  
67 1 1;
68  
69 =encoding utf-8
70  
71 =head1 NAME
72  
73 SBOM::CycloneDX::Component::Pedigree - Component Pedigree
74  
75 =head1 SYNOPSIS
76  
77 SBOM::CycloneDX::Component::Pedigree->new();
78  
79  
80 =head1 DESCRIPTION
81  
82 Component pedigree is a way to document complex supply chain scenarios where
83 components are created, distributed, modified, redistributed, combined with
84 other components, etc.
85 Pedigree supports viewing this complex chain from the beginning, the end,
86 or anywhere in the middle. It also provides a way to document variants
87 where the exact relation may not be known.
88  
89 =head2 METHODS
90  
91 L<SBOM::CycloneDX::Component::Pedigree> inherits all methods from L<SBOM::CycloneDX::Base>
92 and implements the following new ones.
93  
94 =over
95  
96 =item SBOM::CycloneDX::Component::Pedigree->new( %PARAMS )
97  
98 Properties:
99  
100 =over
101  
102 =item * C<ancestors>, Describes zero or more components in which a component
103 is derived from. This is commonly used to describe forks from existing
104 projects where the forked version contains a ancestor node containing the
105 original component it was forked from. For example, Component A is the
106 original component. Component B is the component being used and documented
107 in the BOM. However, Component B contains a pedigree node with a single
108 ancestor documenting Component A - the original component from which
109 Component B is derived from.
110  
111 =item * C<commits>, A list of zero or more commits which provide a trail
112 describing how the component deviates from an ancestor, descendant, or
113 variant.
114  
115 =item * C<descendants>, Descendants are the exact opposite of ancestors. This
116 provides a way to document all forks (and their forks) of an original or
117 root component.
118  
119 =item * C<notes>, Notes, observations, and other non-structured commentary
120 describing the components pedigree.
121  
122 =item * C<patches>, A list of zero or more patches describing how the
123 component deviates from an ancestor, descendant, or variant. Patches may be
124 complementary to commits or may be used in place of commits.
125  
126 =item * C<variants>, Variants describe relations where the relationship
127 between the components is not known. For example, if Component A contains
128 nearly identical code to Component B. They are both related, but it is
129 unclear if one is derived from the other, or if they share a common
130 ancestor.
131  
132 =back
133  
134 =item $pedigree->ancestors
135  
136 =item $pedigree->commits
137  
138 =item $pedigree->descendants
139  
140 =item $pedigree->notes
141  
142 =item $pedigree->patches
143  
144 =item $pedigree->variants
145  
146 =back
147  
148  
149 =head1 SUPPORT
150  
151 =head2 Bugs / Feature Requests
152  
153 Please report any bugs or feature requests through the issue tracker
154 at L<https://github.com/giterlizzi/perl-SBOM-CycloneDX/issues>.
155 You will be notified automatically of any progress on your issue.
156  
157 =head2 Source Code
158  
159 This is open source software. The code repository is available for
160 public review and contribution under the terms of the license.
161  
162 L<https://github.com/giterlizzi/perl-SBOM-CycloneDX>
163  
164 git clone https://github.com/giterlizzi/perl-SBOM-CycloneDX.git
165  
166  
167 =head1 AUTHOR
168  
169 =over 4
170  
171 =item * Giuseppe Di Terlizzi <gdt@cpan.org>
172  
173 =back
174  
175  
176 =head1 LICENSE AND COPYRIGHT
177  
178 This software is copyright (c) 2025-2026 by Giuseppe Di Terlizzi.
179  
180 This is free software; you can redistribute it and/or modify it under
181 the same terms as the Perl 5 programming language system itself.
182  
183 =cut
« CycloneDX/CryptoProperties/ProtocolProperties.pm ↑ Summary CycloneDX/Vulnerability/Analysis.pm »