/ 
URI-PackageURL-2.26
⭐ Starred 4 / URI::VersionRange::Version

NAME

URI::VersionRange::Version - Version scheme helper class

SYNOPSIS

package URI::VersionRange::Scheme::generic {

    use Version::libversion::XS qw(version_compare2);

    use parent 'URI::VersionRange::Version';
    use overload ('cmp' => \&compare, '<=>' => \&compare, fallback => 1);

    sub compare {
        my ($left, $right) = @_;
        return version_compare2($left->[0], $right->[0]);
    }

}

my $vers = URI::VersionRange->from_string('vers:generic/>v1.00|!=v2.10|<=v3.00');

if ($vers->contains('v2.50')) {
  # do stuff
}

DESCRIPTION

This is a base class for the version scheme helper.

The version comparator is provided by the scheme class (see "HOW TO CREATE A NEW SCHEME COMPARATOR CLASS") and it's used by URI::VersionRange for contains and for sorting the constraints in to_string.

BUNDLED SCHEME COMPARATORS

  • cpan - version module

  • semver - Semantic Versioning 2.0.0 (https://semver.org)

  • npm - Same as semver

  • datetime - RFC 3339 timestamp (leap second 60 is not supported)

  • intdot - Integers separated by dots (eg. 10.234.5.12)

  • lexicographic - Byte-wise comparison of the UTF-8 encoded versions

For all other schemes the generic comparator is used (see generic_version_compare in URI::VersionRange::Util).

OBJECT-ORIENTED INTERFACE

new

$v = URI::VersionRange::Version->new( $value )

Create new URI::VersionRange::Version instance using provided version value.

compare

$v->compare

Compare the version

from_native

$vers_string = $class->from_native( $native_range, $scheme )

Convert the native range of the scheme into a VERS string (optional).

If implemented in the scheme class, this method is used by URI::VersionRange->from_native instead of native_range_to_vers (see URI::VersionRange::Util).

load

$class = URI::VersionRange::Version->load( $scheme )

Load scheme class.

The class name is built using the scheme, replacing period . and dash - with underscore _ (eg. foo-bar --> URI::VersionRange::Scheme::foo_bar).

This method will attempt to load the classes in this order:

  • URI::VersionRange::Scheme::<scheme>

  • URI::VersionRange::Version::<scheme> (legacy naming convention)

  • URI::VersionRange::Scheme::generic (fallback)

  • URI::VersionRange::Version::generic (fallback)

If no class is found, the generic comparator of URI::VersionRange::Version will be used.

Croaks if the scheme class exists but fails to load (eg. syntax error or missing dependency).

HOW TO CREATE A NEW SCHEME COMPARATOR CLASS

  • Create a new package using the naming convention URI::VersionRange::Scheme::<scheme> by extending URI::VersionRange::Version (period . and dash - in the scheme must be replaced with underscore _).

  • Implements the compare($left, $right) subroutine with the algorithm required by the scheme.

    $left and $right arguments of compare are ARRAY and have as their first element the value of the version to be compared.

  • overload '<=>' and cmp operators using compare subroutine (MANDATORY)

  • Implement the from_native($class, $native_range, $scheme) subroutine to convert the native range of the scheme into a VERS string (optional)

This is an example that implements a comparator for the generic fallback scheme using Version::libversion::XS module:

package URI::VersionRange::Scheme::generic {

    use Version::libversion::XS qw(version_compare2);

    use parent 'URI::VersionRange::Version';
    use overload ('cmp' => \&compare, '<=>' => \&compare, fallback => 1);

    sub compare {
        my ($left, $right) = @_;
        return version_compare2($left->[0], $right->[0]);
    }

}

This is an another example for the rpm scheme using RPM4 module:

package URI::VersionRange::Scheme::rpm {

    use RPM4;

    use parent 'URI::VersionRange::Version';
    use overload ('cmp' => \&compare, '<=>' => \&compare, fallback => 1);

    sub compare {
        my ($left, $right) = @_;
        return rpmvercmp($left->[0], $right->[0]);
    }

}

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/giterlizzi/perl-URI-PackageURL/issues. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/giterlizzi/perl-URI-PackageURL

git clone https://github.com/giterlizzi/perl-URI-PackageURL.git

AUTHOR

  • Giuseppe Di Terlizzi <gdt@cpan.org>

LICENSE AND COPYRIGHT

This software is copyright (c) 2022-2026 by Giuseppe Di Terlizzi.

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