dbf 0.5.1 → 0.5.2

data/README.txt

@@ -46,6 +46,25 @@ Copyright (c) 2006-2007 Keith Morrison <keithm@infused.org, www.infused.org>
   reader.find :first, :first_name => 'Keith'
   reader.find(10)
   
+== Dealing with deleted records
+xBase database systems do not physically delete records, but merely mark the
+records for deletion. The file must be compacted using a special utility to
+remove the deleted records.
+
+DBF returns nil for any record that has been marked for deletion, so if the
+database file has deleted records, you need to be careful when looping. For
+example, the following will fail if it encounters a nil record:
+
+  reader.records.each do |record| puts record['name'] end
+  
+Therefore, it's a good idea to compact the records array to remove any nil
+records before iterating over it:
+
+  reader.records.compact.each do |record|
+    puts record['name']
+    puts record['email']
+  end
+  
 == Limitations and known bugs
   
 * DBF is read-only at the moment

data/Rakefile

@@ -2,7 +2,7 @@ require 'hoe'
 require 'spec/rake/spectask'
 
 PKG_NAME = "dbf"
-PKG_VERSION = "0.5.1"
+PKG_VERSION = "0.5.2"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 Hoe.new PKG_NAME, PKG_VERSION do |p|
@@ -17,7 +17,7 @@ Hoe.new PKG_NAME, PKG_VERSION do |p|
 end
 
 desc 'Run tests'
-task :default => :test
+task :default => [:spec, :test]
 
 desc 'Run tests'
 Rake::TestTask.new :test do |t|
@@ -28,6 +28,6 @@ end
 
 desc "Run specs"
 Spec::Rake::SpecTask.new :spec do |t|
-  t.spec_opts = ["-f specdoc"]
+  # t.spec_opts = ["-f specdoc"]
   t.spec_files = FileList['spec/**/*spec.rb']
 end

data/lib/dbf/reader.rb

@@ -2,16 +2,22 @@ module DBF
   class Reader
     # The total number of fields (columns)
     attr_reader :field_count
+    
     # An array of DBF::Field records
     attr_reader :fields
-    # The total number of records.  This number includes any deleted records.
+    
+    # The total number of records.  This number includes records marked as deleted.
     attr_reader :record_count
+    
     # Internal dBase version number
     attr_reader :version
+    
     # Last updated datetime
     attr_reader :last_updated
+    
     # Either :fpt or :dpt
     attr_reader :memo_file_format
+    
     # The block size for memo records
     attr_reader :memo_block_size
     
@@ -55,7 +61,8 @@ module DBF
       @fields.detect {|f| f.name == field_name.to_s}
     end
     
-    # An array of all the records contained in the database file
+    # An array of all the records contained in the database file.  Each record is an instance
+    # of DBF::Record (or nil if the record is marked for deletion).
     def records
       if in_memory?
         @records ||= get_all_records_from_file
@@ -66,7 +73,7 @@ module DBF
     
     alias_method :rows, :records
     
-    # Returns the record at <tt>index</tt>.
+    # Returns a DBF::Record (or nil if the record has been marked for deletion) for the record at <tt>index</tt>.
     def record(index)
       if in_memory?
         records[index]
@@ -237,10 +244,16 @@ module DBF
       end
       
       def get_all_records_from_file
-        seek_to_record(0)
-        Array.new(@record_count) do |i|
-          active_record? ? DBF::Record.new(self, @data_file, @memo_file) : nil
+        all_records = []
+        0.upto(@record_count - 1) do |n|
+          seek_to_record(n)
+          if active_record?
+            all_records << DBF::Record.new(self, @data_file, @memo_file)
+          else
+            all_records << nil
+          end
         end
+        all_records
       end
     
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: dbf
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
-date: 2007-06-05 00:00:00 -07:00
+  version: 0.5.2
+date: 2007-06-12 00:00:00 -07:00
 summary: A small fast library for reading dBase, xBase, Clipper and FoxPro database files.
 require_paths: 
 - lib