Canary-Stability/Stability.pm

=head1 NAME

Canary::Stability - canary to check perl compatibility for schmorp's modules

=head1 SYNOPSIS

 # in Makefile.PL
 use Canary::Stability DISTNAME => 2001, MINIMUM_PERL_VERSION;

=head1 DESCRIPTION

This module is used by Schmorp's modules during configuration stage to
test the installed perl for compatibility with his modules.

It's not, at this stage, meant as a tool for other module authors,
although in principle nothing prevents them from subscribing to the same
ideas.

See the F<Makefile.PL> in L<Coro> or L<AnyEvent> for usage examples.

=cut

package Canary::Stability;

BEGIN {
   $VERSION = 2001;
}

sub sgr {
   # we just assume ANSI almost everywhere
   # red 31, yellow 33, green 32

   $ENV{PERL_CANARY_STABILITY_COLOUR} ne 0
   and ((-t STDOUT and length $ENV{TERM}) or $ENV{PERL_CANARY_STABILITY_COLOUR})
   and print "\e[$_[0]m";
}

sub import {
   my (undef, $distname, $minvers, $minperl) = @_;

   $ENV{PERL_CANARY_STABILITY_DISABLE}
      and return;

   $minperl ||= 5.008002;

   if ($minvers > $VERSION) {
      sgr 33;
      print <<EOF;

***
*** The stability canary says: (nothing, it died of old age).
***
*** Your Canary::Stability module (used by $distname) is too old.
*** This is not a fatal problem - while you might want to upgrade to version
*** $minvers (currently installed version: $VERSION) to get better support
*** status testing, you might also not want to care at all, and all will
*** be well as long $distname works well enough for you, as the stability
*** canary is only used when installing the distribution.
***

EOF
   } elsif ($] < $minperl) {

      sgr 33;
      print <<EOF;

***
*** The stability canary says: chirp (it seems concerned about something).
***
*** Your perl version ($]) is older than the $distname distribution
*** likes ($minperl). This is not a fatal problem - the module might work
*** well with your version of perl, but it does mean the author likely
*** won't do anything to make it work if it breaks.
***

EOF
   } elsif (defined $Internals::StabilityBranchVersion) {
      # note to people studying this modules sources:
      # the above test is not considered a clean or stable way to
      # test for the stability branch.

      sgr 32;
      print <<EOF;

***
*** The stability canary says: chirp! chirp! (it seems to be quite excited)
***
*** It seems you are running schmorp's stability branch of perl.
*** All should be well, and if it isn't, you should report this as a bug
*** to the $distname author.
***

EOF
   } elsif ($] <= 5.020) {
      #sgr 32;
      print <<EOF;

***
*** The stability canary says: chirp! chirp! (it seems to be quite happy)
***
*** Your version of perl ($]) is quite supported by $distname, nothing
*** else to be said, hope it comes in handy.
***

EOF
   } else {
      sgr 31;
      print <<EOF;

***
*** The stability canary says: (nothing, it was driven away by harsh weather)
***
*** It seems you are running perl version $], likely the "official" or
*** "standard" version. While there is nothing wrong with doing that,
*** standard perl versions 5.022 and up are not supported by $distname.
*** While this might be fatal, it might also be all right - if you run into
*** problems, you might want to downgrade your perl or switch to the
*** stability branch.
***
*** If everything works fine, you can ignore this message.
***
EOF
      sgr 0;
      print <<EOF;
*** Stability canary mini-FAQ:
***
*** Do I need to do anything?
***    With luck, no. While some distributions are known to fail
***    already, most should probably work. This message is here
***    to alert you that your perl is not supported by $distname,
***    and if things go wrong, you either need to downgrade, or
***    sidegrade to the stability variant of your perl version,
***    or simply live with the consequences.
***
*** What is this canary thing?
***    It's purpose is to check support status of $distname with
***    respect to your perl version.
***
*** What is this "stability branch"?
***    It's a branch or fork of the official perl, by schmorp, to
***    improve stability and compatibility with existing modules.
***
*** How can I skip this prompt on automated installs?
***    Set PERL_CANARY_STABILITY_NOPROMPT=1 in your environment.
***    More info is in the Canary::Stability manpage.
***
*** Long version of this FAQ: http://stableperl.schmorp.de/faq.html
*** Stability Branch homepage: http://stableperl.schmorp.de/
***

