dbf 1.0.7 → 1.0.8

data/History.txt

@@ -1,3 +1,10 @@
+== 1.0.8
+
+* Truncate column names on NULL
+* Fix schema dump for date and datetime columns
+* Replace internal helpers with ActiveSupport
+* Always underscore attribute names
+
 == 1.0.7
 
 * Remove support for original column names.  All columns names are now downcased/underscored.

data/README.txt

@@ -1,8 +1,8 @@
 = 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.
+DBF is a small fast library for reading dBase, xBase, Clipper and FoxPro database files
 
-Copyright (c) 2006-2008 Keith Morrison <keithm@infused.org, www.infused.org>
+Copyright (c) 2006-2009 Keith Morrison <keithm@infused.org, www.infused.org>
 
 * Official project page: http://rubyforge.org/projects/dbf
 * API Documentation: http://dbf.rubyforge.org/docs
@@ -91,7 +91,7 @@ A small command-line utility called dbf is installed along with the gem.
 
 (The MIT Licence)
 
-Copyright (c) 2006-2008 Keith Morrison <keithm@infused.org>
+Copyright (c) 2006-2009 Keith Morrison <keithm@infused.org, www.infused.org>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/Rakefile

@@ -2,7 +2,7 @@ require 'hoe'
 require 'spec/rake/spectask'
 
 PKG_NAME = "dbf"
-PKG_VERSION = "1.0.7"
+PKG_VERSION = "1.0.8"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 Hoe.new PKG_NAME, PKG_VERSION do |p|

data/bin/dbf

@@ -18,22 +18,22 @@ else
 
   # create an ActiveRecord::Schema
   if $a
-    reader = DBF::Table.new filename
-    puts reader.schema
+    table = DBF::Table.new filename
+    puts table.schema
   end
   
   if $s
-    reader = DBF::Table.new filename
+    table = DBF::Table.new filename
     puts
     puts "Database: #{filename}"
-    puts "Type: (#{reader.version}) #{reader.version_description}"
-    puts "Memo Type: #{reader.memo_file_format}" if reader.has_memo_file?
-    puts "Records: #{reader.record_count}"
+    puts "Type: (#{table.version}) #{table.version_description}"
+    puts "Memo Type: #{table.memo_file_format}" if table.has_memo_file?
+    puts "Records: #{table.record_count}"
     
     puts "\nFields:"
     puts "Name             Type       Length     Decimal"
     puts "-" * 78
-    reader.columns.each do |f|
+    table.columns.each do |f|
       puts "%-16s %-10s %-10s %-10s" % [f.name, f.type, f.length, f.decimal]
     end
   end

data/dbf.gemspec

@@ -1,38 +1,37 @@
-(in /Users/keithm/projects/dbf)
 Gem::Specification.new do |s|
   s.name = %q{dbf}
-  s.version = "1.0.7"
+  s.version = "1.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Keith Morrison"]
-  s.date = %q{2008-09-02}
+  s.date = %q{2009-01-02}
   s.default_executable = %q{dbf}
-  s.description = %q{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-2008 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}
+  s.description = %q{DBF is a small fast library for reading dBase, xBase, Clipper and FoxPro database files  Copyright (c) 2006-2009 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}
   s.email = %q{keithm@infused.org}
   s.executables = ["dbf"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt", "spec/fixtures/dbase_83_schema.txt"]
+  s.extra_rdoc_files = ["History.txt", "README.txt"]
   s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/dbf", "dbf.gemspec", "lib/dbf.rb", "lib/dbf/column.rb", "lib/dbf/globals.rb", "lib/dbf/record.rb", "lib/dbf/table.rb", "spec/fixtures/dbase_03.dbf", "spec/fixtures/dbase_30.dbf", "spec/fixtures/dbase_30.fpt", "spec/fixtures/dbase_83.dbf", "spec/fixtures/dbase_83.dbt", "spec/fixtures/dbase_83_schema.txt", "spec/fixtures/dbase_8b.dbf", "spec/fixtures/dbase_8b.dbt", "spec/fixtures/dbase_f5.dbf", "spec/fixtures/dbase_f5.fpt", "spec/functional/dbf_shared.rb", "spec/functional/format_03_spec.rb", "spec/functional/format_30_spec.rb", "spec/functional/format_83_spec.rb", "spec/functional/format_8b_spec.rb", "spec/functional/format_f5_spec.rb", "spec/spec_helper.rb", "spec/unit/column_spec.rb", "spec/unit/record_spec.rb", "spec/unit/table_spec.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/infused/dm-dbf/tree/master}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{dbf}
