dbf 0.4.6 → 0.4.7

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2006-2007 Keith Morrison <keithm@infused.org>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,67 @@
+= DBF
+
+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.
+
+== Features
+
+* No external dependencies
+* DB fields are type cast
+* Date/Time fields are returned as either a Time or Date object.  Date 
+  will only be used if the date is outside the range for Time.
+
+== Installation
+
+  gem install dbf
+  
+== Usage
+
+  reader = DBF::Reader.new("old_data.dbf")
+  
+  reader.records.each do |record|
+    puts record['name']
+    puts record['email']
+  end
+  
+  puts reader.records[4]['name']
+  puts reader.record(4)['name']
+  
+=== A note on record vs. records
+
+DBF::Reader#records is an in-memory array of all rows in the database.  All
+rows are loaded the first time that the method is called.  Subsequent calls
+retrieve the row from memory.
+
+DBF::Reader#record retrieves the requested row from the database each time
+it is called. 
+
+Using records is probably faster most of the time.  Record is more appropriate 
+for very large databases where you don't want the whole db loaded into memory.
+
+== Limitations and known bugs
+  
+* DBF is read-only.  Writing to the database has not yet been implemented.
+
+== License
+
+Copyright (c) 2006-2007 Keith Morrison <keithm@infused.org>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,14 +1,15 @@
 require 'hoe'
+require 'spec/rake/spectask'
 
 PKG_NAME = "dbf"
-PKG_VERSION = "0.4.6"
+PKG_VERSION = "0.4.7"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 Hoe.new PKG_NAME, PKG_VERSION do |p|
   p.rubyforge_name = PKG_NAME
   p.author = "Keith Morrison"
   p.email = "keithm@infused.org"
-  p.summary = "A library for reading dBase (or xBase, Clipper, Foxpro, etc) database files"
+  p.summary = "A small fast library for reading dBase, xBase, Clipper and FoxPro database files."
   p.url = "http://dbf.rubyforge.org"
   p.need_tar = true
   p.need_zip = true
@@ -23,3 +24,9 @@ Rake::TestTask.new :test do |t|
   t.pattern = 'test/*_test.rb'
   t.verbose = true
 end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new :spec do |t|
+  t.spec_opts = ["-f specdoc"]
+  t.spec_files = FileList['spec/**/*spec.rb']
+end

data/lib/dbf.rb

@@ -1,4 +1,6 @@
 require 'date'
 
-require 'dbf/common'
+require 'dbf/globals'
+require 'dbf/record'
+require 'dbf/field'
 require 'dbf/reader'

data/lib/dbf/field.rb

@@ -0,0 +1,12 @@
+module DBF
+  class FieldLengthError < DBFError; end
+  class Field
+    attr_reader :name, :type, :length, :decimal
+
+    def initialize(name, type, length, decimal)
+      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/globals.rb

@@ -0,0 +1,22 @@
+module DBF
+  DBF_HEADER_SIZE = 32
+  FPT_HEADER_SIZE = 512
+  FPT_BLOCK_HEADER_SIZE = 8
+  DATE_REGEXP = /([\d]{4})([\d]{2})([\d]{2})/
+  VERSION_DESCRIPTIONS = {
+    "02" => "FoxBase",
+    "03" => "dBase III without memo file",
+    "04" => "dBase IV without memo file",
+    "05" => "dBase V without memo file",
+    "30" => "Visual FoxPro",
+    "31" => "Visual FoxPro with AutoIncrement field",
+    "7b" => "dBase IV with memo file",
+    "83" => "dBase III with memo file",
+    "8b" => "dBase IV with memo file",
+    "8e" => "dBase IV with SQL table",
+    "f5" => "FoxPro with memo file",
+    "fb" => "FoxPro without memo file"
+  }
+  
+  class DBFError < StandardError; end
+end

data/lib/dbf/reader.rb

@@ -44,7 +44,7 @@ module DBF
       seek_to_record(0)
       @records ||= Array.new(@record_count) do |i|
         if active_record?
-          Record.new(self, @data_file, @memo_file)
+          DBF::Record.new(self, @data_file, @memo_file)
         else
           seek_to_record(i + 1)
           nil
@@ -117,86 +117,4 @@ module DBF
     
   end
   
