Final prep for 1.0006 release
[dbsrgits/DBM-Deep.git] / Changes
1 Revision history for DBM::Deep.
2
3 1.0006 Oct 01 23:15:00 2007 EDT
4     - (This version is compatible with 1.0005)
5     - Removed Clone and replaced it with a hand-written datastructure walker.
6       - This greatly reduces the footprint of a large import
7       - This bypasses a failure of Clone under Perl 5.9.5
8       - Moved t/37_delete_edge_cases.t to t_attic because it wasn't really used
9     - import() has a stricter API now. This is a potentially incompatible API
10       change. Only HASH and ARRAY refs are now allowed and they must match the type
11       of the object being imported into.
12
13 1.0005 Oct 01 11:15:00 2007 EDT
14     - (This version is compatible with 1.0004)
15     - Added proper singleton support. This means that the following now works:
16         $db->{foo} = [ 1 .. 3];
17         my $x = $db->{foo};
18         my $y = $db->{foo};
19         is( $x, $y ); # Now passes
20       - This means that Data::Dumper now properly reports when $db->{foo} = $db->{bar}
21
22 1.0004 Sep 28 12:15:00 2007 EDT
23     - (This version is compatible with 1.0003)
24     - Fixed the Changes file (wrong version was displayed for 1.0003)
25     - Added filter sugar methods to be more API-compatible with other DBMs
26       - This was added to support a patch provided to IO::All so it can
27         use DBM::Deep as a DBM provider.
28     - Implemented _dump_file in order to display the file structure. As a
29       result, the following bugs were fixed:
30       - Arrays and hashes now clean up after themselves better.
31       - Bucketlists now clean up after themselves better.
32       - Reindexing properly clears the old bucketlist before freeing it.
33
34 1.0003 Sep 24 14:00:00 2007 EDT
35     - THIS VERSION IS INCOMPATIBLE WITH FILES FROM ALL OTHER PRIOR VERSIONS.
36     - Further fixes for unshift/shift/splice and references (RT# 29583)
37     - To fix that, I had to put support for real references in.
38       - the 16 and 22 tests are now re-enabled.
39       - Yes, this means that real references work. See t/45_references.t
40
41 1.0002 Sep 20 22:00:00 2007 EDT
42     - (This version is compatible with 1.0001)
43     - Expanded _throw_error() so that it provides better information.
44       (Thanks brian d foy!)
45     - Fixed how shift, unshift, and splice work when there are references
46       being moved. It now no longer dies.
47     - Added diag in t/17_import.t to note that the failing tests on blead
48       are due to Clone being broken, not DBM::Deep. The tests will still
49       fail because I don't want users to install something that's broken
50       and deal with those bug reports.
51
52 1.0001 Mar 12 16:15:00 2007 EDT
53     - (This version is compatible with 1.0000)
54     - Added a missing dependency on IO::Scalar (RT #25387)
55     - Fixed how t/44_upgrade_db.t and utils/upgrade_db.pl worked
56       - utils/upgrade_db.pl now uses #!perl, not #!/usr/bin/perl
57       - t/44_upgrade_db.t now explicitly calls $^X
58         (Thanks merlyn!)
59
60 1.0000 Feb 26 22:30:00 2007 EST
61     - THIS VERSION IS INCOMPATIBLE WITH FILES FROM ALL OTHER PRIOR VERSIONS.
62       - To aid in this form of upgrades, DBM::Deep now checks the file format
63         version to make sure that it knows how to read it.
64       - db_upgrade.pl was added to utils/. This will -NOT- install onto
65         your system. This is deliberate.
66       - db_upgrade.pl will not handle developer release file formats. This
67         is due to the fact that all developer releases in preparation for a
68         given release share the same file version, even though the file
69         format may change. This is deliberate.
70     - Importing no longer takes place within a transaction
71     - The following parameters were added:
72       - data_sector_size - this determines the default size of a data sector.
73     - Correctly handle opening readonly files
74
75 0.99_04 Jan 24 22:30:00 2007 EST
76     - Added the missing lib/DBM/Deep.pod file to the MANIFEST
77     - Fixed a poorly-designed test that was failing depending on what Clone::Any
78       was using.
79     - All "use 5.6.0;" lines are now "use 5.006_000;" to avoid warnings about
80       unsupported vstrings in 5.9.x
81
82 0.99_03 Jan 23 22:30:00 2007 EST
83     - THIS VERSION IS INCOMPATIBLE WITH FILES FROM ALL OTHER PRIOR VERSIONS.
84       - The fileformat changed completely. I will be writing a converter, but
85         it's not there right now. Do NOT expect that this module will
86         correctly detect older versions and handle them sanely. Sanity will be
87         there for 1.00, but we're not there yet, are we?
88     - Converted to use FileHandle::Fmode to handle filehandle status checks
89     - Fixed bug with deleting already-deleted items on Win32 (reported by Nigel Sandever)
90     - The guts of how transactions work has been rewritten to better handle
91       some edgecases. This required a complete rewrite of the engine.
92     - Freespace management is now in place. It's not perfect, but it's there.
93     - The rewrite of the engine required a rewrite of how first_key/next_key
94       was implemented. This should result in significant speed improvements.
95     - Self-reference has been removed. This means you cannot do:
96           $db->{foo} = { x => 'y' };
97           $db->{bar} = $db->{foo};
98       I hope to be able to return this functionality by 1.00, but I cannot
99       promise anything. To do this properly, it requires refcounting in order
100       to correctly handle deletions and transactions. Once you move away from
101       a simple tree, everything becomes really hard.
102
103 0.99_02 Apr 28 05:00:00 2006 Pacific
104     - Added missing file to the MANIFEST
105
106 0.99_01 Apr 27 18:00:00 2006 Pacific
107     - Added explicit dependency on Perl 5.6.0
108       - Digest::MD5 requires 5.6.0
109       - Sub::Uplevel (dep of Test::Exception) requires 5.6.0
110     - Removed error()/clear_error()
111       - All error-handling is done with die()
112     - Broke out DBM::Deep's code into DBM::Deep::Engine
113     - Tied variables can no longer be assigned to a DBM::Deep object.
114       - This includes cross-file assignments.
115     - Autovivification now works
116       - This is a consequence of the fact that all assignments are tied.
117     - set_pack() and set_digest() have been removed.
118       - Instead, you will now pass the appropriate values into new()
119       - A pack_size parameter has been added to make 64-bit files easier
120     - Transactions now work
121
122 0.983 Apr 10 20:00:00 2006 Pacific
123     - Added patch inspired by Jeff Janes (Thanks!)
124       - Autovivification now works correctly
125       - The following now works correctly
126         my %hash = ( a => 1 );
127         $db->{hash} = \%hash;
128         $hash{b} = 2;
129         cmp_ok( $db->{hash}{b}, '==', 2 );
130     - (RT#18530) - DBM::Deep now plays nicely with -l
131
132 0.982 Mar 08 11:00:00 2006 Pacific
133     - Fixed smoketests that were failing on Win32
134     - Added restriction for Perl 5.6.0 or higher.
135       - Digest::MD5 and Sub::Uplevel (dep of Test::Exception) require 5.6+
136
137 0.981 Mar 06 11:00:00 2006 Pacific
138     - (RT#17947) - Fixed test that was failing on older Perls
139
140 0.98  Feb 28 11:00:00 2006 Pacific
141     - Added in patch by David Cantrell to allow use of DATA filehandle
142     - Fixed bug where attempting to export() a structure that used autobless would die
143     - Fixed arraytest slowness by localizing $SIG{__DIE__} to prevent Test::Builder's
144       $SIG{__DIE__} from being called. (q.v. http://perldoc.perl.org/functions/eval.html)
145     - More methods have been made private:
146         - root() is now _root()
147         - base_offset() is now _base_offset()
148         - fh() is now _fh()
149         - type() is now _type()
150         - precalc_sizes() is now _precalc_sizes()
151
152 0.97  Feb 24 10:00:00 2006 Pacific
153     - Reorganization of distribution to a more standard layout
154     - Migration to Module::Build with EU::MM backwards compatibility
155     - Migration of all tests to use Test::More and Test::Exception
156     - Added Devel::Cover report to DBM::Deep POD
157       - Test coverage improved to 89.6% (and climbing)
158     - The following methods have been renamed to reflect their private nature:
159         - init() is now _init()
160         - open() is now _open()
161         - close() is now _close()
162         - load_tag() is now _load_tag()
163         - index_lookup() is now _index_lookup()
164         - add_bucket() is now _add_bucket()
165         - get_bucket_value() is now _get_bucket_value()
166         - delete_bucket() is now _delete_bucket()
167         - bucket_exists() is now _bucket_exists()
168         - find_bucket_list() is now _find_bucket_list()
169         - traverse_index() is now _traverse_index()
170         - get_next_key() is now _get_next_key()
171         - copy_node() is now _copy_node()
172         - throw_error() is now _throw_error()
173     - The various tied classes have been broken out. This means that testing
174         "ref( $obj ) eq 'DBM::Deep'" will now fail. The correct test is
175         "eval { $obj->isa( 'DBM::Deep' ) }".
176     - The various methods like push and delete now have the same return values as
177       the standard builtins.
178     - TIEARRAY and TIEHASH now check their parameters more thoroughly
179     - Negative indices for arrays works as expected, including throwing the appropriate
180       errors.
181     - RT #16877 is fixed (DBM::Deep broken with Perl 5.9.3+).
182     - RT #14893 is fixed (tie() and new() use different parameter lists).
183     - A bug with optimize and threading is fixed.
184     - autobless has received some attention, resulting in a number of bugs fixed.
185     - Removed mode option as it just caused confusion.
186     - Removed volatile option as it is pretty useless (use locking instead)
187     - Locking now implicitly enables autoflush
188
189 0.96  Oct 14 09:55:00 2005 Pacific
190     - Fixed build (OS X hidden files killed it)
191     - You can now pass in an optional filehandle to the constructor
192
193 0.95  Oct 12 13:58:00 2005 Pacific
194     - Added optional autobless flag to preserve and restore blessed hashes
195     - Fixed bug where 0 could not be fetched using get_next_key
196     - Fixed bug where tie() constructor didn't accept a hash ref for args
197     - optimize() now preserves user/group/permissions
198     - Errors are now FATAL (meaning it calls die()), unless you set debug flag
199
200 0.94  Apr 13 19:00:26 2004 Pacific
201     - Fixed bug reported by John Cardenas (corruption at key level when
202          replace of less data was done on bucket)
203
204 0.93  Feb 15 19:53:17 2004 Pacific
205     - Fixed optmize() on Win32 where orig file couldn't be overwritten unless
206          filehandle was closed first.  This change introduces a potential race
207          condition when using locking and optmize() on Win32, but it can be 
208          fixed in the future using a soft copy instead of Perl's rename().
209
210 0.92  Feb 12 19:10:22 2004 Pacific
211     - Fixed bug where passing a reference to a different DBM::Deep object
212          would still result in an internal reference.
213     - Added export() method for recursively extracting hashes/arrays into
214          standard in-memory Perl structures.
215     - Added import() method for recursively importing existing Perl hash/
216          array structures
217     - Fixed bug where optimize() wouldn't work if base level of DB was
218          an array instead of a hash.
219
220 0.91  Feb 12 02:30:22 2004 Pacific
221     - Fixed bug with splice() when length of removed section was 0
222     - Updated POD re: circular refs and optimize()
223     - Had to jump version numbers to 0.91 because in previous releases
224          I used only a single digit after the decimal which was confusing
225          the CPAN indexer.
226
227 0.10  Feb 11 08:58:35 2004 Pacific
228     - Fixed bug where default file mode was CLEARING files (Thanks Rich!)
229     - Added experimental support for circular references
230     - Fixed bugs in shift(), unshift() and splice() where nested objects
231         in array would be recursively re-stored as basic hashes/arrays
232     - Fixed typos in POD docs
233
234 0.9   Feb 10 03:25:48 2004 Pacific
235     - Added Filters for storing/fetching keys/values
236     - Added hook for supplying own hashing algorithm
237     - FIxed some typos in POD docs, added new sections
238
239 0.8   Feb 8 02:38:22 2004 Pacific
240     - Renamed to DBM::Deep for CPAN
241     - Added optimize() method for rekindling unused space
242     - Now returning hybrid tie()/OO object from new()
243     - Basic error handling introduced
244     - Added debug mode for printing errors to STDERR
245     - Added TYPE_HASH and TYPE_ARRAY constants for "type" param
246     - Added clone() method for safe copying of objects
247     - Wrote POD documentation
248     - Added set_pack() function for manipulating LONG_SIZE / LONG_PACK
249     - Added aliases for most tied functions for public use
250     - Now setting binmode() on FileHandle for Win32
251     - Added 45 unit tests
252
253 0.7   Jan 4 11:31:50 2003 UTC
254     - Renamed to DeepDB
255     - Changed file signature to DPDB (not compatible with older versions)
256     - Converted array length to packed long instead of sprintf()ed string
257
258 0.6   Dec 31 15:12:03 2002 UTC
259     - Some misc optimizations for speed
260
261 0.5   Oct 18 08:55:29 2002 UTC
262     - support for force_return_next parameter in traverse_index() method for 
263       ultra-fast combined key search/removal
264
265 0.4   Oct 15 20:07:47 2002 UTC
266     - now making sure filehandle is open for all DB calls
267
268 0.3   Oct 3 19:04:13 2002 UTC
269     - fixed bug that could cause corrupted data when using locking
270
271 0.2   Aug 6 16:37:32 2002 UTC
272     - Removed base index caching, as it can cause problems when two processes 
273       are populating the db at the same time (even with locking)
274
275 0.1   Jun 3 08:06:26 2002 UTC
276     - initial release