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