Variable-Disposition-0.005000755001750001750 014525212552 14331 5ustar00tomtom000000000000README100644001750001750 507214525212552 15276 0ustar00tomtom000000000000Variable-Disposition-0.005NAME Variable::Disposition - helper functions for disposing of variables SYNOPSIS use feature qw(say); use Variable::Disposition; my $x = []; dispose $x; say '$x is no longer defined'; DESCRIPTION Provides some basic helper functions for making sure variables go away when you want them to. Currently provides "dispose" as a default import. To avoid this: use Variable::Disposition (); In addition, "retain" and "retain_future" are available as optional imports. use Variable::Disposition qw(dispose retain retain_future); The :all tag can be used to import every available function: use Variable::Disposition qw(:all); but it would be safer to use a version instead: use Variable::Disposition qw(:v1); since these are guaranteed not to change in future. Other functions for use with Future and IO::Async are likely to be added later. FUNCTIONS dispose Undefines the given variable, then checks that the original ref was destroyed. my $x = [1,2,3]; dispose $x; # $x is no longer defined. This is primarily intended for cases where you no longer need a variable, and want to ensure that you haven't accidentally captured a strong reference to it elsewhere. Note that this clears the caller's variable. This function is defined with a prototype of ($), since it is only intended for use on scalar variables. To clear multiple variables, use a foreach loop: my ($x, $y, $z) = ...; dispose $_ for $x, $y, $z; is($x, undef); is($y, undef); is($z, undef); retain Keeps a copy of this variable until program exit or "dispose". Returns the original variable. retain_future Holds a copy of the given Future until it's marked ready, then releases our copy. Does not use "dispose", since that could interfere with other callbacks attached to the Future. Since Future 0.36, this behaviour is directly available via the "retain" in Future method, so it is recommended to use that instead of this function. Returns the original Future. SEE ALSO * Devel::Refcount - assert_oneref is almost identical to this, although it doesn't clear the variable it's called on * Closure::Explicit - provides a sub{} wrapper that will complain if you capture a lexical without explicitly declaring that you're going to do that. AUTHOR Tom Molesworth LICENSE Copyright Tom Molesworth 2014-2015. Licensed under the same terms as Perl itself. Changes100644001750001750 211514525212552 15704 0ustar00tomtom000000000000Variable-Disposition-0.005Revision history for Variable-Disposition 0.005 2023-11-16 03:00:57+08:00 Asia/Singapore [Bugs fixed] - when Future::XS is installed, t/retain_future.t failed due to attempting to pass a value to `->cancel`, thanks to ANDK for reporting 0.004 2015-02-11 22:17:44+00:00 Europe/London No new features. Dependencies: * Require Future.pm, there's some test failures on older versions of Future and I don't feel like messing around with version checks, given that everything else I use depends on Future.pm anyway - patches welcome if anyone feels differently. 0.003 2015-02-09 02:51:40+00:00 Europe/London No new features. Bugs fixed: * retain_future was returning undef for completed Futures 0.002 2015-01-30 20:40:28+00:00 Europe/London New features: * retain - holds on to a variable until dispose/exit * retain_future - holds on to a Future until it's ready Documentation: * Expanded description of some details of the dispose() function including mention of the ($) prototype. 0.001 2014-08-30 20:43:59+01:00 Europe/London Initial CPAN release LICENSE100644001750001750 4643514525212552 15453 0ustar00tomtom000000000000Variable-Disposition-0.005This software is copyright (c) 2014 by Tom Molesworth. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2014 by Tom Molesworth. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Perl Artistic License 1.0 --- This software is Copyright (c) 2014 by Tom Molesworth. This is free software, licensed under: The Perl Artistic License 1.0 The "Artistic License" Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder as specified below. "Copyright Holder" is whoever is named in the copyright or copyrights for the package. "You" is you, if you're thinking about copying or distributing this Package. "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as uunet.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) give non-standard executables non-standard names, and clearly document the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. You may embed this Package's interpreter within an executable of yours (by linking); this shall be construed as a mere form of aggregation, provided that the complete Standard Version of the interpreter is so embedded. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whoever generated them, and may be sold commercially, and may be aggregated with this Package. If such scripts or library files are aggregated with this Package via the so-called "undump" or "unexec" methods of producing a binary executable image, then distribution of such an image shall neither be construed as a distribution of this Package nor shall it fall under the restrictions of Paragraphs 3 and 4, provided that you do not represent such an executable image as a Standard Version of this Package. 7. C subroutines (or comparably compiled subroutines in other languages) supplied by you and linked into this Package in order to emulate subroutines and variables of the language defined by this Package shall not be considered part of this Package, but are the equivalent of input as in Paragraph 6, provided these subroutines do not change the language in any way that would cause it to fail the regression tests for the language. 8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package. 9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End cpanfile100644001750001750 23514525212552 16076 0ustar00tomtom000000000000Variable-Disposition-0.005requires 'Future', '>= 0.36'; on 'test' => sub { requires 'Test::More', '>= 0.98'; requires 'Test::Fatal', '>= 0.010'; requires 'Test::Refcount', 0; }; dist.ini100644001750001750 31614525212552 16036 0ustar00tomtom000000000000Variable-Disposition-0.005name = Variable-Disposition author = Tom Molesworth license = Perl_5 copyright_holder = Tom Molesworth copyright_year = 2014 main_module = lib/Variable/Disposition.pm [@Author::TEAM] META.yml100644001750001750 226414525212552 15667 0ustar00tomtom000000000000Variable-Disposition-0.005--- abstract: 'dispose of variables' author: - 'Tom Molesworth ' build_requires: ExtUtils::MakeMaker: '0' File::Spec: '0' IO::Handle: '0' IPC::Open3: '0' Test::CheckDeps: '0.010' Test::Fatal: '0.010' Test::More: '0.98' Test::Refcount: '0' configure_requires: ExtUtils::MakeMaker: '0' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.030, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Variable-Disposition no_index: directory: - eg - share - shares - t - xt provides: Variable::Disposition: file: lib/Variable/Disposition.pm version: '0.005' requires: Future: '0.36' resources: bugtracker: https://github.com/team-at-cpan/Variable-Disposition/issues homepage: https://github.com/team-at-cpan/Variable-Disposition repository: https://github.com/team-at-cpan/Variable-Disposition.git version: '0.005' x_authority: cpan:TEAM x_contributors: - 'Tom Molesworth ' x_generated_by_perl: v5.38.0 x_serialization_backend: 'YAML::Tiny version 1.74' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' MANIFEST100644001750001750 107114525212552 15542 0ustar00tomtom000000000000Variable-Disposition-0.005# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.030. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README cpanfile dist.ini lib/Variable/Disposition.pm lib/Variable/Disposition.pod t/00-check-deps.t t/00-compile.t t/00-report-prereqs.dd t/00-report-prereqs.t t/basic.t t/retain.t t/retain_future.t xt/author/distmeta.t xt/author/eol.t xt/author/minimum-version.t xt/author/mojibake.t xt/author/no-tabs.t xt/author/pod-syntax.t xt/author/portability.t xt/author/test-version.t xt/release/common_spelling.t xt/release/cpan-changes.t t000755001750001750 014525212552 14515 5ustar00tomtom000000000000Variable-Disposition-0.005basic.t100644001750001750 223014525212552 16120 0ustar00tomtom000000000000Variable-Disposition-0.005/tuse strict; use warnings; use Test::More; use Test::Fatal; use Variable::Disposition; { my $x = [1,2,3]; isa_ok($x, 'ARRAY'); dispose $x; is($x, undef, 'was undefined correctly'); } { my $x = [1,2,3]; my $copy = $x; like(exception { dispose $x; }, qr/not released/, 'raise an exception if variable is still around'); is($x, undef, 'was still undefined correctly'); is(exception { dispose $copy; }, undef, 'no exception when last copy goes'); } { my $x = 'test'; like(exception { dispose $x; }, qr/not a ref/, 'raise an exception when called on non-ref'); is($x, 'test', 'still defined'); undef $x; like(exception { dispose $x; }, qr/not defined/, 'raise an exception when called on undef'); } my $destroyed = 0; { { package Local::Test; sub DESTROY { ++$destroyed } } my $x = bless {}, 'Local::Test'; is($destroyed, 0, 'not yet destroyed'); dispose $x; is($destroyed, 1, 'destroyed after dispose()'); is($x, undef, 'was undef'); } is($destroyed, 1, 'still only a single DESTROY called when leaving scope'); done_testing; META.json100644001750001750 513214525212552 16034 0ustar00tomtom000000000000Variable-Disposition-0.005{ "abstract" : "dispose of variables", "author" : [ "Tom Molesworth " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.030, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Variable-Disposition", "no_index" : { "directory" : [ "eg", "share", "shares", "t", "xt" ] }, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "develop" : { "requires" : { "Dist::Zilla" : "5", "Dist::Zilla::PluginBundle::Author::TEAM" : "0", "Software::License::Perl_5" : "0", "Test::CPAN::Changes" : "0.19", "Test::CPAN::Meta" : "0", "Test::EOL" : "0", "Test::MinimumVersion" : "0", "Test::Mojibake" : "0", "Test::More" : "0.88", "Test::NoTabs" : "0", "Test::Pod" : "1.41", "Test::Portability::Files" : "0", "Test::Version" : "1" } }, "runtime" : { "requires" : { "Future" : "0.36" } }, "test" : { "recommends" : { "CPAN::Meta" : "2.120900" }, "requires" : { "ExtUtils::MakeMaker" : "0", "File::Spec" : "0", "IO::Handle" : "0", "IPC::Open3" : "0", "Test::CheckDeps" : "0.010", "Test::Fatal" : "0.010", "Test::More" : "0.98", "Test::Refcount" : "0" } } }, "provides" : { "Variable::Disposition" : { "file" : "lib/Variable/Disposition.pm", "version" : "0.005" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/team-at-cpan/Variable-Disposition/issues" }, "homepage" : "https://github.com/team-at-cpan/Variable-Disposition", "repository" : { "type" : "git", "url" : "https://github.com/team-at-cpan/Variable-Disposition.git", "web" : "https://github.com/team-at-cpan/Variable-Disposition" } }, "version" : "0.005", "x_authority" : "cpan:TEAM", "x_contributors" : [ "Tom Molesworth " ], "x_generated_by_perl" : "v5.38.0", "x_serialization_backend" : "Cpanel::JSON::XS version 4.37", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" } retain.t100644001750001750 104314525212552 16322 0ustar00tomtom000000000000Variable-Disposition-0.005/tuse strict; use warnings; use Test::More; use Test::Refcount; use Variable::Disposition qw(retain dispose); my $copy; { my $x = []; Scalar::Util::weaken($copy = $x); ok($x, 'have a variable'); is_refcount($x, 1, 'refcount is now 1'); Scalar::Util::weaken($copy = $x); is_refcount($x, 1, 'refcount is still 1'); retain($x); is_refcount($x, 2, 'refcount is now 2'); } is_refcount($copy, 1, 'refcount is still 1'); ok($copy, 'copy still exists'); dispose($copy); is($copy, undef, 'copy went away'); done_testing; Makefile.PL100644001750001750 253714525212552 16373 0ustar00tomtom000000000000Variable-Disposition-0.005# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.030. use strict; use warnings; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "dispose of variables", "AUTHOR" => "Tom Molesworth ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "Variable-Disposition", "LICENSE" => "perl", "NAME" => "Variable::Disposition", "PREREQ_PM" => { "Future" => "0.36" }, "TEST_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Test::CheckDeps" => "0.010", "Test::Fatal" => "0.010", "Test::More" => "0.98", "Test::Refcount" => 0 }, "VERSION" => "0.005", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Future" => "0.36", "IO::Handle" => 0, "IPC::Open3" => 0, "Test::CheckDeps" => "0.010", "Test::Fatal" => "0.010", "Test::More" => "0.98", "Test::Refcount" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); 00-compile.t100644001750001750 264514525212552 16716 0ustar00tomtom000000000000Variable-Disposition-0.005/tuse 5.006; use strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::Compile 2.058 use Test::More; plan tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0); my @module_files = ( 'Variable/Disposition.pm' ); # no fake home requested my @switches = ( -d 'blib' ? '-Mblib' : '-Ilib', ); use File::Spec; use IPC::Open3; use IO::Handle; open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; my @warnings; for my $lib (@module_files) { # see L my $stderr = IO::Handle->new; diag('Running: ', join(', ', map { my $str = $_; $str =~ s/'/\\'/g; q{'} . $str . q{'} } $^X, @switches, '-e', "require q[$lib]")) if $ENV{PERL_COMPILE_TEST_DEBUG}; my $pid = open3($stdin, '>&STDERR', $stderr, $^X, @switches, '-e', "require q[$lib]"); binmode $stderr, ':crlf' if $^O eq 'MSWin32'; my @_warnings = <$stderr>; waitpid($pid, 0); is($?, 0, "$lib loaded ok"); shift @_warnings if @_warnings and $_warnings[0] =~ /^Using .*\bblib/ and not eval { +require blib; blib->VERSION('1.01') }; if (@_warnings) { warn @_warnings; push @warnings, @_warnings; } } is(scalar(@warnings), 0, 'no warnings found') or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ) if $ENV{AUTHOR_TESTING}; author000755001750001750 014525212552 16207 5ustar00tomtom000000000000Variable-Disposition-0.005/xteol.t100644001750001750 137514525212552 17321 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/authoruse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::EOL 0.19 use Test::More 0.88; use Test::EOL; my @files = ( 'lib/Variable/Disposition.pm', 'lib/Variable/Disposition.pod', 't/00-check-deps.t', 't/00-compile.t', 't/00-report-prereqs.dd', 't/00-report-prereqs.t', 't/basic.t', 't/retain.t', 't/retain_future.t', 'xt/author/distmeta.t', 'xt/author/eol.t', 'xt/author/minimum-version.t', 'xt/author/mojibake.t', 'xt/author/no-tabs.t', 'xt/author/pod-syntax.t', 'xt/author/portability.t', 'xt/author/test-version.t', 'xt/release/common_spelling.t', 'xt/release/cpan-changes.t' ); eol_unix_ok($_, { trailing_whitespace => 1 }) foreach @files; done_testing; retain_future.t100644001750001750 146214525212552 17721 0ustar00tomtom000000000000Variable-Disposition-0.005/tuse strict; use warnings; use Test::More; use Test::Refcount; use Variable::Disposition qw(retain_future dispose); unless(eval { require Future }) { plan skip_all => 'this test requires Future.pm'; } for my $resolution (qw(done fail cancel)) { my $f = Future->new; is_refcount($f, 1, 'refcount is 1'); retain_future($f); is_refcount($f, 2, 'refcount is now 2'); $f->$resolution($resolution eq 'cancel' ? () : '...'); is_refcount($f, 1, 'refcount is back to 1 after ' . $resolution); dispose($f); is($f, undef, 'goes away after dispose'); } { ok(retain_future(Future->done), 'can retain ->done Future'); ok(retain_future(Future->fail("...")), 'can retain ->failed Future'); ok(retain_future(Future->new->cancel), 'can retain ->cancelled Future'); } done_testing; 00-check-deps.t100644001750001750 43514525212552 17247 0ustar00tomtom000000000000Variable-Disposition-0.005/tuse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::CheckDeps 0.014 use Test::More 0.94; use Test::CheckDeps 0.010; check_dependencies('classic'); if (0) { BAIL_OUT("Missing dependencies") if !Test::More->builder->is_passing; } done_testing; no-tabs.t100644001750001750 134314525212552 20100 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/authoruse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::NoTabs 0.15 use Test::More 0.88; use Test::NoTabs; my @files = ( 'lib/Variable/Disposition.pm', 'lib/Variable/Disposition.pod', 't/00-check-deps.t', 't/00-compile.t', 't/00-report-prereqs.dd', 't/00-report-prereqs.t', 't/basic.t', 't/retain.t', 't/retain_future.t', 'xt/author/distmeta.t', 'xt/author/eol.t', 'xt/author/minimum-version.t', 'xt/author/mojibake.t', 'xt/author/no-tabs.t', 'xt/author/pod-syntax.t', 'xt/author/portability.t', 'xt/author/test-version.t', 'xt/release/common_spelling.t', 'xt/release/cpan-changes.t' ); notabs_ok($_) foreach @files; done_testing; mojibake.t100644001750001750 15114525212552 20272 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/author#!perl use strict; use warnings qw(all); use Test::More; use Test::Mojibake; all_files_encoding_ok(); distmeta.t100644001750001750 22314525212552 20323 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::MetaTests. use strict; use warnings; use Test::CPAN::Meta; meta_yaml_ok(); 00-report-prereqs.t100644001750001750 1360114525212552 20272 0ustar00tomtom000000000000Variable-Disposition-0.005/t#!perl use strict; use warnings; # This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.029 use Test::More tests => 1; use ExtUtils::MakeMaker; use File::Spec; # from $version::LAX my $lax_version_re = qr/(?: undef | (?: (?:[0-9]+) (?: \. | (?:\.[0-9]+) (?:_[0-9]+)? )? | (?:\.[0-9]+) (?:_[0-9]+)? ) | (?: v (?:[0-9]+) (?: (?:\.[0-9]+)+ (?:_[0-9]+)? )? | (?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)? ) )/x; # hide optional CPAN::Meta modules from prereq scanner # and check if they are available my $cpan_meta = "CPAN::Meta"; my $cpan_meta_pre = "CPAN::Meta::Prereqs"; my $HAS_CPAN_META = eval "require $cpan_meta; $cpan_meta->VERSION('2.120900')" && eval "require $cpan_meta_pre"; ## no critic # Verify requirements? my $DO_VERIFY_PREREQS = 1; sub _max { my $max = shift; $max = ( $_ > $max ) ? $_ : $max for @_; return $max; } sub _merge_prereqs { my ($collector, $prereqs) = @_; # CPAN::Meta::Prereqs object if (ref $collector eq $cpan_meta_pre) { return $collector->with_merged_prereqs( CPAN::Meta::Prereqs->new( $prereqs ) ); } # Raw hashrefs for my $phase ( keys %$prereqs ) { for my $type ( keys %{ $prereqs->{$phase} } ) { for my $module ( keys %{ $prereqs->{$phase}{$type} } ) { $collector->{$phase}{$type}{$module} = $prereqs->{$phase}{$type}{$module}; } } } return $collector; } my @include = qw( ); my @exclude = qw( ); # Add static prereqs to the included modules list my $static_prereqs = do './t/00-report-prereqs.dd'; # Merge all prereqs (either with ::Prereqs or a hashref) my $full_prereqs = _merge_prereqs( ( $HAS_CPAN_META ? $cpan_meta_pre->new : {} ), $static_prereqs ); # Add dynamic prereqs to the included modules list (if we can) my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; my $cpan_meta_error; if ( $source && $HAS_CPAN_META && (my $meta = eval { CPAN::Meta->load_file($source) } ) ) { $full_prereqs = _merge_prereqs($full_prereqs, $meta->prereqs); } else { $cpan_meta_error = $@; # capture error from CPAN::Meta->load_file($source) $source = 'static metadata'; } my @full_reports; my @dep_errors; my $req_hash = $HAS_CPAN_META ? $full_prereqs->as_string_hash : $full_prereqs; # Add static includes into a fake section for my $mod (@include) { $req_hash->{other}{modules}{$mod} = 0; } for my $phase ( qw(configure build test runtime develop other) ) { next unless $req_hash->{$phase}; next if ($phase eq 'develop' and not $ENV{AUTHOR_TESTING}); for my $type ( qw(requires recommends suggests conflicts modules) ) { next unless $req_hash->{$phase}{$type}; my $title = ucfirst($phase).' '.ucfirst($type); my @reports = [qw/Module Want Have/]; for my $mod ( sort keys %{ $req_hash->{$phase}{$type} } ) { next if grep { $_ eq $mod } @exclude; my $want = $req_hash->{$phase}{$type}{$mod}; $want = "undef" unless defined $want; $want = "any" if !$want && $want == 0; if ($mod eq 'perl') { push @reports, ['perl', $want, $]]; next; } my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; my $file = $mod; $file =~ s{::}{/}g; $file .= ".pm"; my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; if ($prefix) { my $have = MM->parse_version( File::Spec->catfile($prefix, $file) ); $have = "undef" unless defined $have; push @reports, [$mod, $want, $have]; if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META && $type eq 'requires' ) { if ( $have !~ /\A$lax_version_re\z/ ) { push @dep_errors, "$mod version '$have' cannot be parsed ($req_string)"; } elsif ( ! $full_prereqs->requirements_for( $phase, $type )->accepts_module( $mod => $have ) ) { push @dep_errors, "$mod version '$have' is not in required range '$want'"; } } } else { push @reports, [$mod, $want, "missing"]; if ( $DO_VERIFY_PREREQS && $type eq 'requires' ) { push @dep_errors, "$mod is not installed ($req_string)"; } } } if ( @reports ) { push @full_reports, "=== $title ===\n\n"; my $ml = _max( map { length $_->[0] } @reports ); my $wl = _max( map { length $_->[1] } @reports ); my $hl = _max( map { length $_->[2] } @reports ); if ($type eq 'modules') { splice @reports, 1, 0, ["-" x $ml, "", "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s\n", -$ml, $_->[0], $hl, $_->[2]) } @reports; } else { splice @reports, 1, 0, ["-" x $ml, "-" x $wl, "-" x $hl]; push @full_reports, map { sprintf(" %*s %*s %*s\n", -$ml, $_->[0], $wl, $_->[1], $hl, $_->[2]) } @reports; } push @full_reports, "\n"; } } } if ( @full_reports ) { diag "\nVersions for all modules listed in $source (including optional ones):\n\n", @full_reports; } if ( $cpan_meta_error || @dep_errors ) { diag "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n"; } if ( $cpan_meta_error ) { my ($orig_source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; diag "\nCPAN::Meta->load_file('$orig_source') failed with: $cpan_meta_error\n"; } if ( @dep_errors ) { diag join("\n", "\nThe following REQUIRED prerequisites were not satisfied:\n", @dep_errors, "\n" ); } pass('Reported prereqs'); # vim: ts=4 sts=4 sw=4 et: pod-syntax.t100644001750001750 25214525212552 20621 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/author#!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use strict; use warnings; use Test::More; use Test::Pod 1.41; all_pod_files_ok(); 00-report-prereqs.dd100644001750001750 410614525212552 20376 0ustar00tomtom000000000000Variable-Disposition-0.005/tdo { my $x = { 'configure' => { 'requires' => { 'ExtUtils::MakeMaker' => '0' } }, 'develop' => { 'requires' => { 'Dist::Zilla' => '5', 'Dist::Zilla::PluginBundle::Author::TEAM' => '0', 'Software::License::Perl_5' => '0', 'Test::CPAN::Changes' => '0.19', 'Test::CPAN::Meta' => '0', 'Test::EOL' => '0', 'Test::MinimumVersion' => '0', 'Test::Mojibake' => '0', 'Test::More' => '0.88', 'Test::NoTabs' => '0', 'Test::Pod' => '1.41', 'Test::Portability::Files' => '0', 'Test::Version' => '1' } }, 'runtime' => { 'requires' => { 'Future' => '0.36' } }, 'test' => { 'recommends' => { 'CPAN::Meta' => '2.120900' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'File::Spec' => '0', 'IO::Handle' => '0', 'IPC::Open3' => '0', 'Test::CheckDeps' => '0.010', 'Test::Fatal' => '0.010', 'Test::More' => '0.98', 'Test::Refcount' => '0' } } }; $x; }portability.t100644001750001750 13014525212552 21050 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/authoruse strict; use warnings; use Test::More; use Test::Portability::Files; run_tests(); test-version.t100644001750001750 63714525212552 21164 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/authoruse strict; use warnings; use Test::More; # generated by Dist::Zilla::Plugin::Test::Version 1.09 use Test::Version; my @imports = qw( version_all_ok ); my $params = { is_strict => 0, has_version => 1, multiple => 0, }; push @imports, $params if version->parse( $Test::Version::VERSION ) >= version->parse('1.002'); Test::Version->import(@imports); version_all_ok; done_testing; release000755001750001750 014525212552 16325 5ustar00tomtom000000000000Variable-Disposition-0.005/xtcpan-changes.t100644001750001750 34414525212552 21162 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/releaseuse strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::CPAN::Changes 0.012 use Test::More 0.96 tests => 1; use Test::CPAN::Changes; subtest 'changes_ok' => sub { changes_file_ok('Changes'); }; Variable000755001750001750 014525212552 16545 5ustar00tomtom000000000000Variable-Disposition-0.005/libDisposition.pm100644001750001750 700014525212552 21544 0ustar00tomtom000000000000Variable-Disposition-0.005/lib/Variablepackage Variable::Disposition; # ABSTRACT: dispose of variables use strict; use warnings; use parent qw(Exporter); our $VERSION = '0.005'; =head1 NAME Variable::Disposition - helper functions for disposing of variables =head1 SYNOPSIS use feature qw(say); use Variable::Disposition; my $x = []; dispose $x; say '$x is no longer defined'; =head1 DESCRIPTION Provides some basic helper functions for making sure variables go away when you want them to. Currently provides L as a default import. To avoid this: use Variable::Disposition (); In addition, L and L are available as optional imports. use Variable::Disposition qw(dispose retain retain_future); The C< :all > tag can be used to import every available function: use Variable::Disposition qw(:all); but it would be safer to use a version instead: use Variable::Disposition qw(:v1); since these are guaranteed not to change in future. Other functions for use with L and L are likely to be added later. =cut our @EXPORT_OK = qw(dispose retain retain_future); our %EXPORT_TAGS = ( all => [ @EXPORT_OK ], v1 => [ qw(dispose retain retain_future) ], ); our @EXPORT = qw(dispose); use Scalar::Util (); our %RETAINED; =head1 FUNCTIONS =cut =head2 dispose Undefines the given variable, then checks that the original ref was destroyed. my $x = [1,2,3]; dispose $x; # $x is no longer defined. This is primarily intended for cases where you no longer need a variable, and want to ensure that you haven't accidentally captured a strong reference to it elsewhere. Note that this clears the B's variable. This function is defined with a prototype of ($), since it is only intended for use on scalar variables. To clear multiple variables, use a L loop: my ($x, $y, $z) = ...; dispose $_ for $x, $y, $z; is($x, undef); is($y, undef); is($z, undef); =cut sub dispose($) { die "Variable not defined" unless defined $_[0]; die "Variable was not a ref" unless ref $_[0]; delete $RETAINED{$_[0]}; # just in case we'd previously retained this one Scalar::Util::weaken(my $copy = $_[0]); undef $_[0]; die "Variable was not released" if defined $copy; } =head2 retain Keeps a copy of this variable until program exit or L. Returns the original variable. =cut sub retain($) { die "Variable not defined" unless defined $_[0]; die "Variable was not a ref" unless ref $_[0]; $RETAINED{$_[0]} = $_[0]; $_[0] } =head2 retain_future Holds a copy of the given L until it's marked ready, then releases our copy. Does not use L, since that could interfere with other callbacks attached to the L. Since Future 0.36, this behaviour is directly available via the L method, so it is recommended to use that instead of this function. Returns the original L. =cut sub retain_future { my ($f) = @_; die "Variable does not seem to be a Future, since it has no ->on_ready method" unless $f->can('on_ready'); return $f->retain; } 1; __END__ =head1 SEE ALSO =over 4 =item * L - assert_oneref is almost identical to this, although it doesn't clear the variable it's called on =item * L - provides a sub{} wrapper that will complain if you capture a lexical without explicitly declaring that you're going to do that. =back =head1 AUTHOR Tom Molesworth =head1 LICENSE Copyright Tom Molesworth 2014-2015. Licensed under the same terms as Perl itself. minimum-version.t100644001750001750 15314525212552 21651 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/authoruse strict; use warnings; use Test::More; use Test::MinimumVersion; all_minimum_version_ok( qq{5.14.0} ); Disposition.pod100644001750001750 630314525212552 21717 0ustar00tomtom000000000000Variable-Disposition-0.005/lib/Variable=encoding utf8 =for comment POD_DERIVED_INDEX_GENERATED The following documentation is automatically generated. Please do not edit this file, but rather the original, inline with Variable::Disposition at lib/Variable/Disposition.pm (on the system that originally ran this). If you do edit this file, and don't want your changes to be removed, make sure you change the first line. =cut =head1 NAME Variable::Disposition - helper functions for disposing of variables =head1 SYNOPSIS use feature qw(say); use Variable::Disposition; my $x = []; dispose $x; say '$x is no longer defined'; =head1 DESCRIPTION Provides some basic helper functions for making sure variables go away when you want them to. Currently provides L as a default import. To avoid this: use Variable::Disposition (); In addition, L and L are available as optional imports. use Variable::Disposition qw(dispose retain retain_future); The C< :all > tag can be used to import every available function: use Variable::Disposition qw(:all); but it would be safer to use a version instead: use Variable::Disposition qw(:v1); since these are guaranteed not to change in future. Other functions for use with L and L are likely to be added later. =head1 FUNCTIONS =head2 dispose Undefines the given variable, then checks that the original ref was destroyed. my $x = [1,2,3]; dispose $x; # $x is no longer defined. This is primarily intended for cases where you no longer need a variable, and want to ensure that you haven't accidentally captured a strong reference to it elsewhere. Note that this clears the B's variable. This function is defined with a prototype of ($), since it is only intended for use on scalar variables. To clear multiple variables, use a L loop: my ($x, $y, $z) = ...; dispose $_ for $x, $y, $z; is($x, undef); is($y, undef); is($z, undef); =head2 retain Keeps a copy of this variable until program exit or L. Returns the original variable. =head2 retain_future Holds a copy of the given L until it's marked ready, then releases our copy. Does not use L, since that could interfere with other callbacks attached to the L. Since Future 0.36, this behaviour is directly available via the L method, so it is recommended to use that instead of this function. Returns the original L. =head1 SEE ALSO =over 4 =item * L - assert_oneref is almost identical to this, although it doesn't clear the variable it's called on =item * L - provides a sub{} wrapper that will complain if you capture a lexical without explicitly declaring that you're going to do that. =back =head1 INHERITED METHODS =over 4 =item L L, L, L, L, L, L, L, L =back =head1 AUTHOR Tom Molesworth =head1 LICENSE Copyright Tom Molesworth 2014-2015. Licensed under the same terms as Perl itself. common_spelling.t100644001750001750 36014525212552 22016 0ustar00tomtom000000000000Variable-Disposition-0.005/xt/release#!/usr/bin/perl use strict; use warnings; use Test::More; eval "use Test::Pod::Spelling::CommonMistakes"; if ( $@ ) { plan skip_all => 'Test::Pod::Spelling::CommonMistakes required for testing POD'; } else { all_pod_files_ok(); }