EOF

      unless ($ENV{PERL_CANARY_STABILITY_NOPROMPT}) {
         require ExtUtils::MakeMaker;

         ExtUtils::MakeMaker::prompt ("Continue anyways? ", "y") =~ /^y/i
            or die "FATAL: User aborted configuration of $distname.\n";
      }
   }

   sgr 0;
}

=head1 ENVIRONMENT VARIABLES

=over 4

=item C<PERL_CANARY_STABILITY_NOPROMPT=1>

Do not prompt the user on alert messages.

=item C<PERL_CANARY_STABILITY_COLOUR=0>

Disable use of colour.

=item C<PERL_CANARY_STABILITY_COLOUR=1>

Force use of colour.

=item C<PERL_CANARY_STABILITY_DISABLE=1>

Disable this modules functionality completely.

=back

=head1 AUTHOR

 Marc Lehmann <schmorp@schmorp.de>
 http://home.schmorp.de/

=cut

1

Revision:	1.5
Committed:	Thu Jun 25 14:38:27 2015 UTC (8 years, 10 months ago) by root
Branch:	MAIN
Changes since 1.4:	+2 -4 lines
Log Message:	* empty log message *
#	Content
1	=head1 NAME
2
3	Canary::Stability - canary to check perl compatibility for schmorp's modules
4
5	=head1 SYNOPSIS
6
7	# in Makefile.PL
8	use Canary::Stability DISTNAME => 2001, MINIMUM_PERL_VERSION;
9
10	=head1 DESCRIPTION
11
12	This module is used by Schmorp's modules during configuration stage to
13	test the installed perl for compatibility with his modules.
14
15	It's not, at this stage, meant as a tool for other module authors,
16	although in principle nothing prevents them from subscribing to the same
17	ideas.
18
19	See the F<Makefile.PL> in L<Coro> or L<AnyEvent> for usage examples.
20
21	=cut
22
23	package Canary::Stability;
24
25	BEGIN {
26	$VERSION = 2001;
27	}
28
29	sub sgr {
30	# we just assume ANSI almost everywhere
31	# red 31, yellow 33, green 32
32
33	$ENV{PERL_CANARY_STABILITY_COLOUR} ne 0
34	and ((-t STDOUT and length $ENV{TERM}) or $ENV{PERL_CANARY_STABILITY_COLOUR})
35	and print "\e[$_[0]m";
36	}
37
38	sub import {
39	my (undef, $distname, $minvers, $minperl) = @_;
40
41	$ENV{PERL_CANARY_STABILITY_DISABLE}
42	and return;
43
44	$minperl \|\|= 5.008002;
45
46	if ($minvers > $VERSION) {
47	sgr 33;
48	print <<EOF;
49
50	***
51	*** The stability canary says: (nothing, it died of old age).
52	***
53	*** Your Canary::Stability module (used by $distname) is too old.
54	*** This is not a fatal problem - while you might want to upgrade to version
55	*** $minvers (currently installed version: $VERSION) to get better support
56	*** status testing, you might also not want to care at all, and all will
57	*** be well as long $distname works well enough for you, as the stability
58	*** canary is only used when installing the distribution.
59	***
60
61	EOF
62	} elsif ($] < $minperl) {
63
64	sgr 33;
65	print <<EOF;
66
67	***
68	*** The stability canary says: chirp (it seems concerned about something).
69	***
70	*** Your perl version ($]) is older than the $distname distribution
71	*** likes ($minperl). This is not a fatal problem - the module might work
72	*** well with your version of perl, but it does mean the author likely
73	*** won't do anything to make it work if it breaks.
74	***
75
76	EOF
77	} elsif (defined $Internals::StabilityBranchVersion) {
78	# note to people studying this modules sources:
79	# the above test is not considered a clean or stable way to
80	# test for the stability branch.
81
82	sgr 32;
83	print <<EOF;
84
85	***
86	*** The stability canary says: chirp! chirp! (it seems to be quite excited)
87	***
88	*** It seems you are running schmorp's stability branch of perl.
89	*** All should be well, and if it isn't, you should report this as a bug
90	*** to the $distname author.
91	***
92
93	EOF
94	} elsif ($] <= 5.020) {
95	#sgr 32;
96	print <<EOF;
97
98	***
99	*** The stability canary says: chirp! chirp! (it seems to be quite happy)
100	***
101	*** Your version of perl ($]) is quite supported by $distname, nothing
102	*** else to be said, hope it comes in handy.
103	***
104
105	EOF
106	} else {
107	sgr 31;
108	print <<EOF;
109
110	***
111	*** The stability canary says: (nothing, it was driven away by harsh weather)
112	***
113	*** It seems you are running perl version $], likely the "official" or
114	*** "standard" version. While there is nothing wrong with doing that,
115	*** standard perl versions 5.022 and up are not supported by $distname.
116	*** While this might be fatal, it might also be all right - if you run into
117	*** problems, you might want to downgrade your perl or switch to the
118	*** stability branch.
119	***
120	*** If everything works fine, you can ignore this message.
121	***
122	EOF
123	sgr 0;
124	print <<EOF;
125	*** Stability canary mini-FAQ:
126	***
127	*** Do I need to do anything?
128	*** With luck, no. While some distributions are known to fail
129	*** already, most should probably work. This message is here
130	*** to alert you that your perl is not supported by $distname,
131	*** and if things go wrong, you either need to downgrade, or
132	*** sidegrade to the stability variant of your perl version,
133	*** or simply live with the consequences.
134	***
135	*** What is this canary thing?
136	*** It's purpose is to check support status of $distname with
137	*** respect to your perl version.
138	***
139	*** What is this "stability branch"?
140	*** It's a branch or fork of the official perl, by schmorp, to
141	*** improve stability and compatibility with existing modules.
142	***
143	*** How can I skip this prompt on automated installs?
144	*** Set PERL_CANARY_STABILITY_NOPROMPT=1 in your environment.
145	*** More info is in the Canary::Stability manpage.
146	***
147	*** Long version of this FAQ: http://stableperl.schmorp.de/faq.html
148	*** Stability Branch homepage: http://stableperl.schmorp.de/
149	***
150
151	EOF
152
153	unless ($ENV{PERL_CANARY_STABILITY_NOPROMPT}) {
154	require ExtUtils::MakeMaker;
155
156	ExtUtils::MakeMaker::prompt ("Continue anyways? ", "y") =~ /^y/i
157	or die "FATAL: User aborted configuration of $distname.\n";
158	}
159	}
160
161	sgr 0;
162	}
163
164	=head1 ENVIRONMENT VARIABLES
165
166	=over 4
167
168	=item C<PERL_CANARY_STABILITY_NOPROMPT=1>
169
170	Do not prompt the user on alert messages.
171
172	=item C<PERL_CANARY_STABILITY_COLOUR=0>
173
174	Disable use of colour.
175
176	=item C<PERL_CANARY_STABILITY_COLOUR=1>
177
178	Force use of colour.
179
180	=item C<PERL_CANARY_STABILITY_DISABLE=1>
181
182	Disable this modules functionality completely.
183
184	=back
185
186	=head1 AUTHOR
187
188	Marc Lehmann <schmorp@schmorp.de>
189	http://home.schmorp.de/
190
191	=cut
192
193	1
194