File Coverage

blib/lib/SBOM/CycloneDX/ReleaseNotes.pm

Criterion	Covered	Total	%
statement	29	47	61.7
branch	0	20	0.0
condition			n/a
subroutine	10	11	90.9
pod	1	1	100.0
total	40	79	50.6

line	stmt	bran	sub	pod	time	code
1						package SBOM::CycloneDX::ReleaseNotes;
2
3	1		1		2714	use 5.010001;
	1				4
4	1		1		4	use strict;
	1				2
	1				19
5	1		1		3	use warnings;
	1				2
	1				61
6	1		1		5	use utf8;
	1				3
	1				9
7
8	1		1		79	use SBOM::CycloneDX::List;
	1				3
	1				37
9	1		1		7	use SBOM::CycloneDX::Timestamp;
	1				3
	1				55
10
11	1		1		8	use Types::Standard qw(Str InstanceOf);
	1				2
	1				13
12	1		1		2802	use Types::TypeTiny qw(ArrayLike);
	1				3
	1				8
13
14	1		1		406	use Moo;
	1				2
	1				11
15	1		1		475	use namespace::autoclean;
	1				1
	1				15
16
17						extends 'SBOM::CycloneDX::Base';
18
19						has type => (is => 'rw', isa => Str, required => 1);
20						has title => (is => 'rw', isa => Str);
21						has featured_image => (is => 'rw', isa => Str); # URL
22						has social_image => (is => 'rw', isa => Str);
23						has description => (is => 'rw', isa => Str);
24
25						has timestamp => (
26						is => 'rw',
27						isa => InstanceOf ['SBOM::CycloneDX::Timestamp'],
28						coerce => sub { ref($_[0]) ? $_[0] : SBOM::CycloneDX::Timestamp->new($_[0]) }
29						);
30
31						has aliases => (is => 'rw', isa => ArrayLike [Str], default => sub { SBOM::CycloneDX::List->new });
32						has tags => (is => 'rw', isa => ArrayLike [Str], default => sub { SBOM::CycloneDX::List->new });
33
34						has resolves => (
35						is => 'rw',
36						isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Issue']],
37						default => sub { SBOM::CycloneDX::List->new }
38						);
39
40						has notes => (
41						is => 'rw',
42						isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Note']],
43						default => sub { SBOM::CycloneDX::List->new }
44						);
45
46						has properties => (
47						is => 'rw',
48						isa => ArrayLike [InstanceOf ['SBOM::CycloneDX::Property']],
49						default => sub { SBOM::CycloneDX::List->new }
50						);
51
52						sub TO_JSON {
53
54	0		0	1		my $self = shift;
55
56	0					my $json = {type => $self->type};
57
58	0	0				$json->{title} = $self->title if $self->title;
59	0	0				$json->{featuredImage} = $self->featured_image if $self->featured_image;
60	0	0				$json->{socialImage} = $self->social_image if $self->social_image;
61	0	0				$json->{description} = $self->description if $self->description;
62	0	0				$json->{timestamp} = $self->timestamp if $self->timestamp;
63	0	0				$json->{aliases} = $self->aliases if @{$self->aliases};
	0
64	0	0				$json->{tags} = $self->tags if @{$self->tags};
	0
65	0	0				$json->{resolves} = $self->resolves if @{$self->resolves};
	0
66	0	0				$json->{notes} = $self->notes if @{$self->notes};
	0
67	0	0				$json->{properties} = $self->properties if @{$self->properties};
	0
68
69	0					return $json;
70
71						}
72
73						1;
74
75						=encoding utf-8
76
77						=head1 NAME
78
79						SBOM::CycloneDX::ReleaseNotes - Specifies release notes
80
81						=head1 SYNOPSIS
82
83						$release_notes = SBOM::CycloneDX::ReleaseNotes->new(
84						type => 'major'
85						);
86
87
88						=head1 DESCRIPTION
89
90						L provides the release notes.
91
92						=head2 METHODS
93
94						L inherits all methods from L
95						and implements the following new ones.
96
97						=over
98
99						=item SBOM::CycloneDX::ReleaseNotes->new( %PARAMS )
100
101						Properties:
102
103						=over
104
105						=item * C, The software versioning type the release note describes.
106
107						=item * C, The title of the release. </td> </tr> <tr> <td class="h" > <a name="108">108</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="109">109</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<featured_image>, The URL to an image that may be prominently displayed </td> </tr> <tr> <td class="h" > <a name="110">110</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> with the release note. </td> </tr> <tr> <td class="h" > <a name="111">111</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="112">112</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<social_image>, The URL to an image that may be used in messaging on </td> </tr> <tr> <td class="h" > <a name="113">113</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> social media platforms. </td> </tr> <tr> <td class="h" > <a name="114">114</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="115">115</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<description>, A short description of the release. </td> </tr> <tr> <td class="h" > <a name="116">116</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="117">117</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<timestamp>, The date and time (timestamp) when the release note was </td> </tr> <tr> <td class="h" > <a name="118">118</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> created. </td> </tr> <tr> <td class="h" > <a name="119">119</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="120">120</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<aliases>, One or more alternate names the release may be referred to. </td> </tr> <tr> <td class="h" > <a name="121">121</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> This may include unofficial terms used by development and marketing teams (e.g. </td> </tr> <tr> <td class="h" > <a name="122">122</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> code names). </td> </tr> <tr> <td class="h" > <a name="123">123</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="124">124</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<tags>, Textual strings that aid in discovery, search, and retrieval of </td> </tr> <tr> <td class="h" > <a name="125">125</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> the associated object. Tags often serve as a way to group or categorize similar </td> </tr> <tr> <td class="h" > <a name="126">126</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> or related objects by various attributes. </td> </tr> <tr> <td class="h" > <a name="127">127</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="128">128</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<resolves>, A collection of issues that have been resolved. </td> </tr> <tr> <td class="h" > <a name="129">129</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> See L<SBOM::CycloneDX::Issue> </td> </tr> <tr> <td class="h" > <a name="130">130</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="131">131</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<notes>, Zero or more release notes containing the locale and content. </td> </tr> <tr> <td class="h" > <a name="132">132</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Multiple note objects may be specified to support release notes in a wide variety </td> </tr> <tr> <td class="h" > <a name="133">133</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> of languages. See L<SBOM::CycloneDX::Note> </td> </tr> <tr> <td class="h" > <a name="134">134</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="135">135</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * C<properties>, Provides the ability to document properties in a name-value </td> </tr> <tr> <td class="h" > <a name="136">136</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> store. This provides flexibility to include data not officially supported in the </td> </tr> <tr> <td class="h" > <a name="137">137</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> standard without having to use additional namespaces or create extensions. </td> </tr> <tr> <td class="h" > <a name="138">138</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Unlike key-value stores, properties support duplicate names, each potentially </td> </tr> <tr> <td class="h" > <a name="139">139</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> having different values. Property names of interest to the general public are </td> </tr> <tr> <td class="h" > <a name="140">140</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> encouraged to be registered in the CycloneDX Property Taxonomy. Formal </td> </tr> <tr> <td class="h" > <a name="141">141</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> registration is optional. See L<SBOM::CycloneDX::Property> </td> </tr> <tr> <td class="h" > <a name="142">142</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="143">143</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back </td> </tr> <tr> <td class="h" > <a name="144">144</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="145">145</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->type </td> </tr> <tr> <td class="h" > <a name="146">146</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="147">147</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->title </td> </tr> <tr> <td class="h" > <a name="148">148</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="149">149</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->featured_image </td> </tr> <tr> <td class="h" > <a name="150">150</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="151">151</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->social_image </td> </tr> <tr> <td class="h" > <a name="152">152</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="153">153</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->description </td> </tr> <tr> <td class="h" > <a name="154">154</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="155">155</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->timestamp </td> </tr> <tr> <td class="h" > <a name="156">156</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="157">157</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->aliases </td> </tr> <tr> <td class="h" > <a name="158">158</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="159">159</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->tags </td> </tr> <tr> <td class="h" > <a name="160">160</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="161">161</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->resolves </td> </tr> <tr> <td class="h" > <a name="162">162</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="163">163</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->notes </td> </tr> <tr> <td class="h" > <a name="164">164</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="165">165</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $release_notes->properties </td> </tr> <tr> <td class="h" > <a name="166">166</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="167">167</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="168">168</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back </td> </tr> <tr> <td class="h" > <a name="169">169</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="170">170</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 SUPPORT </td> </tr> <tr> <td class="h" > <a name="171">171</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="172">172</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head2 Bugs / Feature Requests </td> </tr> <tr> <td class="h" > <a name="173">173</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="174">174</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Please report any bugs or feature requests through the issue tracker </td> </tr> <tr> <td class="h" > <a name="175">175</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> at L<https://github.com/giterlizzi/perl-SBOM-CycloneDX/issues>. </td> </tr> <tr> <td class="h" > <a name="176">176</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> You will be notified automatically of any progress on your issue. </td> </tr> <tr> <td class="h" > <a name="177">177</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="178">178</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head2 Source Code </td> </tr> <tr> <td class="h" > <a name="179">179</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="180">180</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> This is open source software. The code repository is available for </td> </tr> <tr> <td class="h" > <a name="181">181</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> public review and contribution under the terms of the license. </td> </tr> <tr> <td class="h" > <a name="182">182</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="183">183</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> L<https://github.com/giterlizzi/perl-SBOM-CycloneDX> </td> </tr> <tr> <td class="h" > <a name="184">184</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="185">185</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> git clone https://github.com/giterlizzi/perl-SBOM-CycloneDX.git </td> </tr> <tr> <td class="h" > <a name="186">186</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="187">187</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="188">188</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 AUTHOR </td> </tr> <tr> <td class="h" > <a name="189">189</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="190">190</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =over 4 </td> </tr> <tr> <td class="h" > <a name="191">191</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="192">192</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item * Giuseppe Di Terlizzi <gdt@cpan.org> </td> </tr> <tr> <td class="h" > <a name="193">193</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="194">194</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back </td> </tr> <tr> <td class="h" > <a name="195">195</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="196">196</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="197">197</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 LICENSE AND COPYRIGHT </td> </tr> <tr> <td class="h" > <a name="198">198</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="199">199</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> This software is copyright (c) 2025-2026 by Giuseppe Di Terlizzi. </td> </tr> <tr> <td class="h" > <a name="200">200</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="201">201</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> This is free software; you can redistribute it and/or modify it under </td> </tr> <tr> <td class="h" > <a name="202">202</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> the same terms as the Perl 5 programming language system itself. </td> </tr> <tr> <td class="h" > <a name="203">203</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="204">204</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =cut </td> </tr> </table> </body> </html>