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