Dancer-Plugin-DBIC-0.1802000755001750000144 012077524420 14520 5ustar00naveedusers000000000000README100644001750000144 1340012077524420 15477 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802NAME Dancer::Plugin::DBIC - DBIx::Class interface for Dancer applications VERSION version 0.1802 SYNOPSIS use Dancer; use Dancer::Plugin::DBIC qw(schema resultset rset); get '/users/:user_id' => sub { my $user = schema('default')->resultset('User')->find(param 'user_id'); # If you are accessing the 'default' schema, then all the following # are equivalent to the above: $user = schema->resultset('User')->find(param 'user_id'); $user = resultset('User')->find(param 'user_id'); $user = rset('User')->find(param 'user_id'); template user_profile => { user => $user }; }; dance; DESCRIPTION This plugin makes it very easy to create Dancer applications that interface with databases. It automatically exports the keyword "schema" which returns a DBIx::Class::Schema object. You just need to configure your database connection information. For performance, schema objects are cached in memory and are lazy loaded the first time they are accessed. CONFIGURATION Configuration can be done in your Dancer config file. This is a minimal example. It defines one database named "default": plugins: DBIC: default: dsn: dbi:SQLite:dbname=some.db In this example, there are 2 databases configured named "default" and "foo": plugins: DBIC: default: dsn: dbi:SQLite:dbname=some.db schema_class: MyApp::Schema foo: dsn: dbi:mysql:foo schema_class: Foo::Schema user: bob pass: secret options: RaiseError: 1 PrintError: 1 Each database configured must at least have a dsn option. The dsn option should be the DBI driver connection string. All other options are optional. If you only have one schema configured, or one of them is named "default", you can call "schema" without an argument to get the only or "default" schema, respectively. If a schema_class option is not provided, then DBIx::Class::Schema::Loader will be used to dynamically load the schema by introspecting the database corresponding to the dsn value. Remember that you need DBIx::Class::Schema::Loader installed to take advantage of that. The schema_class option, should be a proper Perl package name that Dancer::Plugin::DBIC will use as a DBIx::Class::Schema class. Optionally, a database configuation may have user, pass, and options parameters as described in the documentation for "connect()" in DBI. You may also declare your connection information in the following format (which may look more familiar to DBIC users): plugins: DBIC: default: connect_info: - dbi:mysql:foo - bob - secret - RaiseError: 1 PrintError: 1 FUNCTIONS schema my $user = schema->resultset('User')->find('bob'); The "schema" keyword returns a DBIx::Class::Schema object ready for you to use. If you have configured only one database, then you can simply call "schema" with no arguments. If you have configured multiple databases, you can still call "schema" with no arguments if there is a database named "default" in the configuration. With no argument, the "default" schema is returned. Otherwise, you must provide "schema()" with the name of the database: my $user = schema('foo')->resultset('User')->find('bob'); resultset This is a convenience method that will save you some typing. Use this only when accessing the "default" schema. my $user = resultset('User')->find('bob'); is equivalent to: my $user = schema->resultset('User')->find('bob'); rset my $user = rset('User')->find('bob'); This is simply an alias for "resultset". SCHEMA GENERATION There are two approaches for generating schema classes. You may generate your own DBIx::Class classes and set the corresponding "schema_class" setting in your configuration as shown above. This is the recommended approach for performance and stability. It is also possible to have schema classes dynamically generated if you omit the "schema_class" configuration setting. This requires you to have DBIx::Class::Schema::Loader installed. The "v7" naming scheme will be used for naming the auto generated classes. See "naming" in DBIx::Class::Schema::Loader::Base for more information about naming. For generating your own schema classes, you can use the dbicdump command line tool provided by DBIx::Class::Schema::Loader to help you. For example, if your app were named Foo, then you could run the following from the root of your project directory: dbicdump -o dump_directory=./lib Foo::Schema dbi:SQLite:/path/to/foo.db For that example, your "schema_class" setting would be "Foo::Schema". CONTRIBUTORS * Alexis Sukrieh * Dagfinn Ilmari Mannsåker <> * David Precious * Fabrice Gabolde <> * Franck Cuny * Steven Humphrey <> * Yanick Champoux <> AUTHORS * Al Newkirk * Naveed Massjouni COPYRIGHT AND LICENSE This software is copyright (c) 2010 by awncorp. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Changes100644001750000144 227312077524420 16100 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802Revision history for Dancer-Plugin-DBIC 0.1802 2013-01-22 Updated version requirement for Dancer. A newer Dancer is required to use the plugin_args() function. 0.1801 2013-01-21 Fixed tests to pass on Dancer 2. Thanks Yanick Champoux (https://github.com/yanick)! 0.1800 2013-01-18 Added the resultset and rset keywords. 0.1700 2013-01-01 Added support for Dancer 2. Thanks Steven Humphrey (https://github.com/shumphrey)! 0.1601 2012-10-01 Added logic to skip some tests when DBIx::Class::Schema::Loader is not installed. 0.1600 2012-09-29 DBIx::Class::Schema::Loader is now an optional dependency. Thanks Fabrice Gabolde (https://github.com/fgabolde)! Started using Module::Load for dynamically loading modules. 0.1506 2012-04-12 When multiple databases are configured, calling schema with no args returns the schema for the databased named 'default'. Thanks Dagfinn Ilmari Mannsåker (https://github.com/ilmari)! 0.1505 2012-02-07 Updating POD to warn about dynamic loading of schema classes. Thanks David Precious (https://github.com/bigpresh)! LICENSE100644001750000144 4363412077524420 15640 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802This software is copyright (c) 2010 by awncorp. 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) 2010 by awncorp. 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) 2010 by awncorp. 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 dist.ini100644001750000144 131412077524420 16244 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802name = Dancer-Plugin-DBIC author = Al Newkirk author = Naveed Massjouni license = Perl_5 copyright_holder = awncorp copyright_year = 2010 version = 0.1802 [Prereqs] Dancer = 1.3098 DBIx::Class = 0 Module::Load = 0 [Prereqs / RuntimeRecommends] DBIx::Class::Schema::Loader = 0.07002 [MetaResources] bugtracker.web = https://github.com/ironcamel/Dancer-Plugin-DBIC/issues repository.type = git repository.url = git://github.com/ironcamel/Dancer-Plugin-DBIC.git repository.web = https://github.com/ironcamel/Dancer-Plugin-DBIC [@Filter] -bundle = @Basic -remove = Readme [OurPkgVersion] [PodWeaver] [ReadmeFromPod] META.yml100644001750000144 132112077524420 16047 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802--- abstract: 'DBIx::Class interface for Dancer applications' author: - 'Al Newkirk ' - 'Naveed Massjouni ' build_requires: {} configure_requires: ExtUtils::MakeMaker: 6.30 dynamic_config: 0 generated_by: 'Dist::Zilla version 4.300028, CPAN::Meta::Converter version 2.120921' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: Dancer-Plugin-DBIC recommends: DBIx::Class::Schema::Loader: 0.07002 requires: DBIx::Class: 0 Dancer: 1.3098 Module::Load: 0 resources: bugtracker: https://github.com/ironcamel/Dancer-Plugin-DBIC/issues repository: git://github.com/ironcamel/Dancer-Plugin-DBIC.git version: 0.1802 MANIFEST100644001750000144 35412077524420 15714 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802Changes LICENSE MANIFEST META.yml Makefile.PL README README.md dist.ini lib/Dancer/Plugin/DBIC.pm t/01-single-schema.t t/02-multiple-schemas.t t/03-dynamic-schemas.t t/04-testapp.t t/lib/Foo.pm t/lib/Foo/Result/User.pm t/lib/TestApp.pm README.md100644001750000144 115712077524420 16064 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802# DESCRIPTION This plugin makes it very easy to create Dancer applications that interface with databases. It automatically exports the keyword `schema` which returns a DBIx::Class::Schema object. You just need to configure your database connection information. For performance, schema objects are cached in memory and are lazy loaded the first time they are accessed. # INSTALLATION cpan Dancer::Plugin::DBIC # DOCUMENTATION See [Dancer::Plugin::DBIC](https://metacpan.org/module/Dancer::Plugin::DBIC). Also, after installation, you can view the documentation via `man` or `perldoc`: man Dancer::Plugin::DBIC Makefile.PL100644001750000144 211712077524420 16554 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802 use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( "ABSTRACT" => "DBIx::Class interface for Dancer applications", "AUTHOR" => "Al Newkirk , Naveed Massjouni ", "BUILD_REQUIRES" => {}, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.30" }, "DISTNAME" => "Dancer-Plugin-DBIC", "EXE_FILES" => [], "LICENSE" => "perl", "NAME" => "Dancer::Plugin::DBIC", "PREREQ_PM" => { "DBIx::Class" => 0, "Dancer" => "1.3098", "Module::Load" => 0 }, "VERSION" => "0.1802", "test" => { "TESTS" => "t/*.t" } ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) { my $br = delete $WriteMakefileArgs{BUILD_REQUIRES}; my $pp = $WriteMakefileArgs{PREREQ_PM}; for my $mod ( keys %$br ) { if ( exists $pp->{$mod} ) { $pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod}; } else { $pp->{$mod} = $br->{$mod}; } } } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); lib000755001750000144 012077524420 15452 5ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/tFoo.pm100644001750000144 15212077524420 16651 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/t/libpackage Foo; use base 'DBIx::Class::Schema'; use strict; use warnings; __PACKAGE__->load_namespaces; 1; t000755001750000144 012077524420 14704 5ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.180204-testapp.t100644001750000144 257412077524420 17142 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/tuse strict; use warnings; use Test::More; use Dancer qw(:syntax :tests); use Dancer::Plugin::DBIC; use t::lib::TestApp; use Dancer::Test apps => [ 't::lib::TestApp' ]; use DBI; use File::Temp qw(tempfile); eval { require DBD::SQLite; require DBIx::Class::Schema::Loader }; if ($@) { plan skip_all => 'DBD::SQLite and DBIx::Class::Schema::Loader required for these tests'; } else { plan tests => 7; } my (undef, $dbfile) = tempfile(SUFFIX => '.db'); set plugins => { DBIC => { foo => { dsn => "dbi:SQLite:dbname=$dbfile", } } }; my $dbh = DBI->connect("dbi:SQLite:dbname=$dbfile"); my @sql = ( q/create table users (id INTEGER primary key, name VARCHAR(64))/, q/insert into users values (1, 'sukria')/, q/insert into users values (2, 'bigpresh')/, ); $dbh->do($_) for @sql; response_status_is [ GET => '/' ], 200, "GET / is found"; response_content_like [ GET => '/' ], qr/2/, "content looks good for /"; response_status_is [ GET => '/user/1' ], 200, 'GET /user/1 is found'; response_content_like [ GET => '/user/1' ], qr/sukria/, 'content looks good for /user/1'; response_content_like [ GET => '/user/2' ], qr/bigpresh/, "content looks good for /user/2"; response_status_is [ DELETE => '/user/2' ], 200, 'DELETE /user/2 is ok'; response_content_like [ GET => '/' ], qr/1/, 'content looks good for /'; unlink $dbfile; TestApp.pm100644001750000144 57712077524420 17521 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/t/libpackage t::lib::TestApp; use Dancer; use Dancer::Plugin::DBIC; get '/' => sub { my $total_user = schema->resultset('User')->search(); $total_user->count(); }; get '/user/:id' => sub { my $user = schema->resultset('User')->find( params->{id} ); $user->name; }; del '/user/:id' => sub { schema->resultset('User')->find( params->{id} )->delete; 'ok'; }; 1; 01-single-schema.t100644001750000144 264412077524420 20174 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/tuse strict; use warnings; use lib 't/lib'; use Test::More tests => 4, import => ['!pass']; use Test::Exception; use Dancer qw(:syntax); use Dancer::Plugin::DBIC; use DBI; use File::Temp qw(tempfile); eval { require DBD::SQLite }; plan skip_all => 'DBD::SQLite required to run these tests' if $@; my (undef, $dbfile) = tempfile(SUFFIX => '.db'); set plugins => { DBIC => { foo => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfile", }, } }; my $dbh = DBI->connect("dbi:SQLite:dbname=$dbfile"); ok $dbh->do(q{ create table user (name varchar(100) primary key, age int) }), 'Created sqlite test db.'; my @users = ( ['bob', 2] ); for my $user (@users) { $dbh->do('insert into user values(?,?)', {}, @$user) } subtest 'schema' => sub { my $user = schema->resultset('User')->find('bob'); is $user->age => '2', 'Bob is a baby.'; $user = schema('foo')->resultset('User')->find('bob'); is $user->age => '2', 'Found Bob via explicit schema name.'; }; subtest 'resultset' => sub { my $user = resultset('User')->find('bob'); is $user->age => '2', 'Found Bob via resultset.'; $user = rset('User')->find('bob'); is $user->age => '2', 'Found Bob via rset.'; }; subtest 'invalid schema name' => sub { throws_ok { schema('bar')->resultset('User')->find('bob') } qr/schema bar is not configured/, 'Missing schema error thrown'; }; unlink $dbfile; 03-dynamic-schemas.t100644001750000144 206412077524420 20520 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/t# Test dynamic schema loading by not providing a schema_class config option. # These tests require DBIx::Class::Schema::Loader to be installed use strict; use warnings; use Test::More; use Dancer qw(:syntax !pass); use Dancer::Plugin::DBIC; use DBI; use File::Temp qw(tempfile); eval { require DBD::SQLite; require DBIx::Class::Schema::Loader }; if ($@) { plan skip_all => 'DBD::SQLite and DBIx::Class::Schema::Loader required for these tests'; } else { plan tests => 3; } my (undef, $dbfile) = tempfile(SUFFIX => '.db'); set plugins => { DBIC => { foo => { dsn => "dbi:SQLite:dbname=$dbfile", } } }; my $dbh = DBI->connect("dbi:SQLite:dbname=$dbfile"); ok $dbh->do(q{ create table user (name varchar(100) primary key, age int) }), 'Created sqlite test db.'; my @users = ( ['bob', 40] ); for my $user (@users) { $dbh->do('insert into user values(?,?)', {}, @$user) } my $user = schema('foo')->resultset('User')->find('bob'); ok $user, 'Found bob.'; is $user->age => '40', 'Bob is even older.'; unlink $dbfile; 02-multiple-schemas.t100644001750000144 414212077524420 20725 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/tuse strict; use warnings; use lib 't/lib'; use Test::More tests => 9, import => ['!pass']; use Test::Exception; use Dancer qw(:syntax); use Dancer::Plugin::DBIC; use DBI; use File::Temp qw(tempfile); eval { require DBD::SQLite }; plan skip_all => 'DBD::SQLite required to run these tests' if $@; my (undef, $dbfile1) = tempfile(SUFFIX => '.db'); my (undef, $dbfile2) = tempfile(SUFFIX => '.db'); set plugins => { DBIC => { foo => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfile1", }, bar => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfile2", }, } }; my $dbh1 = DBI->connect("dbi:SQLite:dbname=$dbfile1"); my $dbh2 = DBI->connect("dbi:SQLite:dbname=$dbfile2"); ok $dbh1->do(q{ create table user (name varchar(100) primary key, age int) }), 'Created sqlite test db.'; my @users = ( ['bob', 30] ); for my $user (@users) { $dbh1->do('insert into user values(?,?)', {}, @$user) } ok $dbh2->do(q{ create table user (name varchar(100) primary key, age int) }), 'Created sqlite test db.'; @users = ( ['sue', 20] ); for my $user (@users) { $dbh2->do(q{ insert into user values(?,?) }, {}, @$user); } my $user = schema('foo')->resultset('User')->find('bob'); ok $user, 'Found bob.'; is $user->age => '30', 'Bob is getting old.'; $user = schema('bar')->resultset('User')->find('sue'); ok $user, 'Found sue.'; is $user->age => '20', 'Sue is the right age.'; throws_ok { schema('poo')->resultset('User')->find('bob') } qr/schema poo is not configured/, 'Missing schema error thrown'; throws_ok { schema->resultset('User')->find('bob') } qr/The schema default is not configured/, 'Missing default schema error thrown'; set plugins => { DBIC => { default => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfile1", }, bar => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfile2", }, } }; lives_and { ok schema->resultset('User')->find('bob'), 'Found bob.' } 'Default schema'; unlink $dbfile1, $dbfile2; Result000755001750000144 012077524420 17453 5ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/t/lib/FooUser.pm100644001750000144 46012077524420 21047 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/t/lib/Foo/Resultpackage Foo::Result::User; use base 'DBIx::Class::Core'; use strict; use warnings; __PACKAGE__->table("user"); __PACKAGE__->add_columns( name => { data_type => "varchar", is_nullable => 0, size => 100 }, age => { data_type => "int", is_nullable => 1 }, ); __PACKAGE__->set_primary_key("name"); 1; Plugin000755001750000144 012077524420 17641 5ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/lib/DancerDBIC.pm100644001750000144 1655112077524420 21070 0ustar00naveedusers000000000000Dancer-Plugin-DBIC-0.1802/lib/Dancer/Pluginpackage Dancer::Plugin::DBIC; our $VERSION = '0.1802'; # VERSION use strict; use warnings; use utf8; use Dancer::Plugin; use Module::Load; my $schemas = {}; sub schema { my ($self, $name) = plugin_args(@_); my $cfg = plugin_setting; if (not defined $name) { if (keys %$cfg == 1) { ($name) = keys %$cfg; } elsif (keys %$cfg) { $name = "default"; } else { die "No schemas are configured"; } } return $schemas->{$name} if $schemas->{$name}; my $options = $cfg->{$name} or die "The schema $name is not configured"; my @conn_info = $options->{connect_info} ? @{$options->{connect_info}} : @$options{qw(dsn user pass options)}; warn "The pckg option is deprecated. Please use schema_class instead." if $options->{pckg}; my $schema_class = $options->{schema_class} || $options->{pckg}; if ($schema_class) { $schema_class =~ s/-/::/g; eval { load $schema_class }; die "Could not load schema_class $schema_class" if $@; $schemas->{$name} = $schema_class->connect(@conn_info) } else { my $dbic_loader = 'DBIx::Class::Schema::Loader'; eval { load $dbic_loader }; die "You must provide a schema_class option or install $dbic_loader." if $@; $dbic_loader->naming('v7'); $schemas->{$name} = DBIx::Class::Schema::Loader->connect(@conn_info); } return $schemas->{$name}; }; sub resultset { my ($self, $rset_name) = plugin_args(@_); return schema->resultset($rset_name); } register schema => \&schema; register resultset => \&resultset; register rset => \&resultset; register_plugin for_versions => [ 1, 2 ]; # ABSTRACT: DBIx::Class interface for Dancer applications 1; __END__ =pod =head1 NAME Dancer::Plugin::DBIC - DBIx::Class interface for Dancer applications =head1 VERSION version 0.1802 =head1 SYNOPSIS use Dancer; use Dancer::Plugin::DBIC qw(schema resultset rset); get '/users/:user_id' => sub { my $user = schema('default')->resultset('User')->find(param 'user_id'); # If you are accessing the 'default' schema, then all the following # are equivalent to the above: $user = schema->resultset('User')->find(param 'user_id'); $user = resultset('User')->find(param 'user_id'); $user = rset('User')->find(param 'user_id'); template user_profile => { user => $user }; }; dance; =head1 DESCRIPTION This plugin makes it very easy to create L applications that interface with databases. It automatically exports the keyword C which returns a L object. You just need to configure your database connection information. For performance, schema objects are cached in memory and are lazy loaded the first time they are accessed. =encoding utf8 =head1 CONFIGURATION Configuration can be done in your L config file. This is a minimal example. It defines one database named C: plugins: DBIC: default: dsn: dbi:SQLite:dbname=some.db In this example, there are 2 databases configured named C and C: plugins: DBIC: default: dsn: dbi:SQLite:dbname=some.db schema_class: MyApp::Schema foo: dsn: dbi:mysql:foo schema_class: Foo::Schema user: bob pass: secret options: RaiseError: 1 PrintError: 1 Each database configured must at least have a dsn option. The dsn option should be the L driver connection string. All other options are optional. If you only have one schema configured, or one of them is named C, you can call C without an argument to get the only or C schema, respectively. If a schema_class option is not provided, then L will be used to dynamically load the schema by introspecting the database corresponding to the dsn value. Remember that you need L installed to take advantage of that. The schema_class option, should be a proper Perl package name that Dancer::Plugin::DBIC will use as a L class. Optionally, a database configuation may have user, pass, and options parameters as described in the documentation for C in L. You may also declare your connection information in the following format (which may look more familiar to DBIC users): plugins: DBIC: default: connect_info: - dbi:mysql:foo - bob - secret - RaiseError: 1 PrintError: 1 =head1 FUNCTIONS =head2 schema my $user = schema->resultset('User')->find('bob'); The C keyword returns a L object ready for you to use. If you have configured only one database, then you can simply call C with no arguments. If you have configured multiple databases, you can still call C with no arguments if there is a database named C in the configuration. With no argument, the C schema is returned. Otherwise, you B provide C with the name of the database: my $user = schema('foo')->resultset('User')->find('bob'); =head2 resultset This is a convenience method that will save you some typing. Use this B when accessing the C schema. my $user = resultset('User')->find('bob'); is equivalent to: my $user = schema->resultset('User')->find('bob'); =head2 rset my $user = rset('User')->find('bob'); This is simply an alias for C. =head1 SCHEMA GENERATION There are two approaches for generating schema classes. You may generate your own L classes and set the corresponding C setting in your configuration as shown above. This is the recommended approach for performance and stability. It is also possible to have schema classes dynamically generated if you omit the C configuration setting. This requires you to have L installed. The C naming scheme will be used for naming the auto generated classes. See L for more information about naming. For generating your own schema classes, you can use the L command line tool provided by L to help you. For example, if your app were named Foo, then you could run the following from the root of your project directory: dbicdump -o dump_directory=./lib Foo::Schema dbi:SQLite:/path/to/foo.db For that example, your C setting would be C. =head1 CONTRIBUTORS =over 4 =item * Alexis Sukrieh =item * Dagfinn Ilmari Mannsåker > =item * David Precious =item * Fabrice Gabolde > =item * Franck Cuny =item * Steven Humphrey > =item * Yanick Champoux > =back =head1 AUTHORS =over 4 =item * Al Newkirk =item * Naveed Massjouni =back =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2010 by awncorp. 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