doc fixup from C. J. Collier
[gitmo/Moose.git] / Changes
1 Revision history for Perl extension Moose
2
3 0.21
4     * Moose::Meta::Role
5       - fixed issue where custom attribute metaclasses
6         where not handled correctly in roles
7         - added tests for this
8         
9     ~~ many spelling fixes in the docs ~~
10     ~~    thanks to rlb3 for this !!   ~~
11
12 0.20 Friday, April 6th, 2007
13     >> I messed up the SKIP logic in one test
14        so this release is just to fix that.
15
16     * Moose
17       - 'has' now also accepts an ARRAY ref
18         to create multiple attrs (see docs)
19         (thanks to konobi for this)
20          - added tests and docs 
21
22 0.19 Thurs. April 5th, 2007
23     ~~ More documentation updates ~~
24
25     * Moose::Util::TypeConstraints
26       - 'type' now supports messages as well
27         thanks to phaylon for finding this
28         - added tests for this
29       - added &list_all_type_constraints and 
30         &list_all_builtin_type_constraints
31         functions to facilitate introspection.
32     
33     * Moose::Meta::Attribute
34       - fixed regexp 'handles' declarations 
35         to build the list of delegated methods
36         correctly (and not override important 
37         things like &new) thanks to ashleyb 
38         for finding this
39         - added tests and docs for this
40       - added the 'documentation' attributes
41         so that you can actually document your 
42         attributes and inspect them through the 
43         meta-object.
44         - added tests and docs for this
45
46     * Moose::Meta::Class
47       - when loading custom attribute metaclasses
48         it will first look in for the class in the 
49         Moose::Meta::Attribute::Custom::$name, and 
50         then default to just loading $name.
51         - added tests and docs for this
52
53     * Moose::Meta::TypeConstraint
54       - type constraints now stringify to their names.
55         - added test for this
56
57     * misc.
58       - added tests to assure we work with Module::Refresh 
59       - added stricter test skip logic in the Moose POOP 
60         test, ask Rob Kinyon why.
61         - *cough* DBM::Deep 1.0 backwards compatability sucks *cough* ;)
62
63 0.18 Sat. March 10, 2007
64     ~~ Many, many documentation updates ~~
65
66     * misc.
67       - We now use Class::MOP::load_class to 
68         load all classes.    
69       - added tests to show types and subtypes 
70         working with Declare::Constraints::Simple
71         and Test::Deep as constraint engines.
72
73 0.18_001
74     !! You must have Class::MOP 0.37_001  !!
75     !! for this developer release to work !!
76
77     This release was primarily adding the immutable
78     feature to Moose. An immutable class is one which 
79     you promise not to alter. When you set the class 
80     as immutable it will perform various bits of 
81     memoization and inline certain part of the code
82     (constructors, destructors and accessors). This 
83     minimizes (and in some cases totally eliminates)
84     one of Moose's biggest performance hits. This 
85     feature is not on by default, and is 100% optional.
86     It has several configurable bits as well, so you 
87     can pick and choose to your specific needs.
88     
89     The changes involved in this were fairly wide and 
90     highly specific, but 100% backwards compatible, so 
91     I am not going to enumerate them here. If you are 
92     truely interested in what was changed, please do 
93     a diff :)
94
95 0.17 Tues. Nov. 14, 2006
96     * Moose::Meta::Method::Accessor
97       - bugfix for read-only accessors which 
98         are have a type constraint and lazy.
99         Thanks to chansen for finding it.
100
101 0.16 Tues. Nov. 14, 2006
102     ++ NOTE ++
103     There are some speed improvements in this release, 
104     but they are only the begining, so stay tuned.
105     
106     * Moose::Object
107       - BUILDALL and DEMOLISHALL no longer get 
108         called unless they actually need to be.
109         This gave us a signifigant speed boost
110         for the cases when there is no BUILD or 
111         DEMOLISH method present.
112         
113     * Moose::Util::TypeConstraints
114     * Moose::Meta::TypeConstraint
115       - added an 'optimize_as' option to the 
116         type constraint, which allows for a
117         hand optimized version of the type 
118         constraint to be used when possible.
119       - Any internally created type constraints
120         now provide an optimized version as well.
121
122 0.15 Sun. Nov. 5, 2006
123     ++ NOTE ++
124     This version of Moose *must* have Class::MOP 0.36 in order 
125     to work correctly. A number of small internal tweaks have 
126     been made in order to be compatible with that release.
127
128     * Moose::Util::TypeConstraints
129       - added &unimport so that you can clean out 
130         your class namespace of these exported 
131         keywords
132     
133     * Moose::Meta::Class
134       - fixed minor issue which occasionally 
135         comes up during global destruction 
136         (thanks omega)
137       - moved Moose::Meta::Method::Overriden into 
138         its own file.
139       
140     * Moose::Meta::Role      
141       - moved Moose::Meta::Role::Method into 
142         its own file.
143               
144     * Moose::Meta::Attribute
145       - changed how we do type checks so that 
146         we reduce the overall cost, but still 
147         retain correctness.
148        *** API CHANGE ***
149       - moved accessor generation methods to 
150         Moose::Meta::Method::Accessor to 
151         conform to the API changes from 
152         Class::MOP 0.36
153           
154     * Moose::Meta::TypeConstraint
155       - changed how constraints are compiled
156         so that we do less recursion and more
157         iteration. This makes the type check 
158         faster :)
159       - moved Moose::Meta::TypeConstraint::Union
160         into its own file
161     
162     * Moose::Meta::Method::Accessor
163       - created this from methods formerly found in 
164         Moose::Meta::Attribute
165     
166     * Moose::Meta::Role::Method
167       - moved this from Moose::Meta::Role
168           
169     * Moose::Meta::Method::Overriden
170       - moved this from Moose::Meta::Class
171       
172     * Moose::Meta::TypeConstraint::Union
173       - moved this from Moose::Meta::TypeConstraint
174
175 0.14 Mon. Oct. 9, 2006
176
177     * Moose::Meta::Attribute
178       - fixed lazy attributes which were not getting 
179         checked with the type constraint (thanks ashley)
180         - added tests for this
181       - removed the over-enthusiastic DWIMery of the 
182         automatic ArrayRef and HashRef defaults, it 
183         broke predicates in an ugly way.
184         - removed tests for this
185
186 0.13 Sat. Sept. 30, 2006
187     ++ NOTE ++
188     This version of Moose *must* have Class::MOP 0.35 in order 
189     to work correctly. A number of small internal tweaks have 
190     been made in order to be compatible with that release.
191
192     * Moose
193       - Removed the use of UNIVERSAL::require to be a better
194         symbol table citizen and remove a dependency 
195         (thanks Adam Kennedy)
196
197       **~~ removed experimental & undocumented feature ~~**
198       - commented out the 'method' and 'self' keywords, see the 
199         comments for more info.
200
201     * Moose::Cookbook
202       - added a FAQ and WTF files to document frequently 
203         asked questions and common problems
204         
205     * Moose::Util::TypeConstraints
206       - added GlobRef and FileHandle type constraint
207         - added tests for this
208         
209     * Moose::Meta::Attribute
210       - if your attribute 'isa' ArrayRef of HashRef, and you have
211         not explicitly set a default, then make the default DWIM.
212         This will also work for subtypes of ArrayRef and HashRef 
213         as well.
214       - you can now auto-deref subtypes of ArrayRef or HashRef too.
215         - new test added for this (thanks to ashley)
216         
217     * Moose::Meta::Role
218       - added basic support for runtime role composition
219         but this is still *highly experimental*, so feedback 
220         is much appreciated :)
221         - added tests for this
222
223     * Moose::Meta::TypeConstraint
224       - the type constraint now handles the coercion process
225         through delegation, this is to support the coercion 
226         of unions
227         
228     * Moose::Meta::TypeConstraint::Union
229       - it is now possible for coercions to be performed 
230         on a type union
231         - added tests for this (thanks to konobi)
232
233     * Moose::Meta::TypeCoercion
234       - properly capturing error when type constraint 
235         is not found
236
237     * Build.PL
238       - Scalar::Util 1.18 is bad on Win32, so temporarily
239         only require version 1.17 for Win32 and cygwin.
240         (thanks Adam Kennedy)        
241
242 0.12 Sat. Sept. 1, 2006
243     * Moose::Cookbook
244       - Recipe5 (subtypes & coercion) has been written
245       
246     * Moose
247       - fixed "bad meta" error message to be more descriptive      
248       - fixed &unimport to not remove the &inner and &super  
249         keywords because we need to localize them.
250       - fixed number of spelling/grammer issues, thanks Theory :)
251       
252       **~~ experimental & undocumented feature ~~**
253       - added the method and self keywords, they are basically 
254         just sugar, and they may not stay around.
255         
256     * Moose::Object
257       - added &dump method to easily Data::Dumper 
258         an object
259         
260     * Moose::Meta::TypeConstraint
261       - added the &is_a_type_of method to check both the current
262         and the subtype of a method (similar to &isa with classes)
263
264     * Moose::Meta::Role
265       - this is now a subclass of Class::MOP::Module, and no longer
266         creates the _role_meta ugliness of before. 
267         - fixed tests to reflect this change
268     
269 0.11 Wed. July 12, 2006
270     * Moose
271       - added an &unimport method to remove all the keywords
272         that Moose will import, simply add 'no Moose' to the 
273         bottom of your class file. 
274         
275     * t/
276       - fixed some test failures caused by a forgotten test 
277         dependency.
278
279 0.10 Thurs. July 6, 2006
280     * Moose
281       - improved error message when loading modules so
282         it is less confusing when you load a role.
283       - added &calculate_all_roles method to 
284         Moose::Meta::Class and Moose::Meta::Role
285         
286     NOTE:
287     This module has been tested against Class::MOP 0.30
288     but it does not yet utilize the optimizations 
289     it makes available. Stay tuned for that ;)
290     
291 0.09_03 Fri. June 23, 2006
292     ++ DEVELOPER RELEASE ++
293     * Moose
294       - 'use strict' and 'use warnings' are no longer
295          needed in Moose classes, Moose itself will 
296          turn them on for you.
297          - added tests for this
298       - moved code from exported subs to private methods
299         in Moose::Meta::Class
300          
301     * Moose::Role
302       - as with Moose, strict and warnings are 
303         automatically turned on for you.
304          - added tests for this        
305         
306     * Moose::Meta::Role
307       - now handles an edge case for override errors
308         - added tests for this
309       - added some more edge case tests
310
311 0.09_02 Tues. May 16, 2006
312     ++ DEVELOPER RELEASE ++
313     * Moose
314       - added prototypes to the exported subs
315       - updated docs
316       
317     * Moose::Role
318       - added prototypes to the exported subs      
319       - updated docs
320       
321     * Moose::Util::TypeConstraints
322       - cleaned up prototypes for the subs      
323       - updated docs      
324
325 0.09_01 Fri. May 12, 2006
326     ++ DEVELOPER RELEASE ++
327       - This release works in combination with 
328         Class::MOP 0.29_01, it is a developer 
329         release because it uses the a new 
330         instance sub-protocol and a fairly
331         complete Role implementation. It has 
332         not yet been optimized, so it slower
333         the the previous CPAN version. This 
334         release also lacks good updated docs, 
335         the official release will have updated docs.
336
337     * Moose 
338       - refactored the keyword exports
339         - 'with' now checks Role validaity and 
340           accepts more than one Role at a time
341         - 'extends' makes metaclass adjustments as 
342            needed to ensure metaclass compatability
343           
344     * Moose::Role
345       - refactored the keyword exports
346         - 'with' now checks Role validaity and 
347           accepts more than one Role at a time
348           
349     * Moose::Util::TypeConstraints
350       - added the 'enum' keyword for simple 
351         string enumerations which can be used as 
352         type constraints
353         - see example of usage in t/202_example.t
354         
355     * Moose::Object
356       - more careful checking of params to new()
357       
358     * Moose::Meta::Role
359       - much work done on the role composition
360         - many new tests for conflict detection 
361           and composition edge cases
362         - not enough documentation, I suggest 
363           looking at the tests    
364       
365     * Moose::Meta::Instance
366       - added new Instance metaclass to support 
367         the new Class::MOP instance protocol
368         
369     * Moose::Meta::Class
370       - some small changes to support the new 
371         instance protocol
372       - some small additions to support Roles
373         
374     * Moose::Meta::Attribute
375       - some improvements to the accessor generation code
376         by nothingmuch
377       - some small changes to support the new 
378         instance protocol
379       - (still somewhat) experimental delegation support 
380         with the 'handles' option
381         - added several tests for this
382         - no docs for this yet
383
384 0.05 Thurs. April 27, 2006
385     * Moose
386       - keywords are now exported with Sub::Exporter
387         thanks to chansen for this commit
388       - has keyword now takes a 'metaclass' option 
389         to support custom attribute meta-classes 
390         on a per-attribute basis
391         - added tests for this  
392       - the 'has' keyword not accepts inherited slot
393         specifications (has '+foo'). This is still an 
394         experimental feature and probably not finished
395         see t/038_attribute_inherited_slot_specs.t for 
396         more details, or ask about it on #moose
397         - added tests for this
398         
399     * Moose::Role
400       - keywords are now exported with Sub::Exporter
401
402     * Moose::Utils::TypeConstraints
403       - reorganized the type constraint hierarchy, thanks
404         to nothingmuch and chansen for his help and advice 
405         on this
406         - added some tests for this
407       - keywords are now exported with Sub::Exporter
408         thanks to chansen for this commit
409
410     * Moose::Meta::Class
411       - due to changes in Class::MOP, we had to change
412         construct_instance (for the better)
413         
414     * Moose::Meta::Attribute
415       - due to changes in Class::MOP, we had to add the 
416         initialize_instance_slot method (it's a good thing)
417         
418     * Moose::Meta::TypeConstraint
419       - added type constraint unions 
420         - added tests for this
421       - added the is_subtype_of predicate method
422         - added tests for this
423
424 0.04 Sun. April 16th, 2006
425     * Moose::Role
426       - Roles can now consume other roles
427         - added tests for this
428       - Roles can specify required methods now with 
429         the requires() keyword
430         - added tests for this
431
432     * Moose::Meta::Role
433       - ripped out much of it's guts ,.. much cleaner now
434       - added required methods and correct handling of 
435         them in apply() for both classes and roles
436         - added tests for this
437       - no longer adds a does() method to consuming classes 
438         it relys on the one in Moose::Object
439       - added roles attribute and some methods to support 
440         roles consuming roles
441
442     * Moose::Meta::Attribute
443       - added support for triggers on attributes
444         - added tests for this
445       - added support for does option on an attribute 
446         - added tests for this
447         
448     * Moose::Meta::Class
449       - added support for attribute triggers in the 
450         object construction
451         - added tests for this
452     
453     * Moose
454       - Moose no longer creates a subtype for your class 
455         if a subtype of the same name already exists, this 
456         should DWIM in 99.9999% of all cases
457         
458     * Moose::Util::TypeConstraints
459       - fixed bug where incorrect subtype conflicts were 
460         being reported
461         - added test for this
462         
463     * Moose::Object
464       - this class can now be extended with 'use base' if
465         you need it, it properly loads the metaclass class now
466         - added test for this
467
468 0.03_02 Wed. April 12, 2006
469     * Moose
470       - you must now explictly use Moose::Util::TypeConstraints
471         it no longer gets exported for you automatically
472         
473     * Moose::Object
474       - new() now accepts hash-refs as well as key/value lists
475       - added does() method to check for Roles
476         - added tests for this
477
478     * Moose::Meta::Class
479       - added roles attribute along with the add_role() and 
480         does_role() methods
481         - added tests for this 
482
483     * Moose::Meta::Role
484       - now adds a does() method to consuming classes 
485         which tests the class's hierarchy for roles
486         - added tests for this
487
488 0.03_01 Mon. April 10, 2006
489     * Moose::Cookbook
490       - added new Role recipe (no content yet, only code)
491       
492     * Moose
493       - added 'with' keyword for Role support
494         - added test and docs for this
495       - fixed subtype quoting bug
496         - added test for this 
497
498     * Moose::Role
499       - Roles for Moose
500         - added test and docs
501
502     * Moose::Util::TypeConstraints
503       - added the message keyword to add custom
504         error messages to type constraints        
505       
506     * Moose::Meta::Role
507       - the meta role to support Moose::Role
508         - added tests and docs
509         
510     * Moose::Meta::Class
511       - moved a number of things from Moose.pm 
512         to here, they should have been here 
513         in the first place
514
515     * Moose::Meta::Attribute
516       - moved the attribute option macros here
517         instead of putting them in Moose.pm
518
519     * Moose::Meta::TypeConstraint
520       - added the message attributes and the 
521         validate method
522         - added tests and docs for this
523
524 0.03 Thurs. March 30, 2006
525     * Moose::Cookbook
526       - added the Moose::Cookbook with 5 recipes, 
527         describing all the stuff Moose can do.
528
529     * Moose
530       - fixed an issue with &extends super class loading
531         it now captures errors and deals with inline 
532         packages correctly (bug found by mst, solution 
533         stolen from alias)
534       - added super/override & inner/augment features
535         - added tests and docs for these
536     
537     * Moose::Object
538       - BUILDALL now takes a reference of the %params 
539         that are passed to &new, and passes that to 
540         each BUILD as well.
541         
542     * Moose::Util::TypeConstraints
543       - Type constraints now survive runtime reloading
544         - added test for this
545
546         * Moose::Meta::Class
547           - fixed the way attribute defaults are handled 
548             during instance construction (bug found by chansen)
549
550     * Moose::Meta::Attribute
551       - read-only attributes now actually enforce their
552         read-only-ness (this corrected in Class::MOP as 
553         well)
554
555 0.02 Tues. March 21, 2006
556     * Moose
557       - many more tests, fixing some bugs and  
558         edge cases
559       - &extends now loads the base module with
560         UNIVERSAL::require 
561         - added UNIVERSAL::require to the 
562           dependencies list
563       ** API CHANGES **
564       - each new Moose class will also create 
565         and register a subtype of Object which 
566         correspond to the new Moose class.      
567       - the 'isa' option in &has now only 
568         accepts strings, and will DWIM in 
569         almost all cases
570     
571     * Moose::Util::TypeConstraints
572       - added type coercion features
573         - added tests for this
574         - added support for this in attributes 
575           and instance construction
576       ** API CHANGES **
577       - type construction no longer creates a 
578         function, it registers the type instead.
579         - added several functions to get the 
580           registered types 
581
582     * Moose::Object
583       - BUILDALL and DEMOLISHALL were broken 
584         because of a mis-named hash key, Whoops :)
585     
586     * Moose::Meta::Attribute
587       - adding support for coercion in the
588         autogenerated accessors
589         
590     * Moose::Meta::Class
591       - adding support for coercion in the
592         instance construction  
593
594     * Moose::Meta::TypeConstraint
595     * Moose::Meta::TypeCoercion
596           - type constraints and coercions are now 
597             full fledges meta-objects
598
599 0.01 Wed. March 15, 2006
600     - Moooooooooooooooooose!!!