-
Notifications
You must be signed in to change notification settings - Fork 67
Extract runtime detection constants into separated module #138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3370594
Move runtime detections into dedicated library
happy-barney c549ab7
Use runtime constants in tests as well
happy-barney 8a44bd2
fixup! Move runtime detections into dedicated library
happy-barney 033f677
fixup! Move runtime detections into dedicated library
happy-barney File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| package TAP::Harness::Runtime; | ||
|
|
||
| use strict; | ||
| use warnings; | ||
|
|
||
| use base q (Exporter); | ||
|
|
||
| use constant HAS_TIME_HIRES => !! eval q { use Time::HiRes qw (time); 1 }; | ||
| use constant IS_VMS => $^O eq q (VMS); | ||
| use constant IS_WIN32 => ($^O =~ qr (^ (MS) Win32 $)x); | ||
| use constant IS_UNIXY => ! (IS_VMS || IS_WIN32); | ||
|
|
||
| my @constants = qw ( | ||
| IS_VMS | ||
| IS_WIN32 | ||
| IS_UNIXY | ||
| HAS_TIME_HIRES | ||
| ); | ||
|
|
||
| our @EXPORT_OK = ( | ||
| @constants, | ||
| HAS_TIME_HIRES ? qw (time) : (), | ||
| ); | ||
|
|
||
| our %EXPORT_TAGS = ( | ||
| all => \ @EXPORT_OK, | ||
| constants => \ @constants, | ||
| ); | ||
|
|
||
| sub import { | ||
| my ($caller, @arguments) = @_; | ||
|
|
||
| # 'time' is exported only when Time::HiRes is available | ||
| # but can be always requested | ||
| @arguments = grep { $_ ne q (time) } @arguments | ||
| unless HAS_TIME_HIRES | ||
| ; | ||
|
|
||
| local @_ = ($caller, @arguments); | ||
| goto \ &Exporter::import; | ||
| } | ||
|
|
||
| 1; | ||
|
|
||
| __END__ | ||
|
|
||
| =pod | ||
|
|
||
| =encoding utf8 | ||
|
|
||
| =head1 NAME | ||
|
|
||
| TAP::Harness::Runtime - constants to identify runtime environment | ||
|
|
||
| =head1 SYNOPSIS | ||
|
|
||
| package My:Superb::Package; | ||
|
|
||
| # import constants | ||
| use TAP::Harness::Runtime qw (:constants); | ||
|
|
||
| =head1 DESCRIPTION | ||
|
|
||
| Module wraps runtime detection used by multiple modules into single module. | ||
|
|
||
| =head1 EXPORTABLE FUNCTIONS | ||
|
|
||
| =head2 HAS_TIME_HIRES | ||
|
|
||
| Constant evaluating as C<true> when module L<Time::HiRes> is importable. | ||
|
|
||
| =head2 IS_VMS | ||
|
|
||
| Constant evaluating as C<true> when running on VMS. | ||
|
|
||
| =head2 IS_WIN32 | ||
|
|
||
| Constant evaluating as C<true> when running on Windows (32-bit or 64-bit) | ||
|
|
||
| =head2 IS_UNIXY | ||
|
|
||
| Constant evaluating as C<true> when running system which behaves like Unix. | ||
|
|
||
| =head2 time | ||
|
|
||
| When L<Time::HiRes> is available module reexports its C<time> function. | ||
|
|
||
| Symbol can be requested for import even if L<Time::HiRes> isn't available | ||
| without causing any error. | ||
|
|
||
| =head1 EXPORT TAGS | ||
|
|
||
| =head2 all | ||
|
|
||
| Import all exported symbols. | ||
|
|
||
| =head2 constants | ||
|
|
||
| Import all constants. | ||
|
|
||
| =head1 SEE ALSO | ||
|
|
||
| L<TAP::Harness> | ||
|
|
||
| =head1 BUGS | ||
|
|
||
| Please report any bugs or feature request at | ||
| L<https://github.com/Perl-Toolchain-Gang/Test-Harness/issues> | ||
|
|
||
| =head1 REPOSITORY | ||
|
|
||
| L<https://github.com/Perl-Toolchain-Gang/Test-Harness> | ||
|
|
||
| =head1 LICENCE AND COPYRIGHT | ||
|
|
||
| This module is free software; you can redistribute it and/or | ||
| modify it under same terms as L<Test::Harness> distribution. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This changes the eval from a block style evaluation to a string, which is not a good change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Block eval would not be able to test a use statement, but this can easily be done with a block eval:
eval { require Time::HiRes; Time::HiRes->import('time'); 1 }There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@karenetheridge original code had string evaluation.
I'm using form
q { }for string containing code (hence{as paired delimiter).commit introducing this change is
fixup!of original commit. I'm using such approach to show reaction to code review comment, referring fixup commit(s) dealing with given issue raised in given comment.(when I was taught this approach I hesitated but at the end, in many PR-review cycles, I found out that review by commit and reacting with fixups saved lot of time especially on reviewer's side)
@Grinnz my aim was only to extract existing runtime detection into dedicated library, but your suggestion is too good to be omitted ... 033f677