Object-Tiny-1.06/0000755000175100017510000000000011051577510013421 5ustar adamadam00000000000000Object-Tiny-1.06/META.yml0000644000175100017510000000071211051577510014672 0ustar adamadam00000000000000--- #YAML:1.0 name: Object-Tiny version: 1.06 abstract: A date object with as little code as possible license: perl author: - Adam Kennedy generated_by: ExtUtils::MakeMaker version 6.44 distribution_type: module requires: Test::More: 0.47 meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.3.html version: 1.3 Object-Tiny-1.06/README0000644000175100017510000002152711051577471014316 0ustar adamadam00000000000000NAME Object::Tiny - Class building as simple as it gets SYNOPSIS # Define a class package Foo; use Object::Tiny qw{ bar baz }; 1; # Use the class my $object = Foo->new( bar => 1 ); print "bar is " . $object->bar . "\n"; DESCRIPTION There's a whole bunch of class builders out there. In fact, creating a class builder seems to be something of a rite of passage (this is my fifth, at least). Unfortunately, most of the time I want a class builder I'm in a hurry and sketching out lots of fairly simple data classes with fairly simple structure, mostly just read-only accessors, and that's about it. Often this is for code that won't end up on CPAN, so adding a small dependency doesn't matter much. I just want to be able to define these classes FAST. By which I mean LESS typing than writing them by hand, not more. And I don't need all those weird complex features that bloat out the code and take over the whole way I build modules. And so, I present yet another member of the Tiny family of modules, Object::Tiny. The goal here is really just to save me some typing. There's others that could do the job just fine, but I want something that does as little as possible and creates code the same way I'd have written it by hand anyway. To use Object::Tiny, just call it with a list of accessors to be created. use Object::Tiny 'foo', 'bar'; For a large list, I lay it out like this... use Object::Tiny qw{ item_font_face item_font_color item_font_size item_text_content item_display_time seperator_font_face seperator_font_color seperator_font_size seperator_text_content }; This will create a bunch of simple accessors, and set the inheritance to be the child of Object::Tiny. Object::Tiny is empty other than a basic "new" constructor which does the following sub new { my $class = shift; return bless { @_ }, $class; } In fact, if doing the following in your class gets annoying... sub new { my $class = shift; my $self = $class->SUPER::new( @_ ); # Extra checking and such ... return $self; } ... then feel free to ditch the SUPER call and just create the hash yourself! It's not going to make a lick of different and there's nothing magic going on under the covers you might break. And that's really all there is to it. Let a million simple data classes bloom. Features? We don't need no stinking features. Handling Subclasses If the class you are using Object::Tiny for is already a subclass of another Object::Tiny class (or a subclass of anything else) it doesn't really work to make the class use multiple inheritance. So in this case, Object::Tiny will create the accessors you specify, but WON'T make it a subclass of Object::Tiny. Why bother when Class::Accessor::* already does the same thing? As a class builder, Object::Tiny inevitably is compared to Class::Accessor and related modules. They seem so similar, so why would I reimplement it? The answer is that for experienced developers that don't need or want hand-holding, Object::Tiny is just outright better, faster or cheaper on every single metric than Class::Accessor::Fast, which is the most comparable member of the Class::Accessor::* family. Object::Tiny is 93% smaller than Class::Accessor::Fast Class::Accessor::Fast requires about 125k of memory to load. Object::Tiny requires about 8k of memory to load. Object::Tiny is 75% more terse to use than Class::Accessor::Fast Object::Tiny is used with the least possible number of keystrokes (short of making the actual name Object::Tiny smaller). And it requires no ugly constructor methods. I mean really, what sort of a method name is 'mk_ro_accessors'. That sort of thing went out of style in the early nineties. Using Class::Accessor::Fast... package Foo::Bar; use base 'Class::Accessor::Fast'; Foo::Bar->mk_ro_accessors(qw{ foo bar baz }); Using Object::Tiny... package Foo::Bar; use Object::Tiny qw{ foo bar baz }; Further, Object::Tiny lets you pass your params in directly, without having to wrap them in an additional HASH reference that will just be copied ANYWAY inside the constructor. Using Class::Accessor::Fast... my $object = Foo::Bar->new( { foo => 1, bar => 2, baz => 3, } ); Using Object::Tiny... my $object = Foo::Bar->new( foo => 1, bar => 2, baz => 3, ); Object::Tiny constructors are 110% faster than Class::Accessor::Fast Object::Tiny accessors are identical in speed to Class::Accessor::Fast accessors, but Object::Tiny constructors are TWICE as fast as Class::Accessor::Fast constructors, DESPITE C:A:Fast forcing you to pass by reference (which is typically done for speed reasons). Benchmarking constructor plus accessors... Rate accessor tiny accessor 100949/s -- -45% tiny 182382/s 81% -- Benchmarking constructor alone... Rate accessor tiny accessor 156470/s -- -54% tiny 342231/s 119% -- Benchmarking accessors alone... Rate tiny accessor tiny 81.0/s -- -0% accessor 81.0/s 0% -- Object::Tiny pollutes your API 95% less than Class::Accessor::Fast Object::Tiny adds two methods to your class, "new" and "import". The "new" constructor is so trivial you can just ignore it and use your own if you wish, and the "import" will shortcut and do nothing (it is used to implement the "use Object::Tiny qw{ foo bar baz };" syntax itself). So if you make your own import, you can ignore the Object::Tiny one. Class::Accessor::Fast isn't quite as light, adding all sorts of useless extra public methods (why on earth would you want to add method accessors at run-time?). Here's what the classes used in the benchmark end up like. DB<1> use Class::Inspector DB<2> x Class::Inspector->methods('Foo_Bar_Tiny'); 0 ARRAY(0xfda780) 0 'bar' 1 'baz' 2 'foo' 3 'import' 4 'new' DB<3> x Class::Inspector->methods('Foo_Bar_Accessor'); 0 ARRAY(0xfdb3c8) 0 '_bar_accessor' 1 '_baz_accessor' 2 '_carp' 3 '_croak' 4 '_foo_accessor' 5 '_mk_accessors' 6 'accessor_name_for' 7 'bar' 8 'baz' 9 'best_practice_accessor_name_for' 10 'best_practice_mutator_name_for' 11 'follow_best_practice' 12 'foo' 13 'get' 14 'make_accessor' 15 'make_ro_accessor' 16 'make_wo_accessor' 17 'mk_accessors' 18 'mk_ro_accessors' 19 'mk_wo_accessors' 20 'mutator_name_for' 21 'new' 22 'set' As you can see, Object::Tiny adds 2 methods to your class, Class::Accessor adds 16 methods, plus one extra one for every accessor. Object::Tiny doesn't have any of the caveats of Class::Accessor::Fast When you call use Object::Tiny qw{ foo bar baz } it isn't treated as some sort of specification for the class, it's just a list of accessors you want made for you. So if you want to customize "foo" you don't need to get into contortions with "pure" base classes or calling alternate internal methods. Just make your own "foo" method and remove "foo" from the list passed to the "use" call. Object::Tiny is more back-compatible than Class::Accessor::Fast Class::Accessor::Fast has a minimum Perl dependency of 5.005002. Object::Tiny has a minimum Perl dependency of 5.004. Object::Tiny has no module dependencies whatsoever Object::Tiny does not load ANYTHING at all outside of its own single .pm file. So Object::Tiny will never get confused in odd situations due to old or weird versions of other modules (Class::Accessor::Fast has a dependency on base.pm, which has some caveats of its own). SUPPORT Bugs should be reported via the CPAN bug tracker at For other issues, contact the author. AUTHOR Adam Kennedy SEE ALSO Config::Tiny COPYRIGHT Copyright 2007 - 2008 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. Object-Tiny-1.06/Makefile.PL0000644000175100017510000000111311051577471015375 0ustar adamadam00000000000000use strict; use vars qw{$VERSION}; BEGIN { require 5.003_96; $VERSION = '1.06'; } use ExtUtils::MakeMaker; WriteMakefile( NAME => 'Object::Tiny', ABSTRACT => 'A date object with as little code as possible', VERSION => $VERSION, PREREQ_PM => { # Skip on Windows to avoid breaking ActivePerl PPMs # 0.47 means 5.6.2 or newer, which everyone on Win32 has. ($^O eq 'MSWin32' ? () : ('Test::More' => '0.47')), }, ($] >= 5.005 ? ( AUTHOR => 'Adam Kennedy ', ) : ()), ($ExtUtils::MakeMaker::VERSION ge '6.30_00' ? ( LICENSE => 'perl', ) : ()), ); Object-Tiny-1.06/LICENSE0000644000175100017510000004737111051577471014450 0ustar adamadam00000000000000 Terms of Perl 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 General Public License (GPL) Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU 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. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), 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 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 show them these terms so they know 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. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. 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 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 derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 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 License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. 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. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary 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 License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 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 Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing 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 for copying, distributing or modifying the Program or works based on it. 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. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. 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 this 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 this License, you may choose any version ever published by the Free Software Foundation. 10. 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 11. 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. 12. 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 ---------------------------------------------------------------------------- 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 Object-Tiny-1.06/examples/0000755000175100017510000000000011051577510015237 5ustar adamadam00000000000000Object-Tiny-1.06/examples/Foo_Bar_Accessor.pm0000644000175100017510000000016711051577471020740 0ustar adamadam00000000000000package Foo_Bar_Accessor; use base 'Class::Accessor::Fast'; Foo_Bar_Accessor->mk_ro_accessors(qw{ foo bar baz }); 1; Object-Tiny-1.06/examples/benchmark.pl0000644000175100017510000000315711051577471017542 0ustar adamadam00000000000000#!/usr/bin/perl BEGIN { $DB::single = 1; } use Object::Tiny (); use Class::Accessor::Fast (); use Foo_Bar_Accessor (); use Foo_Bar_Accessor2 (); use Foo_Bar_Tiny (); use Foo_Bar_Tiny2 (); use Benchmark ':all'; print "\nBenchmarking constructor plus accessors...\n"; cmpthese( 1000000, { 'tiny' => ' my $object = Foo_Bar_Tiny->new( foo => 1, bar => 2, baz => 4, ); $object->foo; $object->bar; $object->baz; ', 'accessor' => ' my $object = Foo_Bar_Accessor->new( { foo => 1, bar => 2, baz => 4, } ); $object->foo; $object->bar; $object->baz; ', } ); sleep 1; print "\nBenchmarking constructor alone...\n"; cmpthese( 1000000, { 'tiny' => ' Foo_Bar_Tiny->new( foo => 1, bar => 2, baz => 4, ); ', 'accessor' => ' Foo_Bar_Accessor->new( { foo => 1, bar => 2, baz => 4, } ); ', } ); sleep 1; print "\nBenchmarking accessors alone...\n"; my $tiny = Foo_Bar_Tiny->new( foo => 1, bar => 2, baz => 4, ); my $accessor = Foo_Bar_Tiny->new( { foo => 1, bar => 2, baz => 3, } ); cmpthese( 1000, { 'tiny' => sub { foreach ( 1 .. 1000 ) { $tiny->foo; $tiny->bar; $tiny->baz; } }, 'accessor' => sub { foreach ( 1 .. 1000 ) { $accessor->foo; $accessor->bar; $accessor->baz; } }, } ); Object-Tiny-1.06/examples/Foo_Bar_Accessor2.pm0000644000175100017510000000024011051577471021012 0ustar adamadam00000000000000package Foo_Bar_Accessor2; use base 'Class::Accessor::Fast'; Foo_Bar_Accessor->mk_ro_accessors(qw{ q w e r t y u i o p a s d f g h j k l z x c v b n m }); 1; Object-Tiny-1.06/examples/Foo_Bar_Tiny.pm0000644000175100017510000000007711051577471020121 0ustar adamadam00000000000000package Foo_Bar_Tiny; use Object::Tiny qw{ foo bar baz }; 1; Object-Tiny-1.06/examples/Foo_Bar_Tiny2.pm0000644000175100017510000000015111051577471020174 0ustar adamadam00000000000000package Foo_Bar_Tiny2; use Object::Tiny qw{ q w e r t y u i o p a s d f g h j k l z x c v b n m q}; 1; Object-Tiny-1.06/lib/0000755000175100017510000000000011051577510014167 5ustar adamadam00000000000000Object-Tiny-1.06/lib/Object/0000755000175100017510000000000011051577510015375 5ustar adamadam00000000000000Object-Tiny-1.06/lib/Object/Tiny.pm0000644000175100017510000002141411051577471016666 0ustar adamadam00000000000000package Object::Tiny; use strict 'vars', 'subs'; BEGIN { require 5.004; $Object::Tiny::VERSION = '1.06'; } sub import { return unless shift eq 'Object::Tiny'; my $pkg = caller; my $child = !! @{"${pkg}::ISA"}; eval join "\n", "package $pkg;", ($child ? () : "\@${pkg}::ISA = 'Object::Tiny';"), map { defined and ! ref and /^[^\W\d]\w*$/s or die "Invalid accessor name '$_'"; "sub $_ { return \$_[0]->{$_} }" } @_; die "Failed to generate $pkg" if $@; return 1; } sub new { my $class = shift; bless { @_ }, $class; } 1; __END__ =pod =head1 NAME Object::Tiny - Class building as simple as it gets =head1 SYNOPSIS # Define a class package Foo; use Object::Tiny qw{ bar baz }; 1; # Use the class my $object = Foo->new( bar => 1 ); print "bar is " . $object->bar . "\n"; =head1 DESCRIPTION There's a whole bunch of class builders out there. In fact, creating a class builder seems to be something of a rite of passage (this is my fifth, at least). Unfortunately, most of the time I want a class builder I'm in a hurry and sketching out lots of fairly simple data classes with fairly simple structure, mostly just read-only accessors, and that's about it. Often this is for code that won't end up on CPAN, so adding a small dependency doesn't matter much. I just want to be able to define these classes FAST. By which I mean LESS typing than writing them by hand, not more. And I don't need all those weird complex features that bloat out the code and take over the whole way I build modules. And so, I present yet another member of the Tiny family of modules, Object::Tiny. The goal here is really just to save me some typing. There's others that could do the job just fine, but I want something that does as little as possible and creates code the same way I'd have written it by hand anyway. To use Object::Tiny, just call it with a list of accessors to be created. use Object::Tiny 'foo', 'bar'; For a large list, I lay it out like this... use Object::Tiny qw{ item_font_face item_font_color item_font_size item_text_content item_display_time seperator_font_face seperator_font_color seperator_font_size seperator_text_content }; This will create a bunch of simple accessors, and set the inheritance to be the child of Object::Tiny. Object::Tiny is empty other than a basic C constructor which does the following sub new { my $class = shift; return bless { @_ }, $class; } In fact, if doing the following in your class gets annoying... sub new { my $class = shift; my $self = $class->SUPER::new( @_ ); # Extra checking and such ... return $self; } ... then feel free to ditch the SUPER call and just create the hash yourself! It's not going to make a lick of different and there's nothing magic going on under the covers you might break. And that's really all there is to it. Let a million simple data classes bloom. Features? We don't need no stinking features. =head2 Handling Subclasses If the class you are using Object::Tiny for is already a subclass of another Object::Tiny class (or a subclass of anything else) it doesn't really work to make the class use multiple inheritance. So in this case, Object::Tiny will create the accessors you specify, but WON'T make it a subclass of Object::Tiny. =head2 Why bother when Class::Accessor::* already does the same thing? As a class builder, L inevitably is compared to L and related modules. They seem so similar, so why would I reimplement it? The answer is that for experienced developers that don't need or want hand-holding, Object::Tiny is just outright better, faster or cheaper on every single metric than L, which is the most comparable member of the Class::Accessor::* family. B Class::Accessor::Fast requires about 125k of memory to load. Object::Tiny requires about 8k of memory to load. B Object::Tiny is used with the least possible number of keystrokes (short of making the actual name Object::Tiny smaller). And it requires no ugly constructor methods. I mean really, what sort of a method name is 'mk_ro_accessors'. That sort of thing went out of style in the early nineties. Using Class::Accessor::Fast... package Foo::Bar; use base 'Class::Accessor::Fast'; Foo::Bar->mk_ro_accessors(qw{ foo bar baz }); Using Object::Tiny... package Foo::Bar; use Object::Tiny qw{ foo bar baz }; Further, Object::Tiny lets you pass your params in directly, without having to wrap them in an additional HASH reference that will just be copied ANYWAY inside the constructor. Using Class::Accessor::Fast... my $object = Foo::Bar->new( { foo => 1, bar => 2, baz => 3, } ); Using Object::Tiny... my $object = Foo::Bar->new( foo => 1, bar => 2, baz => 3, ); B Object::Tiny accessors are identical in speed to Class::Accessor::Fast accessors, but Object::Tiny constructors are TWICE as fast as Class::Accessor::Fast constructors, DESPITE C:A:Fast forcing you to pass by reference (which is typically done for speed reasons). Benchmarking constructor plus accessors... Rate accessor tiny accessor 100949/s -- -45% tiny 182382/s 81% -- Benchmarking constructor alone... Rate accessor tiny accessor 156470/s -- -54% tiny 342231/s 119% -- Benchmarking accessors alone... Rate tiny accessor tiny 81.0/s -- -0% accessor 81.0/s 0% -- B Object::Tiny adds two methods to your class, C and C. The C constructor is so trivial you can just ignore it and use your own if you wish, and the C will shortcut and do nothing (it is used to implement the C<"use Object::Tiny qw{ foo bar baz };"> syntax itself). So if you make your own import, you can ignore the Object::Tiny one. Class::Accessor::Fast isn't quite as light, adding all sorts of useless extra public methods (why on earth would you want to add method accessors at run-time?). Here's what the classes used in the benchmark end up like. DB<1> use Class::Inspector DB<2> x Class::Inspector->methods('Foo_Bar_Tiny'); 0 ARRAY(0xfda780) 0 'bar' 1 'baz' 2 'foo' 3 'import' 4 'new' DB<3> x Class::Inspector->methods('Foo_Bar_Accessor'); 0 ARRAY(0xfdb3c8) 0 '_bar_accessor' 1 '_baz_accessor' 2 '_carp' 3 '_croak' 4 '_foo_accessor' 5 '_mk_accessors' 6 'accessor_name_for' 7 'bar' 8 'baz' 9 'best_practice_accessor_name_for' 10 'best_practice_mutator_name_for' 11 'follow_best_practice' 12 'foo' 13 'get' 14 'make_accessor' 15 'make_ro_accessor' 16 'make_wo_accessor' 17 'mk_accessors' 18 'mk_ro_accessors' 19 'mk_wo_accessors' 20 'mutator_name_for' 21 'new' 22 'set' As you can see, Object::Tiny adds 2 methods to your class, Class::Accessor adds 16 methods, plus one extra one for every accessor. B When you call B it isn't treated as some sort of specification for the class, it's just a list of accessors you want made for you. So if you want to customize C you don't need to get into contortions with "pure" base classes or calling alternate internal methods. Just make your own C method and remove C from the list passed to the C call. B Class::Accessor::Fast has a minimum Perl dependency of 5.005002. Object::Tiny has a minimum Perl dependency of 5.004. B Object::Tiny does not load ANYTHING at all outside of its own single .pm file. So Object::Tiny will never get confused in odd situations due to old or weird versions of other modules (Class::Accessor::Fast has a dependency on base.pm, which has some caveats of its own). =head1 SUPPORT Bugs should be reported via the CPAN bug tracker at L For other issues, contact the author. =head1 AUTHOR Adam Kennedy Eadamk@cpan.orgE =head1 SEE ALSO L =head1 COPYRIGHT Copyright 2007 - 2008 Adam Kennedy. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. =cut Object-Tiny-1.06/MANIFEST0000644000175100017510000000056411051577510014557 0ustar adamadam00000000000000Changes examples/benchmark.pl examples/Foo_Bar_Accessor.pm examples/Foo_Bar_Accessor2.pm examples/Foo_Bar_Tiny.pm examples/Foo_Bar_Tiny2.pm lib/Object/Tiny.pm LICENSE Makefile.PL MANIFEST This list of files README t/01_compile.t t/02_main.t t/03_subclass.t t/97_meta.t t/98_pod.t t/99_pmv.t META.yml Module meta-data (added by MakeMaker) Object-Tiny-1.06/Changes0000644000175100017510000000152411051577471014724 0ustar adamadam00000000000000Revision history for Perl extension Object-Tiny 1.06 Fri 4 Jul 2008 - No functional changes - Using strict.pm all the time - Fixing META.yml - Fixed two "it's" into "its" in the documentation. (SHLOMIF) 1.05 Thu 1 Nov 2007 - No functional changes - Converted Makefile.PL from Module::Install to EU:MM 1.04 Mon 22 Oct 2007 - No functional changes - Upgrading to a newer set of AUTOMATED_TESTING tests 1.03 Tue 4 Sep 2007 - Use explicit return in the generated accessors (makes them 5-10% faster according to benchmarking) - Jonathon Rockway asks why both when we have Class::Accessor::Fast. (I've added a documentation segment to answer it) 1.02 Wed 9 May 2007 - Fixing some POD things - No functional changes 1.01 Fri 23 Mar 2007 - Allowing the use of Object::Tiny with sub-classes 1.00 Tue 20 Mar 2007 - Initial release Object-Tiny-1.06/t/0000755000175100017510000000000011051577510013664 5ustar adamadam00000000000000Object-Tiny-1.06/t/97_meta.t0000644000175100017510000000107311051577471015325 0ustar adamadam00000000000000#!/usr/bin/perl # Test that our META.yml file matches the current specification. use strict; BEGIN { $| = 1; $^W = 1; } my $MODULE = 'Test::CPAN::Meta 0.12'; # Don't run tests for installs use Test::More; unless ( $ENV{AUTOMATED_TESTING} or $ENV{RELEASE_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Load the testing module eval "use $MODULE"; if ( $@ ) { $ENV{RELEASE_TESTING} ? die( "Failed to load required release-testing module $MODULE" ) : plan( skip_all => "$MODULE not available for testing" ); } meta_yaml_ok(); Object-Tiny-1.06/t/01_compile.t0000644000175100017510000000032011051577471016002 0ustar adamadam00000000000000#!/usr/bin/perl # Compile-testing for Object::Tiny use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 2; ok( $] >= 5.004, 'Perl version is 5.004 or newer' ); require_ok( 'Object::Tiny' ); Object-Tiny-1.06/t/03_subclass.t0000644000175100017510000000176111051577471016205 0ustar adamadam00000000000000#!/usr/bin/perl # Simple tests for a simple module use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 12; # Define a class SCOPE: { eval " package Bar; sub new { my \$class = shift; return bless { \@_ }, \$class; } package Foo; \@Foo::ISA = 'Bar'; use Object::Tiny qw{ foo bar }; "; ok( ! $@, 'Created package without error' ); } # Create a trivial object SCOPE: { my $empty = Foo->new; isa_ok( $empty, 'Foo' ); isa_ok( $empty, 'Bar' ); ok( ! $empty->isa('Object::Tiny'), 'Is not an Object::Tiny' ); is( scalar( keys %$empty ), 0, 'Empty object is empty' ); } # Create a real object SCOPE: { my $object = Foo->new( foo => 1, bar => 2, baz => 3 ); isa_ok( $object, 'Foo' ); isa_ok( $object, 'Bar' ); is( scalar( keys %$object ), 3, 'Object contains expect elements' ); is( $object->foo, 1, '->foo ok' ); is( $object->bar, 2, '->bar ok' ); eval { $object->baz; }; ok( $@, '->bar returns an error' ); is( $object->{baz}, 3, '->{baz} does contain value' ); } Object-Tiny-1.06/t/98_pod.t0000644000175100017510000000116711051577471015166 0ustar adamadam00000000000000#!/usr/bin/perl # Test that the syntax of our POD documentation is valid use strict; BEGIN { $| = 1; $^W = 1; } my @MODULES = ( 'Pod::Simple 3.07', 'Test::Pod 1.26', ); # Don't run tests for installs use Test::More; unless ( $ENV{AUTOMATED_TESTING} or $ENV{RELEASE_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Load the testing modules foreach my $MODULE ( @MODULES ) { eval "use $MODULE"; if ( $@ ) { $ENV{RELEASE_TESTING} ? die( "Failed to load required release-testing module $MODULE" ) : plan( skip_all => "$MODULE not available for testing" ); } } all_pod_files_ok(); Object-Tiny-1.06/t/02_main.t0000644000175100017510000000177011051577471015311 0ustar adamadam00000000000000#!/usr/bin/perl # Simple tests for a simple module use strict; BEGIN { $| = 1; $^W = 1; } use Test::More tests => 12; # Define a class SCOPE: { eval " package Foo; use Object::Tiny qw{ foo bar }; "; ok( ! $@, 'Created package without error' ); } # Create a trivial object SCOPE: { my $empty = Foo->new; isa_ok( $empty, 'Foo' ); isa_ok( $empty, 'Object::Tiny' ); is( scalar( keys %$empty ), 0, 'Empty object is empty' ); } # Create a real object SCOPE: { my $object = Foo->new( foo => 1, bar => 2, baz => 3 ); isa_ok( $object, 'Foo' ); isa_ok( $object, 'Object::Tiny' ); is( scalar( keys %$object ), 3, 'Object contains expect elements' ); is( $object->foo, 1, '->foo ok' ); is( $object->bar, 2, '->bar ok' ); eval { $object->baz; }; ok( $@, '->bar returns an error' ); is( $object->{baz}, 3, '->{baz} does contain value' ); } # Trigger the constructor exception SCOPE: { eval "package Bar; use Object::Tiny 'bad thing';"; ok( $@ =~ /Invalid accessor name/, 'Got expected error' ); } Object-Tiny-1.06/t/99_pmv.t0000644000175100017510000000112711051577471015203 0ustar adamadam00000000000000#!/usr/bin/perl # Test that our declared minimum Perl version matches our syntax use strict; BEGIN { $| = 1; $^W = 1; } my $MODULE = 'Test::MinimumVersion 0.008'; # Don't run tests for installs use Test::More; unless ( $ENV{AUTOMATED_TESTING} or $ENV{RELEASE_TESTING} ) { plan( skip_all => "Author tests not required for installation" ); } # Load the testing module eval "use $MODULE"; if ( $@ ) { $ENV{RELEASE_TESTING} ? die( "Failed to load required release-testing module $MODULE" ) : plan( skip_all => "$MODULE not available for testing" ); } all_minimum_version_from_metayml_ok();