-  s.rubygems_version = %q{1.2.0}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{A small fast library for reading dBase, xBase, Clipper and FoxPro database files.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
-    if current_version >= 3 then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.1.0"])
-      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.1.0"])
-      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.1.0"])
-    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
   end
 end

data/lib/dbf/column.rb

@@ -1,14 +1,44 @@
 module DBF
   class ColumnLengthError < DBFError; end
+  class ColumnNameError < DBFError; end
   
   class Column
-    include Helpers
-    
     attr_reader :name, :type, :length, :decimal
-
+    
     def initialize(name, type, length, decimal)
-      raise ColumnLengthError, "field length must be greater than 0" unless length > 0
       @name, @type, @length, @decimal = strip_non_ascii_chars(name), type, length, decimal
+      
+      raise ColumnLengthError, "field length must be greater than 0" unless length > 0
+      raise ColumnNameError, "column name cannot be empty" if @name.length == 0
+    end
+    
+    def type_cast(value)
+      value = value.is_a?(Array) ? value.first : value
+      
+      case type
+      when 'N' # number
+        decimal.zero? ? unpack_integer(value) : value.to_f
+      when 'D' # date
+        value.to_date unless value.blank?
+      when 'L' # logical
+        value.strip =~ /^(y|t)$/i ? true : false
+      when 'I' # integer
+        unpack_integer(value)
+      when 'T' # datetime
+        decode_datetime(value)
+      else
+        value.to_s.strip
+      end
+    end
+    
+    def decode_datetime(value)
+      days, milliseconds = value.unpack('l2')
+      seconds = milliseconds / 1000
+      DateTime.jd(days, seconds/3600, seconds/60 % 60, seconds % 60)
+    end
+    
+    def unpack_integer(value)
+      value.unpack('v').first.to_i
     end
     
     def schema_definition
@@ -19,7 +49,11 @@ module DBF
         else
           ":integer"
         end
+      when "I" # integer
+        ":integer"
       when "D" # date
+        ":date"
+      when "T" # datetime
         ":datetime"
       when "L" # boolean
         ":boolean"
@@ -32,15 +66,13 @@ module DBF
       "\"#{name.underscore}\", #{data_type}\n"
     end
     
-    private
-    
+    # strip all non-ascii and non-printable characters
     def strip_non_ascii_chars(s)
-      clean = ''
-      s.each_byte do |char|
-        clean << char if char > 31 && char < 128
-      end
-      clean
+      # truncate the string at the first null character
+      s = s[0, s.index("\x00")] if s.index("\x00")
+      
+      s.gsub(/[^\x20-\x7E]/,"")
     end
   end
   
-end
+end

data/lib/dbf/globals.rb

@@ -23,14 +23,5 @@ module DBF
   MS_PER_HOUR   = MS_PER_MINUTE * 60
   
   class DBFError < StandardError; end
-  
-  module Helpers
-    # def underscore(camel_cased_word)
-    #   camel_cased_word.to_s.gsub(/::/, '/').
-    #     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    #     gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    #     tr("-", "_").
-    #     downcase
-    # end
-  end
+
 end

data/lib/dbf/record.rb

@@ -1,7 +1,5 @@
 module DBF
   class Record
-    include Helpers
-    
     attr_reader :attributes
     
     def initialize(table)
@@ -29,31 +27,16 @@ module DBF
     
     def initialize_values(columns)
       @attributes = columns.inject({}) do |hash, column|
-        hash[column.name.underscore] = typecast_column(column)
+        if column.type == 'M'
+          starting_block = unpack_string(column).to_i
+          hash[column.name.underscore] = read_memo(starting_block)
+        else
+          value = unpack_column(column)
+          hash[column.name.underscore] = column.type_cast(value)
+        end
         hash
       end
     end
-    
-    def typecast_column(column)
-      case column.type
-      when 'N' # number
-        column.decimal.zero? ? unpack_string(column).to_i : unpack_string(column).to_f
-      when 'D' # date
-        raw = unpack_string(column).strip
-        raw.to_time unless raw.blank?
-      when 'M' # memo
-        starting_block = unpack_string(column).to_i
-        read_memo(starting_block)
-      when 'L' # logical
-        unpack_string(column) =~ /^(y|t)$/i ? true : false
-      when 'I' # integer
-        unpack_integer(column)
-      when 'T' # datetime
-        unpack_datetime(column)
-      else
-        unpack_string(column).strip
-      end
-    end
   
     def unpack_column(column)
       @data.read(column.length).to_s.unpack("a#{column.length}")
@@ -62,18 +45,6 @@ module DBF
     def unpack_string(column)
       unpack_column(column).to_s
     end
-    
-    def unpack_integer(column)
-      @data.read(column.length).unpack("v").first
-    end
-    
-    def unpack_datetime(column)
-      days, milliseconds = @data.read(column.length).unpack('l2')
-      hours = (milliseconds / MS_PER_HOUR).to_i
-      minutes = ((milliseconds - (hours * MS_PER_HOUR)) / MS_PER_MINUTE).to_i
-      seconds = ((milliseconds - (hours * MS_PER_HOUR) - (minutes * MS_PER_MINUTE)) / MS_PER_SECOND).to_i
-      DateTime.jd(days, hours, minutes, seconds)
-    end
   
     def read_memo(start_block)
       return nil if !@table.has_memo_file? || start_block < 1

data/lib/dbf/table.rb

@@ -13,9 +13,9 @@ module DBF
     attr_reader :data                   # DBF file handle
     attr_reader :memo                   # Memo file handle
     
-    # Initializes a new DBF::Reader
+    # Initializes a new DBF::Table
     # Example:
-    #   reader = DBF::Reader.new 'data.dbf'
+    #   table = DBF::Table.new 'data.dbf'
     def initialize(filename, options = {})
       @data = File.open(filename, 'rb')
       @memo = open_memo(filename)
@@ -78,16 +78,16 @@ module DBF
     # Find records using a simple ActiveRecord-like syntax.
     #
     # Examples:
-    #   reader = DBF::Reader.new 'mydata.dbf'
+    #   table = DBF::Table.new 'mydata.dbf'
     #   
     #   # Find record number 5
-    #   reader.find(5)
+    #   table.find(5)
     #
     #   # Find all records for Keith Morrison
-    #   reader.find :all, :first_name => "Keith", :last_name => "Morrison"
+    #   table.find :all, :first_name => "Keith", :last_name => "Morrison"
     # 
     #   # Find first record
-    #   reader.find :first, :first_name => "Keith"
+    #   table.find :first, :first_name => "Keith"
     #
     # The <b>command</b> can be an id, :all, or :first.
     # <b>options</b> is optional and, if specified, should be a hash where the keys correspond

data/spec/unit/column_spec.rb

@@ -24,9 +24,57 @@ describe DBF::Column do
     end
   
     it "should raise an error if length is greater than 0" do
-      lambda { column = DBF::Column.new "ColumnName", "N", -1, 0 }.should raise_error(DBF::ColumnLengthError)
+      lambda { DBF::Column.new "ColumnName", "N", -1, 0 }.should raise_error(DBF::ColumnLengthError)
+    end
+    
+    it "should raise error on emtpy column names" do
+      lambda { DBF::Column.new "\xFF\xFC", "N", 1, 0 }.should raise_error(DBF::ColumnNameError)
+    end
+    
+  end
+  
+  context "#type_cast" do
+    it "should cast numbers with decimals to Float" do
+      value = "13.5"
+      column = DBF::Column.new "ColumnName", "N", 2, 1
+      column.type_cast(value).should == 13.5
+    end
+    
+    it "should cast numbers with no decimals to Integer" do
+      value = "135"
+      column = DBF::Column.new "ColumnName", "N", 3, 0
+      column.type_cast(value).should == 13105
+    end
+    
+    it "should cast :integer to Integer" do
+      value = "135"
+      column = DBF::Column.new "ColumnName", "I", 3, 0
+      column.type_cast(value).should == 13105
+    end
+    
+    it "should cast boolean to True" do
+      value = "y"
+      column = DBF::Column.new "ColumnName", "L", 1, 0
+      column.type_cast(value).should == true
+    end
+    
+    it "should cast boolean to False" do
+      value = "n"
+      column = DBF::Column.new "ColumnName", "L", 1, 0
+      column.type_cast(value).should == false
+    end
+    
+    it "should cast :datetime columns to DateTime" do
+      value = "Nl%\000\300Z\252\003"
+      column = DBF::Column.new "ColumnName", "T", 16, 0
+      column.type_cast(value).should == "2002-10-10T17:04:56+00:00"
+    end
+    
+    it "should cast :date columns to Date" do
+      value = "20050712"
+      column = DBF::Column.new "ColumnName", "D", 8, 0
+      column.type_cast(value).should == Date.new(2005,7,12)
     end
-
   end
   
   context "#schema_definition" do
@@ -40,8 +88,13 @@ describe DBF::Column do
       column.schema_definition.should == "\"column_name\", :float\n"
     end
     
-    it "should define a datetime column if type is (D)ate" do
+    it "should define a date column if type is (D)ate" do
       column = DBF::Column.new "ColumnName", "D", 8, 0
+      column.schema_definition.should == "\"column_name\", :date\n"
+    end
+    
+    it "should define a datetime column if type is (D)ate" do
+      column = DBF::Column.new "ColumnName", "T", 16, 0
       column.schema_definition.should == "\"column_name\", :datetime\n"
     end
     
@@ -62,10 +115,17 @@ describe DBF::Column do
   end
   
   context "#strip_non_ascii_chars" do
-    it "should strip characters below decimal 32 and above decimal 128" do
-      column = DBF::Column.new "ColumnName", "N", 1, 0
-      column.send(:strip_non_ascii_chars, "--\x1F-\x68\x65\x6C\x6C\x6F world-\x80--").should == "---hello world---"
+    before do
+      @column = DBF::Column.new "ColumnName", "N", 1, 0
+    end
+    
+    it "should strip characters below decimal 32 and above decimal 127" do
+      @column.strip_non_ascii_chars("--\x1F-\x68\x65\x6C\x6C\x6F world-\x80--").should == "---hello world---"
+    end
+
+    it "should truncate characters with decimal 0" do
+      @column.strip_non_ascii_chars("--\x1F-\x68\x65\x6C\x6C\x6F \x00 world-\x80--").should == "---hello "
     end
   end
   
-end
+end

data/spec/unit/record_spec.rb

@@ -44,19 +44,19 @@ describe DBF::Record do
       table.records.all? {|record| record.attributes["webinclude"].should satisfy {|v| v == true || v == false}}
     end
   
-    it "should typecast datetime columns to DateTime" do
-      record = example_record("Nl%\000\300Z\252\003")
-      column = mock('column', :length => 8)
-  
-      record.instance_eval {unpack_datetime(column)}.to_s.should == "2002-10-10T17:04:56+00:00"
-    end
-  
-    it "should typecast integers to Fixnum" do
-      record = example_record("\017\020\000\000")
-      column = mock('column', :length => 4)
-  
-      record.instance_eval {unpack_integer(column)}.should == 4111
-    end
+    # it "should typecast datetime columns to DateTime" do
+    #   record = example_record("Nl%\000\300Z\252\003")
+    #   column = mock('column', :length => 8)
+    #   
+    #   record.instance_eval {unpack_datetime(column)}.to_s.should == "2002-10-10T17:04:56+00:00"
+    # end
+    #   
+    # it "should typecast integers to Fixnum" do
+    #   record = example_record("\017\020\000\000")
+    #   column = mock('column', :length => 4)
+    #   
+    #   record.instance_eval {unpack_integer(column)}.should == 4111
+    # end
   end
   
   describe '#memo_block_content_size' do
@@ -95,30 +95,5 @@ describe DBF::Record do
       record.send(:read_memo, 5).should be_nil
     end
   end
-  
-  describe "#typecase_column" do
-    before do
-      @table = mock_table
-      @column = mock('column')
-      @column.stub!(:name).and_return('created')
-      @column.stub!(:length).and_return(8)
-      @column.stub!(:type).and_return('D')
-      @table.stub!(:columns).and_return([@column])
-      @record = DBF::Record.new(@table)
-    end
-    
-    describe 'when column is type D' do
-      it 'should return Time' do
-        @record.stub!(:unpack_string).and_return('20080606')
-        @record.send(:typecast_column, @column).should == Time.gm(2008, 6, 6)
-      end
-    
-      it 'should return Date if Time is out of range' do
-        @record.stub!(:unpack_string).and_return('19440606')
-        @record.send(:typecast_column, @column).should == Date.new(1944, 6, 6)
-      end
-    end
-    
-  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dbf
 version: !ruby/object:Gem::Version 
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors: 
 - Keith Morrison
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-02 00:00:00 -07:00
+date: 2009-01-02 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,9 +30,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.2
     version: 
-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-2008 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"
+description: "DBF is a small fast library for reading dBase, xBase, Clipper and FoxPro database files  Copyright (c) 2006-2009 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"
 email: keithm@infused.org
 executables: 
 - dbf
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dbf
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A small fast library for reading dBase, xBase, Clipper and FoxPro database files.