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
|
package Dist::Zilla::PluginBundle::Filter 6.033;
# ABSTRACT: use another bundle, with some plugins removed
use Moose;
with 'Dist::Zilla::Role::PluginBundle';
use Dist::Zilla::Pragmas;
use namespace::autoclean;
use List::Util 1.33 qw(any);
use Module::Runtime qw(use_module);
use Dist::Zilla::Util;
#pod =head1 SYNOPSIS
#pod
#pod In your F<dist.ini>:
#pod
#pod [@Filter]
#pod -bundle = @Basic
#pod -version = 5.031
#pod -remove = ShareDir
#pod -remove = UploadToCPAN
#pod option = for_basic
#pod
#pod =head1 DESCRIPTION
#pod
#pod This plugin bundle actually wraps and modifies another plugin bundle. It
#pod includes all the configuration for the bundle named in the C<-bundle> attribute,
#pod but removes all the entries whose package is given in the C<-remove> attributes.
#pod
#pod A minimum required version of the bundle can be specified with the C<-version>
#pod attribute.
#pod
#pod Options not prefixed with C<-> will be passed to the bundle to be filtered.
#pod
#pod B<NOTE:> When you filter a bundle you B<SHOULD NOT> include it directly in
#pod your C<dist.ini> file. This plugin will take care of including it for you.
#pod
#pod =head1 SEE ALSO
#pod
#pod Core Dist::Zilla plugins: L<@Basic|Dist::Zilla::PluginBundle::Basic>.
#pod
#pod Dist::Zilla roles: L<PluginBundle|Dist::Zilla::Role::PluginBundle>.
#pod
#pod =cut
sub mvp_multivalue_args { qw(remove -remove) }
sub bundle_config {
my ($self, $section) = @_;
my $class = (ref $self) || $self;
my $config = {};
my $has_filter_args = any { /^-/ } keys %{ $section->{payload} };
for my $key (keys %{ $section->{payload} }) {
my $val = $section->{payload}->{$key};
my $target = $has_filter_args && ($key !~ /^-/)
? 'bundle'
: 'filter';
$key =~ s/^-// if $target eq 'filter';
$config->{$target}->{$key} = $val;
}
Carp::croak("no bundle given for bundle filter")
unless my $bundle = $config->{filter}->{bundle};
my $pkg = Dist::Zilla::Util->expand_config_package_name($bundle);
my $version = $config->{filter}->{version};
unless (eval { &use_module($pkg, $version ? $version : ()); 1 }) {
# XXX Naughty! -- rjbs, 2013-07-23
Config::MVP::Section->missing_package($pkg, $bundle);
}
my @plugins = $pkg->bundle_config({
name => $section->{name}, # not 100% sure about this -- rjbs, 2010-03-06
package => $pkg,
payload => $config->{bundle} || {},
});
return @plugins unless my $remove = $config->{filter}->{remove};
for my $i (reverse 0 .. $#plugins) {
splice @plugins, $i, 1 if any(sub {
$plugins[$i][1] eq Dist::Zilla::Util->expand_config_package_name($_)
}, @$remove);
}
return @plugins;
}
__PACKAGE__->meta->make_immutable;
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dist::Zilla::PluginBundle::Filter - use another bundle, with some plugins removed
=head1 VERSION
version 6.033
=head1 SYNOPSIS
In your F<dist.ini>:
[@Filter]
-bundle = @Basic
-version = 5.031
-remove = ShareDir
-remove = UploadToCPAN
option = for_basic
=head1 DESCRIPTION
This plugin bundle actually wraps and modifies another plugin bundle. It
includes all the configuration for the bundle named in the C<-bundle> attribute,
but removes all the entries whose package is given in the C<-remove> attributes.
A minimum required version of the bundle can be specified with the C<-version>
attribute.
Options not prefixed with C<-> will be passed to the bundle to be filtered.
B<NOTE:> When you filter a bundle you B<SHOULD NOT> include it directly in
your C<dist.ini> file. This plugin will take care of including it for you.
=head1 PERL VERSION
This module should work on any version of perl still receiving updates from
the Perl 5 Porters. This means it should work on any version of perl
released in the last two to three years. (That is, if the most recently
released version is v5.40, then this module should work on both v5.40 and
v5.38.)
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased. The version may be increased
for any reason, and there is no promise that patches will be accepted to
lower the minimum required perl.
=head1 SEE ALSO
Core Dist::Zilla plugins: L<@Basic|Dist::Zilla::PluginBundle::Basic>.
Dist::Zilla roles: L<PluginBundle|Dist::Zilla::Role::PluginBundle>.
=head1 AUTHOR
Ricardo SIGNES 😏 <cpan@semiotic.systems>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2025 by 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
|