CPAN::R...:Dynamic(3)

📦
version 0.003 · 8 versions
, in arch rolling

🌸 CPAN::Requirements::Dynamic 🌸

okay bestie, welcome to the manual page for CPAN::Requirements::Dynamic — which the header line shows as CPAN::R...:Dynamic(3) because it got truncated, and honestly the ellipsis is serving main character energy 💅. Anyway. This is the page for dynamic prerequisites in meta files, and it's genuinely so fun once you get it. Let's go 🫶

⭐ VERSION ⭐

version 0.003 — tiny number, big vibes ✨

🦋 SYNOPSIS 🦋

here's the whole mood, verbatim, no cap:

my $result = $dynamic->evaluate({
  expressions => [
    {
      condition => [ 'has_perl' => 'v5.20.0' ],
      prereqs => { Bar => "1.3" },
    },
    {
      condition => [ is_os => 'linux' ],
      prereqs => { Baz => "1.4" },
    },
    {
      condition => [ config_defined => 'usethreads' ],
      prereqs => { Quz => "1.5" },
    },
    {
      condition => [ and =>
        [ config_defined => 'usethreads' ],
        [ is_os => 'openbsd' ],
      ],
      prereqs => { Euz => "1.7" },
    },
    {
      condition => [ not => is_os_type => 'Unix'],
      error => 'OS unsupported',
    },
  ],
});

look at her go 😭💖

💜 DESCRIPTION 💜

So this module implements a format for describing dynamic prerequisites of a distribution. That's it, that's the whole description. It's giving "confident and concise" and we respect it 😌🔥

🎀 METHODS 🎀

🌈 new(%options)

The constructor! It takes two named arguments, both optional but like... highly recommended, bestie, please use them 🥺

  • config — an ExtUtils::Config (compatible) object for reading configuration. it's giving "power source" 🔋
  • pureperl_only — this should be the value of the "pureperl-only" flag. yes, exact string, keep the quotes in your head 🎀

🌈 evaluate(%options)

This one takes a hash with two named arguments: "version" and "expressions" ✨

  • version is the version of the format, and it currently defaults to 1 (humble queen 👑)
  • expressions is a list of hashes, and each hash can contain the following keys:

💖 the keys 💖

  • condition — the condition of the dynamic requirement. it's an array with a name as first value(s) and zero or more arguments following it. the semantics live below under "Conditions" 👀
  • prereqs — a hash with modules for keys and the required version as values (e.g. { Foo => '1.234' }). love a key-value moment 💫
  • phase — the phase of the requirements. defaults to 'runtime'. other valid values include 'build' and 'test' 🧚
  • relation — the relation of the requirements. defaults to 'requires', but other valid values include 'recommends', 'suggests' and 'conflicts' ⚔️
  • error — it will die with this error if set. the two messages "No support for OS" and "OS unsupported" have special meaning to CPAN Testers and are generally encouraged for situations that indicate not a failed build but an impossibility to build. so like, use them with intention, iykyk 💀
ngl this is the important bit: "condition" and one of "prereqs" or "error" are mandatory. not optional, not "maybe later", mandatory periodt 📌

🌈 evaluate_file($filename)

takes a filename — and it can be either a YAML file or a JSON file — and evaluates it. two formats, one method, slay 🦋

🌈 Conditions

this is the whole condition catalogue, bestie, buckle up 🎢

  • can_run($command) — returns true if a $command can be run 🏃
  • config_defined($variable) — returns true if a specific configuration variable is defined 🎯
  • has_env($variable) — returns true if the environmental variable with the name in $variable is true 🌱
  • has_perl($version) — returns true if the perl version satisfies $version. and $version is interpreted exactly as in the CPAN::Meta spec (e.g. 1.2 equals '>= 1.2') 😮 no improvising!
  • is_extended — returns true if extended testing is asked for 🧪
  • is_os(@systems) — returns true if the OS name equals any of @systems 🖥️
  • is_os_type($type) — returns true if the OS type equals $type. typical values of $type are 'Unix' or 'Windows' 🪟
  • is_smoker — returns true when running on a smoker 💨 (yes, that's really what it's called, iconic)
  • has_env — this returns true if the given environmental variable is true. (yep, this one appears a second time in this list — the page said it twice and I'm not about to erase her truth 💅🫶)
  • want_xs — returns true if a compiler appears to be available, and the "pureperl_only" option has not been set ⚙️
  • not — takes an expression and negates its value 🙃
  • or — takes a list of arrayrefs, each containing a condition expression. if at least one of the conditions is true, this will also return true 🌟
  • and — takes a list of arrayrefs, each containing a condition expression. if all of the conditions are true, this will also return true 💯

🍓 AUTHOR 🍓

Leon Timmermans <fawaka@gmail.com> — thank you legend 🙌

This software is copyright (c) 2023 by Leon Timmermans.

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

okay and the cutest little sign-off for you: this page is from perl v5.42.2, dated 2026-07-12, and it lives under the name CPAN::R...:Dynamic(3) (truncated again, she's consistent ✨). that's the whole thing bestie, you ate this, go write some dynamic prereqs 🎀🦋💜

📦 where this page comes from