Mixin-ExtraFields-0.140003/000755 000765 000024 00000000000 14354077610 015347 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/LICENSE000644 000765 000024 00000043656 14354077610 016372 0ustar00rjbsstaff000000 000000 This software is copyright (c) 2022 by Ricardo Signes. 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) 2022 by Ricardo Signes. 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 Artistic License 1.0 --- This software is Copyright (c) 2022 by Ricardo Signes. This is free software, licensed under: The 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. - "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 ftp.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) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting 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. 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 whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. 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 Mixin-ExtraFields-0.140003/Changes000644 000765 000024 00000002621 14354077610 016643 0ustar00rjbsstaff000000 000000 Changelog for Mixin-ExtraFields 0.140003 2022-12-31 13:29:27-05:00 America/New_York - update packaging and metadata - minimum required Perl is now v5.12 0.140002 2013-10-03 19:20:01 America/New_York fix documentation embarrassments (thanks, fschlich@github!) 0.140001 2013-09-28 21:58:59 America/New_York woah! replace *ancient* Dist::Zilla configuration 0.132720 2013-09-28 21:55:52 America/New_York update bugtracker, repo links 0.100971 2010-04-07 08:00:05 America/New_York make all package version numbers match 0.100970 2010-04-06 21:49:43 America/New_York repackage with Dist::Zilla to fix some packaging issues in 0.008 0.008 2010-01-18 - allow the user to specify a different driver base class - allow the user to provide a driver instance to ->import 0.007 2007-11-14 prereqs incorrect: missing Sub::Exporter and ::Install 0.006 2007-11-13 manifest was missing key file 0.005 2007-11-07 explicit undef for 'id' uses object reference address 0.004 2006-12-11 - greatly improve test coverage, fixing major Drver.pm bugs - correct behavior of common ids under HashGuts 0.003 2006-12-11 improve uniqueness of default HashGuts key 0.002 2006-12-10 some documentation improvements 0.001 2006-12-09 first release Mixin-ExtraFields-0.140003/MANIFEST000644 000765 000024 00000001021 14354077610 016472 0ustar00rjbsstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.029. Changes LICENSE MANIFEST META.json META.yml Makefile.PL README dist.ini lib/Mixin/ExtraFields.pm lib/Mixin/ExtraFields/Driver.pm lib/Mixin/ExtraFields/Driver/HashGuts.pm t/00-report-prereqs.dd t/00-report-prereqs.t t/bad-driver.t t/basic.t t/driver-err.t t/lib/MEFD/Minimal.pm t/lib/MEFD/NoCompile.pm t/lib/Object/HasExtraFields.pm t/lib/Object/HasExtraFieldsRA.pm t/minidriver.t t/refaddr.t xt/author/pod-syntax.t xt/release/changes_has_content.t Mixin-ExtraFields-0.140003/t/000755 000765 000024 00000000000 14354077610 015612 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/xt/000755 000765 000024 00000000000 14354077610 016002 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/README000644 000765 000024 00000000601 14354077610 016224 0ustar00rjbsstaff000000 000000 This archive contains the distribution Mixin-ExtraFields, version 0.140003: add extra stashes of data to your objects This software is copyright (c) 2022 by Ricardo Signes. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. This README file was generated by Dist::Zilla::Plugin::Readme v6.029. Mixin-ExtraFields-0.140003/META.yml000644 000765 000024 00000027427 14354077610 016634 0ustar00rjbsstaff000000 000000 --- abstract: 'add extra stashes of data to your objects' author: - 'Ricardo Signes ' build_requires: ExtUtils::MakeMaker: '0' File::Spec: '0' Test::More: '0.96' base: '0' lib: '0' configure_requires: ExtUtils::MakeMaker: '6.78' dynamic_config: 0 generated_by: 'Dist::Zilla version 6.029, 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: Mixin-ExtraFields requires: Carp: '0' Scalar::Util: '0' String::RewritePrefix: '0' Sub::Exporter: '0.972' Sub::Install: '0' parent: '0' perl: '5.012' strict: '0' warnings: '0' resources: bugtracker: https://github.com/rjbs/Mixin-ExtraFields/issues homepage: https://github.com/rjbs/Mixin-ExtraFields repository: https://github.com/rjbs/Mixin-ExtraFields.git version: '0.140003' x_Dist_Zilla: perl: version: '5.037002' plugins: - class: Dist::Zilla::Plugin::Git::GatherDir config: Dist::Zilla::Plugin::GatherDir: exclude_filename: [] exclude_match: [] follow_symlinks: 0 include_dotfiles: 0 prefix: '' prune_directory: [] root: . Dist::Zilla::Plugin::Git::GatherDir: include_untracked: 0 name: '@RJBS/Git::GatherDir' version: '2.048' - class: Dist::Zilla::Plugin::CheckPrereqsIndexed name: '@RJBS/CheckPrereqsIndexed' version: '0.021' - class: Dist::Zilla::Plugin::CheckExtraTests name: '@RJBS/CheckExtraTests' version: '0.029' - class: Dist::Zilla::Plugin::PromptIfStale config: Dist::Zilla::Plugin::PromptIfStale: check_all_plugins: 0 check_all_prereqs: 0 modules: - Dist::Zilla::PluginBundle::RJBS phase: build run_under_travis: 0 skip: [] name: '@RJBS/RJBS-Outdated' version: '0.057' - class: Dist::Zilla::Plugin::PromptIfStale config: Dist::Zilla::Plugin::PromptIfStale: check_all_plugins: 1 check_all_prereqs: 0 modules: [] phase: release run_under_travis: 0 skip: - Dist::Zilla::Plugin::RJBSMisc name: '@RJBS/CPAN-Outdated' version: '0.057' - class: Dist::Zilla::Plugin::PruneCruft name: '@RJBS/@Filter/PruneCruft' version: '6.029' - class: Dist::Zilla::Plugin::ManifestSkip name: '@RJBS/@Filter/ManifestSkip' version: '6.029' - class: Dist::Zilla::Plugin::MetaYAML name: '@RJBS/@Filter/MetaYAML' version: '6.029' - class: Dist::Zilla::Plugin::License name: '@RJBS/@Filter/License' version: '6.029' - class: Dist::Zilla::Plugin::Readme name: '@RJBS/@Filter/Readme' version: '6.029' - class: Dist::Zilla::Plugin::ExecDir name: '@RJBS/@Filter/ExecDir' version: '6.029' - class: Dist::Zilla::Plugin::ShareDir name: '@RJBS/@Filter/ShareDir' version: '6.029' - class: Dist::Zilla::Plugin::Manifest name: '@RJBS/@Filter/Manifest' version: '6.029' - class: Dist::Zilla::Plugin::TestRelease name: '@RJBS/@Filter/TestRelease' version: '6.029' - class: Dist::Zilla::Plugin::ConfirmRelease name: '@RJBS/@Filter/ConfirmRelease' version: '6.029' - class: Dist::Zilla::Plugin::UploadToCPAN name: '@RJBS/@Filter/UploadToCPAN' version: '6.029' - class: Dist::Zilla::Plugin::MakeMaker config: Dist::Zilla::Role::TestRunner: default_jobs: 9 name: '@RJBS/MakeMaker' version: '6.029' - class: Dist::Zilla::Plugin::AutoPrereqs name: '@RJBS/AutoPrereqs' version: '6.029' - class: Dist::Zilla::Plugin::Git::NextVersion config: Dist::Zilla::Plugin::Git::NextVersion: first_version: '0.001' version_by_branch: 1 version_regexp: (?^:^([0-9]+\.[0-9]+)$) Dist::Zilla::Role::Git::Repo: git_version: 2.38.0 repo_root: . name: '@RJBS/Git::NextVersion' version: '2.048' - class: Dist::Zilla::Plugin::PkgVersion name: '@RJBS/PkgVersion' version: '6.029' - class: Dist::Zilla::Plugin::MetaConfig name: '@RJBS/MetaConfig' version: '6.029' - class: Dist::Zilla::Plugin::MetaJSON name: '@RJBS/MetaJSON' version: '6.029' - class: Dist::Zilla::Plugin::NextRelease name: '@RJBS/NextRelease' version: '6.029' - class: Dist::Zilla::Plugin::Test::ChangesHasContent name: '@RJBS/Test::ChangesHasContent' version: '0.011' - class: Dist::Zilla::Plugin::PodSyntaxTests name: '@RJBS/PodSyntaxTests' version: '6.029' - class: Dist::Zilla::Plugin::Test::ReportPrereqs name: '@RJBS/Test::ReportPrereqs' version: '0.028' - class: Dist::Zilla::Plugin::Git::Remote::Check name: '@RJBS/Git::Remote::Check' version: 0.1.2 - class: Dist::Zilla::Plugin::Prereqs config: Dist::Zilla::Plugin::Prereqs: phase: test type: requires name: '@RJBS/TestMoreWithSubtests' version: '6.029' - class: Dist::Zilla::Plugin::PodWeaver config: Dist::Zilla::Plugin::PodWeaver: config_plugins: - '@RJBS' finder: - ':InstallModules' - ':ExecFiles' plugins: - class: Pod::Weaver::Plugin::EnsurePod5 name: '@CorePrep/EnsurePod5' version: '4.018' - class: Pod::Weaver::Plugin::H1Nester name: '@CorePrep/H1Nester' version: '4.018' - class: Pod::Weaver::Plugin::SingleEncoding name: '@RJBS/SingleEncoding' version: '4.018' - class: Pod::Weaver::Section::Name name: '@RJBS/Name' version: '4.018' - class: Pod::Weaver::Section::Version name: '@RJBS/Version' version: '4.018' - class: Pod::Weaver::Section::Region name: '@RJBS/Prelude' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Synopsis' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Description' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Overview' version: '4.018' - class: Pod::Weaver::Section::Generic name: '@RJBS/Stability' version: '4.018' - class: Pod::Weaver::Section::GenerateSection name: '@RJBS/PerlSupport' version: '4.018' - class: Pod::Weaver::Section::Collect name: Attributes version: '4.018' - class: Pod::Weaver::Section::Collect name: Methods version: '4.018' - class: Pod::Weaver::Section::Collect name: Functions version: '4.018' - class: Pod::Weaver::Section::Leftovers name: '@RJBS/Leftovers' version: '4.018' - class: Pod::Weaver::Section::Region name: '@RJBS/postlude' version: '4.018' - class: Pod::Weaver::Section::Authors name: '@RJBS/Authors' version: '4.018' - class: Pod::Weaver::Section::Contributors name: '@RJBS/Contributors' version: '0.009' - class: Pod::Weaver::Section::Legal name: '@RJBS/Legal' version: '4.018' - class: Pod::Weaver::Plugin::Transformer name: '@RJBS/List' version: '4.018' name: '@RJBS/PodWeaver' version: '4.009' - class: Dist::Zilla::Plugin::RJBSMisc name: '@RJBS/RJBSMisc' version: '5.020' - class: Dist::Zilla::Plugin::GithubMeta name: '@RJBS/GithubMeta' version: '0.58' - class: Dist::Zilla::Plugin::Git::Check config: Dist::Zilla::Plugin::Git::Check: untracked_files: die Dist::Zilla::Role::Git::DirtyFiles: allow_dirty: - Changes - dist.ini allow_dirty_match: [] changelog: Changes Dist::Zilla::Role::Git::Repo: git_version: 2.38.0 repo_root: . name: '@RJBS/@Git/Check' version: '2.048' - class: Dist::Zilla::Plugin::Git::Commit config: Dist::Zilla::Plugin::Git::Commit: add_files_in: [] commit_msg: v%V%n%n%c signoff: 0 Dist::Zilla::Role::Git::DirtyFiles: allow_dirty: - Changes - dist.ini allow_dirty_match: [] changelog: Changes Dist::Zilla::Role::Git::Repo: git_version: 2.38.0 repo_root: . Dist::Zilla::Role::Git::StringFormatter: time_zone: local name: '@RJBS/@Git/Commit' version: '2.048' - class: Dist::Zilla::Plugin::Git::Tag config: Dist::Zilla::Plugin::Git::Tag: branch: ~ changelog: Changes signed: 0 tag: '0.140003' tag_format: '%v' tag_message: v%V Dist::Zilla::Role::Git::Repo: git_version: 2.38.0 repo_root: . Dist::Zilla::Role::Git::StringFormatter: time_zone: local name: '@RJBS/@Git/Tag' version: '2.048' - class: Dist::Zilla::Plugin::Git::Push config: Dist::Zilla::Plugin::Git::Push: push_to: - 'github :' remotes_must_exist: 0 Dist::Zilla::Role::Git::Repo: git_version: 2.38.0 repo_root: . name: '@RJBS/@Git/Push' version: '2.048' - class: Dist::Zilla::Plugin::Git::Contributors config: Dist::Zilla::Plugin::Git::Contributors: git_version: 2.38.0 include_authors: 0 include_releaser: 1 order_by: name paths: [] name: '@RJBS/Git::Contributors' version: '0.036' - class: Dist::Zilla::Plugin::FinderCode name: ':InstallModules' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':IncModules' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':TestFiles' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':ExtraTestFiles' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':ExecFiles' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':PerlExecFiles' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':ShareFiles' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':MainModule' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':AllFiles' version: '6.029' - class: Dist::Zilla::Plugin::FinderCode name: ':NoFiles' version: '6.029' zilla: class: Dist::Zilla::Dist::Builder config: is_trial: 0 version: '6.029' x_contributors: - 'Ricardo SIGNES ' - 'Ricardo Signes ' x_generated_by_perl: v5.37.2 x_rjbs_perl_window: long-term x_serialization_backend: 'YAML::Tiny version 1.73' x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later' Mixin-ExtraFields-0.140003/lib/000755 000765 000024 00000000000 14354077610 016115 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/Makefile.PL000644 000765 000024 00000003046 14354077610 017324 0ustar00rjbsstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.029. use strict; use warnings; use 5.012; use ExtUtils::MakeMaker 6.78; my %WriteMakefileArgs = ( "ABSTRACT" => "add extra stashes of data to your objects", "AUTHOR" => "Ricardo Signes ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.78" }, "DISTNAME" => "Mixin-ExtraFields", "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.012", "NAME" => "Mixin::ExtraFields", "PREREQ_PM" => { "Carp" => 0, "Scalar::Util" => 0, "String::RewritePrefix" => 0, "Sub::Exporter" => "0.972", "Sub::Install" => 0, "parent" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Test::More" => "0.96", "base" => 0, "lib" => 0 }, "VERSION" => "0.140003", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "Scalar::Util" => 0, "String::RewritePrefix" => 0, "Sub::Exporter" => "0.972", "Sub::Install" => 0, "Test::More" => "0.96", "base" => 0, "lib" => 0, "parent" => 0, "strict" => 0, "warnings" => 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); Mixin-ExtraFields-0.140003/META.json000644 000765 000024 00000044741 14354077610 017002 0ustar00rjbsstaff000000 000000 { "abstract" : "add extra stashes of data to your objects", "author" : [ "Ricardo Signes " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 6.029, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Mixin-ExtraFields", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.78" } }, "develop" : { "requires" : { "Encode" : "0", "Test::More" : "0", "Test::Pod" : "1.41" } }, "runtime" : { "requires" : { "Carp" : "0", "Scalar::Util" : "0", "String::RewritePrefix" : "0", "Sub::Exporter" : "0.972", "Sub::Install" : "0", "parent" : "0", "perl" : "5.012", "strict" : "0", "warnings" : "0" } }, "test" : { "recommends" : { "CPAN::Meta" : "2.120900" }, "requires" : { "ExtUtils::MakeMaker" : "0", "File::Spec" : "0", "Test::More" : "0.96", "base" : "0", "lib" : "0" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/rjbs/Mixin-ExtraFields/issues" }, "homepage" : "https://github.com/rjbs/Mixin-ExtraFields", "repository" : { "type" : "git", "url" : "https://github.com/rjbs/Mixin-ExtraFields.git", "web" : "https://github.com/rjbs/Mixin-ExtraFields" } }, "version" : "0.140003", "x_Dist_Zilla" : { "perl" : { "version" : "5.037002" }, "plugins" : [ { "class" : "Dist::Zilla::Plugin::Git::GatherDir", "config" : { "Dist::Zilla::Plugin::GatherDir" : { "exclude_filename" : [], "exclude_match" : [], "follow_symlinks" : 0, "include_dotfiles" : 0, "prefix" : "", "prune_directory" : [], "root" : "." }, "Dist::Zilla::Plugin::Git::GatherDir" : { "include_untracked" : 0 } }, "name" : "@RJBS/Git::GatherDir", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::CheckPrereqsIndexed", "name" : "@RJBS/CheckPrereqsIndexed", "version" : "0.021" }, { "class" : "Dist::Zilla::Plugin::CheckExtraTests", "name" : "@RJBS/CheckExtraTests", "version" : "0.029" }, { "class" : "Dist::Zilla::Plugin::PromptIfStale", "config" : { "Dist::Zilla::Plugin::PromptIfStale" : { "check_all_plugins" : 0, "check_all_prereqs" : 0, "modules" : [ "Dist::Zilla::PluginBundle::RJBS" ], "phase" : "build", "run_under_travis" : 0, "skip" : [] } }, "name" : "@RJBS/RJBS-Outdated", "version" : "0.057" }, { "class" : "Dist::Zilla::Plugin::PromptIfStale", "config" : { "Dist::Zilla::Plugin::PromptIfStale" : { "check_all_plugins" : 1, "check_all_prereqs" : 0, "modules" : [], "phase" : "release", "run_under_travis" : 0, "skip" : [ "Dist::Zilla::Plugin::RJBSMisc" ] } }, "name" : "@RJBS/CPAN-Outdated", "version" : "0.057" }, { "class" : "Dist::Zilla::Plugin::PruneCruft", "name" : "@RJBS/@Filter/PruneCruft", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::ManifestSkip", "name" : "@RJBS/@Filter/ManifestSkip", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::MetaYAML", "name" : "@RJBS/@Filter/MetaYAML", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::License", "name" : "@RJBS/@Filter/License", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::Readme", "name" : "@RJBS/@Filter/Readme", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::ExecDir", "name" : "@RJBS/@Filter/ExecDir", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::ShareDir", "name" : "@RJBS/@Filter/ShareDir", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::Manifest", "name" : "@RJBS/@Filter/Manifest", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::TestRelease", "name" : "@RJBS/@Filter/TestRelease", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::ConfirmRelease", "name" : "@RJBS/@Filter/ConfirmRelease", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::UploadToCPAN", "name" : "@RJBS/@Filter/UploadToCPAN", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::MakeMaker", "config" : { "Dist::Zilla::Role::TestRunner" : { "default_jobs" : 9 } }, "name" : "@RJBS/MakeMaker", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::AutoPrereqs", "name" : "@RJBS/AutoPrereqs", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::Git::NextVersion", "config" : { "Dist::Zilla::Plugin::Git::NextVersion" : { "first_version" : "0.001", "version_by_branch" : 1, "version_regexp" : "(?^:^([0-9]+\\.[0-9]+)$)" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.38.0", "repo_root" : "." } }, "name" : "@RJBS/Git::NextVersion", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::PkgVersion", "name" : "@RJBS/PkgVersion", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::MetaConfig", "name" : "@RJBS/MetaConfig", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::MetaJSON", "name" : "@RJBS/MetaJSON", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::NextRelease", "name" : "@RJBS/NextRelease", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::Test::ChangesHasContent", "name" : "@RJBS/Test::ChangesHasContent", "version" : "0.011" }, { "class" : "Dist::Zilla::Plugin::PodSyntaxTests", "name" : "@RJBS/PodSyntaxTests", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::Test::ReportPrereqs", "name" : "@RJBS/Test::ReportPrereqs", "version" : "0.028" }, { "class" : "Dist::Zilla::Plugin::Git::Remote::Check", "name" : "@RJBS/Git::Remote::Check", "version" : "0.1.2" }, { "class" : "Dist::Zilla::Plugin::Prereqs", "config" : { "Dist::Zilla::Plugin::Prereqs" : { "phase" : "test", "type" : "requires" } }, "name" : "@RJBS/TestMoreWithSubtests", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::PodWeaver", "config" : { "Dist::Zilla::Plugin::PodWeaver" : { "config_plugins" : [ "@RJBS" ], "finder" : [ ":InstallModules", ":ExecFiles" ], "plugins" : [ { "class" : "Pod::Weaver::Plugin::EnsurePod5", "name" : "@CorePrep/EnsurePod5", "version" : "4.018" }, { "class" : "Pod::Weaver::Plugin::H1Nester", "name" : "@CorePrep/H1Nester", "version" : "4.018" }, { "class" : "Pod::Weaver::Plugin::SingleEncoding", "name" : "@RJBS/SingleEncoding", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Name", "name" : "@RJBS/Name", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Version", "name" : "@RJBS/Version", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Region", "name" : "@RJBS/Prelude", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Synopsis", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Description", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Overview", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Generic", "name" : "@RJBS/Stability", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::GenerateSection", "name" : "@RJBS/PerlSupport", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "Attributes", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "Methods", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Collect", "name" : "Functions", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Leftovers", "name" : "@RJBS/Leftovers", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Region", "name" : "@RJBS/postlude", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Authors", "name" : "@RJBS/Authors", "version" : "4.018" }, { "class" : "Pod::Weaver::Section::Contributors", "name" : "@RJBS/Contributors", "version" : "0.009" }, { "class" : "Pod::Weaver::Section::Legal", "name" : "@RJBS/Legal", "version" : "4.018" }, { "class" : "Pod::Weaver::Plugin::Transformer", "name" : "@RJBS/List", "version" : "4.018" } ] } }, "name" : "@RJBS/PodWeaver", "version" : "4.009" }, { "class" : "Dist::Zilla::Plugin::RJBSMisc", "name" : "@RJBS/RJBSMisc", "version" : "5.020" }, { "class" : "Dist::Zilla::Plugin::GithubMeta", "name" : "@RJBS/GithubMeta", "version" : "0.58" }, { "class" : "Dist::Zilla::Plugin::Git::Check", "config" : { "Dist::Zilla::Plugin::Git::Check" : { "untracked_files" : "die" }, "Dist::Zilla::Role::Git::DirtyFiles" : { "allow_dirty" : [ "Changes", "dist.ini" ], "allow_dirty_match" : [], "changelog" : "Changes" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.38.0", "repo_root" : "." } }, "name" : "@RJBS/@Git/Check", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Commit", "config" : { "Dist::Zilla::Plugin::Git::Commit" : { "add_files_in" : [], "commit_msg" : "v%V%n%n%c", "signoff" : 0 }, "Dist::Zilla::Role::Git::DirtyFiles" : { "allow_dirty" : [ "Changes", "dist.ini" ], "allow_dirty_match" : [], "changelog" : "Changes" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.38.0", "repo_root" : "." }, "Dist::Zilla::Role::Git::StringFormatter" : { "time_zone" : "local" } }, "name" : "@RJBS/@Git/Commit", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Tag", "config" : { "Dist::Zilla::Plugin::Git::Tag" : { "branch" : null, "changelog" : "Changes", "signed" : 0, "tag" : "0.140003", "tag_format" : "%v", "tag_message" : "v%V" }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.38.0", "repo_root" : "." }, "Dist::Zilla::Role::Git::StringFormatter" : { "time_zone" : "local" } }, "name" : "@RJBS/@Git/Tag", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Push", "config" : { "Dist::Zilla::Plugin::Git::Push" : { "push_to" : [ "github :" ], "remotes_must_exist" : 0 }, "Dist::Zilla::Role::Git::Repo" : { "git_version" : "2.38.0", "repo_root" : "." } }, "name" : "@RJBS/@Git/Push", "version" : "2.048" }, { "class" : "Dist::Zilla::Plugin::Git::Contributors", "config" : { "Dist::Zilla::Plugin::Git::Contributors" : { "git_version" : "2.38.0", "include_authors" : 0, "include_releaser" : 1, "order_by" : "name", "paths" : [] } }, "name" : "@RJBS/Git::Contributors", "version" : "0.036" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":InstallModules", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":IncModules", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":TestFiles", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExtraTestFiles", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ExecFiles", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":PerlExecFiles", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":ShareFiles", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":MainModule", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":AllFiles", "version" : "6.029" }, { "class" : "Dist::Zilla::Plugin::FinderCode", "name" : ":NoFiles", "version" : "6.029" } ], "zilla" : { "class" : "Dist::Zilla::Dist::Builder", "config" : { "is_trial" : 0 }, "version" : "6.029" } }, "x_contributors" : [ "Ricardo SIGNES ", "Ricardo Signes " ], "x_generated_by_perl" : "v5.37.2", "x_rjbs_perl_window" : "long-term", "x_serialization_backend" : "Cpanel::JSON::XS version 4.30", "x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later" } Mixin-ExtraFields-0.140003/dist.ini000644 000765 000024 00000000241 14354077610 017010 0ustar00rjbsstaff000000 000000 name = Mixin-ExtraFields author = Ricardo Signes license = Perl_5 copyright_holder = Ricardo Signes [@RJBS] perl-window = long-term Mixin-ExtraFields-0.140003/lib/Mixin/000755 000765 000024 00000000000 14354077610 017201 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/lib/Mixin/ExtraFields/000755 000765 000024 00000000000 14354077610 021413 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/lib/Mixin/ExtraFields.pm000644 000765 000024 00000054617 14354077610 021766 0ustar00rjbsstaff000000 000000 use strict; use warnings; package Mixin::ExtraFields 0.140003; # ABSTRACT: add extra stashes of data to your objects use Carp (); use String::RewritePrefix; #pod =head1 SYNOPSIS #pod #pod If you use the ExtraFields mixin in your class: #pod #pod package Corporate::WorkOrder; #pod #pod use Mixin::ExtraFields -fields => { #pod id => 'workorder_id', #pod moniker => 'note', #pod driver => { HashGuts => { hash_key => '_notes' } } #pod }; #pod #pod ...your objects will then have methods for manipulating their extra fields: #pod #pod my $workorder = Corporate::WorkOrder->retrieve(1234); #pod #pod if ($workorder->note_exists('debug_next')) { #pod warn $workorder->note_get('debug_next'); #pod $workorder->note_delete('debug_next'); #pod } #pod #pod if ($workorder->note_get('time_bomb')) { #pod $workorder->note_delete_all; #pod $workorder->note_set( #pod last_explosion => time, #pod explosion_cause => 'time bomb', #pod ); #pod } #pod #pod =head1 DESCRIPTION #pod #pod Sometimes your well-defined object needs a way to tack on arbirary extra #pod fields. This might be a set of session-specific ephemeral data, a stash of #pod settings that need to be easy to grow over time, or any sort of name-and-value #pod parameters. Adding more and more methods can be cumbersome, and may not be #pod helpful if the names vary greatly. Accessing an object's guts directly is #pod simple, but is difficult to control when subclassing, and can make altering #pod your object's structure difficult. #pod #pod Mixin::ExtraFields provides a simple way to add an arbitrary number of stashes #pod for named data. These data can be stored in the object, in a database, or #pod anywhere else. The storage mechanism is abstracted away from the provided #pod interface, so one storage mechanism can be easily swapped for another. #pod Multiple ExtraFields stashes can be mixed into one class, using one or many #pod storage mechanisms. #pod #pod =head1 MIXING IN #pod #pod To create a stash of extra fields, just C Mixin::ExtraFields and import #pod the C group like this: #pod #pod use Mixin::ExtraFields -fields => { driver => 'SomeDriver' }; #pod #pod The only argument required for the group is C, which names the driver #pod (storage mechanism) to use. For more information, see L, #pod below. #pod #pod Other valid arguments are: #pod #pod id - the name of the method to call on objects to get their unique identifier #pod default: id; an explicit undef will use each object's reference addr #pod #pod moniker - the name to use in forming mixed-in method names #pod default: extra #pod #pod =head2 Specifying a Driver #pod #pod The C argument can be given as either a driver identifier or a #pod reference to a hash of options. If given as a hash reference, one of the #pod entries in the hash must be C, giving the driver identifier for the #pod driver. #pod #pod A driver identifier must be either: #pod #pod =over #pod #pod =item * an object of a class descended from the driver base class #pod #pod =item * a partial class name, to follow the driver base class name #pod #pod =item * a full class name, prepended with + #pod #pod =back #pod #pod The driver base class is provided by the C> method. In #pod almost all cases, it will be C. #pod #pod =head1 GENERATED METHODS #pod #pod The default implementation of Mixin::ExtraFields provides a number of methods #pod for accessing the extras. #pod #pod Wherever "extra" appears in the following method names, the C argument #pod given to the C group will be used instead. For example, if the use #pod statement looked like this: #pod #pod use Mixin::ExtraFields -fields => { moniker => 'info', driver => 'HashGuts' }; #pod #pod ...then a method called C would be generated, rather than #pod C. The C group also respects renaming options documented #pod in L. #pod #pod =head2 exists_extra #pod #pod if ($obj->exists_extra($name)) { ... } #pod #pod This method returns true if there is an entry in the extras for the given name. #pod #pod =head2 get_extra #pod #pod =head2 get_detailed_extra #pod #pod my $value = $obj->get_extra($name); #pod #pod my $value_hash = $obj->get_detailed_extra($name); #pod #pod These methods return the entry for the given name. If none exists, the method #pod returns undef. The detailed version of this method will return a hashref #pod describing all information available about the entry. While this information #pod is driver-specific, it is required to have an entry for the key C, #pod providing the value that would have been returned by C. #pod #pod =head2 get_all_extra #pod #pod =head2 get_all_detailed_extra #pod #pod my %extra = $obj->get_all_extra; #pod #pod my %extra_hash = $obj->get_all_detailed_extra; #pod #pod These methods return a list of name/value pairs. The values are in the same #pod form as those returned by the get-by-name methods, above. #pod #pod =head2 get_all_extra_names #pod #pod my @names = $obj->get_all_extra_names; #pod #pod This method returns the names of all existing extras. #pod #pod =head2 set_extra #pod #pod $obj->set_extra($name => $value); #pod #pod This method sets the given extra. If no entry existed before, one is created. #pod If one existed for this name, it is replaced. #pod #pod =head2 delete_extra #pod #pod $obj->delete_extra($name); #pod #pod This method deletes the named entry. After deletion, no entry will exist for #pod that name. #pod #pod =head2 delete_all_extra #pod #pod $obj->delete_all_extra; #pod #pod This method deletes all entries for the object. #pod #pod =cut #pod =head1 SUBCLASSING #pod #pod Mixin::ExtraFields can be subclassed to produce different methods, provide #pod different names, or behave differently in other ways. Subclassing #pod Mixin::ExtraFields can produce many distinct and powerful tools. #pod #pod None of the generated methods, above, are implemented in Mixin::ExtraFields. #pod The methods below are its actual methods, which work together to build and #pod export the methods that are mixed in. These are the methods you should #pod override when subclassing Mixin::ExtraFields. #pod #pod For information on writing drivers, see L. #pod #pod =cut #pod =begin wishful_thinking #pod #pod Wouldn't that be super? Too bad that I can't defer the calling of this method #pod until C is called. #pod #pod =head2 default_group_name #pod #pod my $name = Mixin::ExtraFields->default_group_name; #pod #pod This method returns the name to be used as the exported group. It defaults to #pod "fields". By overriding this to return, for example, "stuff," your module #pod could be used as follows: #pod #pod use Mixin::ExtraFields::Subclass -stuff => { moniker => "things" }; #pod #pod =end wishful_thinking #pod #pod =cut use Sub::Exporter 0.972 -setup => { groups => [ fields => \'gen_fields_group', ], }; #pod =head2 default_moniker #pod #pod This method returns the default moniker. The default default moniker defaults #pod to the default "extra". #pod #pod =cut sub default_moniker { 'extra' } #pod =head2 methods #pod #pod This method returns a list of base method names to construct and install. #pod These method names will be transformed into the installed method names via #pod C>. #pod #pod my @methods = Mixin::ExtraFields->methods; #pod #pod =cut sub methods { qw( exists get_detailed get_all_detailed get get_all get_all_names set delete delete_all ) } #pod =head2 method_name #pod #pod my $method_name = Mixin::ExtraFields->method_name($method_base, $moniker); #pod #pod This method returns the method name that will be installed into the importing #pod class. Its default behavior is to join the method base (which comes from the #pod C> method) and the moniker with an underscore, more or less. #pod #pod =cut sub method_name { my ($self, $method, $moniker) = @_; return "get_all_$moniker\_names" if $method eq 'get_all_names'; return "$method\_$moniker"; } #pod =head2 driver_method_name #pod #pod This method returns the name of the driver method used to implement the given #pod method name. This is primarily useful in the default implementation of #pod MixinExtraFields, where there is a one-to-one correspondence between installed #pod methods and driver methods. #pod #pod Changing this method could very easily cause incompatibility with standard #pod driver classes, and should only be done by the wise, brave, or reckless. #pod #pod =cut sub driver_method_name { my ($self, $method) = @_; $self->method_name($method, 'extra'); } #pod =head2 gen_fields_group #pod #pod my $sub_href = Mixin::ExtraFields->gen_fields_group($name, \%arg, \%col); #pod #pod This method is a group generator, as used by L and described in #pod its documentation. It is the method you are least likely to subclass. #pod #pod =cut sub gen_fields_group { my ($class, $name, $arg, $col) = @_; $arg->{driver} ||= $class->default_driver_arg; my $driver = $class->build_driver($arg->{driver}); my $id_method; if (exists $arg->{id} and defined $arg->{id}) { $id_method = $arg->{id}; } elsif (exists $arg->{id}) { require Scalar::Util; $id_method = \&Scalar::Util::refaddr; } else { $id_method = 'id'; } my $moniker = $arg->{moniker} || $class->default_moniker; my %method; for my $method_name ($class->methods) { my $install_method = $class->method_name($method_name, $moniker); $method{ $install_method } = $class->build_method( $method_name, { id_method => \$id_method, driver => \$driver, moniker => \$moniker, # So that things can refer to one another } ); } return \%method; } #pod =head2 build_method #pod #pod my $code = Mixin::ExtraFields->build_method($method_name, \%arg); #pod #pod This routine builds the requested method. It is passed a method name in the #pod form returned by the C method and a hashref of the following data: #pod #pod id_method - the method to call on objects to get their unique id #pod driver - the storage driver #pod moniker - the moniker of the set of extras being built #pod #pod B The values for the above arguments are references to the values you'd #pod expect. That is, if the id method is "foo" you will be given an reference to #pod the string foo. (This reduces the copies of common values that will be enclosed #pod into generated code.) #pod #pod =cut sub build_method { my ($self, $method_name, $arg) = @_; # Remember that these are all passed in as references, to avoid unneeded # copying. -- rjbs, 2006-12-07 my $id_method = $arg->{id_method}; my $driver = $arg->{driver}; my $driver_method = $self->driver_method_name($method_name); return sub { my $object = shift; my $id = $object->$$id_method; Carp::confess "couldn't determine id for object" unless defined $id; $$driver->$driver_method($object, $id, @_); }; } #pod =head2 default_driver_arg #pod #pod my $arg = Mixin::ExtraFields->default_driver_arg; #pod #pod This method a default value for the C argument to the fields group #pod generator. By default, this method will croak if called. #pod #pod =cut sub default_driver_arg { my ($class) = shift; Carp::croak "no driver supplied to $class"; } #pod =head2 build_driver #pod #pod my $driver = Mixin::ExtraFields->build_driver($arg); #pod #pod This method constructs and returns the driver object to be used by the #pod generated methods. It is passed the C argument given in the importing #pod code's C statement. #pod #pod =cut sub build_driver { my ($self, $arg) = @_; return $arg if Params::Util::_INSTANCE($arg, $self->driver_base_class); my ($driver_class, $driver_args) = $self->_driver_class_and_args($arg); Carp::croak("invalid class name for driver: $driver_class") unless Params::Util::_CLASS($driver_class); eval "require $driver_class; 1" or Carp::croak $@; my $driver = $driver_class->from_args($driver_args); } sub _driver_class_and_args { my ($self, $arg) = @_; my $class; if (ref $arg) { $class = delete $arg->{class}; } else { $class = $arg; $arg = {}; } $class = String::RewritePrefix->rewrite( { '+' => '', '=' => '', '' => $self->driver_base_class . '::', }, $class, ); return $class, $arg; } #pod =head2 driver_base_class #pod #pod This is the name of the name of the class which drivers are expected to #pod subclass. By default it returns C. #pod #pod =cut sub driver_base_class { 'Mixin::ExtraFields::Driver' } #pod =head1 TODO #pod #pod =over #pod #pod =item * handle invocants without ids (classes) and drivers that don't need ids #pod #pod =back #pod #pod =cut 1; __END__ =pod =encoding UTF-8 =head1 NAME Mixin::ExtraFields - add extra stashes of data to your objects =head1 VERSION version 0.140003 =head1 SYNOPSIS If you use the ExtraFields mixin in your class: package Corporate::WorkOrder; use Mixin::ExtraFields -fields => { id => 'workorder_id', moniker => 'note', driver => { HashGuts => { hash_key => '_notes' } } }; ...your objects will then have methods for manipulating their extra fields: my $workorder = Corporate::WorkOrder->retrieve(1234); if ($workorder->note_exists('debug_next')) { warn $workorder->note_get('debug_next'); $workorder->note_delete('debug_next'); } if ($workorder->note_get('time_bomb')) { $workorder->note_delete_all; $workorder->note_set( last_explosion => time, explosion_cause => 'time bomb', ); } =head1 DESCRIPTION Sometimes your well-defined object needs a way to tack on arbirary extra fields. This might be a set of session-specific ephemeral data, a stash of settings that need to be easy to grow over time, or any sort of name-and-value parameters. Adding more and more methods can be cumbersome, and may not be helpful if the names vary greatly. Accessing an object's guts directly is simple, but is difficult to control when subclassing, and can make altering your object's structure difficult. Mixin::ExtraFields provides a simple way to add an arbitrary number of stashes for named data. These data can be stored in the object, in a database, or anywhere else. The storage mechanism is abstracted away from the provided interface, so one storage mechanism can be easily swapped for another. Multiple ExtraFields stashes can be mixed into one class, using one or many storage mechanisms. =head1 PERL VERSION This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years. Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. =head1 MIXING IN To create a stash of extra fields, just C Mixin::ExtraFields and import the C group like this: use Mixin::ExtraFields -fields => { driver => 'SomeDriver' }; The only argument required for the group is C, which names the driver (storage mechanism) to use. For more information, see L, below. Other valid arguments are: id - the name of the method to call on objects to get their unique identifier default: id; an explicit undef will use each object's reference addr moniker - the name to use in forming mixed-in method names default: extra =head2 Specifying a Driver The C argument can be given as either a driver identifier or a reference to a hash of options. If given as a hash reference, one of the entries in the hash must be C, giving the driver identifier for the driver. A driver identifier must be either: =over =item * an object of a class descended from the driver base class =item * a partial class name, to follow the driver base class name =item * a full class name, prepended with + =back The driver base class is provided by the C> method. In almost all cases, it will be C. =head1 GENERATED METHODS The default implementation of Mixin::ExtraFields provides a number of methods for accessing the extras. Wherever "extra" appears in the following method names, the C argument given to the C group will be used instead. For example, if the use statement looked like this: use Mixin::ExtraFields -fields => { moniker => 'info', driver => 'HashGuts' }; ...then a method called C would be generated, rather than C. The C group also respects renaming options documented in L. =head2 exists_extra if ($obj->exists_extra($name)) { ... } This method returns true if there is an entry in the extras for the given name. =head2 get_extra =head2 get_detailed_extra my $value = $obj->get_extra($name); my $value_hash = $obj->get_detailed_extra($name); These methods return the entry for the given name. If none exists, the method returns undef. The detailed version of this method will return a hashref describing all information available about the entry. While this information is driver-specific, it is required to have an entry for the key C, providing the value that would have been returned by C. =head2 get_all_extra =head2 get_all_detailed_extra my %extra = $obj->get_all_extra; my %extra_hash = $obj->get_all_detailed_extra; These methods return a list of name/value pairs. The values are in the same form as those returned by the get-by-name methods, above. =head2 get_all_extra_names my @names = $obj->get_all_extra_names; This method returns the names of all existing extras. =head2 set_extra $obj->set_extra($name => $value); This method sets the given extra. If no entry existed before, one is created. If one existed for this name, it is replaced. =head2 delete_extra $obj->delete_extra($name); This method deletes the named entry. After deletion, no entry will exist for that name. =head2 delete_all_extra $obj->delete_all_extra; This method deletes all entries for the object. =head1 SUBCLASSING Mixin::ExtraFields can be subclassed to produce different methods, provide different names, or behave differently in other ways. Subclassing Mixin::ExtraFields can produce many distinct and powerful tools. None of the generated methods, above, are implemented in Mixin::ExtraFields. The methods below are its actual methods, which work together to build and export the methods that are mixed in. These are the methods you should override when subclassing Mixin::ExtraFields. For information on writing drivers, see L. =begin wishful_thinking Wouldn't that be super? Too bad that I can't defer the calling of this method until C is called. =head2 default_group_name my $name = Mixin::ExtraFields->default_group_name; This method returns the name to be used as the exported group. It defaults to "fields". By overriding this to return, for example, "stuff," your module could be used as follows: use Mixin::ExtraFields::Subclass -stuff => { moniker => "things" }; =end wishful_thinking =head2 default_moniker This method returns the default moniker. The default default moniker defaults to the default "extra". =head2 methods This method returns a list of base method names to construct and install. These method names will be transformed into the installed method names via C>. my @methods = Mixin::ExtraFields->methods; =head2 method_name my $method_name = Mixin::ExtraFields->method_name($method_base, $moniker); This method returns the method name that will be installed into the importing class. Its default behavior is to join the method base (which comes from the C> method) and the moniker with an underscore, more or less. =head2 driver_method_name This method returns the name of the driver method used to implement the given method name. This is primarily useful in the default implementation of MixinExtraFields, where there is a one-to-one correspondence between installed methods and driver methods. Changing this method could very easily cause incompatibility with standard driver classes, and should only be done by the wise, brave, or reckless. =head2 gen_fields_group my $sub_href = Mixin::ExtraFields->gen_fields_group($name, \%arg, \%col); This method is a group generator, as used by L and described in its documentation. It is the method you are least likely to subclass. =head2 build_method my $code = Mixin::ExtraFields->build_method($method_name, \%arg); This routine builds the requested method. It is passed a method name in the form returned by the C method and a hashref of the following data: id_method - the method to call on objects to get their unique id driver - the storage driver moniker - the moniker of the set of extras being built B The values for the above arguments are references to the values you'd expect. That is, if the id method is "foo" you will be given an reference to the string foo. (This reduces the copies of common values that will be enclosed into generated code.) =head2 default_driver_arg my $arg = Mixin::ExtraFields->default_driver_arg; This method a default value for the C argument to the fields group generator. By default, this method will croak if called. =head2 build_driver my $driver = Mixin::ExtraFields->build_driver($arg); This method constructs and returns the driver object to be used by the generated methods. It is passed the C argument given in the importing code's C statement. =head2 driver_base_class This is the name of the name of the class which drivers are expected to subclass. By default it returns C. =head1 TODO =over =item * handle invocants without ids (classes) and drivers that don't need ids =back =head1 AUTHOR Ricardo Signes =head1 CONTRIBUTORS =for stopwords Ricardo SIGNES Signes =over 4 =item * Ricardo SIGNES =item * Ricardo Signes =back =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2022 by Ricardo Signes. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut Mixin-ExtraFields-0.140003/lib/Mixin/ExtraFields/Driver/000755 000765 000024 00000000000 14354077610 022646 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/lib/Mixin/ExtraFields/Driver.pm000644 000765 000024 00000023224 14354077610 023207 0ustar00rjbsstaff000000 000000 use strict; use warnings; package Mixin::ExtraFields::Driver 0.140003; # ABSTRACT: a backend for extra field storage use Carp (); use Sub::Install (); #pod =head1 SYNOPSIS #pod #pod This is really not something you'd use on your own, it's just used by #pod Mixin::ExtraFields, but if you insist... #pod #pod my $driver = Mixin::ExtraFields::Driver::Phlogiston->from_args(\%arg); #pod #pod $driver->set($obj, $obj_id, flammable => "very!"); #pod #pod =head1 DESCRIPTION #pod #pod Mixin::ExtraFields::Driver is a base class for drivers used by #pod Mixin::ExtraFields -- hence the name. A driver is expected to store and #pod retrieve data keyed to an object and a name or key. It can store this in any #pod way it likes, and does not need to guarantee persistence across processes. #pod #pod =head1 SUBCLASSING #pod #pod All drivers must implement the four methods listed below. The base class has #pod implementations of these methods which will die noisily (C-ing) when #pod called. #pod #pod Almost all methods are passed the same data as their first two arguments: #pod C<$object>, the object for which the driver is to find or alter data, and #pod C<$id>, that object's unique id. While this may be slighly redundant, it keeps #pod the id-finding call in one place. #pod #pod =head2 from_args #pod #pod my $driver = Mixin::ExtraFields::Driver::Subclass->from_args(\%arg); #pod #pod This method must return a driver object appropriate to the given args. It is #pod not called C because it need not return a new object for each call to it. #pod Returning identical objects for identical configurations may be safe for some #pod driver implementations, and it is expressly allowed. #pod #pod The arguments passed to this method are those given as the C option to #pod the C import group in Mixin::ExtraFields, less the C option. #pod #pod =head2 get_all_detailed_extra #pod #pod my %extra = $driver->get_all_detailed_extra($object, $id); #pod #pod This method must return all available information about all existing extra #pod fields for the given object. It must be returned as a list of name/value #pod pairs. The values must be references to hashes. Each hash must have an entry #pod for the key C giving the value for that name. #pod #pod =head2 set_extra #pod #pod $driver->set_extra($object, $id, $name, $value); #pod #pod This method must set the named extra to the given value. #pod #pod =head2 delete_extra #pod #pod $driver->delete_extra($object, $id, $name); #pod #pod This method must delete the named extra, causing it to cease to exist. #pod #pod =cut BEGIN { for my $name (qw(from_args get_all_detailed_extra set_extra delete_extra)) { Sub::Install::install_sub({ as => $name, code => sub { Carp::confess "method $name called but not implemented!" }, }); } } #pod =head1 OPTIMIZING #pod #pod The methods below can all be implemented in terms of those above. If they are #pod not provided by the subclass, basic implementations exist. These #pod implementations may be less efficient than implementations crafted for the #pod specifics of the storage engine behind the driver, so authors of driver #pod subclasses should consider implementing these methods. #pod #pod =head2 get_all_extra #pod #pod my %extra = $driver->get_all_extra($object, $id); #pod #pod This method behaves like C, above, but provides the #pod entry's value, not a detailed hashref, as the value for each entry. #pod #pod =cut sub get_all_extra { my ($self, $object, $id) = @_; my %extra = $self->get_all_detailed_extra($object, $id); my @simple = map { $_ => $extra{$_}{value} } keys %extra; } #pod =head2 get_extra #pod #pod =head2 get_detailed_extra #pod #pod my $value = $driver->get_extra($object, $id, $name); #pod #pod my $hash = $driver->get_detailed_extra($object, $id, $name); #pod #pod These methods return a single value requested by name, either as the value #pod itself or a detailed hashref describing it. #pod #pod =cut sub get_extra { my ($self, $object, $id, $name) = @_; my $extra = $self->get_detailed_extra($object, $id, $name); return $extra ? $extra->{value} : (); } sub get_detailed_extra { my ($self, $object, $id, $name) = @_; my %extra = $self->get_all_detailed_extra($object, $id); return exists $extra{$name} ? $extra{$name} : (); } #pod =head2 get_all_extra_names #pod #pod my @names = $driver->get_all_extra_names($object, $id); #pod #pod This method returns the names of all existing extras for the given object. #pod #pod =cut sub get_all_extra_names { my ($self, $object, $id) = @_; my %extra = $self->get_all_detailed_extra($object, $id); return keys %extra; } #pod =head2 exists_extra #pod #pod if ($driver->exists_extra($object, $id, $name)) { ... } #pod #pod This method returns true if an entry exists for the given name and false #pod otherwise. #pod #pod =cut sub exists_extra { my ($self, $object, $id, $name) = @_; my %extra = $self->get_all_detailed_extra($object, $id); return exists $extra{ $name }; } #pod =head2 delete_all_extra #pod #pod $driver->delete_all_extra($object, $id); #pod #pod This method deletes all extras for the object, as per the C #pod method. #pod #pod =cut sub delete_all_extra { my ($self, $object, $id) = @_; for my $name ($self->get_all_extra_names($object, $id)) { $self->delete_extra($object, $id, $name); } } 1; __END__ =pod =encoding UTF-8 =head1 NAME Mixin::ExtraFields::Driver - a backend for extra field storage =head1 VERSION version 0.140003 =head1 SYNOPSIS This is really not something you'd use on your own, it's just used by Mixin::ExtraFields, but if you insist... my $driver = Mixin::ExtraFields::Driver::Phlogiston->from_args(\%arg); $driver->set($obj, $obj_id, flammable => "very!"); =head1 DESCRIPTION Mixin::ExtraFields::Driver is a base class for drivers used by Mixin::ExtraFields -- hence the name. A driver is expected to store and retrieve data keyed to an object and a name or key. It can store this in any way it likes, and does not need to guarantee persistence across processes. =head1 PERL VERSION This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years. Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. =head1 SUBCLASSING All drivers must implement the four methods listed below. The base class has implementations of these methods which will die noisily (C-ing) when called. Almost all methods are passed the same data as their first two arguments: C<$object>, the object for which the driver is to find or alter data, and C<$id>, that object's unique id. While this may be slighly redundant, it keeps the id-finding call in one place. =head2 from_args my $driver = Mixin::ExtraFields::Driver::Subclass->from_args(\%arg); This method must return a driver object appropriate to the given args. It is not called C because it need not return a new object for each call to it. Returning identical objects for identical configurations may be safe for some driver implementations, and it is expressly allowed. The arguments passed to this method are those given as the C option to the C import group in Mixin::ExtraFields, less the C option. =head2 get_all_detailed_extra my %extra = $driver->get_all_detailed_extra($object, $id); This method must return all available information about all existing extra fields for the given object. It must be returned as a list of name/value pairs. The values must be references to hashes. Each hash must have an entry for the key C giving the value for that name. =head2 set_extra $driver->set_extra($object, $id, $name, $value); This method must set the named extra to the given value. =head2 delete_extra $driver->delete_extra($object, $id, $name); This method must delete the named extra, causing it to cease to exist. =head1 OPTIMIZING The methods below can all be implemented in terms of those above. If they are not provided by the subclass, basic implementations exist. These implementations may be less efficient than implementations crafted for the specifics of the storage engine behind the driver, so authors of driver subclasses should consider implementing these methods. =head2 get_all_extra my %extra = $driver->get_all_extra($object, $id); This method behaves like C, above, but provides the entry's value, not a detailed hashref, as the value for each entry. =head2 get_extra =head2 get_detailed_extra my $value = $driver->get_extra($object, $id, $name); my $hash = $driver->get_detailed_extra($object, $id, $name); These methods return a single value requested by name, either as the value itself or a detailed hashref describing it. =head2 get_all_extra_names my @names = $driver->get_all_extra_names($object, $id); This method returns the names of all existing extras for the given object. =head2 exists_extra if ($driver->exists_extra($object, $id, $name)) { ... } This method returns true if an entry exists for the given name and false otherwise. =head2 delete_all_extra $driver->delete_all_extra($object, $id); This method deletes all extras for the object, as per the C method. =head1 AUTHOR Ricardo Signes =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2022 by Ricardo Signes. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut Mixin-ExtraFields-0.140003/lib/Mixin/ExtraFields/Driver/HashGuts.pm000644 000765 000024 00000015304 14354077610 024735 0ustar00rjbsstaff000000 000000 use strict; use warnings; package Mixin::ExtraFields::Driver::HashGuts 0.140003; use parent qw(Mixin::ExtraFields::Driver); # ABSTRACT: store extras in a hashy object's guts #pod =head1 SYNOPSIS #pod #pod package Your::HashBased::Class; #pod #pod use Mixin::ExtraFields -fields => { driver => 'HashGuts' }; #pod #pod =head1 DESCRIPTION #pod #pod This driver class implements an extremely simple storage mechanism: extras are #pod stored on the object on which the mixed-in methods are called. By default, #pod they are stored under the key returned by the C> method, #pod but this can be changed by providing a C argument to the driver #pod configuration, like so: #pod #pod use Mixin::ExtraFields -fields => { #pod driver => { class => 'HashGuts', hash_key => "\0Something\0Wicked\0" } #pod }; #pod #pod =head1 METHODS #pod #pod In addition to the methods required by Mixin::ExtraFields::Driver, the #pod following methods are provided: #pod #pod =head2 hash_key #pod #pod my $key = $driver->hash_key; #pod #pod This method returns the key where the driver will store its extras. #pod #pod =cut sub hash_key { my ($self) = @_; return $self->{hash_key}; } #pod =head2 default_hash_key #pod #pod If no C argument is given for the driver, this method is called #pod during driver initialization. It will return a unique string to be used as the #pod hash key. #pod #pod =cut my $i = 0; sub default_hash_key { my ($self) = @_; return "$self" . '@' . $i++; } #pod =head2 storage #pod #pod This method returns the hashref of storage used for extras. Individual objects #pod get weak references to their id within this hashref. #pod #pod =cut sub storage { $_[0]->{storage} } #pod =head2 storage_for #pod #pod my $stash = $driver->storage_for($object, $id); #pod #pod This method returns the hashref to use to store extras for the given object and #pod id. This hashref is stored on both the hash-based object (in its C #pod entry) and on the driver (in the entry for C<$id> in its C hash). #pod #pod All objects with the same id should end up with the same hash in their #pod C field. B of these references are weakened, which means two #pod things: first, even if all objects with a given id go out of scope, future #pod objects with that id will retain the original extras; secondly, memory used to #pod store extras is never reclaimed. If this is a problem, use a more #pod sophisticated driver. #pod #pod =cut sub storage_for { my ($self, $object, $id) = @_; my $store = $self->storage->{ $id } ||= {}; unless ($object->{ $self->hash_key }||0 == $store) { $object->{ $self->hash_key } ||= $store; } return $store } sub from_args { my ($class, $arg) = @_; my $self = bless { storage => {} } => $class; $self->{hash_key} = $arg->{hash_key} || $self->default_hash_key; return $self; } sub exists_extra { my ($self, $object, $id, $name) = @_; return exists $self->storage_for($object, $id)->{$name}; } sub get_extra { my ($self, $object, $id, $name) = @_; # avoid autovivifying entries on get. return unless $self->exists_extra($object, $id, $name); return $self->storage_for($object, $id)->{$name}; } sub get_detailed_extra { my ($self, $object, $id, $name) = @_; # avoid autovivifying entries on get. return unless $self->exists_extra($object, $id, $name); return { value => $self->storage_for($object, $id)->{$name} }; } sub get_all_detailed_extra { my ($self, $object, $id) = @_; my $stash = $self->storage_for($object, $id); my @all_detailed = map { $_ => { value => $stash->{$_} } } keys %$stash; } sub get_all_extra { my ($self, $object, $id) = @_; return %{ $self->storage_for($object, $id) }; } sub set_extra { my ($self, $object, $id, $name, $value) = @_; $self->storage_for($object, $id)->{$name} = $value; } sub delete_extra { my ($self, $object, $id, $name) = @_; delete $self->storage_for($object, $id)->{$name}; } sub delete_all_extra { my ($self, $object, $id) = @_; %{ $self->storage_for($object, $id) } = (); } 1; __END__ =pod =encoding UTF-8 =head1 NAME Mixin::ExtraFields::Driver::HashGuts - store extras in a hashy object's guts =head1 VERSION version 0.140003 =head1 SYNOPSIS package Your::HashBased::Class; use Mixin::ExtraFields -fields => { driver => 'HashGuts' }; =head1 DESCRIPTION This driver class implements an extremely simple storage mechanism: extras are stored on the object on which the mixed-in methods are called. By default, they are stored under the key returned by the C> method, but this can be changed by providing a C argument to the driver configuration, like so: use Mixin::ExtraFields -fields => { driver => { class => 'HashGuts', hash_key => "\0Something\0Wicked\0" } }; =head1 PERL VERSION This library should run on perls released even a long time ago. It should work on any version of perl released in the last five years. Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. =head1 METHODS In addition to the methods required by Mixin::ExtraFields::Driver, the following methods are provided: =head2 hash_key my $key = $driver->hash_key; This method returns the key where the driver will store its extras. =head2 default_hash_key If no C argument is given for the driver, this method is called during driver initialization. It will return a unique string to be used as the hash key. =head2 storage This method returns the hashref of storage used for extras. Individual objects get weak references to their id within this hashref. =head2 storage_for my $stash = $driver->storage_for($object, $id); This method returns the hashref to use to store extras for the given object and id. This hashref is stored on both the hash-based object (in its C entry) and on the driver (in the entry for C<$id> in its C hash). All objects with the same id should end up with the same hash in their C field. B of these references are weakened, which means two things: first, even if all objects with a given id go out of scope, future objects with that id will retain the original extras; secondly, memory used to store extras is never reclaimed. If this is a problem, use a more sophisticated driver. =head1 AUTHOR Ricardo Signes =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2022 by Ricardo Signes. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut Mixin-ExtraFields-0.140003/xt/author/000755 000765 000024 00000000000 14354077610 017304 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/xt/release/000755 000765 000024 00000000000 14354077610 017422 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/xt/release/changes_has_content.t000644 000765 000024 00000002104 14354077610 023601 0ustar00rjbsstaff000000 000000 use Test::More tests => 2; note 'Checking Changes'; my $changes_file = 'Changes'; my $newver = '0.140003'; my $trial_token = '-TRIAL'; my $encoding = 'UTF-8'; SKIP: { ok(-e $changes_file, "$changes_file file exists") or skip 'Changes is missing', 1; ok(_get_changes($newver), "$changes_file has content for $newver"); } done_testing; sub _get_changes { my $newver = shift; # parse changelog to find commit message open(my $fh, '<', $changes_file) or die "cannot open $changes_file: $!"; my $changelog = join('', <$fh>); if ($encoding) { require Encode; $changelog = Encode::decode($encoding, $changelog, Encode::FB_CROAK()); } close $fh; my @content = grep { /^$newver(?:$trial_token)?(?:\s+|$)/ ... /^\S/ } # from newver to un-indented split /\n/, $changelog; shift @content; # drop the version line # drop unindented last line and trailing blank lines pop @content while ( @content && $content[-1] =~ /^(?:\S|\s*$)/ ); # return number of non-blank lines return scalar @content; } Mixin-ExtraFields-0.140003/xt/author/pod-syntax.t000644 000765 000024 00000000252 14354077610 021576 0ustar00rjbsstaff000000 000000 #!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(); Mixin-ExtraFields-0.140003/t/minidriver.t000644 000765 000024 00000003165 14354077610 020154 0ustar00rjbsstaff000000 000000 use strict; use warnings; use Test::More tests => 16; BEGIN { require_ok('Mixin::ExtraFields'); } use lib 't/lib'; my $test_class; BEGIN { $test_class = 'Object::HasExtraFields'; use_ok($test_class); } my $object = $test_class->new; isa_ok($object, $test_class); can_ok( $object, map { "$_\_mini" } qw(get get_all set exists delete delete_all), ); ok( ! $object->exists_mini('datum'), "there exists no mini/datum yet"); is($object->get_mini('datum'), undef, "mini/datum shows undef value"); ok( ! $object->exists_mini('datum'), "get mini/datum value doesn't autoviv"); $object->set_mini(datum => 10); ok($object->exists_mini('datum'), "mini/datum exists now"); is($object->get_mini('datum'), 10, "mini/datum has the value we supplied"); $object->set_mini(doomed => 20); $object->delete_mini(doomed => 20); ok( ! $object->exists_mini('doomed'), "there exists no mini/doomed after set and delete" ); is($object->get_mini('doomed'), undef, "mini/doomed shows undef value"); is_deeply( [ $object->get_all_mini_names ], [ qw(datum) ], "get_all_mini_names gets the one name that it should", ); is_deeply( [ $object->get_all_mini ], [ datum => 10 ], "get_all_mini gets the one pair that it should", ); is_deeply( [ $object->get_detailed_mini('datum') ], [ { value => 10 } ], "get_detailed_mini gets the hashref that it should", ); is_deeply( [ $object->get_all_detailed_mini ], [ datum => { value => 10 } ], "get_all_detailed_mini gets the one pair that it should", ); $object->delete_all_mini; is_deeply( [ $object->get_all_mini ], [ ], "get_all_mini gets an empty list after delete_all_mini", ); Mixin-ExtraFields-0.140003/t/basic.t000644 000765 000024 00000005636 14354077610 017072 0ustar00rjbsstaff000000 000000 use strict; use warnings; use Test::More tests => 29; BEGIN { require_ok('Mixin::ExtraFields'); } use lib 't/lib'; my $test_class; BEGIN { $test_class = 'Object::HasExtraFields'; use_ok($test_class); } my $object = $test_class->new; isa_ok($object, $test_class); can_ok( $object, map { "$_\_extra" } qw(get get_all set exists delete delete_all), ); is_deeply( [ $object->get_all_extra ], [ ], "when we begin, there are no extras", ); is_deeply( [ $object->get_all_detailed_extra ], [ ], "...even if we ask for all the details", ); ok( ! $object->exists_extra('datum'), "there exists no extra 'datum' yet"); is($object->get_extra('datum'), undef, "extra 'datum' shows undef value"); is($object->get_detailed_extra('datum'), undef, "...even with _detailed_"); ok( ! $object->exists_extra('datum'), "getting 'datum' value doesn't autoviv"); $object->set_extra(datum => 10); ok($object->exists_extra('datum'), "extra 'datum' exists now"); is($object->get_extra('datum'), 10, "extra/datum has the value we supplied"); is( $object->{_extra}{datum}, 10, "with a fixed hash key, we can go find extras in the hash guts", ); ok( ! $object->exists_misc('datum'), "there exists no misc 'datum' yet"); is($object->get_misc('datum'), undef, "misc/datum has the value we supplied"); $object->set_misc(datum => 20); ok($object->exists_misc('datum'), "there now exists misc 'datum'"); is($object->get_misc('datum'), 20, "misc/datum has the value we supplied"); is($object->get_extra('datum'), 10, "extra/datum has the value we supplied"); $object->delete_extra('datum'); ok( ! $object->exists_extra('datum'), "there exists no extra 'datum' again"); is($object->get_extra('datum'), undef, "extra 'datum' shows undef value"); is_deeply( [ $object->get_all_misc_names ], [ qw(datum) ], "get_all_misc_names gets the one name that it should", ); is_deeply( [ $object->get_all_misc ], [ datum => 20 ], "get_all_misc gets the one pair that it should", ); is_deeply( [ $object->get_detailed_misc('datum') ], [ { value => 20 } ], "get_detailed_misc gets the hashref that it should", ); is_deeply( [ $object->get_all_detailed_misc ], [ datum => { value => 20 } ], "get_all_detailed_misc gets the one pair that it should", ); $object->set_extra(datum => 10); is_deeply( [ $object->get_all_detailed_extra ], [ datum => { value => 10 } ], "get_all_detailed_extra gets the one pair that it should", ); my $other = $test_class->new; is_deeply( [ $other->get_all_detailed_misc ], [ ], "...but gets nothing from a new obj" ); is_deeply( [ $other->get_all_detailed_extra ], [ datum => { value => 10 } ], "...but get_all_detailed_extra does! it uses a shared id" ); $object->delete_all_misc; is_deeply( [ $object->get_all_misc ], [ ], "after delete_all_misc, get_all_misc gets nothing", ); eval { (ref $object)->get_all_misc }; like($@, qr/couldn't determine id/, "exception thrown if called on class"); Mixin-ExtraFields-0.140003/t/refaddr.t000644 000765 000024 00000002206 14354077610 017406 0ustar00rjbsstaff000000 000000 use strict; use warnings; use Test::More tests => 13; BEGIN { require_ok('Mixin::ExtraFields'); } use lib 't/lib'; my $test_class; BEGIN { $test_class = 'Object::HasExtraFieldsRA'; use_ok($test_class); } my $object = $test_class->new; isa_ok($object, $test_class); can_ok( $object, map { "$_\_extra" } qw(get get_all set exists delete delete_all), ); is_deeply( [ $object->get_all_extra ], [ ], "when we begin, there are no extras", ); is_deeply( [ $object->get_all_detailed_extra ], [ ], "...even if we ask for all the details", ); ok( ! $object->exists_extra('datum'), "there exists no extra 'datum' yet"); is($object->get_extra('datum'), undef, "extra 'datum' shows undef value"); is($object->get_detailed_extra('datum'), undef, "...even with _detailed_"); ok( ! $object->exists_extra('datum'), "getting 'datum' value doesn't autoviv"); $object->set_extra(datum => 10); ok($object->exists_extra('datum'), "extra 'datum' exists now"); is($object->get_extra('datum'), 10, "extra/datum has the value we supplied"); is( $object->{_extra}{datum}, 10, "with a fixed hash key, we can go find extras in the hash guts", ); Mixin-ExtraFields-0.140003/t/00-report-prereqs.t000644 000765 000024 00000013452 14354077610 021213 0ustar00rjbsstaff000000 000000 #!perl use strict; use warnings; # This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.028 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 $mod eq 'perl'; next if grep { $_ eq $mod } @exclude; my $file = $mod; $file =~ s{::}{/}g; $file .= ".pm"; my ($prefix) = grep { -e File::Spec->catfile($_, $file) } @INC; my $want = $req_hash->{$phase}{$type}{$mod}; $want = "undef" unless defined $want; $want = "any" if !$want && $want == 0; my $req_string = $want eq 'any' ? 'any version required' : "version '$want' required"; 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: Mixin-ExtraFields-0.140003/t/lib/000755 000765 000024 00000000000 14354077610 016360 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/t/bad-driver.t000644 000765 000024 00000000772 14354077610 020024 0ustar00rjbsstaff000000 000000 use strict; use warnings; use Test::More; { package Bad::Driver; use base qw(Mixin::ExtraFields::Driver); # Look at us! We're so BAD! We're not going to defined ANY of the required # methods! } my $driver = bless {} => 'Bad::Driver'; my @methods = qw(from_args get_all_detailed_extra set_extra delete_extra); plan tests => scalar @methods; for (@methods) { eval { $driver->$_ }; like( $@, qr/not implemented/, "$_ call without implementation throws correct error", ); } Mixin-ExtraFields-0.140003/t/driver-err.t000644 000765 000024 00000001122 14354077610 020054 0ustar00rjbsstaff000000 000000 use strict; use warnings; # Let's just test a couple of the failures that should be possible if you screw # up your driver declaration. use Test::More tests => 2; use lib 't/lib'; eval { package MEF::Tarkin::Grand; require Mixin::ExtraFields; Mixin::ExtraFields->import('-fields'); }; like($@, qr/no driver supplied/, "there is no default default driver"); eval { package MEF::Tarkin::Grand; require Mixin::ExtraFields; Mixin::ExtraFields->import(-fields => { driver => '+MEFD::NoCompile' }); }; like($@, qr/compilation failed/i, "we can't use a driver that won't compile!"); Mixin-ExtraFields-0.140003/t/00-report-prereqs.dd000644 000765 000024 00000003253 14354077610 021335 0ustar00rjbsstaff000000 000000 do { my $x = { 'configure' => { 'requires' => { 'ExtUtils::MakeMaker' => '6.78' } }, 'develop' => { 'requires' => { 'Encode' => '0', 'Test::More' => '0', 'Test::Pod' => '1.41' } }, 'runtime' => { 'requires' => { 'Carp' => '0', 'Scalar::Util' => '0', 'String::RewritePrefix' => '0', 'Sub::Exporter' => '0.972', 'Sub::Install' => '0', 'parent' => '0', 'perl' => '5.012', 'strict' => '0', 'warnings' => '0' } }, 'test' => { 'recommends' => { 'CPAN::Meta' => '2.120900' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'File::Spec' => '0', 'Test::More' => '0.96', 'base' => '0', 'lib' => '0' } } }; $x; }Mixin-ExtraFields-0.140003/t/lib/Object/000755 000765 000024 00000000000 14354077610 017566 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/t/lib/MEFD/000755 000765 000024 00000000000 14354077610 017073 5ustar00rjbsstaff000000 000000 Mixin-ExtraFields-0.140003/t/lib/MEFD/Minimal.pm000644 000765 000024 00000001145 14354077610 021020 0ustar00rjbsstaff000000 000000 use strict; use warnings; # This is a stripped-down HashGuts, used to test the fallback behavior of # methods in the driver base class. package MEFD::Minimal; use base qw(Mixin::ExtraFields::Driver); sub from_args { bless {} => $_[0]; } sub get_all_detailed_extra { my ($self, $object, $id) = @_; my $stash = $object->{_stash}; my @all = map { $_ => { value => $stash->{$_} } } keys %$stash; } sub delete_extra { my ($self, $object, $id, $name) = @_; delete $object->{_stash}{$name}; } sub set_extra { my ($self, $object, $id, $name, $value) = @_; $object->{_stash}{$name} = $value; } 1; Mixin-ExtraFields-0.140003/t/lib/MEFD/NoCompile.pm000644 000765 000024 00000000022 14354077610 021310 0ustar00rjbsstaff000000 000000 use strict; $x; Mixin-ExtraFields-0.140003/t/lib/Object/HasExtraFields.pm000644 000765 000024 00000000750 14354077610 022774 0ustar00rjbsstaff000000 000000 use strict; use warnings; package Object::HasExtraFields; use Carp (); use Mixin::ExtraFields -fields => { driver => { class => 'HashGuts', hash_key => '_extra' }, id => 'alt_id', }, -fields => { driver => 'HashGuts', moniker => 'misc' }, -fields => { driver => '+MEFD::Minimal', moniker => 'mini' }; sub new { return bless {} => shift; } sub id { return unless ref $_[0]; "id_" . (0 + $_[0]); } sub alt_id { 0 } # pretty lame for a unique id, huh? 1; Mixin-ExtraFields-0.140003/t/lib/Object/HasExtraFieldsRA.pm000644 000765 000024 00000000371 14354077610 023216 0ustar00rjbsstaff000000 000000 use strict; use warnings; package Object::HasExtraFieldsRA; use Carp (); use Mixin::ExtraFields -fields => { driver => { class => 'HashGuts', hash_key => '_extra' }, id => undef, }, ; sub new { return bless {} => shift; } 1;