From: John Peacock Date: Mon, 23 Jun 2003 21:58:18 +0000 (-0400) Subject: version.pm up to date with CPAN X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c8d69e4a510de0f5933cdb167bdf5c1394fdb4a9;p=p5sagit%2Fp5-mst-13.2.git version.pm up to date with CPAN Message-ID: <3EF7B03A.2060705@rowman.com> p4raw-id: //depot/perl@19847 --- diff --git a/lib/version.pm b/lib/version.pm index 15cf81b..520c781 100644 --- a/lib/version.pm +++ b/lib/version.pm @@ -1,4 +1,4 @@ -#!/usr/bin/perl -w +#!perl -w package version; use 5.005_03; @@ -9,7 +9,7 @@ use vars qw(@ISA $VERSION $CLASS); @ISA = qw(DynaLoader); -$VERSION = (qw$Revision: 2.7 $)[1]/10; +$VERSION = 0.29; # stop using CVS and switch to subversion $CLASS = 'version'; @@ -36,8 +36,9 @@ version - Perl extension for Version Objects $vstring = new version qw(v1.2); # must be quoted! print $vstring; # 1.2 - $betaver = new version "1.2_3"; # must be quoted! - print $betaver; # 1.2_3 + $alphaver = new version "1.2_3"; # must be quoted! + print $alphaver; # 1.2_3 + print $alphaver->is_alpha(); # true $perlver = new version 5.005_03; # must not be quoted! print $perlver; # 5.5.30 @@ -60,12 +61,16 @@ There are actually two distinct ways to initialize versions: =over 4 -=item * Numeric Versions - any initial parameter which "looks like -a number", see L. +=item * Numeric Versions -=item * V-String Versions - any initial parameter which contains more -than one decimal point, contains an embedded underscore, or has a -leading 'v' see L. +Any initial parameter which "looks like a number", see L. + +=item * V-String Versions + +Any initial parameter which contains more than one decimal point, +contains an embedded underscore, or has a leading 'v' see L. =back @@ -77,7 +82,7 @@ the default stringification will always be in a reduced form, i.e.: $v3 = new version v1.2.3; # 1.2.3 for Perl > v5.8.0 $v4 = new version 1.2.3; # 1.2.3 for Perl > v5.8.0 -Please see L for more details on how Perl will parse various +Please see L<"Quoting"> for more details on how Perl will parse various input values. Any value passed to the new() operator will be parsed only so far as it @@ -105,10 +110,10 @@ will have trailing zeros added to make up the difference. For example: $v = new version 1.002; # 1.2 $v = new version 1.0023; # 1.2.300 $v = new version 1.00203; # 1.2.30 - $v = new version 1.002_03; # 1.2.30 See L + $v = new version 1.002_03; # 1.2.30 See L<"Quoting"> $v = new version 1.002003; # 1.2.3 -All of the preceeding examples except the second to last are true +All of the preceeding examples except the second to last are true whether or not the input value is quoted. The important feature is that the input value contains only a single decimal. @@ -117,7 +122,7 @@ the input value contains only a single decimal. These are the newest form of versions, and correspond to Perl's own version style beginning with v5.6.0. Starting with Perl v5.10.0, this is likely to be the preferred form. This method requires that -the input parameter be quoted, although Perl > v5.9.0 can use bare +the input parameter be quoted, although Perl > v5.9.0 can use bare v-strings as a special form of quoting. Unlike L, V-String Versions must either have more than @@ -126,7 +131,7 @@ like this "v5.6" (much like v-string notation). In fact, with the newest Perl v-strings themselves can be used to initialize version objects. Also unlike L, leading zeros are B significant, and trailing zeros must be explicitely specified (i.e. -will not be automatically added). In addition, the subversions are +will not be automatically added). In addition, the subversions are not enforced to be three decimal places. So, for example: @@ -138,10 +143,10 @@ So, for example: $v = new version "v1.0003"; # 1.3 In additional to conventional versions, V-String Versions can be -used to create L. +used to create L. In general, V-String Versions permit the greatest amount of freedom -to specify a version, whereas Numeric Versions enforce a certain +to specify a version, whereas Numeric Versions enforce a certain uniformity. See also L for an additional method of initializing version objects. @@ -149,17 +154,18 @@ initializing version objects. Overloading has been used with version objects to provide a natural interface for their use. All mathematical operations are forbidden, -since they don't make any sense for versions. +since they don't make any sense for base version objects. =over 4 -=item * New Operator - Like all OO interfaces, the new() operator is -used to initialize version objects. One way to increment versions -when programming is to use the CVS variable $Revision, which is -automatically incremented by CVS every time the file is committed to -the repository. +=item * New Operator + +Like all OO interfaces, the new() operator is used to initialize +version objects. One way to increment versions when programming is to +use the CVS variable $Revision, which is automatically incremented by +CVS every time the file is committed to the repository. -=back +=back In order to facilitate this feature, the following code can be employed: @@ -169,7 +175,7 @@ code can be employed: and the version object will be created as if the following code were used: - $VERSION = new version "v2.6"; + $VERSION = new version "v2.7"; In other words, the version will be automatically parsed out of the string, and it will be quoted to preserve the meaning CVS normally @@ -178,13 +184,14 @@ carries for versions. For the subsequent examples, the following two objects will be used: $ver = new version "1.2.3"; # see "Quoting" below - $beta = new version "1.2_3"; # see "Beta versions" below + $alpha = new version "1.2_3"; # see "Alpha versions" below =over 4 -=item * Stringification - Any time a version object is used as a string, -a stringified representation is returned in reduced form (no extraneous -zeros): +=item * Stringification + +Any time a version object is used as a string, a stringified +representation is returned in reduced form (no extraneous zeros): =back @@ -193,28 +200,25 @@ zeros): =over 4 -=item * Numification - although all mathematical operations on version -objects are forbidden by default, it is possible to retrieve a number -which roughly corresponds to the version object through the use of the -$obj->numify method. For formatting purposes, when displaying a number -which corresponds a version object, all sub versions are assumed to have -three decimal places. So for example: +=item * Numification -=back +Although all mathematical operations on version objects are forbidden +by default, it is possible to retrieve a number which roughly +corresponds to the version object through the use of the $obj->numify +method. For formatting purposes, when displaying a number which +corresponds a version object, all sub versions are assumed to have +three decimal places. So for example: print $ver->numify; # prints 1.002003 -=over 4 - -=item * Comparison operators - Both cmp and <=> operators perform the -same comparison between terms (upgrading to a version object -automatically). Perl automatically generates all of the other comparison -operators based on those two. In addition to the obvious equalities -listed below, appending a single trailing 0 term does not change the -value of a version for comparison purposes. In other words "v1.2" and -"v1.2.0" are identical versions. +=item * Comparison operators -=back +Both cmp and <=> operators perform the same comparison between terms +(upgrading to a version object automatically). Perl automatically +generates all of the other comparison operators based on those two. +In addition to the obvious equalities listed below, appending a single +trailing 0 term does not change the value of a version for comparison +purposes. In other words "v1.2" and "v1.2.0" are identical versions. For example, the following relations hold: @@ -231,24 +235,42 @@ In versions of Perl prior to the 5.9.0 development releases, it is not permitted to use bare v-strings in either form, due to the nature of Perl's parsing operation. After that version (and in the stable 5.10.0 release), v-strings can be used with version objects without problem, see L<"Quoting"> -for more discussion of this topic. In the case of the last two lines of +for more discussion of this topic. In the case of the last two lines of the table above, only the string comparison will be true; the numerical comparison will test false. However, you can do this: $ver == "1.2.3" or $ver == "v1.2.3" # both true even though you are doing a "numeric" comparison with a "string" value. -It is probably best to chose either the numeric notation or the string +It is probably best to chose either the numeric notation or the string notation and stick with it, to reduce confusion. See also L<"Quoting">. +=item * Logical Operators + +If you need to test whether a version object +has been initialized, you can simply test it directly: + + $vobj = new version $something; + if ( $vobj ) # true only if $something was non-blank + +You can also test whether a version object is a L, for +example to prevent the use of some feature not present in the main +release: + + $vobj = new version "1.2_3"; # MUST QUOTE + ...later... + if ( $vobj->is_alpha ) # True + +=back + =head2 Quoting -Because of the nature of the Perl parsing and tokenizing routines, +Because of the nature of the Perl parsing and tokenizing routines, certain initialization values B be quoted in order to correctly parse as the intended version, and additionally, some initial values B be quoted to obtain the intended version. -Except for L, any version initialized with something +Except for L, any version initialized with something that looks like a number (a single decimal place) will be parsed in the same way whether or not the term is quoted. In order to be compatible with earlier Perl version styles, any use of versions of @@ -260,7 +282,7 @@ The complicating factor is that in bare numbers (i.e. unquoted), the underscore is a legal numeric character and is automatically stripped by the Perl tokenizer before the version code is called. However, if a number containing a single decimal and an underscore is quoted, i.e. -not bare, that is considered a L and the underscore is +not bare, that is considered a L and the underscore is significant. If you use a mathematic formula that resolves to a floating point number, @@ -287,43 +309,40 @@ There are two types of Version Objects: =over 4 -=item * Ordinary versions - These are the versions that normal -modules will use. Can contain as many subversions as required. -In particular, those using RCS/CVS can use one of the following: +=item * Ordinary versions -=back +These are the versions that normal modules will use. Can contain as +many subversions as required. In particular, those using RCS/CVS can +use one of the following: - $VERSION = new version qw$Revision: 2.7 $; + $VERSION = new version qw$Revision: 2.7 $; -and the current RCS Revision for that file will be inserted -automatically. If the file has been moved to a branch, the -Revision will have three or more elements; otherwise, it will -have only two. This allows you to automatically increment -your module version by using the Revision number from the primary -file in a distribution, see L. +and the current RCS Revision for that file will be inserted +automatically. If the file has been moved to a branch, the Revision +will have three or more elements; otherwise, it will have only two. +This allows you to automatically increment your module version by +using the Revision number from the primary file in a distribution, see +L. -=over 4 +=item * alpha versions -=item * Beta versions - For module authors using CPAN, the -convention has been to note unstable releases with an underscore -in the version string, see L. Beta releases will test as being -newer than the more recent stable release, and less than the next -stable release. For example: - -=back +For module authors using CPAN, the convention has been to note +unstable releases with an underscore in the version string, see +L. Alpha releases will test as being newer than the more recent +stable release, and less than the next stable release. For example: - $betaver = new version "12.3_1"; # must quote + $alphaver = new version "12.3_1"; # must quote obeys the relationship - 12.3 < $betaver < 12.4 + 12.3 < $alphaver < 12.4 As a matter of fact, if is also true that - 12.3.0 < $betaver < 12.3.1 + 12.3.0 < $alphaver < 12.3.1 -where the subversion is identical but the beta release is less than -the non-beta release. +where the subversion is identical but the alpha release is less than +the non-alpha release. =head2 Replacement UNIVERSAL::VERSION diff --git a/lib/version.t b/lib/version.t index 4e34e56..6f753bd 100644 --- a/lib/version.t +++ b/lib/version.t @@ -1,11 +1,11 @@ #! /usr/local/perl -w # Before `make install' is performed this script should be runnable with # `make test'. After `make install' it should work as `perl test.pl' -# $Revision: 2.3 $ +# $Revision: 2.4 $ ######################### -use Test::More tests => 71; +use Test::More tests => 73; use_ok("version"); # If we made it this far, we are ok. my ($version, $new_version); @@ -35,7 +35,7 @@ is ( "$version" , "5.5" , '5.005 eq 5.5' ); $version = new version "5.006.001"; is ( "$version" , "5.6.1" , '5.006.001 eq 5.6.1' ); $version = new version "1.2.3_4"; -is ( "$version" , "1.2.3_4" , 'beta version 1.2.3_4 eq 1.2.3_4' ); +is ( "$version" , "1.2.3_4" , 'alpha version 1.2.3_4 eq 1.2.3_4' ); # test illegal formats diag "test illegal formats" unless $ENV{PERL_CORE}; @@ -123,37 +123,39 @@ ok ( $version eq "2002.9.30.1",'$version eq 2002.9.30.1'); ok ( $version->numify == 2002.009030001, '$version->numify == 2002.009030001'); -# now test with Beta version form with string +# now test with alpha version form with string $version = new version "1.2.3"; $new_version = "1.2.3_4"; -diag "tests with beta-style non-objects" unless $ENV{PERL_CORE}; +diag "tests with alpha-style non-objects" unless $ENV{PERL_CORE}; ok ( $version lt $new_version, '$version lt $new_version' ); ok ( $new_version gt $version, '$new_version gt $version' ); ok ( $version ne $new_version, '$version ne $new_version' ); $version = new version "1.2.4"; -diag "numeric tests with beta-style non-objects" unless $ENV{PERL_CORE}; +diag "numeric tests with alpha-style non-objects" unless $ENV{PERL_CORE}; ok ( $version > $new_version, '$version > $new_version' ); ok ( $new_version < $version, '$new_version < $version' ); ok ( $version != $new_version, '$version != $new_version' ); -# now test with Beta version form with object +# now test with alpha version form with object $version = new version "1.2.3"; $new_version = new version "1.2.3_4"; -diag "tests with beta-style objects" unless $ENV{PERL_CORE}; +diag "tests with alpha-style objects" unless $ENV{PERL_CORE}; ok ( $version < $new_version, '$version < $new_version' ); ok ( $new_version > $version, '$new_version > $version' ); ok ( $version != $new_version, '$version != $new_version' ); +ok ( !$version->is_alpha, '!$version->is_alpha'); +ok ( $new_version->is_alpha, '$new_version->is_alpha'); $version = new version "1.2.4"; -diag "tests with beta-style objects" unless $ENV{PERL_CORE}; +diag "tests with alpha-style objects" unless $ENV{PERL_CORE}; ok ( $version > $new_version, '$version > $new_version' ); ok ( $new_version < $version, '$new_version < $version' ); ok ( $version != $new_version, '$version != $new_version' ); $version = new version "1.2.4"; $new_version = new version "1.2_4"; -diag "tests with beta-style objects with same subversion" unless $ENV{PERL_CORE}; +diag "tests with alpha-style objects with same subversion" unless $ENV{PERL_CORE}; ok ( $version > $new_version, '$version > $new_version' ); ok ( $new_version < $version, '$new_version < $version' ); ok ( $version != $new_version, '$version != $new_version' ); diff --git a/universal.c b/universal.c index 22be54f..b4563e4 100644 --- a/universal.c +++ b/universal.c @@ -171,6 +171,7 @@ XS(XS_version_numify); XS(XS_version_vcmp); XS(XS_version_boolean); XS(XS_version_noop); +XS(XS_version_is_alpha); XS(XS_utf8_is_utf8); XS(XS_utf8_valid); XS(XS_utf8_encode); @@ -210,6 +211,7 @@ Perl_boot_core_UNIVERSAL(pTHX) newXS("version::boolean", XS_version_boolean, file); newXS("version::(nomethod", XS_version_noop, file); newXS("version::noop", XS_version_noop, file); + newXS("version::is_alpha", XS_version_is_alpha, file); } newXS("utf8::is_utf8", XS_utf8_is_utf8, file); newXS("utf8::valid", XS_utf8_valid, file); @@ -528,6 +530,34 @@ XS(XS_version_noop) XSRETURN_EMPTY; } +XS(XS_version_is_alpha) +{ + dXSARGS; + if (items != 1) + Perl_croak(aTHX_ "Usage: version::is_alpha(lobj)"); + SP -= items; + { + SV *lobj; + + if (sv_derived_from(ST(0), "version")) { + SV *tmp = SvRV(ST(0)); + lobj = tmp; + } + else + Perl_croak(aTHX_ "lobj is not of type version"); +{ + I32 len = av_len((AV *)lobj); + I32 digit = SvIVX(*av_fetch((AV *)lobj, len, 0)); + if ( digit < 0 ) + XSRETURN_YES; + else + XSRETURN_NO; +} + PUTBACK; + return; + } +} + XS(XS_utf8_is_utf8) { dXSARGS;