CGI-Application-Plugin-DBH-4.04000755001750001750 012244506243 15226 5ustar00frewfrew000000000000README100644001750001750 1405312244506243 16212 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04NAME CGI::Application::Plugin::DBH - Easy DBI access from CGI::Application VERSION version 4.04 SYNOPSIS use CGI::Application::Plugin::DBH (qw/dbh_config dbh/); sub cgiapp_init { my $self = shift; # use the same args as DBI->connect(); $self->dbh_config($data_source, $username, $auth, \%attr); # or to use more than one dbh $self->dbh_config('my_handle', [ $data_source, $user, $auth, \%attr ]); $self->dbh_config('my_other_handle', [ $data_source, $user, $auth, \%attr ]); } sub my_run_mode { my $self = shift; my $date = $self->dbh->selectrow_array("SELECT CURRENT_DATE"); # again with a named handle $date = $self->dbh('my_handle')->selectrow_array("SELECT CURRENT_DATE"); # OR ... my $dbh = $self->dbh; # again with a named handle $dbh = $self->dbh('my_other_handle'); my $date = $dbh->selectrow_array("SELECT CURRENT_DATE"); } DESCRIPTION CGI::Application::Plugin::DBH adds easy access to a DBI database handle to your CGI::Application modules. Lazy loading is used to prevent a database connection from being made if the "dbh" method is not called during the request. In other words, the database connection is not created until it is actually needed. METHODS dbh() my $date = $self->dbh->selectrow_array("SELECT CURRENT_DATE"); # again with a named handle $date = $self->dbh('my_handle')->selectrow_array("SELECT CURRENT_DATE"); # OR ... my $dbh = $self->dbh; # again with a named handle $dbh = $self->dbh('my_other_handle'); my $date = $dbh->selectrow_array("SELECT CURRENT_DATE"); This method will return the current DBI database handle. The database handle is created on the first call to this method, and any subsequent calls will return the same handle. dbh_config() sub cgiapp_init { my $self = shift; # use the same args as DBI->connect(); $self->dbh_config($data_source, $username, $auth, \%attr); # or to use more than one dbh $self->dbh_config('my_handle', [ $data_source, $user, $auth, \%attr ]); $self->dbh_config('my_other_handle', [ $data_source, $user, $auth, \%attr ]); # ...or use some existing handle you have $self->dbh_config($DBH); $self->dbh_config('my_handle', $DBH); # this works too # Use a callback to create your owh handle that is still lazy loaded $self->dbh_config(sub { DBI->connect_cached(); }); } Used to provide your DBI connection parameters. You can either pass in an existing DBI database handle, or provide the usual parameters used for DBI->connect(). The recommended place to call "dbh_config" is in the "cgiapp_init" stage of CGI::Application. If this method is called after the database handle has already been accessed, then it will die with an error message. Automatic configuration using CGI::App instance parameters An alternative to explicitly calling "dbh_config" in your application is to rely on the presence of specific instance parameters that allow the plugin to configure itself. If you set the CGI::App parameter "::Plugin::DBH::dbh_config" to an array reference the contents of that array will be used as parameters to "dbh_config" (if it has not been explicitly called before). The code in the synopsis can be rewritten as use CGI::Application::Plugin::DBH (qw/dbh/); # no longer a need to import dbh_config sub cgiapp_init { # you do not need to do anything here } sub my_run_mode { # this part stays unchanged .... } and in the instance script ( or instance configuration file, if you have) $app->param('::Plugin::DBH::dbh_config' => [ $data_source, $username, $auth, \%attr ] ); If you want to configure more than one handle, set up a hash with the handle names as keys: $app->param('::Plugin::DBH::dbh_config' => { my_handle => [ $data_source, $username, $auth, \%attr ] , my_other_handle => [ $data_source, $username, $auth, \%attr ] } ); Automatic configuration with DBI environment variables If you do not set any parameters, and do not call "dbh_config", this plugin checks to see if you set the DBI environment variable "DBI_DSN". If present, this DSN will be used for the default handle. Note that the DBI documentation does not encourage using this method (especially in the context of web applications), that you will most likely have to also set "DBI_USER" and "DBI_PASS", and that this can only be used for the default handle. dbh_default_name() sub my_runmode { my $self = shift; my $old_handle_name = $self->dbh_default_name('my_handle'); $self->some_legacy_code(); # some_legacy_code() will get "my_handle" # when it calls $self->dbh() without parameters $self->dbh_default_name($old_handle_name); # Return to normal. } Can be used to alter the name of the handle that is returned by dbh() when called with no parameters. It can even be used to alter the name used for the unnamed handle if called before dbh_config(). Using this method is completely optional. If you don't have a use for it don't use it. Internally the handle name "__cgi_application_plugin_dbh" is used to keep track of the unnamed handle unless it is changed by dbh_default_name() before a call to dbh_config() without a name parameter. SEE ALSO Ima::DBI is similar, but has much more complexity and features. CGI::Application, DBI, CGI::Application::Plugin::ValidateRM AUTHOR Mark Stosberg COPYRIGHT AND LICENSE This software is copyright (c) 2013 by Mark Stosberg. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Changes100644001750001750 303212244506243 16600 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04Revision history for Perl extension CGI::Application::Plugin::DBH 4.04 2013-11-24 17:32:50 America/Chicago - Fix various Dist::Zilla conversion errors 4.03 2013-11-23 10:28:14 America/Chicago - Fix warning RT#73776 (Arthur Axel 'fREW' Schmidt) - Fix some typos (David Steinbrunner) 4.02 2013-11-11 13:24:41 America/Chicago - Fix missing dep on DBD::Mock (Arthur Axel 'fREW' Schmidt) 4.01 Fri Jan 18 22:29:42 EST 2013 [No Significant Changes] - Rework test for an existing database handle to avoid test failures related to DBD::Mock. We depend on Test::MockObject now instead. Some other minor code clean-ups: - "use parent" instead of "use base" - use "our" instead of "use vars" 4.00 Thu Nov 3 16:59:28 EST 2005 - Added support for configuring through a callback. This can be used to create a connection on your own, and still have it be lazy loaded. This was requested for use with connect_cached(). 3.00 Thu Mar 17 20:07:32 EST 2005 - Added support for auto-configuring the handle through the instance script or environment variables. (Thilo Planz). 2.00 Wed Oct 6 21:21:55 EST 2004 - Added support for multiple handles and named handles. The API is completely backwards compatible with the existing behavior. (Tony Fraser) 1.00 Wed Sep 8 19:15:44 EST 2004 - Bumped version for release to CPAN 0.02 Sun Sep 5 12:05:50 EST 2004 - Added support for initializing with an existing database handle. 0.01 Sat Sep 4 21:54:31 EST 2004 - initial release LICENSE100644001750001750 4365612244506243 16352 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04This software is copyright (c) 2013 by Mark Stosberg. 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) 2013 by Mark Stosberg. 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, Suite 500, Boston, MA 02110-1335 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) 2013 by Mark Stosberg. 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 MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End cpanfile100644001750001750 31112244506243 16766 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04requires 'parent'; requires 'CGI::Application'; requires 'DBI'; on test => sub { requires 'Test::More' => 1.001002; requires 'Test::MockObject' => 1.20120301; requires 'DBD::Mock' => 0.11 }; dist.ini100644001750001750 47712244506243 16743 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04name = CGI-Application-Plugin-DBH author = Mark Stosberg license = Perl_5 copyright_holder = Mark Stosberg version = 4.04 [NextRelease] [@Git] [@Basic] [GithubMeta] [MetaJSON] [PodWeaver] [PkgVersion] [ReadmeFromPod] [PodSyntaxTests] [Prereqs::FromCPANfile] META.yml100644001750001750 126012244506243 16557 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04--- abstract: 'Easy DBI access from CGI::Application' author: - 'Mark Stosberg ' build_requires: DBD::Mock: 0.11 Test::MockObject: 1.20120301 Test::More: 1.001002 configure_requires: ExtUtils::MakeMaker: 6.30 dynamic_config: 0 generated_by: 'Dist::Zilla version 5.006, CPAN::Meta::Converter version 2.132830' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: CGI-Application-Plugin-DBH requires: CGI::Application: 0 DBI: 0 parent: 0 resources: homepage: https://github.com/frioux/CGI-Application-Plugin-DBH repository: https://github.com/frioux/CGI-Application-Plugin-DBH.git version: 4.04 MANIFEST100644001750001750 40712244506243 16421 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04Changes LICENSE MANIFEST META.json META.yml Makefile.PL README cpanfile dist.ini lib/CGI/Application/Plugin/DBH.pm t/TestAppAutoConfig.pm t/TestAppBasic.pm t/TestAppMultiHandle.pm t/auto_config.t t/basic.t t/existing_dbh.t t/multi_handle.t t/release-pod-syntax.t t000755001750001750 012244506243 15412 5ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04basic.t100644001750001750 46612244506243 17006 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tuse Test::More qw/no_plan/; BEGIN { use_ok('CGI::Application::Plugin::DBH') }; use lib './t'; use strict; $ENV{CGI_APP_RETURN_ONLY} = 1; use TestAppBasic; my $t1_obj = TestAppBasic->new(); my $t1_output = $t1_obj->run(); use UNIVERSAL; ok($t1_obj->dbh->isa('DBI::db'), 'dbh() method returns DBI handle'); META.json100644001750001750 251112244506243 16727 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04{ "abstract" : "Easy DBI access from CGI::Application", "author" : [ "Mark Stosberg " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 5.006, CPAN::Meta::Converter version 2.132830", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "CGI-Application-Plugin-DBH", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.30" } }, "develop" : { "requires" : { "Test::Pod" : "1.41" } }, "runtime" : { "requires" : { "CGI::Application" : "0", "DBI" : "0", "parent" : "0" } }, "test" : { "requires" : { "DBD::Mock" : "0.11", "Test::MockObject" : "1.20120301", "Test::More" : "1.001002" } } }, "release_status" : "stable", "resources" : { "homepage" : "https://github.com/frioux/CGI-Application-Plugin-DBH", "repository" : { "type" : "git", "url" : "https://github.com/frioux/CGI-Application-Plugin-DBH.git", "web" : "https://github.com/frioux/CGI-Application-Plugin-DBH" } }, "version" : "4.04" } Makefile.PL100644001750001750 232112244506243 17257 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04 use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "Easy DBI access from CGI::Application", "AUTHOR" => "Mark Stosberg ", "BUILD_REQUIRES" => {}, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30" }, "DISTNAME" => "CGI-Application-Plugin-DBH", "EXE_FILES" => [], "LICENSE" => "perl", "NAME" => "CGI::Application::Plugin::DBH", "PREREQ_PM" => { "CGI::Application" => 0, "DBI" => 0, "parent" => 0 }, "TEST_REQUIRES" => { "DBD::Mock" => "0.11", "Test::MockObject" => "1.20120301", "Test::More" => "1.001002" }, "VERSION" => "4.04", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "CGI::Application" => 0, "DBD::Mock" => "0.11", "DBI" => 0, "Test::MockObject" => "1.20120301", "Test::More" => "1.001002", "parent" => 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); auto_config.t100644001750001750 352512244506243 20241 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tuse Test::More qw/no_plan/; BEGIN { use_ok('CGI::Application::Plugin::DBH') }; use lib './t'; use strict; #### Test DBI environment variables $ENV{CGI_APP_RETURN_ONLY} = 1; $ENV{DBI_DSN}='dbi:Mock:'; $ENV{DBI_USER}=''; $ENV{DBI_PASS}=''; use TestAppAutoConfig; my $t1_obj = TestAppAutoConfig->new(); my $t1_output = $t1_obj->run(); use UNIVERSAL; ok($t1_obj->dbh->isa('DBI::db'), 'dbh() method returns DBI handle'); eval{ $t1_obj->dbh('blah') }; ok ($@ =~ /^must call dbh_config/ , 'only default handle is configured'); ok( $t1_obj->dbh( $t1_obj->dbh_default_name()) ->isa('DBI::db'), 'default handle is configured'); #### Test CGI::App instance parameters (default handle) delete $ENV{DBI_DSN}; $t1_obj = TestAppAutoConfig->new(); $t1_obj->param('::Plugin::DBH::dbh_config' => [ 'dbi:Mock:', '', '', {AutoCommit => 1, RaiseError => 1} ] ); $t1_output = $t1_obj->run(); ok($t1_obj->dbh->isa('DBI::db'), 'dbh() method returns DBI handle'); eval{ $t1_obj->dbh('blah') }; ok ($@ =~ /^must call dbh_config/ , 'only default handle is configured'); ok( $t1_obj->dbh( $t1_obj->dbh_default_name()) ->isa('DBI::db'), 'default handle is configured'); #### Test CGI::App instance parameters (two handles) $t1_obj = TestAppAutoConfig->new(); $t1_obj->param('::Plugin::DBH::dbh_config' => { handle1 => [ 'dbi:Mock:', '', '', {AutoCommit => 1, RaiseError => 1} ], handle2 => [ 'dbi:Mock:', '', '', {AutoCommit => 1, RaiseError => 1} ]} ); $t1_obj->dbh_default_name('handle1'); $t1_output = $t1_obj->run(); ok($t1_obj->dbh->isa('DBI::db'), 'dbh() method returns DBI handle'); eval{ $t1_obj->dbh('blah') }; ok ($@ =~ /^must call dbh_config/ , 'only handle1 and handle2 are configured'); ok( $t1_obj->dbh('handle1') ->isa('DBI::db'), 'handle1 is configured'); ok( $t1_obj->dbh('handle2') ->isa('DBI::db'), 'handle2 is configured'); existing_dbh.t100644001750001750 106012244506243 20403 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tuse Test::More; use Test::MockObject; use strict; use warnings; # Create our app instance that uses the plugin my $app = TestAppExistingDBH->new(); # Mock a DBI object. my $mock_dbh = Test::MockObject->new; $mock_dbh->set_isa('DBI::db'); $mock_dbh->set_true('ping'); # Test using the existing handle. $app->dbh_config($mock_dbh); isa_ok($app->dbh,'DBI::db','dbh() method returns DBI handle when using existing handle'); done_testing(); package TestAppExistingDBH; use parent 'CGI::Application'; use CGI::Application::Plugin::DBH qw(dbh_config dbh); multi_handle.t100644001750001750 314712244506243 20411 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tuse Test::More qw/no_plan/; BEGIN { use_ok('CGI::Application::Plugin::DBH') }; use lib './t'; use strict; $ENV{CGI_APP_RETURN_ONLY} = 1; use TestAppMultiHandle; my $t1_obj = TestAppMultiHandle->new(); my $t1_output = $t1_obj->run(); ok($t1_obj->dbh_default_name eq "__cgi_application_plugin_dbh", "deafult handle name was preserved"); ok($t1_obj->param('orig_name1') eq "__cgi_application_plugin_dbh", "name stored for first dbh_default_name() is correct"); ok($t1_obj->param('orig_name2') eq "handle1", "name stored for second dbh_default_name() is correct"); use UNIVERSAL; # Default handle should be unset eval {$t1_obj->dbh}; ok($@ =~ /must call dbh_config/, 'dbh() method dies for default handle'); # We should have 4 named handles ok($t1_obj->dbh('handle1')->isa('DBI::db'), 'dbh("handle1") method returns DBI handle'); ok($t1_obj->dbh('handle2')->isa('DBI::db'), 'dbh("handle2") method returns DBI handle'); ok($t1_obj->dbh('handle3')->isa('DBI::db'), 'dbh("handle3") method returns DBI handle'); ok($t1_obj->dbh('handle4')->isa('DBI::db'), 'dbh("handle4") method returns DBI handle'); # Handles 2 and 3 should be the same as 1 ok($t1_obj->dbh('handle2') == $t1_obj->dbh('handle1'), "handle2 is a copy of handle1"); ok($t1_obj->dbh('handle3') == $t1_obj->dbh('handle1'), "handle3 is a copy of handle1"); # Handle 4 should be different ok($t1_obj->dbh('handle1') != $t1_obj->dbh('handle4'), "handle4 is not a copy of handle1"); ok($t1_obj->dbh('handle2') != $t1_obj->dbh('handle4'), "handle4 is not a copy of handle2"); ok($t1_obj->dbh('handle3') != $t1_obj->dbh('handle4'), "handle4 is not a copy of handle3"); TestAppBasic.pm100644001750001750 64512244506243 20417 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tpackage TestAppBasic; use strict; use CGI::Application; @TestAppBasic::ISA = qw(CGI::Application); use CGI::Application::Plugin::DBH (qw/dbh_config dbh/); sub cgiapp_init { my $self = shift; $self->dbh_config('DBI:Mock:','',''); } sub setup { my $self = shift; $self->start_mode('test_mode'); $self->run_modes(test_mode => 'test_mode' ); } sub test_mode { my $self = shift; return 1; } 1; TestAppAutoConfig.pm100644001750001750 61412244506243 21430 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tpackage TestAppAutoConfig; use strict; use CGI::Application; @TestAppAutoConfig::ISA = qw(CGI::Application); use CGI::Application::Plugin::DBH (qw/dbh dbh_default_name/); sub cgiapp_init { my $self = shift; } sub setup { my $self = shift; $self->start_mode('test_mode'); $self->run_modes(test_mode => 'test_mode' ); } sub test_mode { my $self = shift; return 1; } 1; release-pod-syntax.t100644001750001750 45012244506243 21442 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/t#!perl BEGIN { unless ($ENV{RELEASE_TESTING}) { require Test::More; Test::More::plan(skip_all => 'these tests are for release candidate testing'); } } use Test::More; eval "use Test::Pod 1.41"; plan skip_all => "Test::Pod 1.41 required for testing POD" if $@; all_pod_files_ok(); TestAppMultiHandle.pm100644001750001750 117112244506243 21617 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/tpackage TestAppMultiHandle; use strict; use CGI::Application; use TestAppBasic; @TestAppMultiHandle::ISA = qw(TestAppBasic); use CGI::Application::Plugin::DBH (qw/dbh_default_name dbh_config dbh/); sub cgiapp_init { my $self = shift; $self->dbh_config('handle1', [ 'DBI:Mock:','','' ]); $self->dbh_config('handle2', $self->dbh('handle1')); $self->param('orig_name1', $self->dbh_default_name('handle1')); $self->dbh_config('handle3', $self->dbh); $self->param('orig_name2', $self->dbh_default_name('handle4')); $self->dbh_config('DBI:Mock:','',''); $self->dbh_default_name($self->param('orig_name1')); } Plugin000755001750001750 012244506243 22020 5ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/lib/CGI/ApplicationDBH.pm100644001750001750 2251212244506243 23135 0ustar00frewfrew000000000000CGI-Application-Plugin-DBH-4.04/lib/CGI/Application/Pluginpackage CGI::Application::Plugin::DBH; { $CGI::Application::Plugin::DBH::VERSION = '4.04'; } use parent 'Exporter'; # ABSTRACT: Easy DBI access from CGI::Application use strict; use Carp; our @EXPORT_OK = qw( dbh dbh_config dbh_default_name ); sub dbh { my $self = shift; my $name = shift; $self->{__DBH_DEFAULT_NAME} ||= "__cgi_application_plugin_dbh"; # First use case. $name ||= $self->{__DBH_DEFAULT_NAME}; # Unnamed handle case. unless ($self->{__DBH_CONFIG}{$name}){ __auto_config($self, $name); croak "must call dbh_config() before calling dbh()." unless $self->{__DBH_CONFIG}{$name}; } unless( defined($self->{__DBH}{$name}) && $self->{__DBH}{$name}->ping ) { # create DBH object if(my $config = $self->{__DBH_CONFIG}{$name} ) { # Use a callback if (ref $config && ref $config eq 'CODE') { $self->{__DBH}{$name} = $config->(); } # use the parameters the user supplied else { require DBI; $self->{__DBH}{$name} = DBI->connect(@{ $self->{__DBH_CONFIG}{$name} }); } } else { } } return $self->{__DBH}{$name}; } sub dbh_config { my $self = shift; $self->{__DBH_DEFAULT_NAME} ||= "__cgi_application_plugin_dbh"; # First use case. my $name = shift if( ref($_[1]) ); $name ||= $self->{__DBH_DEFAULT_NAME}; # Unnamed handle case. croak "Calling dbh_config after the dbh has already been created" if( defined $self->{__DBH}{$name} ); # See if a handle is being passed in directly. require UNIVERSAL; if( ref($_[0]) eq 'ARRAY' or ref $_[0] eq 'CODE' ) { $self->{__DBH_CONFIG}{$name} = shift; } elsif( ref($_[0]) and $_[0]->isa('DBI::db') ) { $self->{__DBH}{$name} = shift; # Set this to note that we have completed the 'config' stage. $self->{__DBH_CONFIG}{$name} = 1; } else { $self->{__DBH_CONFIG}{$name} = \@_; } } sub __auto_config { # get parameters for dbh_config from CGI::App instance parameters my $app = shift; my $name = shift; my $params = $app->param('::Plugin::DBH::dbh_config'); return __auto_config_env($app, $name) unless $params; # if array reference: only one handle configured, pass array contents to dbh_config if (UNIVERSAL::isa($params, 'ARRAY')){ # verify that we really want the default handle return unless $name eq dbh_default_name($app); dbh_config($app, @$params); return; } # if hash reference: many handles configured, named with the hash keys if (UNIVERSAL::isa($params, 'HASH')){ $params = $params->{$name}; return __auto_config_env($app, $name) unless $params; dbh_config($app, $name, $params); return; } croak "Parameter ::Plugin::DBH::dbh_config must be an array or hash reference"; } sub __auto_config_env{ # check if DBI environment variable is set # this can be used to configure the default handle my $app = shift; my $name = shift; return unless $name eq dbh_default_name($app); return unless $ENV{DBI_DSN}; # DBI_DSN is set, so autoconfigure with all DSN, user id, pass all undefined dbh_config($app, undef, undef, undef); } sub dbh_default_name { my $self = shift; my $old_name = $self->{__DBH_DEFAULT_NAME} || "__cgi_application_plugin_dbh"; # Possible first use case. $self->{__DBH_DEFAULT_NAME} = shift if $_[0]; return $old_name; } 1; __END__ =pod =encoding UTF-8 =head1 NAME CGI::Application::Plugin::DBH - Easy DBI access from CGI::Application =head1 VERSION version 4.04 =head1 SYNOPSIS use CGI::Application::Plugin::DBH (qw/dbh_config dbh/); sub cgiapp_init { my $self = shift; # use the same args as DBI->connect(); $self->dbh_config($data_source, $username, $auth, \%attr); # or to use more than one dbh $self->dbh_config('my_handle', [ $data_source, $user, $auth, \%attr ]); $self->dbh_config('my_other_handle', [ $data_source, $user, $auth, \%attr ]); } sub my_run_mode { my $self = shift; my $date = $self->dbh->selectrow_array("SELECT CURRENT_DATE"); # again with a named handle $date = $self->dbh('my_handle')->selectrow_array("SELECT CURRENT_DATE"); # OR ... my $dbh = $self->dbh; # again with a named handle $dbh = $self->dbh('my_other_handle'); my $date = $dbh->selectrow_array("SELECT CURRENT_DATE"); } =head1 DESCRIPTION CGI::Application::Plugin::DBH adds easy access to a L database handle to your L modules. Lazy loading is used to prevent a database connection from being made if the C method is not called during the request. In other words, the database connection is not created until it is actually needed. =head1 METHODS =head2 dbh() my $date = $self->dbh->selectrow_array("SELECT CURRENT_DATE"); # again with a named handle $date = $self->dbh('my_handle')->selectrow_array("SELECT CURRENT_DATE"); # OR ... my $dbh = $self->dbh; # again with a named handle $dbh = $self->dbh('my_other_handle'); my $date = $dbh->selectrow_array("SELECT CURRENT_DATE"); This method will return the current L database handle. The database handle is created on the first call to this method, and any subsequent calls will return the same handle. =head2 dbh_config() sub cgiapp_init { my $self = shift; # use the same args as DBI->connect(); $self->dbh_config($data_source, $username, $auth, \%attr); # or to use more than one dbh $self->dbh_config('my_handle', [ $data_source, $user, $auth, \%attr ]); $self->dbh_config('my_other_handle', [ $data_source, $user, $auth, \%attr ]); # ...or use some existing handle you have $self->dbh_config($DBH); $self->dbh_config('my_handle', $DBH); # this works too # Use a callback to create your owh handle that is still lazy loaded $self->dbh_config(sub { DBI->connect_cached(); }); } Used to provide your DBI connection parameters. You can either pass in an existing DBI database handle, or provide the usual parameters used for DBI->connect(). The recommended place to call C is in the C stage of L. If this method is called after the database handle has already been accessed, then it will die with an error message. =head3 Automatic configuration using CGI::App instance parameters An alternative to explicitly calling C in your application is to rely on the presence of specific instance parameters that allow the plugin to configure itself. If you set the CGI::App parameter C<::Plugin::DBH::dbh_config> to an array reference the contents of that array will be used as parameters to C (if it has not been explicitly called before). The code in the synopsis can be rewritten as use CGI::Application::Plugin::DBH (qw/dbh/); # no longer a need to import dbh_config sub cgiapp_init { # you do not need to do anything here } sub my_run_mode { # this part stays unchanged .... } and in the instance script ( or instance configuration file, if you have) $app->param('::Plugin::DBH::dbh_config' => [ $data_source, $username, $auth, \%attr ] ); If you want to configure more than one handle, set up a hash with the handle names as keys: $app->param('::Plugin::DBH::dbh_config' => { my_handle => [ $data_source, $username, $auth, \%attr ] , my_other_handle => [ $data_source, $username, $auth, \%attr ] } ); =head3 Automatic configuration with DBI environment variables If you do not set any parameters, and do not call C, this plugin checks to see if you set the DBI environment variable C. If present, this DSN will be used for the default handle. Note that the DBI documentation does not encourage using this method (especially in the context of web applications), that you will most likely have to also set C and C, and that this can only be used for the default handle. =head2 dbh_default_name() sub my_runmode { my $self = shift; my $old_handle_name = $self->dbh_default_name('my_handle'); $self->some_legacy_code(); # some_legacy_code() will get "my_handle" # when it calls $self->dbh() without parameters $self->dbh_default_name($old_handle_name); # Return to normal. } Can be used to alter the name of the handle that is returned by dbh() when called with no parameters. It can even be used to alter the name used for the unnamed handle if called before dbh_config(). Using this method is completely optional. If you don't have a use for it don't use it. Internally the handle name "__cgi_application_plugin_dbh" is used to keep track of the unnamed handle unless it is changed by dbh_default_name() before a call to dbh_config() without a name parameter. =head1 SEE ALSO L is similar, but has much more complexity and features. L, L, L =head1 AUTHOR Mark Stosberg =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2013 by Mark Stosberg. 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