-  class FieldError < StandardError; end
-  
-  class Field
-    attr_accessor :name, :type, :length, :decimal
-
-    def initialize(name, type, length, decimal)
-      raise FieldError, "field length must be greater than 0" unless length > 0
-      self.name, self.type, self.length, self.decimal = name.strip, type, length, decimal
-    end
-
-    def name=(name)
-      @name = name.gsub(/\0/, '')
-    end
-
-  end
-  
-  class Record < Hash
-    
-    def initialize(reader, data_file, memo_file)
-      @reader, @data_file, @memo_file = reader, data_file, memo_file
-      reader.fields.each do |field| 
-        case field.type
-        when 'N' # number
-          self[field.name] = field.decimal == 0 ? unpack_string(field).to_i : unpack_string(field).to_f
-        when 'D' # date
-          raw = unpack_string(field).strip
-          unless raw.empty?
-            begin
-              self[field.name] = Time.gm(*raw.match(DATE_REGEXP).to_a.slice(1,3).map {|n| n.to_i})
-            rescue
-              self[field.name] = Date.new(*raw.match(DATE_REGEXP).to_a.slice(1,3).map {|n| n.to_i})
-            end
-          end
-        when 'M' # memo
-          starting_block = unpack_string(field).to_i
-          self[field.name] = read_memo(starting_block)
-        when 'L' # logical
-          self[field.name] = unpack_string(field) =~ /^(y|t)$/i ? true : false
-        else
-          self[field.name] = unpack_string(field)
-        end
-      end
-      self
-    end
-    
-    def unpack_field(field)
-      @data_file.read(field.length).unpack("a#{field.length}")
-    end
-    
-    def unpack_string(field)
-      unpack_field(field).to_s
-    end
-    
-    def read_memo(start_block)
-      return nil if start_block == 0
-      @memo_file.seek(start_block * @reader.memo_block_size)
-      if @reader.memo_file_format == :fpt
-        memo_type, memo_size, memo_string = @memo_file.read(@reader.memo_block_size).unpack("NNa56")
-        
-        memo_block_content_size = @reader.memo_block_size - FPT_BLOCK_HEADER_SIZE
-        if memo_size > memo_block_content_size
-          memo_string << @memo_file.read(memo_size - @reader.memo_block_size + FPT_BLOCK_HEADER_SIZE)
-        elsif memo_size > 0 and memo_size < memo_block_content_size
-          memo_string = memo_string[0, memo_size]
-        end
-      else
-        case @reader.version
-        when "83" # dbase iii
-          memo_string = ""
-          loop do
-            memo_string << block = @memo_file.read(512)
-            break if block.strip.size < 512
-          end
-        when "8b" # dbase iv
-          memo_type, memo_size = @memo_file.read(8).unpack("LL")
-          memo_string = @memo_file.read(memo_size)
-        end
-      end
-      memo_string
-    end
-  end
-
-end
+end

data/lib/dbf/record.rb

@@ -0,0 +1,66 @@
+module DBF
+  class Record < Hash
+    def initialize(reader, data_file, memo_file)
+      @reader, @data_file, @memo_file = reader, data_file, memo_file
+      reader.fields.each do |field| 
+        case field.type
+        when 'N' # number
+          self[field.name] = field.decimal == 0 ? unpack_string(field).to_i : unpack_string(field).to_f
+        when 'D' # date
+          raw = unpack_string(field).strip
+          unless raw.empty?
+            begin
+              self[field.name] = Time.gm(*raw.match(DATE_REGEXP).to_a.slice(1,3).map {|n| n.to_i})
+            rescue
+              self[field.name] = Date.new(*raw.match(DATE_REGEXP).to_a.slice(1,3).map {|n| n.to_i})
+            end
+          end
+        when 'M' # memo
+          starting_block = unpack_string(field).to_i
+          self[field.name] = read_memo(starting_block)
+        when 'L' # logical
+          self[field.name] = unpack_string(field) =~ /^(y|t)$/i ? true : false
+        else
+          self[field.name] = unpack_string(field)
+        end
+      end
+      self
+    end
+    
+    def unpack_field(field)
+      @data_file.read(field.length).unpack("a#{field.length}")
+    end
+    
+    def unpack_string(field)
+      unpack_field(field).to_s
+    end
+    
+    def read_memo(start_block)
+      return nil if start_block == 0
+      @memo_file.seek(start_block * @reader.memo_block_size)
+      if @reader.memo_file_format == :fpt
+        memo_type, memo_size, memo_string = @memo_file.read(@reader.memo_block_size).unpack("NNa56")
+        
+        memo_block_content_size = @reader.memo_block_size - FPT_BLOCK_HEADER_SIZE
+        if memo_size > memo_block_content_size
+          memo_string << @memo_file.read(memo_size - @reader.memo_block_size + FPT_BLOCK_HEADER_SIZE)
+        elsif memo_size > 0 and memo_size < memo_block_content_size
+          memo_string = memo_string[0, memo_size]
+        end
+      else
+        case @reader.version
+        when "83" # dbase iii
+          memo_string = ""
+          loop do
+            memo_string << block = @memo_file.read(512)
+            break if block.strip.size < 512
+          end
+        when "8b" # dbase iv
+          memo_type, memo_size = @memo_file.read(8).unpack("LL")
+          memo_string = @memo_file.read(memo_size)
+        end
+      end
+      memo_string
+    end
+  end
+end

