1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
|
use 5.006;
use strict;
use warnings;
package CPAN::Meta;
our $VERSION = '2.140640'; # VERSION
# =head1 SYNOPSIS
#
# use v5.10;
# use strict;
# use warnings;
# use CPAN::Meta;
# use Module::Load;
#
# my $meta = CPAN::Meta->load_file('META.json');
#
# printf "testing requirements for %s version %s\n",
# $meta->name,
# $meta->version;
#
# my $prereqs = $meta->effective_prereqs;
#
# for my $phase ( qw/configure runtime build test/ ) {
# say "Requirements for $phase:";
# my $reqs = $prereqs->requirements_for($phase, "requires");
# for my $module ( sort $reqs->required_modules ) {
# my $status;
# if ( eval { load $module unless $module eq 'perl'; 1 } ) {
# my $version = $module eq 'perl' ? $] : $module->VERSION;
# $status = $reqs->accepts_module($module, $version)
# ? "$version ok" : "$version not ok";
# } else {
# $status = "missing"
# };
# say " $module ($status)";
# }
# }
#
# =head1 DESCRIPTION
#
# Software distributions released to the CPAN include a F<META.json> or, for
# older distributions, F<META.yml>, which describes the distribution, its
# contents, and the requirements for building and installing the distribution.
# The data structure stored in the F<META.json> file is described in
# L<CPAN::Meta::Spec>.
#
# CPAN::Meta provides a simple class to represent this distribution metadata (or
# I<distmeta>), along with some helpful methods for interrogating that data.
#
# The documentation below is only for the methods of the CPAN::Meta object. For
# information on the meaning of individual fields, consult the spec.
#
# =cut
use Carp qw(carp croak);
use CPAN::Meta::Feature;
use CPAN::Meta::Prereqs;
use CPAN::Meta::Converter;
use CPAN::Meta::Validator;
use Parse::CPAN::Meta 1.4414 ();
BEGIN { *_dclone = \&CPAN::Meta::Converter::_dclone }
# =head1 STRING DATA
#
# The following methods return a single value, which is the value for the
# corresponding entry in the distmeta structure. Values should be either undef
# or strings.
#
# =for :list
# * abstract
# * description
# * dynamic_config
# * generated_by
# * name
# * release_status
# * version
#
# =cut
BEGIN {
my @STRING_READERS = qw(
abstract
description
dynamic_config
generated_by
name
release_status
version
);
no strict 'refs';
for my $attr (@STRING_READERS) {
*$attr = sub { $_[0]{ $attr } };
}
}
# =head1 LIST DATA
#
# These methods return lists of string values, which might be represented in the
# distmeta structure as arrayrefs or scalars:
#
# =for :list
# * authors
# * keywords
# * licenses
#
# The C<authors> and C<licenses> methods may also be called as C<author> and
# C<license>, respectively, to match the field name in the distmeta structure.
#
# =cut
BEGIN {
my @LIST_READERS = qw(
author
keywords
license
);
no strict 'refs';
for my $attr (@LIST_READERS) {
*$attr = sub {
my $value = $_[0]{ $attr };
croak "$attr must be called in list context"
unless wantarray;
return @{ _dclone($value) } if ref $value;
return $value;
};
}
}
sub authors { $_[0]->author }
sub licenses { $_[0]->license }
# =head1 MAP DATA
#
# These readers return hashrefs of arbitrary unblessed data structures, each
# described more fully in the specification:
#
# =for :list
# * meta_spec
# * resources
# * provides
# * no_index
# * prereqs
# * optional_features
#
# =cut
BEGIN {
my @MAP_READERS = qw(
meta-spec
resources
provides
no_index
prereqs
optional_features
);
no strict 'refs';
for my $attr (@MAP_READERS) {
(my $subname = $attr) =~ s/-/_/;
*$subname = sub {
my $value = $_[0]{ $attr };
return _dclone($value) if $value;
return {};
};
}
}
# =head1 CUSTOM DATA
#
# A list of custom keys are available from the C<custom_keys> method and
# particular keys may be retrieved with the C<custom> method.
#
# say $meta->custom($_) for $meta->custom_keys;
#
# If a custom key refers to a data structure, a deep clone is returned.
#
# =cut
sub custom_keys {
return grep { /^x_/i } keys %{$_[0]};
}
sub custom {
my ($self, $attr) = @_;
my $value = $self->{$attr};
return _dclone($value) if ref $value;
return $value;
}
# =method new
#
# my $meta = CPAN::Meta->new($distmeta_struct, \%options);
#
# Returns a valid CPAN::Meta object or dies if the supplied metadata hash
# reference fails to validate. Older-format metadata will be up-converted to
# version 2 if they validate against the original stated specification.
#
# It takes an optional hashref of options. Valid options include:
#
# =over
#
# =item *
#
# lazy_validation -- if true, new will attempt to convert the given metadata
# to version 2 before attempting to validate it. This means than any
# fixable errors will be handled by CPAN::Meta::Converter before validation.
# (Note that this might result in invalid optional data being silently
# dropped.) The default is false.
#
# =back
#
# =cut
sub _new {
my ($class, $struct, $options) = @_;
my $self;
if ( $options->{lazy_validation} ) {
# try to convert to a valid structure; if succeeds, then return it
my $cmc = CPAN::Meta::Converter->new( $struct );
$self = $cmc->convert( version => 2 ); # valid or dies
return bless $self, $class;
}
else {
# validate original struct
my $cmv = CPAN::Meta::Validator->new( $struct );
unless ( $cmv->is_valid) {
die "Invalid metadata structure. Errors: "
. join(", ", $cmv->errors) . "\n";
}
}
# up-convert older spec versions
my $version = $struct->{'meta-spec'}{version} || '1.0';
if ( $version == 2 ) {
$self = $struct;
}
else {
my $cmc = CPAN::Meta::Converter->new( $struct );
$self = $cmc->convert( version => 2 );
}
return bless $self, $class;
}
sub new {
my ($class, $struct, $options) = @_;
my $self = eval { $class->_new($struct, $options) };
croak($@) if $@;
return $self;
}
# =method create
#
# my $meta = CPAN::Meta->create($distmeta_struct, \%options);
#
# This is same as C<new()>, except that C<generated_by> and C<meta-spec> fields
# will be generated if not provided. This means the metadata structure is
# assumed to otherwise follow the latest L<CPAN::Meta::Spec>.
#
# =cut
sub create {
my ($class, $struct, $options) = @_;
my $version = __PACKAGE__->VERSION || 2;
$struct->{generated_by} ||= __PACKAGE__ . " version $version" ;
$struct->{'meta-spec'}{version} ||= int($version);
my $self = eval { $class->_new($struct, $options) };
croak ($@) if $@;
return $self;
}
# =method load_file
#
# my $meta = CPAN::Meta->load_file($distmeta_file, \%options);
#
# Given a pathname to a file containing metadata, this deserializes the file
# according to its file suffix and constructs a new C<CPAN::Meta> object, just
# like C<new()>. It will die if the deserialized version fails to validate
# against its stated specification version.
#
# It takes the same options as C<new()> but C<lazy_validation> defaults to
# true.
#
# =cut
sub load_file {
my ($class, $file, $options) = @_;
$options->{lazy_validation} = 1 unless exists $options->{lazy_validation};
croak "load_file() requires a valid, readable filename"
unless -r $file;
my $self;
eval {
my $struct = Parse::CPAN::Meta->load_file( $file );
$self = $class->_new($struct, $options);
};
croak($@) if $@;
return $self;
}
# =method load_yaml_string
#
# my $meta = CPAN::Meta->load_yaml_string($yaml, \%options);
#
# This method returns a new CPAN::Meta object using the first document in the
# given YAML string. In other respects it is identical to C<load_file()>.
#
# =cut
sub load_yaml_string {
my ($class, $yaml, $options) = @_;
$options->{lazy_validation} = 1 unless exists $options->{lazy_validation};
my $self;
eval {
my ($struct) = Parse::CPAN::Meta->load_yaml_string( $yaml );
$self = $class->_new($struct, $options);
};
croak($@) if $@;
return $self;
}
# =method load_json_string
#
# my $meta = CPAN::Meta->load_json_string($json, \%options);
#
# This method returns a new CPAN::Meta object using the structure represented by
# the given JSON string. In other respects it is identical to C<load_file()>.
#
# =cut
sub load_json_string {
my ($class, $json, $options) = @_;
$options->{lazy_validation} = 1 unless exists $options->{lazy_validation};
my $self;
eval {
my $struct = Parse::CPAN::Meta->load_json_string( $json );
$self = $class->_new($struct, $options);
};
croak($@) if $@;
return $self;
}
# =method load_string
#
# my $meta = CPAN::Meta->load_string($string, \%options);
#
# If you don't know if a string contains YAML or JSON, this method will use
# L<Parse::CPAN::Meta> to guess. In other respects it is identical to
# C<load_file()>.
#
# =cut
sub load_string {
my ($class, $string, $options) = @_;
$options->{lazy_validation} = 1 unless exists $options->{lazy_validation};
my $self;
eval {
my $struct = Parse::CPAN::Meta->load_string( $string );
$self = $class->_new($struct, $options);
};
croak($@) if $@;
return $self;
}
# =method save
#
# $meta->save($distmeta_file, \%options);
#
# Serializes the object as JSON and writes it to the given file. The only valid
# option is C<version>, which defaults to '2'. On Perl 5.8.1 or later, the file
# is saved with UTF-8 encoding.
#
# For C<version> 2 (or higher), the filename should end in '.json'. L<JSON::PP>
# is the default JSON backend. Using another JSON backend requires L<JSON> 2.5 or
# later and you must set the C<$ENV{PERL_JSON_BACKEND}> to a supported alternate
# backend like L<JSON::XS>.
#
# For C<version> less than 2, the filename should end in '.yml'.
# L<CPAN::Meta::Converter> is used to generate an older metadata structure, which
# is serialized to YAML. CPAN::Meta::YAML is the default YAML backend. You may
# set the C<$ENV{PERL_YAML_BACKEND}> to a supported alternative backend, though
# this is not recommended due to subtle incompatibilities between YAML parsers on
# CPAN.
#
# =cut
sub save {
my ($self, $file, $options) = @_;
my $version = $options->{version} || '2';
my $layer = $] ge '5.008001' ? ':utf8' : '';
if ( $version ge '2' ) {
carp "'$file' should end in '.json'"
unless $file =~ m{\.json$};
}
else {
carp "'$file' should end in '.yml'"
unless $file =~ m{\.yml$};
}
my $data = $self->as_string( $options );
open my $fh, ">$layer", $file
or die "Error opening '$file' for writing: $!\n";
print {$fh} $data;
close $fh
or die "Error closing '$file': $!\n";
return 1;
}
# =method meta_spec_version
#
# This method returns the version part of the C<meta_spec> entry in the distmeta
# structure. It is equivalent to:
#
# $meta->meta_spec->{version};
#
# =cut
sub meta_spec_version {
my ($self) = @_;
return $self->meta_spec->{version};
}
# =method effective_prereqs
#
# my $prereqs = $meta->effective_prereqs;
#
# my $prereqs = $meta->effective_prereqs( \@feature_identifiers );
#
# This method returns a L<CPAN::Meta::Prereqs> object describing all the
# prereqs for the distribution. If an arrayref of feature identifiers is given,
# the prereqs for the identified features are merged together with the
# distribution's core prereqs before the CPAN::Meta::Prereqs object is returned.
#
# =cut
sub effective_prereqs {
my ($self, $features) = @_;
$features ||= [];
my $prereq = CPAN::Meta::Prereqs->new($self->prereqs);
return $prereq unless @$features;
my @other = map {; $self->feature($_)->prereqs } @$features;
return $prereq->with_merged_prereqs(\@other);
}
# =method should_index_file
#
# ... if $meta->should_index_file( $filename );
#
# This method returns true if the given file should be indexed. It decides this
# by checking the C<file> and C<directory> keys in the C<no_index> property of
# the distmeta structure.
#
# C<$filename> should be given in unix format.
#
# =cut
sub should_index_file {
my ($self, $filename) = @_;
for my $no_index_file (@{ $self->no_index->{file} || [] }) {
return if $filename eq $no_index_file;
}
for my $no_index_dir (@{ $self->no_index->{directory} }) {
$no_index_dir =~ s{$}{/} unless $no_index_dir =~ m{/\z};
return if index($filename, $no_index_dir) == 0;
}
return 1;
}
# =method should_index_package
#
# ... if $meta->should_index_package( $package );
#
# This method returns true if the given package should be indexed. It decides
# this by checking the C<package> and C<namespace> keys in the C<no_index>
# property of the distmeta structure.
#
# =cut
sub should_index_package {
my ($self, $package) = @_;
for my $no_index_pkg (@{ $self->no_index->{package} || [] }) {
return if $package eq $no_index_pkg;
}
for my $no_index_ns (@{ $self->no_index->{namespace} }) {
return if index($package, "${no_index_ns}::") == 0;
}
return 1;
}
# =method features
#
# my @feature_objects = $meta->features;
#
# This method returns a list of L<CPAN::Meta::Feature> objects, one for each
# optional feature described by the distribution's metadata.
#
# =cut
sub features {
my ($self) = @_;
my $opt_f = $self->optional_features;
my @features = map {; CPAN::Meta::Feature->new($_ => $opt_f->{ $_ }) }
keys %$opt_f;
return @features;
}
# =method feature
#
# my $feature_object = $meta->feature( $identifier );
#
# This method returns a L<CPAN::Meta::Feature> object for the optional feature
# with the given identifier. If no feature with that identifier exists, an
# exception will be raised.
#
# =cut
sub feature {
my ($self, $ident) = @_;
croak "no feature named $ident"
unless my $f = $self->optional_features->{ $ident };
return CPAN::Meta::Feature->new($ident, $f);
}
# =method as_struct
#
# my $copy = $meta->as_struct( \%options );
#
# This method returns a deep copy of the object's metadata as an unblessed hash
# reference. It takes an optional hashref of options. If the hashref contains
# a C<version> argument, the copied metadata will be converted to the version
# of the specification and returned. For example:
#
# my $old_spec = $meta->as_struct( {version => "1.4"} );
#
# =cut
sub as_struct {
my ($self, $options) = @_;
my $struct = _dclone($self);
if ( $options->{version} ) {
my $cmc = CPAN::Meta::Converter->new( $struct );
$struct = $cmc->convert( version => $options->{version} );
}
return $struct;
}
# =method as_string
#
# my $string = $meta->as_string( \%options );
#
# This method returns a serialized copy of the object's metadata as a character
# string. (The strings are B<not> UTF-8 encoded.) It takes an optional hashref
# of options. If the hashref contains a C<version> argument, the copied metadata
# will be converted to the version of the specification and returned. For
# example:
#
# my $string = $meta->as_string( {version => "1.4"} );
#
# For C<version> greater than or equal to 2, the string will be serialized as
# JSON. For C<version> less than 2, the string will be serialized as YAML. In
# both cases, the same rules are followed as in the C<save()> method for choosing
# a serialization backend.
#
# =cut
sub as_string {
my ($self, $options) = @_;
my $version = $options->{version} || '2';
my $struct;
if ( $self->meta_spec_version ne $version ) {
my $cmc = CPAN::Meta::Converter->new( $self->as_struct );
$struct = $cmc->convert( version => $version );
}
else {
$struct = $self->as_struct;
}
my ($data, $backend);
if ( $version ge '2' ) {
$backend = Parse::CPAN::Meta->json_backend();
$data = $backend->new->pretty->canonical->encode($struct);
}
else {
$backend = Parse::CPAN::Meta->yaml_backend();
$data = eval { no strict 'refs'; &{"$backend\::Dump"}($struct) };
if ( $@ ) {
croak $backend->can('errstr') ? $backend->errstr : $@
}
}
return $data;
}
# Used by JSON::PP, etc. for "convert_blessed"
sub TO_JSON {
return { %{ $_[0] } };
}
1;
# ABSTRACT: the distribution metadata for a CPAN dist
__END__
=pod
=encoding UTF-8
=head1 NAME
CPAN::Meta - the distribution metadata for a CPAN dist
=head1 VERSION
version 2.140640
=head1 SYNOPSIS
use v5.10;
use strict;
use warnings;
use CPAN::Meta;
use Module::Load;
my $meta = CPAN::Meta->load_file('META.json');
printf "testing requirements for %s version %s\n",
$meta->name,
$meta->version;
my $prereqs = $meta->effective_prereqs;
for my $phase ( qw/configure runtime build test/ ) {
say "Requirements for $phase:";
my $reqs = $prereqs->requirements_for($phase, "requires");
for my $module ( sort $reqs->required_modules ) {
my $status;
if ( eval { load $module unless $module eq 'perl'; 1 } ) {
my $version = $module eq 'perl' ? $] : $module->VERSION;
$status = $reqs->accepts_module($module, $version)
? "$version ok" : "$version not ok";
} else {
$status = "missing"
};
say " $module ($status)";
}
}
=head1 DESCRIPTION
Software distributions released to the CPAN include a F<META.json> or, for
older distributions, F<META.yml>, which describes the distribution, its
contents, and the requirements for building and installing the distribution.
The data structure stored in the F<META.json> file is described in
L<CPAN::Meta::Spec>.
CPAN::Meta provides a simple class to represent this distribution metadata (or
I<distmeta>), along with some helpful methods for interrogating that data.
The documentation below is only for the methods of the CPAN::Meta object. For
information on the meaning of individual fields, consult the spec.
=head1 METHODS
=head2 new
my $meta = CPAN::Meta->new($distmeta_struct, \%options);
Returns a valid CPAN::Meta object or dies if the supplied metadata hash
reference fails to validate. Older-format metadata will be up-converted to
version 2 if they validate against the original stated specification.
It takes an optional hashref of options. Valid options include:
=over
=item *
lazy_validation -- if true, new will attempt to convert the given metadata
to version 2 before attempting to validate it. This means than any
fixable errors will be handled by CPAN::Meta::Converter before validation.
(Note that this might result in invalid optional data being silently
dropped.) The default is false.
=back
=head2 create
my $meta = CPAN::Meta->create($distmeta_struct, \%options);
This is same as C<new()>, except that C<generated_by> and C<meta-spec> fields
will be generated if not provided. This means the metadata structure is
assumed to otherwise follow the latest L<CPAN::Meta::Spec>.
=head2 load_file
my $meta = CPAN::Meta->load_file($distmeta_file, \%options);
Given a pathname to a file containing metadata, this deserializes the file
according to its file suffix and constructs a new C<CPAN::Meta> object, just
like C<new()>. It will die if the deserialized version fails to validate
against its stated specification version.
It takes the same options as C<new()> but C<lazy_validation> defaults to
true.
=head2 load_yaml_string
my $meta = CPAN::Meta->load_yaml_string($yaml, \%options);
This method returns a new CPAN::Meta object using the first document in the
given YAML string. In other respects it is identical to C<load_file()>.
=head2 load_json_string
my $meta = CPAN::Meta->load_json_string($json, \%options);
This method returns a new CPAN::Meta object using the structure represented by
the given JSON string. In other respects it is identical to C<load_file()>.
=head2 load_string
my $meta = CPAN::Meta->load_string($string, \%options);
If you don't know if a string contains YAML or JSON, this method will use
L<Parse::CPAN::Meta> to guess. In other respects it is identical to
C<load_file()>.
=head2 save
$meta->save($distmeta_file, \%options);
Serializes the object as JSON and writes it to the given file. The only valid
option is C<version>, which defaults to '2'. On Perl 5.8.1 or later, the file
is saved with UTF-8 encoding.
For C<version> 2 (or higher), the filename should end in '.json'. L<JSON::PP>
is the default JSON backend. Using another JSON backend requires L<JSON> 2.5 or
later and you must set the C<$ENV{PERL_JSON_BACKEND}> to a supported alternate
backend like L<JSON::XS>.
For C<version> less than 2, the filename should end in '.yml'.
L<CPAN::Meta::Converter> is used to generate an older metadata structure, which
is serialized to YAML. CPAN::Meta::YAML is the default YAML backend. You may
set the C<$ENV{PERL_YAML_BACKEND}> to a supported alternative backend, though
this is not recommended due to subtle incompatibilities between YAML parsers on
CPAN.
=head2 meta_spec_version
This method returns the version part of the C<meta_spec> entry in the distmeta
structure. It is equivalent to:
$meta->meta_spec->{version};
=head2 effective_prereqs
my $prereqs = $meta->effective_prereqs;
my $prereqs = $meta->effective_prereqs( \@feature_identifiers );
This method returns a L<CPAN::Meta::Prereqs> object describing all the
prereqs for the distribution. If an arrayref of feature identifiers is given,
the prereqs for the identified features are merged together with the
distribution's core prereqs before the CPAN::Meta::Prereqs object is returned.
=head2 should_index_file
... if $meta->should_index_file( $filename );
This method returns true if the given file should be indexed. It decides this
by checking the C<file> and C<directory> keys in the C<no_index> property of
the distmeta structure.
C<$filename> should be given in unix format.
=head2 should_index_package
... if $meta->should_index_package( $package );
This method returns true if the given package should be indexed. It decides
this by checking the C<package> and C<namespace> keys in the C<no_index>
property of the distmeta structure.
=head2 features
my @feature_objects = $meta->features;
This method returns a list of L<CPAN::Meta::Feature> objects, one for each
optional feature described by the distribution's metadata.
=head2 feature
my $feature_object = $meta->feature( $identifier );
This method returns a L<CPAN::Meta::Feature> object for the optional feature
with the given identifier. If no feature with that identifier exists, an
exception will be raised.
=head2 as_struct
my $copy = $meta->as_struct( \%options );
This method returns a deep copy of the object's metadata as an unblessed hash
reference. It takes an optional hashref of options. If the hashref contains
a C<version> argument, the copied metadata will be converted to the version
of the specification and returned. For example:
my $old_spec = $meta->as_struct( {version => "1.4"} );
=head2 as_string
my $string = $meta->as_string( \%options );
This method returns a serialized copy of the object's metadata as a character
string. (The strings are B<not> UTF-8 encoded.) It takes an optional hashref
of options. If the hashref contains a C<version> argument, the copied metadata
will be converted to the version of the specification and returned. For
example:
my $string = $meta->as_string( {version => "1.4"} );
For C<version> greater than or equal to 2, the string will be serialized as
JSON. For C<version> less than 2, the string will be serialized as YAML. In
both cases, the same rules are followed as in the C<save()> method for choosing
a serialization backend.
=head1 STRING DATA
The following methods return a single value, which is the value for the
corresponding entry in the distmeta structure. Values should be either undef
or strings.
=over 4
=item *
abstract
=item *
description
=item *
dynamic_config
=item *
generated_by
=item *
name
=item *
release_status
=item *
version
=back
=head1 LIST DATA
These methods return lists of string values, which might be represented in the
distmeta structure as arrayrefs or scalars:
=over 4
=item *
authors
=item *
keywords
=item *
licenses
=back
The C<authors> and C<licenses> methods may also be called as C<author> and
C<license>, respectively, to match the field name in the distmeta structure.
=head1 MAP DATA
These readers return hashrefs of arbitrary unblessed data structures, each
described more fully in the specification:
=over 4
=item *
meta_spec
=item *
resources
=item *
provides
=item *
no_index
=item *
prereqs
=item *
optional_features
=back
=head1 CUSTOM DATA
A list of custom keys are available from the C<custom_keys> method and
particular keys may be retrieved with the C<custom> method.
say $meta->custom($_) for $meta->custom_keys;
If a custom key refers to a data structure, a deep clone is returned.
=for Pod::Coverage TO_JSON abstract author authors custom custom_keys description dynamic_config
generated_by keywords license licenses meta_spec name no_index
optional_features prereqs provides release_status resources version
=head1 BUGS
Please report any bugs or feature using the CPAN Request Tracker.
Bugs can be submitted through the web interface at
L<http://rt.cpan.org/Dist/Display.html?Queue=CPAN-Meta>
When submitting a bug or request, please include a test-file or a patch to an
existing test-file that illustrates the bug or desired feature.
=head1 SEE ALSO
=over 4
=item *
L<CPAN::Meta::Converter>
=item *
L<CPAN::Meta::Validator>
=back
=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
=head1 SUPPORT
=head2 Bugs / Feature Requests
Please report any bugs or feature requests through the issue tracker
at L<https://github.com/Perl-Toolchain-Gang/CPAN-Meta/issues>.
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<https://github.com/Perl-Toolchain-Gang/CPAN-Meta>
git clone https://github.com/Perl-Toolchain-Gang/CPAN-Meta.git
=head1 AUTHORS
=over 4
=item *
David Golden <dagolden@cpan.org>
=item *
Ricardo Signes <rjbs@cpan.org>
=back
=head1 CONTRIBUTORS
=over 4
=item *
Ansgar Burchardt <ansgar@cpan.org>
=item *
Avar Arnfjord Bjarmason <avar@cpan.org>
=item *
Christopher J. Madsen <cjm@cpan.org>
=item *
Chuck Adams <cja987@gmail.com>
=item *
Cory G Watson <gphat@cpan.org>
=item *
Damyan Ivanov <dam@cpan.org>
=item *
Eric Wilhelm <ewilhelm@cpan.org>
=item *
Gregor Hermann <gregoa@debian.org>
=item *
Karen Etheridge <ether@cpan.org>
=item *
Ken Williams <kwilliams@cpan.org>
=item *
Kenichi Ishigaki <ishigaki@cpan.org>
=item *
Lars Dieckow <daxim@cpan.org>
=item *
Leon Timmermans <leont@cpan.org>
=item *
Mark Fowler <markf@cpan.org>
=item *
Michael G. Schwern <mschwern@cpan.org>
=item *
Olaf Alders <olaf@wundersolutions.com>
=item *
Olivier Mengue <dolmen@cpan.org>
=item *
Randy Sims <randys@thepierianspring.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2010 by David Golden and Ricardo Signes.
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
|