dbf 0.5.3 → 0.5.4

data/README.txt

@@ -46,24 +46,23 @@ 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.
+== Large databases
 
-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:
+DBF::Reader defaults to loading all records into memory. This may not be what
+you want, especially if the database is large. To disable this behavior, set
+the in_memory option to false during initialization.
 
-  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 = DBF::Reader.new("old_data.dbf", :in_memory => false)
 
-  reader.records.compact.each do |record|
-    puts record['name']
-    puts record['email']
-  end
+== Command-line utility
+
+A small command-line utility called dbf is installed along with the gem.
+
+  $ dbf -h
+  usage: dbf [-h|-s|-a] filename
+    -h = print this message
+    -s = print summary information
+    -a = create an ActiveRecord::Schema
   
 == Limitations and known bugs
   

data/Rakefile

@@ -2,7 +2,7 @@ require 'hoe'
 require 'spec/rake/spectask'
 
 PKG_NAME = "dbf"
-PKG_VERSION = "0.5.3"
+PKG_VERSION = "0.5.4"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 Hoe.new PKG_NAME, PKG_VERSION do |p|
@@ -10,6 +10,7 @@ Hoe.new PKG_NAME, PKG_VERSION do |p|
   p.author = "Keith Morrison"
   p.email = "keithm@infused.org"
   p.summary = "A small fast library for reading dBase, xBase, Clipper and FoxPro database files."
+  p.description = p.paragraphs_of("README.txt", 1..3).join("\n\n")
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.url = "http://dbf.rubyforge.org"
   p.need_tar = true

data/lib/dbf/field.rb

@@ -1,5 +1,6 @@
 module DBF
   class FieldLengthError < DBFError; end
+  
   class Field
     attr_reader :name, :type, :length, :decimal
 
@@ -7,6 +8,5 @@ module DBF
       raise FieldLengthError, "field length must be greater than 0" unless length > 0
       @name, @type, @length, @decimal = name.gsub(/\0/, ''), type, length, decimal
     end
-
   end
 end

data/lib/dbf/reader.rb

@@ -6,9 +6,6 @@ module DBF
     # An array of DBF::Field records
     attr_reader :fields
     
-    # The total number of records.  This number includes records marked as deleted.
-    attr_reader :record_count
-    
     # Internal dBase version number
     attr_reader :version
     
@@ -24,8 +21,10 @@ module DBF
     # Initialize a new DBF::Reader.
     # Example:
     #   reader = DBF::Reader.new 'data.dbf'
-    def initialize(filename)
-      @in_memory = true
+    def initialize(filename, options = {})
+      options = {:in_memory => true}.merge(options)
+      
+      @in_memory = options[:in_memory]
       @data_file = File.open(filename, 'rb')
       @memo_file = open_memo(filename)
       reload!
@@ -37,6 +36,7 @@ module DBF
       get_header_info
       get_memo_header_info if @memo_file
       get_field_descriptors
+      build_db_index
     end
     
     # Returns true if there is a corresponding memo file
@@ -45,14 +45,15 @@ module DBF
     end
     
     # If true, DBF::Reader will load all records into memory.  If false, records are retrieved using file I/O.
+    # You can set this option is set during initialization of the DBF::Reader. Defaults to true. Example:
+    #   reader = DBF::Reader.new 'data.dbf', :in_memory => false
     def in_memory?
       @in_memory
     end
     
-    # Tells DBF::Reader whether to load all records into memory.  Defaults to true.
-    # You may need to set this to false if the database is very large in order to reduce memory usage.
-    def in_memory=(boolean)
-      @in_memory = boolean
+    # The total number of active records.
+    def record_count
+      @db_index.size
     end
     
     # Returns an instance of DBF::Field for <b>field_name</b>.  <b>field_name</b>
@@ -239,7 +240,7 @@ module DBF
       # physical database file. See the documentation for the records method for
       # information on how these two methods differ.
       def get_record_from_file(index)
-        seek_to_record(index)
+        seek_to_record(@db_index[index])
         active_record? ? Record.new(self, @data_file, @memo_file) : nil
       end
       
@@ -249,13 +250,23 @@ module DBF
           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
     
+      def build_db_index
+        @db_index = []
+        @deleted_records = []
+        0.upto(@record_count - 1) do |n|
+          seek_to_record(n)
+          if active_record?
+            @db_index << n
+          else
+            @deleted_records << n
+          end
+        end
+      end
   end
   
 end

data/spec/functional/dbf_shared.rb

@@ -1,8 +1,4 @@
 describe DBF, :shared => true do
-  specify "number of records found should equal number of records calculated from the header information" do
-    @reader.record_count.should == @reader.records.size
-  end
-  
   specify "sum of field lengths should equal record length specified in header" do
     header_record_length = @reader.instance_eval {@record_length}
     sum_of_field_lengths = @reader.fields.inject(1) {|sum, field| sum + field.length}

data/spec/unit/reader_spec.rb

@@ -39,6 +39,12 @@ describe DBF::Reader, "when initialized" do
     @reader.version.should == "83"
   end
   
+  it "should set the in_memory option" do
+    @reader.in_memory?.should be_true
+    reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf", :in_memory => false
+    reader.in_memory?.should be_false
+  end
+  
 end
 
 describe DBF::Reader, "when the in_memory flag is true" do
@@ -64,14 +70,10 @@ end
 
 describe DBF::Reader, "when the in_memory flag is false" do
   
-  before(:each) do
-    @reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf"
-  end
-  
   it "should read the records from disk on every request" do
-    @reader.in_memory = false
-    @reader.expects(:get_all_records_from_file).times(3).returns([])
-    3.times { @reader.records }
+    reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf", :in_memory => false
+    reader.expects(:get_all_records_from_file).times(3).returns([])
+    3.times { reader.records }
   end
 end
 

metadata

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: dbf
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
-date: 2007-06-16 00:00:00 -07:00
+  version: 0.5.4
+date: 2007-06-22 00:00:00 -07:00
 summary: A small fast library for reading dBase, xBase, Clipper and FoxPro database files.
 require_paths: 
 - lib
 email: keithm@infused.org
 homepage: http://dbf.rubyforge.org
 rubyforge_project: dbf
-description: The author was too lazy to write a description
+description: "DBF is a small fast library for reading dBase, xBase, Clipper and FoxPro database files.  It is written completely in Ruby and has no external dependencies.  Copyright (c) 2006-2007 Keith Morrison <keithm@infused.org, www.infused.org>  * Official project page: http://rubyforge.org/projects/dbf * API Documentation: http://dbf.rubyforge.org/docs * To report bugs: http://www.rubyforge.org/tracker/?group_id=2009 * Questions: Email keithm@infused.org and put DBF somewhere in the subject line"
 autorequire: 
 default_executable: 
 bindir: bin