data/test/dbase_iii_read_test.rb

@@ -21,7 +21,7 @@ class DBaseIIIReadTest < Test::Unit::TestCase
       :testable_logical_field_names => [],
       :testable_memo_field_names => []
     }
-    @dbf = DBF::Reader.new(File.join(File.dirname(__FILE__),'databases', 'dbase_iii.dbf'))
+    @dbf = DBF::Reader.new "#{File.dirname(__FILE__)}/databases/dbase_iii.dbf"
   end
   
 end

data/test/foxpro_read_test.rb

@@ -21,7 +21,7 @@ class FoxproReadTest < Test::Unit::TestCase
       :testable_logical_field_names => [],
       :testable_memo_field_names => ["OBSE"]
     }
-    @dbf = DBF::Reader.new(File.join(File.dirname(__FILE__),'databases', 'foxpro.dbf'))
+    @dbf = DBF::Reader.new "#{File.dirname(__FILE__)}/databases/foxpro.dbf"
   end
   
   # make sure we're grabbing the correct memo

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.3
+rubygems_version: 0.9.4
 specification_version: 1
 name: dbf
 version: !ruby/object:Gem::Version 
-  version: 0.4.6
-date: 2007-05-21 00:00:00 -07:00
-summary: A library for reading dBase (or xBase, Clipper, Foxpro, etc) database files
+  version: 0.4.7
+date: 2007-05-25 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
@@ -30,9 +30,13 @@ authors:
 - Keith Morrison
 files: 
 - Rakefile
-- README
+- README.txt
+- LICENSE.txt
 - lib/dbf.rb
+- lib/dbf/field.rb
+- lib/dbf/globals.rb
 - lib/dbf/reader.rb
+- lib/dbf/record.rb
 - test/common.rb
 - test/dbase_iii_read_test.rb
 - test/foxpro_read_test.rb
@@ -47,8 +51,9 @@ test_files: []
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.txt
+- LICENSE.txt
 executables: []
 
 extensions: []

data/README

@@ -1,37 +0,0 @@
-= DBF
-A dBase I/O library.
-
-== Features
-
-  * No external dependencies
-  * DB fields are type cast
-  * Date/Time fields are returned as either a Time or Date object.  Date 
-    will only be used if the date is outside the range for Time.
-  
-== Limitations
-  
-  * Writing to the db has not been implemented yet
-  
-== Usage
-
-  reader = DBF::Reader.new("old_data.dbf")
-  
-  reader.records.each do |record|
-    puts record['name']
-    puts record['email']
-  end
-  
-  puts reader.records[4]['name']
-  puts reader.record(4)['name']
-  
-=== A note on record vs. records
-
-DBF::Reader#records is an in-memory array of all rows in the database.  All
-rows are loaded the first time that the method is called.  Subsequent calls
-retrieve the row from memory.
-
-DBF::Reader#record retrieves the requested row from the database each time
-it is called. 
-
-Using records is probably faster most of the time.  Record is more appropriate 
-for very large databases where you don't want the whole db loaded into memory.