bunch of doc fixes
[gitmo/Class-MOP.git] / Changes
1 Revision history for Perl extension Class-MOP.
2
3 0.53
4     ~~~ some misc. doc. fixes ~~~
5     
6     * Class::MOP::Instance
7       - added get_all_slot_values method (Sartak)
8         - added tests for this (Sartak)
9         
10     * Class::MOP::Class
11       Class::MOP::Method::Constructor
12       Class::MOP::Attribute
13         - making init_arg accept an undefined value
14           to indicate that no constructor args can 
15           be passed (thanks to nothingmuch)
16           - added tests for this
17         - added attribute initializer attribute (rjbs)
18           
19     * Class::MOP.
20         - making this use the new init_arg => undef
21           feature instead of the silly hack from 
22           before (thanks to nothingmuch)
23
24 0.52 Tues. Jan. 22, 2008
25     * Class::MOP::Class
26       - fixed bug in rebless_instance 
27         (discovered by ash)
28
29     * Class::MOP::Method::Constructor
30       - removed assumptions about the existence of 
31         a &meta method
32
33 0.51 Mon. Jan. 14, 2008
34     ~~~ some misc. doc. fixes ~~~
35     ~~ updated copyright dates ~~
36     
37     * Class::MOP
38       - now sets the IS_RUNNING_ON_5_10 
39         constant so that we can take advantage
40         of some of the nice bits of 5.10
41     
42     * Class::MOP::Class
43       - uses the IS_RUNNING_ON_5_10 flag to 
44         optimize the &linearized_isa method 
45         and avoid the hack/check for circular
46         inheritence in &class_precedence_list 
47       - added rebless_instance method (Sartak)
48         - added tests for this
49     
50     * Class::MOP::Immutable 
51       - the immutable class now keeps track of 
52         the transformer which immutablized it
53
54     * Class::MOP::Instance
55       - added rebless_instance_structure method (Sartak)
56         - added tests for this
57
58 0.50 Fri. Dec. 21, 2007
59     * Class::MOP::Class
60       - fixed bug in immutable to make sure that 
61         transformation arguments are saved 
62         correctly (mst)
63         - added tests for this
64         
65     * Class::MOP::Immutable
66       - fixed a bug (see above)
67       
68     * Class::MOP::Attribute
69       - some doc updates
70
71 0.49 Fri. Dec. 14, 2007
72     !! Class::MOP now loads 2 x faster  !!
73     !! with XS speedups (thanks konobi) !!
74         
75     * Class::MOP
76       - removed the dependency on B
77       - added two XS functions (thanks konobi)
78         - get_code_info($code) which replaces all
79           the B fiddling we were doing with
80           faster/leaner XS level fiddling
81         - check_package_cache_flag($pkg_name) which 
82           returns the PL_sub_generation variable to 
83           be used to help manage method caching.
84           
85           NOTE: 
86           In 5.10 or greater this will actually 
87           use the mro::get_pkg_gen instead to give 
88           even more accurate caching information. 
89           blblack++ for that stuff :)
90           
91     * Class::MOP::Class
92       - added the &subclasses method (thanks rlb)
93       - added the update_package_cache_flag and 
94         reset_package_cache_flag which help keep 
95         track of when we need to re-fetch the 
96         method map. 
97       - Several small improvements to take advantage
98         of the new method map caching features
99
100 0.48 Mon. Nov. 26, 2007
101     * Class::MOP::Attribute
102       - fixed get_read/write_method to handle the 
103         HASH ref case, which makes the 
104         get_read/write_method_ref handle it too.
105         - added more tests for this
106
107 0.47 Sat. Nov. 24, 2007
108     * Class::MOP::Attribute
109       - fixed misspelling in get_write_method_ref
110         - added more tests for this
111
112 0.46 Fri. Nov. 23, 2007
113     * Class::MOP::Class
114       - added the linearized_isa method instead of constantly 
115         pruning duplicate classes (this will be even more 
116         useful in the 5.10-compat version coming soon)
117     
118     * Class::MOP::Attribute
119       - added the get_read_method_ref and get_write_method_ref
120         methods which allow you to retrieve a CODE ref which 
121         can always be used to read or write an attribute.
122
123 0.45 Thurs. Nov. 13, 2007
124     * Class::MOP::Attribute
125       - Fix error message on confess (groditi)
126
127 0.44 Thurs. Nov. 13, 2007
128     - Apparently I didn't make dist correctly (groditi)
129
130 0.43 Thurs. Nov. 13, 2007
131     * Class::MOP
132       - Add support for the 'builder' attribute (groditi)
133
134     * Class::MOP::Class
135       - optimise metaclass-already-exists check in 
136         construct_class_instance (groditi)
137       - duplicate check into initialize to save a 
138         call through (groditi)
139
140     * Class::MOP::Attribute
141       - Add support for the 'builder' attribute (groditi)
142       - Make predicates check for the existence of a value, not whether 
143         it is defined (groditi)
144
145     * Class::MOP::Instance
146       - Make predicates check for the existence of a value, not whether 
147         it is defined (groditi)
148
149     * Class::MOP::Method::Accessor 
150       - made this a subclass of Class::MOP::Method::Generated
151         - removed the relevant attributes
152
153     * Class::MOP::Method::Constructor
154       - fixed the cached values we had to be more sane
155       - made this a subclass of Class::MOP::Method::Generated
156       - fixed generated constructor so it properly handles 
157         subclasses now.
158         - added tests for this
159       - added the option to allow for both inlined and 
160         non-inlined constructors.
161       - Update inlined methods for builder and predicate changes (groditi)
162
163     * Class::MOP::Method::Generated
164       - added this class as an abstract base for the 
165         Class::MOP::Method::{Constructor,Accessor} classes
166         - added tests for this
167
168     *t/
169       - Alter tests (005, 014 020, 021) for new builder addition (groditi)
170       - Tests for new predicate behavior (and corrections to old tests) (groditi)
171
172     *examples/
173       - Update ArrayRef based class example to work with predicate changes
174
175 0.42 Mon. July 16, 2007
176     !!! Horray for mst, he fixed it !!!
177
178     * Class::MOP::Package
179       - alter symbol table handling to deal with 5.8.x and 5.9.x
180       
181     * t/
182       - Get rid of the crappy workaround from 0.40/41
183
184 0.41 Sun. July 15, 2007
185     * t/
186         Arghh!!! My TODO test didn't work, so I handle
187         it manually now so that people can use this 
188         with 5.9.5/bleadperl without issue.
189
190 0.40 Tues, July 3, 2007
191     * t/
192       ~ marked a test in 003_methods.t as TODO 
193         for perl 5.9.5 (this test is irrelvant to 
194         the module functioning on 5.9.5 for the most 
195         part anyway)
196
197 0.39 Mon. June 18, 2007
198     * Class::MOP::Immutable
199       - added make_metaclass_mutable + docs (groditi)
200       - removed unused variable
201       - added create_immutable_transformer
202         necessary for sane overloading of immutable behavior
203          - tests for this (groditi) 
204
205     * Class::MOP::Class
206       - Immutability can now be undone,
207         added make_mutable + tests + docs (groditi)
208       - Massive changes to the way Immutable is done
209         for details see comments next to make_immutable
210         This fixes a bug where custom metaclasses broke
211         when made immutable. We are now keeping one immutable 
212         metaclass instance per metaclass instead of just one 
213         to prevent isa hierarchy corruption. Memory use will go
214         up, but I suspect it will be neglible.
215          - New tests added for this behavior.  (groditi)
216
217 0.38 Thurs. May 31, 2007
218     ~~ More documentation updates ~~
219     
220     * Class::MOP::Package
221       - we now deal with stub methods properly
222         - added tests for this
223       - fixed some tests failing on 5.9.5 (thanks blblack)
224         
225     * Class::MOP::Attribute
226       - added get_read_method and get_write_method
227         thanks to groditi for this code, tests 
228         and docs.
229         - added tests and POD for this
230     
231     * Class::MOP::Class
232       - fixed RT issue #27329, clone object now 
233         handles undef values correctly.
234         - added tests for this
235       - Corrected anon-class handling so that they 
236         will not get reaped when instances still 
237         exist which need to reference them. This is 
238         the correct behavior, hopefully this is an 
239         obscure enough feature that there are not too 
240         many work arounds out in the wild.
241         - added tests for this by groditi   
242         - updated docs to explain this
243
244     * metaclass
245       - load custom metaclasses automatically (thanks groditi)
246         - added tests for this behavior
247
248 0.37 Sat. March 10, 2007
249     ~~ Many, many documentation updates ~~
250     
251     * Class::MOP
252       - added &load_class and &is_class_loaded 
253         - added tests and docs for these
254
255     * Class::MOP::Attribute
256       - default now checks the instance with defined to 
257         avoid setting off bool-overloads (found by Carl Franks)
258
259 0.37_002
260     * /t 
261       - bad name in a test, causing meaningless failuress. 
262         No other changes.
263
264 0.37_001
265     
266     ~~ GLOBAL CHANGES ~~
267     - All attribute names are now consistent and follow Perl 6 
268       style (prefixed with the sigil, and ! as the twigil for 
269       private attrs). This should not affect any code, unless 
270       you broke encapsulation, in which case, it is your problem 
271       anyway.
272       
273     !! Class::MOP::Class::Immutable has been removed
274     
275     * Class::MOP::Method::Constructor
276       - this has been moved out of Class::MOP::Class::Immutable 
277         and is a proper subclass of Class::MOP::Method now.
278         
279     * Class::MOP::Class
280       - this module now uses Class::MOP::Immutable for the 
281         immutable transformation instead of 
282         Class::MOP::Class::Immutable.
283         
284     + Class::MOP::Immutable 
285       - this module now controls the transformation from a mutable 
286         to an immutable version of the class. Docs for this will 
287         be coming eventually.
288     
289
290 0.36 Sun. Nov. 5, 2006
291     * Class::MOP::Class
292       - added a few 'no warnings' lines to keep annoying 
293         (and meaningless) warnings from chirping during 
294         global destruction.
295           
296     * Class::MOP
297       - some more bootstrapping is now done on the new 
298         classes
299     
300     * Class::MOP::Class::Immutable
301       *** API CHANGE ***    
302       - constructor generation is now handled by 
303         the Class::MOP::Method::Constructor class
304      
305     * Class::MOP::Method::Constructor
306       - created this to handle constructor generation 
307         in Class::MOP::Class::Immutable
308     
309     * Class::MOP::Attribute
310       *** API CHANGE ***    
311       - attributes now delegate to the 
312         Class::MOP::Method::Accessor to generate 
313         accessors
314     
315     * Class::MOP::Method::Accessor
316       - all accessor generation functions from 
317         Class::MOP::Attribute have been moved here
318
319 0.35 Sat. Sept. 30, 2006
320
321     * scripts/class_browser.pl
322       - initial prototype of a class browser, more 
323         on this to come. Comments and patches are 
324         very much welcome.
325
326     * Class::MOP
327       - All Class::MOP::* accessors are no longer 
328         re-generated in the bootstrap, instead 
329         they are aliased from the originals
330         - fixed tests to reflect
331       - added Class::MOP::Method (and its subclasses) 
332         to the bootstrap
333         - adjusted tests for this
334       - added the Class::MOP::Instance attributes
335         to the bootstrap
336     
337     * Class::MOP::Method
338       *** API CHANGE ***
339       - methods are no longer blessed CODE refs
340         but are actual objects which can be CODE-ified
341         - adjusted tests to compensate
342         - adjusted docs for this        
343
344     * Class::MOP::Class
345       - changed how methods are dealt with to 
346         encapsulate most of the work into the 
347         &get_method_map method
348       - made several adjustments for the change
349         in Class::MOP::Method
350       - &add_attribute now checks if you are adding 
351         a duplicate name, and properly removes the 
352         old one before installing the new one
353         - added tests for this
354         - adjusted docs for this
355     
356     * Class::MOP::Class::Immutable
357       - added caching of &get_method_map
358       - fixed issue with &get_package_symbol
359       - cleaned up the methods that die (patch by David Wheeler)
360     
361     * Class::MOP::Package
362       - added filtering capabilities to 
363         &list_all_package_symbols
364
365 0.34 Sat. Aug. 26, 2006
366     * Class::MOP::Class
367       - added the %:methods attribute, which like
368         the $:version and such just actually goes 
369         to the symbol table to get it's stuff. 
370         However, it makes the MOP more complete.
371      ** API CHANGE **
372       - The &create method now requires that all 
373         but the package name now is passed in as 
374         named parameters. See docs for more info.
375         - updated docs and tests for this
376         
377     * Class::MOP::Object
378       - added &dump method to easily Data::Dumper 
379         an object
380         
381     * Class::MOP
382       - cleaned up the initialization of attributes 
383         which do not store things in the instance 
384       - added the %:methods attribute definition to
385         the bootstrap
386         
387     ~ lots of misc. test cleanup
388
389 0.33 Sat. Aug. 19, 2006
390     * Class::MOP::Class
391       - moved the metaclass cache out of here 
392         and it is now in Class::MOP itself.
393         
394     * Class::MOP
395       - moved all the metaclass cache stuff here
396         - fixed all tests for this
397
398     * Class::MOP::Attribute
399       - reference values (other than CODE refs) 
400         are no longer allowed for defaults
401         - added tests for this
402     
403     * Class::MOP::Package
404       - fixed an issue with perl 5.8.1 and how it deals 
405         with symbol tables. The namespace hash is now 
406         always reloaded from the symbol table. 
407
408     ~ lots of misc. documentation cleanup
409
410 0.32 Sat. Aug. 12, 2006
411     + added Class::MOP::Object so that the 
412       metamodel is more complete (and closer
413       to what Perl 6 will probably be).
414
415     * Class::MOP::Package
416       - refactored entire class, this is now 
417         the primary gateway between the metaclass
418         and the Perl 5 symbol table
419         - added many tests for this
420       - this class is now a subclass of 
421         Class::MOP::Object
422         - added some tests to reflect this
423         
424     * Class::MOP::Class
425       - refactored all symbol table access to 
426         use Class::MOP::Package methods instead
427         
428     * Class::MOP::Module
429       - adding the $:version attribute in the bootstrap
430         so that Module has a version as an attribute
431         - see comment in Class::MOP for details
432       - added the $:authority attribute to this module 
433         as well as an &identifier method, to bring us 
434         ever closer to Perl 6 goodness 
435         - I have added $AUTHORITY to all the modules 
436         - added tests for this
437       
438     * Class::MOP::Instance
439       - added &deinitialize_slot for removing slots 
440         from an instance
441         - added tests for this      
442       
443     * Class::MOP::Attribute 
444       - added support for &deinitialize_slot for removing
445         slots from an instance
446         - added tests for this
447
448 0.31 Sat. July 15, 2006
449
450     * Class::MOP::Class
451       - added &find_method_by_name to locate a method
452         anywhere within the class hierarchy   
453         
454     * Class::MOP::Attribute
455       - added &set_value and &get_value for getting 
456         the value of the attribute for a particular 
457         instance.
458
459 0.30 Wed. July 5, 2006
460     ---------------------------------------
461     This is the first version of Class::MOP 
462     to introduce the immutable features which
463     will be used for optimizating the MOP. 
464     This support should still be considered
465     experimental, but moving towards stability.
466     ---------------------------------------
467     
468     * Created Class::MOP::Class::Immutable  
469     
470     * Created the Class::MOP::Package and 
471       Class::MOP::Module classes to more 
472       closely conform to Perl 6's meta-model
473
474     * Class::MOP::Class
475       - now inherits from Class::MOP::Module
476       - several methods moved to ::Module and 
477         ::Package and now inherited
478         - added tests for this
479       
480     * Class::MOP::Instance
481       - added an is_inlinable method to allow other 
482         classes to check before they attempt to optimize.
483       - added an inline_create_instance to inline 
484         instance creation (of course) 
485         
486     ** API CHANGE **
487       - the Class::MOP::Class::*_package_variable 
488         methods are all now methods of Class::MOP::Package
489         and called *_package_symbol instead. This is 
490         because they are now more general purpose symbol 
491         table manipulation methods.        
492
493 0.29_02 Thurs. June 22, 2006
494     ++ DEVELOPER RELEASE ++
495     * Class::MOP::Class
496       - small change in &create so that it behaves 
497         properly when inherited
498       - small fix to &clone_instance
499
500 0.29_01 Fri. May 12, 2006
501     ++ DEVELOPER RELEASE ++
502       - This release works in combination with 
503         Moose 0.09_01, it is a developer release
504         because it introduces a new instance 
505         sub-protocol and has not yet been 
506         optimized.  
507
508     * Class::MOP::Class
509       - anon-classes are now properly garbage collected
510         - added tests for this 
511       - improved method modifier wrapping 
512
513     * Class::MOP::Instance
514       - added new instance protocol
515         - added tests for this
516       - changed all relevant modules and examples
517         - Class::MOP::Class
518         - Class::MOP::Attribute
519         - examples/*
520
521     * metaclass
522       - you no longer need to specify the metaclass
523         itself, if it is not there, Class::MOP::Class
524         is just assumed
525         - updated tests for this
526
527     * examples/
528       - added ArrayBasedStorage example to show 
529         instance storage using ARRAY refs instead of
530         HASH refs. 
531         - added tests for this
532       - InsideOutClass is totally revised using the 
533         new instance protocol
534         - added more tests for this
535
536 0.26 Mon. April 24, 2006
537     * Class::MOP::Class
538       - added find_attribute_by_name method
539         - added tests and docs for this
540       - some small optimizations
541
542     * Class::MOP::Attribute
543       - some small optimizations
544
545 0.25 Thurs. April 20, 2006
546     * Class::MOP::Class
547       - added create_anon_class for creating anonymous classes
548         - added tests for this
549       - added get_all_metaclasses, get_all_metaclass_names
550         and get_all_metaclass_instances method to allow
551         access to all the cached metaclass objects.
552       - attribute slot initialization is now the responsibility
553         of the attribute itself, and construct_instance now 
554         delegates appropriately
555         
556     * Class::MOP::Attribute
557       - attribute slot initialization is now the responsibility
558         of the attribute itself, so we added a method for it
559         called initialize_instance_slot
560     
561     * examples/
562       - adjusted all the examples to use the new attribute 
563         initialize_instance_slot method 
564
565 0.24 Tues. April 11, 2006
566     * Class::MOP::Class
567       - cleaned up how the before/after/around method 
568         modifiers get named with Sub::Name
569
570 0.23 Thurs. March 30, 2006
571         * Class::MOP::Class
572           - fixed the way attribute defaults are handled 
573             during instance construction (bug found by chansen)
574             
575         * Class::MOP::Attribute
576           - read-only accessors ('reader') will now die if 
577             passed more than one argument (attempting to write
578             to them basically)
579               - added tests for this
580               - adjusted all /example files to comply 
581
582 0.22 Mon. March 20, 2006
583     * Class::MOP::Class
584       - localized $@ in the *_package_variable functions
585         because otherwise, it does ugly things in Moose.
586           - added test case for this
587
588 0.21 Wed. March 15, 2006
589     * Class::MOP::Class
590       - fixed issue where metaclasses are reaped from 
591         our cache in global destruction, and so are not
592         available in DESTORY calls
593
594 0.20 Thurs. March 2, 2006
595     - removed the dependency for Clone since 
596       we no longer to deep-cloning by default.
597     
598     * Class::MOP::Method
599       - added &package_name, &name and 
600         &fully_qualified_name methods, some of 
601         which were formerly private subs in 
602         Class::MOP::Class
603       
604     * Class::MOP::Method::Wrapped
605       - allows for a method to be wrapped with 
606         before, after and around modifiers 
607           - added tests and docs for this feature
608
609     * Class::MOP::Class
610       - improved &get_package_symbol
611           - &version and &superclasses now use it
612       - methods are now blessed into Class::MOP::Method
613         whenever possible
614       - added methods to install CLOS-style method modifiers 
615          - &add_before_method_modifier
616          - &add_after_method_modifier         
617          - &add_around_method_modifier
618              - added tests and docs for these
619       - added &find_next_method_by_name which finds the 
620         equivalent of SUPER::method_name
621
622 0.12 Thurs. Feb 23, 2006
623     - reduced the dependency on B, no need to always 
624       have the latest
625
626     * examples/
627       - added docs to the C3 method dispatch order test
628       - fixed missing Algorithm::C3 dependency by making 
629         the test skip if it is not installed
630
631 0.11 Mon Feb. 20, 2006
632     * examples/
633       - added example of changing method dispatch order to C3
634       
635     * Class::MOP::Class
636       - changed how clone_instance behaves, it now only does a
637         shallow clone (see docs for more details)
638         - added docs and tests
639
640 0.10 Tues Feb. 14, 2006
641     ** This release was mostly about writing more tests and 
642        cleaning out old and dusty code, the MOP should now 
643        be considered "ready to use".
644
645     - adding more tests to get coverage up a little higher,
646       mostly testing errors and edge cases.
647       - test coverage is now at 99%
648       
649     * Class::MOP
650       - no longer optionally exports to UNIVERSAL::meta or
651         creates a custom metaclass generator, use the 
652         metaclass pragma instead.
653
654     * Class::MOP::Class  
655       - fixed a number of minor issues which came up in the 
656         error/edge-case tests
657         
658     * Class::MOP::Attribute 
659       - fixed a number of minor issues which came up in the 
660         error/edge-case tests        
661      
662     * examples/
663       - fixing the AttributesWithHistory example, it was broken.
664
665 0.06 Thurs Feb. 9, 2006
666     * metaclass
667       - adding new metaclass pragma to make setting up the 
668         metaclass a little more straightforward
669         
670     * Class::MOP
671       - clean up bootstrapping to include more complete 
672         attribute definitions for Class::MOP::Class and 
673         Class::MOP::Attribute (accessors, readers, writers, 
674         etc.) ... it is redundant, but is useful meta-info
675         to have around.
676
677     * Class::MOP::Class
678       - fixing minor meta-circularity issue with &meta, it 
679         is now more useful for subclasses
680       - added &get_attribute_map as an accessor for the 
681         hash of attribute meta objects
682       - &compute_all_applicable_attributes now just returns
683         the attribute meta-object, rather than the HASH ref
684         since all the same info can be gotten from the 
685         attribute meta-object itself
686           - updated docs & tests to reflect
687       - added &clone_instance method which does a deep clone
688         of the instance structure created by &construct_instance
689           - added docs & tests for this
690           - added Clone as a dependency
691       - added &new_object and &clone_object convience methods to
692         return blessed new or cloned instances
693           - they handle Class::MOP::Class singletons correctly too
694           - added docs & tests for this
695       - cleaned up the &constuct_class_instance so that it behaves
696         more like &construct_instance (and managed the singletons too)
697       - added the &check_metaclass_compatibility method to make sure
698         that metaclasses are upward and downward compatible.
699           - added tests and docs for this
700           
701     * examples/
702       - adjusting code to use the &Class::MOP::Class::meta
703         fix detailed above
704       - adjusting code to use the metaclass pragma
705       
706 0.05 Sat Feb. 4, 2006
707     * Class::MOP::Class
708       - added the &attribute_metaclass and &method_metaclass
709         attributes which contain a metaclass name to use for 
710         attributes/methods respectively
711     
712     * Class::MOP
713       - bootstrap additional attributes for Class::MOP::Class 
714         
715     * examples/
716       - adjusted the example code and tests to use the new
717         &attribute_metaclass feature of Class::MOP::Class
718       - added new example:
719         - LazyClass
720
721 0.04 Fri Feb. 3, 2006
722     * Class::MOP::Class
723       - some documentation suggestions from #perl6
724     
725     * Class::MOP::Attribute
726       - improved error messages    
727     
728     * examples/
729       - added new examples:
730         - AttributesWithHistory
731         - ClassEncapsultedAttributes
732
733 0.03 Fri Feb. 3, 2006
734     - converted to Module::Build instead of EU::MM
735     
736     * Class::MOP::Attribute
737       - refactored method generation code
738       - attributes are now associated with class directly
739     
740     * examples/
741       - refactored the InsideOut example to take advantage 
742         of the Class::MOP::Attribute refactoring
743       - changed example files to .pod files and hide thier
744         package names from PAUSE (I don't want to own these
745         namespaces really, they are just examples)
746
747 0.02 Thurs Feb. 2, 2006
748     - moving examples from t/lib/* to examples/*
749         - adding POD documentation to the examples
750
751 0.01 Thurs Feb. 2, 2006
752     - Initial release