DBICx-Sugar-0.0001000755001750001750 012505740615 13436 5ustar00naveednaveed000000000000README100644001750001750 1576012505740615 14430 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001NAME DBICx::Sugar - Just some syntax sugar for DBIx::Class VERSION version 0.0001 SYNOPSIS use DBICx::Sugar qw(schema resultset rset); 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'); DESCRIPTION Just some syntax sugar for your DBIx::Class applications. This was originally created to remove code duplication between Dancer::Plugin::DBIC and Dancer2::Plugin::DBIC. CONFIGURATION Configuration can be automatically parsed from a `config.yaml` or `config.yml` file in the current working directory, or it can be explicitly set with the config function: DBICx::Sugar::config({ default => { dsn => ... } }); If you want the config to be autoloaded from a yaml config file, just make sure to put your config data under a top level dbicx_sugar key. simple example Here is a simple example. It defines one database named default: dbicx_sugar: default: dsn: dbi:SQLite:dbname=myapp.db schema_class: MyApp::Schema multiple schemas In this example, there are 2 databases configured named default and foo: dbicx_sugar: default: dsn: dbi:SQLite:dbname=myapp.db schema_class: MyApp::Schema foo: dsn: dbi:Pg:dbname=foo schema_class: Foo::Schema user: bob password: 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. You need DBIx::Class::Schema::Loader installed for this to work. WARNING: Dynamic loading is not recommended for production environments. It is almost always better to provide a schema_class option. The schema_class option should be the name of your DBIx::Class::Schema class. See "SCHEMA GENERATION" Optionally, a database configuration may have user, password, and options parameters as described in the documentation for connect() in DBI. connect_info Alternatively, you may also declare your connection information inside an array named connect_info: dbicx_sugar: default: schema_class: MyApp::Schema connect_info: - dbi:Pg:dbname=foo - bob - secret - RaiseError: 1 PrintError: 1 replicated You can also add database read slaves to your configuration with the replicated config option. This will automatically make your read queries go to a slave and your write queries go to the master. Keep in mind that this will require additional dependencies: DBIx::Class::Optional::Dependencies#Storage::Replicated See DBIx::Class::Storage::DBI::Replicated for more details. Here is an example configuration that adds two read slaves: dbicx_sugar: default: schema_class: MyApp::Schema dsn: dbi:Pg:dbname=master replicated: balancer_type: ::Random # optional balancer_args: # optional auto_validate_every: 5 # optional master_read_weight:1 # optional # pool_type and pool_args are also allowed and are also optional replicants: - - dbi:Pg:dbname=slave1 - user1 - password1 - quote_names: 1 pg_enable_utf8: 1 - - dbi:Pg:dbname=slave2 - user2 - password2 - quote_names: 1 pg_enable_utf8: 1 alias Schema aliases allow you to reference the same underlying database by multiple names. For example: dbicx_sugar: default: dsn: dbi:Pg:dbname=master schema_class: MyApp::Schema slave1: alias: default Now you can access the default schema with schema(), schema('default'), or schema('slave1'). This can come in handy if, for example, you have master/slave replication in your production environment but only a single database in your development environment. You can continue to reference schema('slave1') in your code in both environments by simply creating a schema alias in your development.yml config file, as shown above. FUNCTIONS schema my $user = schema->resultset('User')->find('bob'); Returns a DBIx::Class::Schema object ready for you to use. For performance, schema objects are cached in memory and are lazy loaded the first time they are accessed. 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 Setting the schema_class option and having proper DBIx::Class classes is the recommended approach for performance and stability. 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 this example, your schema_class setting would be 'Foo::Schema'. AUTHOR Naveed Massjouni COPYRIGHT AND LICENSE This software is copyright (c) 2015 by Naveed Massjouni. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. LICENSE100644001750001750 4366712505740615 14564 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001This software is copyright (c) 2015 by Naveed Massjouni. 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) 2015 by Naveed Massjouni. 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) 2015 by Naveed Massjouni. 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 CHANGES100644001750001750 74712505740615 14502 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001================================================== Changes from 2005-03-31 00:00:00 +0000 to present. ================================================== ------------------------------------------- version 0.0001 at 2015-03-29 09:10:36 +0000 ------------------------------------------- Change: ab63e49d6cf396abf1fad6354f8abfcee5991d25 Author: Naveed Massjouni Date : 2015-03-29 05:08:21 +0000 first commit ================ End of releases. ================ META.yml100644001750001750 155212505740615 14773 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001--- abstract: 'Just some syntax sugar for DBIx::Class' author: - 'Naveed Massjouni ' build_requires: DBI: 0 DBIx::Class::Core: 0 DBIx::Class::Schema: 0 File::Spec: 0 File::Temp: 0 IO::Handle: 0 IPC::Open3: 0 Test::Modern: 0 Test::More: 0 Test::Requires: 0 base: 0 perl: 5.006 configure_requires: ExtUtils::MakeMaker: 0 dynamic_config: 0 generated_by: 'Dist::Zilla version 5.031, CPAN::Meta::Converter version 2.142690' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: DBICx-Sugar requires: Carp: 0 DBIx::Class: 0 Exporter: 0 Memoize: 0 Module::Load: 0 SQL::Translator: 0.11018 YAML: 0 strict: 0 warnings: 0 resources: bugtracker: https://github.com/ironcamel/DBICx-Sugar/issues repository: git://github.com/ironcamel/DBICx-Sugar.git version: 0.0001 MANIFEST100644001750001750 50312505740615 14626 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.031. CHANGES LICENSE MANIFEST META.yml Makefile.PL README dist.ini lib/DBICx/Sugar.pm t/00-compile.t t/01-single-schema.t t/02-multiple-schemas.t t/03-dynamic-schemas.t t/05-schema-aliases.t t/06-replicated.t t/lib/Foo.pm t/lib/Foo/Result/User.pm dist.ini100644001750001750 137412505740615 15170 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001name = DBICx-Sugar author = Naveed Massjouni license = Perl_5 copyright_holder = Naveed Massjouni copyright_year = 2015 version = 0.0001 [@Filter] -bundle = @Basic -remove = Readme -remove = GatherDir [AutoPrereqs] [ChangelogFromGit] max_age = 3650 [CopyFilesFromBuild] copy = Makefile.PL [GatherDir] exclude_filename = Makefile.PL [MetaResources] bugtracker.web = https://github.com/ironcamel/DBICx-Sugar/issues repository.type = git repository.url = git://github.com/ironcamel/DBICx-Sugar.git repository.web = https://github.com/ironcamel/DBICx-Sugar [OurPkgVersion] [PodWeaver] [Prereqs] DBIx::Class = 0 SQL::Translator = 0.11018 [ReadmeAnyFromPod] [ReadmeAnyFromPod / MarkdownInRoot] filename = README.md [Test::Compile] Makefile.PL100644001750001750 354412505740615 15477 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.031. use strict; use warnings; use 5.006; use ExtUtils::MakeMaker; my %WriteMakefileArgs = ( "ABSTRACT" => "Just some syntax sugar for DBIx::Class", "AUTHOR" => "Naveed Massjouni ", "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => 0 }, "DISTNAME" => "DBICx-Sugar", "EXE_FILES" => [], "LICENSE" => "perl", "MIN_PERL_VERSION" => "5.006", "NAME" => "DBICx::Sugar", "PREREQ_PM" => { "Carp" => 0, "DBIx::Class" => 0, "Exporter" => 0, "Memoize" => 0, "Module::Load" => 0, "SQL::Translator" => "0.11018", "YAML" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "DBI" => 0, "DBIx::Class::Core" => 0, "DBIx::Class::Schema" => 0, "File::Spec" => 0, "File::Temp" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Test::Modern" => 0, "Test::More" => 0, "Test::Requires" => 0, "base" => 0 }, "VERSION" => "0.0001", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Carp" => 0, "DBI" => 0, "DBIx::Class" => 0, "DBIx::Class::Core" => 0, "DBIx::Class::Schema" => 0, "Exporter" => 0, "ExtUtils::MakeMaker" => 0, "File::Spec" => 0, "File::Temp" => 0, "IO::Handle" => 0, "IPC::Open3" => 0, "Memoize" => 0, "Module::Load" => 0, "SQL::Translator" => "0.11018", "Test::Modern" => 0, "Test::More" => 0, "Test::Requires" => 0, "YAML" => 0, "base" => 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); lib000755001750001750 012505740615 14370 5ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tFoo.pm100644001750001750 15212505740615 15567 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/t/libpackage Foo; use base 'DBIx::Class::Schema'; use strict; use warnings; __PACKAGE__->load_namespaces; 1; t000755001750001750 012505740615 13622 5ustar00naveednaveed000000000000DBICx-Sugar-0.000100-compile.t100644001750001750 211712505740615 16015 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tuse 5.006; use strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::Compile 2.051 use Test::More; plan tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0); my @module_files = ( 'DBICx/Sugar.pm' ); # no fake home requested my $inc_switch = -d 'blib' ? '-Mblib' : '-Ilib'; use File::Spec; use IPC::Open3; use IO::Handle; open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; my @warnings; for my $lib (@module_files) { # see L my $stderr = IO::Handle->new; my $pid = open3($stdin, '>&STDERR', $stderr, $^X, $inc_switch, '-e', "require q[$lib]"); binmode $stderr, ':crlf' if $^O eq 'MSWin32'; my @_warnings = <$stderr>; waitpid($pid, 0); is($?, 0, "$lib loaded ok"); if (@_warnings) { warn @_warnings; push @warnings, @_warnings; } } is(scalar(@warnings), 0, 'no warnings found') or diag 'got warnings: ', ( Test::More->can('explain') ? Test::More::explain(\@warnings) : join("\n", '', @warnings) ) if $ENV{AUTHOR_TESTING}; 06-replicated.t100644001750001750 347112505740615 16513 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tuse Test::Modern; use DBI; use DBICx::Sugar qw(config rset schema); use File::Temp qw(tempfile); use Test::Requires { 'DBD::SQLite' => 0, 'Moose' => 0.98, 'MooseX::Types' => 0.21, 'MooseX::Types::LoadableClass' => 0.011, }; plan tests => 8; my @dbfiles = map { (tempfile SUFFIX => '.db' )[1] } 1..3; my @dbh = ( DBI->connect("dbi:SQLite:dbname=$dbfiles[1]"), DBI->connect("dbi:SQLite:dbname=$dbfiles[2]") ); ok $dbh[0]->do('create table user (name varchar(100) primary key, age int)'); ok $dbh[1]->do('create table user (name varchar(100) primary key, age int)'); $dbh[0]->do('insert into user values(?,?)', {}, 'bob', 20); $dbh[1]->do('insert into user values(?,?)', {}, 'bob', 30); config({ default => { dsn => "dbi:SQLite:dbname=$dbfiles[0]", schema_class => 'Foo', replicated => { balancer_type => '::Random', replicants => [ [ "dbi:SQLite:dbname=$dbfiles[1]" ], [ "dbi:SQLite:dbname=$dbfiles[2]" ], ], }, }, }); schema->deploy; # add a 10 year old bob to master ok rset('User')->create({ name => 'bob', age => 10 }); # should find an older bob from one of the replicants is rset('User')->count({ name => 'bob', age => { '>=', 20 } }), 1, 'found older bob in one of the replicants'; # now force the query to use the master db, which has the 10 year old bob is rset('User')->count({ name => 'bob', age => 10 }, {force_pool => 'master'}), 1, 'found the 30 year old bob in the master db'; my %set = (); for (1 .. 100) { my $bob = rset('User')->single({ name => 'bob' }); $set{$bob->age}++; } is keys %set => 2, 'random balancer accessed both replicants' or diag explain \%set; ok $set{20} && $set{30}; unlink @dbfiles; DBICx000755001750001750 012505740615 15016 5ustar00naveednaveed000000000000DBICx-Sugar-0.0001/libSugar.pm100644001750001750 2342112505740615 16617 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/lib/DBICxpackage DBICx::Sugar; use strict; use warnings; use Carp qw(croak); use Exporter qw(import); use Memoize qw(memoize); use Module::Load; use YAML qw(LoadFile); our $VERSION = '0.0001'; # VERSION our @EXPORT_OK = qw(config rset resultset schema); my $_config; my $_schemas = {}; sub config { my ($data) = @_; if ($data) { croak 'config data must be a hashref' unless 'HASH' eq ref $data; $_config = $data; } return $_config if $_config; my $config_path; if (-f 'config.yaml') { $config_path = 'config.yaml' } elsif (-f 'config.yml') { $config_path = 'config.yml'; } else { croak "could not find a config.yml or config.yaml file"; } return LoadFile($config_path)->{dbicx_sugar}; } sub schema { my ($name) = @_; my $cfg = config(); 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"; if ( my $alias = $options->{alias} ) { $options = $cfg->{$alias} or die "The schema alias $alias does not exist in the config"; return $_schemas->{$alias} if $_schemas->{$alias}; } my @conn_info = $options->{connect_info} ? @{$options->{connect_info}} : @$options{qw(dsn user password options)}; if ( exists $options->{pass} ) { warn "The pass option is deprecated. Use password instead."; $conn_info[2] = $options->{pass}; } my $schema; if ( my $schema_class = $options->{schema_class} ) { $schema_class =~ s/-/::/g; eval { load $schema_class }; die "Could not load schema_class $schema_class: $@" if $@; if ( my $replicated = $options->{replicated} ) { $schema = $schema_class->clone; my %storage_options; my @params = qw( balancer_type balancer_args pool_type pool_args ); for my $p ( @params ) { my $value = $replicated->{$p}; $storage_options{$p} = $value if defined $value; } $schema->storage_type([ '::DBI::Replicated', \%storage_options ]); $schema->connection( @conn_info ); $schema->storage->connect_replicants( @{$replicated->{replicants}}); } else { $schema = $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( $options->{schema_loader_naming} || 'v7' ); $schema = DBIx::Class::Schema::Loader->connect(@conn_info); } return $_schemas->{$name} = $schema; }; sub resultset { my ($rset_name) = @_; return schema()->resultset($rset_name); } sub rset { goto &resultset }; # ABSTRACT: Just some syntax sugar for DBIx::Class 1; __END__ =pod =encoding UTF-8 =head1 NAME DBICx::Sugar - Just some syntax sugar for DBIx::Class =head1 VERSION version 0.0001 =head1 SYNOPSIS use DBICx::Sugar qw(schema resultset rset); 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'); =head1 DESCRIPTION Just some syntax sugar for your DBIx::Class applications. This was originally created to remove code duplication between L and L. =head1 CONFIGURATION Configuration can be automatically parsed from a `config.yaml` or `config.yml` file in the current working directory, or it can be explicitly set with the C function: DBICx::Sugar::config({ default => { dsn => ... } }); If you want the config to be autoloaded from a yaml config file, just make sure to put your config data under a top level C key. =head2 simple example Here is a simple example. It defines one database named C: dbicx_sugar: default: dsn: dbi:SQLite:dbname=myapp.db schema_class: MyApp::Schema =head2 multiple schemas In this example, there are 2 databases configured named C and C: dbicx_sugar: default: dsn: dbi:SQLite:dbname=myapp.db schema_class: MyApp::Schema foo: dsn: dbi:Pg:dbname=foo schema_class: Foo::Schema user: bob password: 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. You need L installed for this to work. WARNING: Dynamic loading is not recommended for production environments. It is almost always better to provide a schema_class option. The schema_class option should be the name of your L class. See L Optionally, a database configuration may have user, password, and options parameters as described in the documentation for C in L. =head2 connect_info Alternatively, you may also declare your connection information inside an array named C: dbicx_sugar: default: schema_class: MyApp::Schema connect_info: - dbi:Pg:dbname=foo - bob - secret - RaiseError: 1 PrintError: 1 =head2 replicated You can also add database read slaves to your configuration with the C config option. This will automatically make your read queries go to a slave and your write queries go to the master. Keep in mind that this will require additional dependencies: L See L for more details. Here is an example configuration that adds two read slaves: dbicx_sugar: default: schema_class: MyApp::Schema dsn: dbi:Pg:dbname=master replicated: balancer_type: ::Random # optional balancer_args: # optional auto_validate_every: 5 # optional master_read_weight:1 # optional # pool_type and pool_args are also allowed and are also optional replicants: - - dbi:Pg:dbname=slave1 - user1 - password1 - quote_names: 1 pg_enable_utf8: 1 - - dbi:Pg:dbname=slave2 - user2 - password2 - quote_names: 1 pg_enable_utf8: 1 =head2 alias Schema aliases allow you to reference the same underlying database by multiple names. For example: dbicx_sugar: default: dsn: dbi:Pg:dbname=master schema_class: MyApp::Schema slave1: alias: default Now you can access the default schema with C, C, or C. This can come in handy if, for example, you have master/slave replication in your production environment but only a single database in your development environment. You can continue to reference C in your code in both environments by simply creating a schema alias in your development.yml config file, as shown above. =head1 FUNCTIONS =head2 schema my $user = schema->resultset('User')->find('bob'); Returns a L object ready for you to use. For performance, schema objects are cached in memory and are lazy loaded the first time they are accessed. 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 Setting the schema_class option and having proper DBIx::Class classes is the recommended approach for performance and stability. 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 this example, your C setting would be C<'Foo::Schema'>. =head1 AUTHOR Naveed Massjouni =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2015 by Naveed Massjouni. 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 01-single-schema.t100644001750001750 175012505740615 17107 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tuse Test::Modern; use DBICx::Sugar qw(config rset resultset schema); use Test::Requires qw(DBD::SQLite); plan tests => 5; config({ foo => { schema_class => 'Foo', dsn => 'dbi:SQLite:dbname=:memory:', } }); schema->deploy; ok rset('User')->create({ name => 'bob', age => 2 }), 'created young bob'; 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 { like exception { schema('bar')->resultset('User')->find('bob') }, qr/schema bar is not configured/, 'missing schema error thrown'; }; 05-schema-aliases.t100644001750001750 161712505740615 17255 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tuse Test::Modern; use DBICx::Sugar qw(config rset schema); use Test::Requires qw(DBD::SQLite); plan tests => 5; config({ default => { schema_class => 'Foo', dsn => 'dbi:SQLite:dbname=:memory:', }, foo => { alias => 'default', }, badalias => { alias => 'zzz', }, }); schema->deploy; ok rset('User')->create({ name => 'bob', age => 30 }); subtest 'default schema' => sub { ok my $user = rset('User')->find('bob'), 'found bob'; is $user->age => '30', 'bob is getting old'; }; subtest 'schema alias' => sub { ok my $user = schema('foo')->resultset('User')->find('bob'), 'found bob'; is $user->age => '30', 'bob is still old'; }; subtest 'bad alias' => sub { like exception { schema('badalias')->resultset('User')->find('bob') }, qr/schema alias zzz does not exist in the config/, 'got bad alias error'; }; 03-dynamic-schemas.t100644001750001750 153312505740615 17436 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tuse Test::Modern; use DBI; use DBICx::Sugar qw(config schema); use File::Temp qw(tempfile); use Test::Requires qw(DBD::SQLite DBIx::Class::Schema::Loader); # Test dynamic schema loading by not providing a schema_class config option. # These tests require DBIx::Class::Schema::Loader to be installed plan tests => 4; my $dbfile = (tempfile SUFFIX => '.db')[1]; config({ 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.t100644001750001750 327312505740615 17647 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/tuse Test::Modern; use DBICx::Sugar qw(config rset resultset schema); use File::Temp qw(tempfile); use Test::Requires qw(DBD::SQLite); plan tests => 3; my @dbfiles = map { (tempfile SUFFIX => '.db' )[1] } 1..2; subtest 'two schemas' => sub { config({ foo => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfiles[0]", }, bar => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfiles[1]", }, }); schema('foo')->deploy; ok schema('foo')->resultset('User')->create({ name => 'bob', age => 30 }); schema('bar')->deploy; ok schema('bar')->resultset('User')->create({ name => 'sue', age => 20 }); 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'; like exception { schema('poo')->resultset('User')->find('bob') }, qr/schema poo is not configured/, 'Missing schema error thrown'; like exception { schema->resultset('User')->find('bob') }, qr/The schema default is not configured/, 'Missing default schema error thrown'; }; subtest 'two schemas with a default schema' => sub { config({ default => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfiles[0]", }, bar => { schema_class => 'Foo', dsn => "dbi:SQLite:dbname=$dbfiles[1]", }, }); ok my $bob = schema->resultset('User')->find('bob'), 'found bob'; is $bob->age => 30; }; unlink @dbfiles; Result000755001750001750 012505740615 16371 5ustar00naveednaveed000000000000DBICx-Sugar-0.0001/t/lib/FooUser.pm100644001750001750 46012505740615 17765 0ustar00naveednaveed000000000000DBICx-Sugar-0.0001/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;