Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CPAN::Meta::Merge (3)

Name

CPAN::Meta::Merge - Merging CPAN Meta fragments

Synopsis

my $merger = CPAN::Meta::Merge->new(default_version => "2");
my $meta = $merger->merge($base, @additional);

Description

Perl Programmers Reference Guide                          CPAN::Meta::Merge(3)



NAME
       CPAN::Meta::Merge - Merging CPAN Meta fragments

VERSION
       version 2.150010

SYNOPSIS
        my $merger = CPAN::Meta::Merge->new(default_version => "2");
        my $meta = $merger->merge($base, @additional);

DESCRIPTION
METHODS
   new
       This creates a CPAN::Meta::Merge object. It takes one mandatory named
       argument, "version", declaring the version of the meta-spec that must
       be used for the merge. It can optionally take an "extra_mappings"
       argument that allows one to add additional merging functions for
       specific elements.

       The "extra_mappings" arguments takes a hash ref with the same type of
       structure as described in CPAN::Meta::Spec, except with its values as
       one of the defined merge strategies or a code ref to a merging
       function.

         my $merger = CPAN::Meta::Merge->new(
             default_version => '2',
             extra_mappings => {
                 'optional_features' => \&custom_merge_function,
                 'x_custom' => 'set_addition',
                 'x_meta_meta' => {
                     name => 'identical',
                     tags => 'set_addition',
                 }
             }
         );

   merge(@fragments)
       Merge all @fragments together. It will accept both CPAN::Meta objects
       and (possibly incomplete) hashrefs of metadata.

MERGE STRATEGIES
       "merge" uses various strategies to combine different elements of the
       CPAN::Meta objects.  The following strategies can be used with the
       extra_mappings argument of "new":

       identical
           The elements must be identical

       set_addition
           The union of two array refs

             [ a, b ] U [ a, c]  = [ a, b, c ]

       uniq_map
           Key value pairs from the right hash are merged to the left hash.
           Key collisions are only allowed if their values are the same.  This
           merge function will recurse into nested hash refs following the
           same merge rules.

       improvise
           This merge strategy will try to pick the appropriate predefined
           strategy based on what element type.  Array refs will try to use
           the "set_addition" strategy,  Hash refs will try to use the
           "uniq_map" strategy, and everything else will try the "identical"
           strategy.

AUTHORS
       o   David Golden <dagolden@cpan.org>

       o   Ricardo Signes <rjbs@cpan.org>

       o   Adam Kennedy <adamk@cpan.org>

COPYRIGHT AND LICENSE
       This software is copyright (c) 2010 by David Golden, Ricardo Signes,
       Adam Kennedy and Contributors.

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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14              CPAN::Meta::Merge(3)