dbf 1.3.0 → 1.5.0

data/lib/dbf/version.rb

@@ -1,3 +1,3 @@
 module DBF
-  VERSION = '1.3.0'
+  VERSION = '1.5.0'
 end

data/spec/{unit → dbf}/column_spec.rb

@@ -1,37 +1,35 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "../spec_helper"))
+require "spec_helper"
 
 describe DBF::Column do
   
   context "when initialized" do
-    before do
-      @column = DBF::Column.new "ColumnName", "N", 1, 0
-    end
+    let(:column) { DBF::Column.new "ColumnName", "N", 1, 0 }
     
     it "sets the #name accessor" do
-      @column.name.should == "ColumnName"
+      column.name.should == "ColumnName"
     end
     
     it "sets the #type accessor" do
-      @column.type.should == "N"
+      column.type.should == "N"
     end
     
     it "sets the #length accessor" do
-      @column.length.should == 1
+      column.length.should == 1
     end
     
     it "sets the #decimal accessor" do
-      @column.decimal.should == 0
+      column.decimal.should == 0
     end
     
-    context 'with length of 0' do
+    describe 'with length of 0' do
       specify { lambda { DBF::Column.new "ColumnName", "N", 0, 0 }.should raise_error(DBF::ColumnLengthError) }
     end
     
-    context 'with length less than 0' do
+    describe 'with length less than 0' do
       specify { lambda { DBF::Column.new "ColumnName", "N", -1, 0 }.should raise_error(DBF::ColumnLengthError) }
     end
     
-    context 'with empty column name' do
+    describe 'with empty column name' do
       specify { lambda { DBF::Column.new "\xFF\xFC", "N", 1, 0 }.should raise_error(DBF::ColumnNameError) }
     end
   end
@@ -75,60 +73,57 @@ describe DBF::Column do
     end
     
     context 'with type L (logical/boolean)' do
+      let(:column) { DBF::Column.new "ColumnName", "L", 1, 0 }
+      
       it "casts 'y' to true" do
-        value = "y"
-        column = DBF::Column.new "ColumnName", "L", 1, 0
-        column.type_cast(value).should == true
+        column.type_cast('y').should == true
       end
       
-      it "casts 'n' to false" do
-        value = "n"
-        column = DBF::Column.new "ColumnName", "L", 1, 0
-        column.type_cast(value).should == false
+      it "casts 't' to true" do
+        column.type_cast('t').should == true
+      end
+      
+      it "casts value other than 't' or 'y' to false" do
+        column.type_cast('n').should == false
       end
     end
     
     context 'with type T (datetime)' do
+      let(:column) { DBF::Column.new "ColumnName", "T", 16, 0 }
+      
       context 'with valid datetime' do
         it "casts 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"
+          column.type_cast("Nl%\000\300Z\252\003").should == "2002-10-10T17:04:56+00:00"
         end
       end
       
       context 'with invalid datetime' do
         it "casts to nil" do
-          value = "Nl%\000\000A\000\999"
-          column = DBF::Column.new "ColumnName", "T", 16, 0
-          column.type_cast(value).should be_nil
+          column.type_cast("Nl%\000\000A\000\999").should be_nil
         end
       end
     end
     
     context 'with type D (date)' do
+      let(:column) { DBF::Column.new "ColumnName", "D", 8, 0 }
+      
       context 'with valid date' do
         it "casts to Date" do
-          value = "20050712"
-          column = DBF::Column.new "ColumnName", "D", 8, 0
-          column.type_cast(value).should == Date.new(2005,7,12)
+          column.type_cast("20050712").should == Date.new(2005,7,12)
         end
       end
       
       context 'with invalid date' do
         it "casts to nil" do
-          value = "0"
-          column = DBF::Column.new "ColumnName", "D", 8, 0
-          column.type_cast(value).should be_nil
+          column.type_cast("0").should be_nil
         end
       end
     end
     
     context 'with type M (memo)' do
       it "casts to string" do
-        value = 'abc'
         column = DBF::Column.new "ColumnName", "M", 3, 0
-        column.type_cast(value).should be_a String
+        column.type_cast('abc').should be_a String
       end
     end
   end
@@ -172,31 +167,27 @@ describe DBF::Column do
     end
   end
   
-  context "#strip_non_ascii_chars" do
-    before do
-      @column = DBF::Column.new "ColumnName", "N", 1, 0
-    end
-    
-    it "strips 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---"
+  context "#name" do    
+    it "contains only ASCII characters" do
+      column = DBF::Column.new "--\x1F-\x68\x65\x6C\x6C\x6F world-\x80--", "N", 1, 0
+      column.name.should == "---hello world---"
     end
 
-    it "truncates characters with decimal 0" do
-      @column.strip_non_ascii_chars("--\x1F-\x68\x65\x6C\x6C\x6F \x00 world-\x80--").should == "---hello "
+    it "is truncated at the null character" do
+      column = DBF::Column.new "--\x1F-\x68\x65\x6C\x6C\x6F \x00 world-\x80--", "N", 1, 0
+      column.name.should == "---hello "
     end
   end
   
   context '#decode_date' do
-    before do
-      @column = DBF::Column.new "ColumnName", "N", 1, 0
-    end
+    let(:column) { DBF::Column.new "ColumnName", "N", 1, 0 }
     
     it 'is nil if value is blank' do
-      @column.decode_date('').should be_nil
+      column.send(:decode_date, '').should be_nil
     end
     
     it 'interperets spaces as zeros' do
-      @column.decode_date('2010 715').should == Date.parse('20100715')
+      column.send(:decode_date, '2010 715').should == Date.parse('20100715')
     end
   end
   

data/spec/dbf/file_formats_spec.rb

@@ -0,0 +1,178 @@
+require "spec_helper"
+
+shared_examples_for 'DBF' do
+  specify "sum of column lengths should equal record length specified in header plus one" do
+    header_record_length = @table.instance_eval {@record_length}
+    sum_of_column_lengths = 1 + @table.columns.sum {|column| column.length}
+    
+    header_record_length.should == sum_of_column_lengths
+  end
+
+  specify "records should be instances of DBF::Record" do
+    @table.all? {|record| record.should be_an_instance_of(DBF::Record)}
+  end
+  
+  specify "record count should be the same as reported in the header" do
+    @table.count.should == @table.record_count
+  end
+  
+  specify "columns should be instances of DBF::Column" do
+    @table.columns.all? {|column| column.should be_an_instance_of(DBF::Column)}
+  end
+  
+  specify "column names should not be blank" do
+    @table.columns.all? {|column| column.name.should_not be_empty}
+  end
+  
+  specify "column types should be valid" do
+    valid_column_types = %w(C N L D M F B G P Y T I V X @ O + 0)
+    @table.columns.all? {|column| valid_column_types.should include(column.type)}
+  end
+  
+  specify "column lengths should be instances of Fixnum" do
+    @table.columns.all? {|column| column.length.should be_an_instance_of(Fixnum)}
+  end
+  
+  specify "column lengths should be larger than 0" do
+    @table.columns.all? {|column| column.length.should > 0}
+  end
+  
+  specify "column decimals should be instances of Fixnum" do
+    @table.columns.all? {|column| column.decimal.should be_an_instance_of(Fixnum)}
+  end
+  
+  specify "column read accessors should return the attribute after typecast" do
+    @table.columns do |column|
+      record = @table.records.first
+      record.send(column.name).should == record[column.name]
+    end
+  end
+  
+  specify "column attributes should be accessible in underscored form" do
+    @table.columns do |column|
+      record = @table.records.first
+      record.send(column_name).should == record.send(column_name.underscore)
+    end
+  end
+  
+end
+
+describe DBF, "of type 03 (dBase III without memo file)" do
+  before do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_03.dbf"
+  end
+  
+  it_should_behave_like "DBF"
+  
+  it "should report the correct version number" do
+    @table.version.should == "03"
+  end
+  
+  it "should report the correct version description" do
+    @table.version_description.should == "dBase III without memo file"
+  end
+  
+  it "should determine the number of records" do
+    @table.record_count.should == 14
+  end
+end
+
+describe DBF, "of type 30 (Visual FoxPro)" do
+  before do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_30.dbf"
+  end
+  
+  it_should_behave_like "DBF"
+  
+  it "should report the correct version number" do
+    @table.version.should == "30"
+  end
+  
+  it "should report the correct version description" do
+    @table.version_description.should == "Visual FoxPro"
+  end
+
+  it "should determine the number of records" do
+    @table.record_count.should == 34
+  end
+end
+
+describe DBF, "of type 31 (Visual FoxPro with AutoIncrement field)" do
+  before do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_31.dbf"
+  end
+  
+  it_should_behave_like "DBF"
+  
+  it "should have a dBase version of 31" do
+    @table.version.should == "31"
+  end
+  
+  it "should report the correct version description" do
+    @table.version_description.should == "Visual FoxPro with AutoIncrement field"
+  end
+  
+  it "should determine the number of records" do
+    @table.record_count.should == 77
+  end
+end
+
+describe DBF, "of type 83 (dBase III with memo file)" do
+  before do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+  end
+  
+  it_should_behave_like "DBF"
+  
+  it "should report the correct version number" do
+    @table.version.should == "83"
+  end
+  
+  it "should report the correct version description" do
+    @table.version_description.should == "dBase III with memo file"
+  end
+  
+  it "should determine the number of records" do
+    @table.record_count.should == 67
+  end
+end
+
+describe DBF, "of type 8b (dBase IV with memo file)" do
+  before do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_8b.dbf"
+  end
+  
+  it_should_behave_like "DBF"
+  
+  it "should report the correct version number" do
+    @table.version.should == "8b"
+  end
+  
+  it "should report the correct version description" do
+    @table.version_description.should == "dBase IV with memo file"
+  end
+  
+  it "should determine the number of records" do
+    @table.record_count.should == 10
+  end
+end
+
+describe DBF, "of type f5 (FoxPro with memo file)" do
+  before do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_f5.dbf"
+  end
+  
+  it_should_behave_like "DBF"
+  
+  it "should report the correct version number" do
+    @table.version.should == "f5"
+  end
+  
+  it "should report the correct version description" do
+    @table.version_description.should == "FoxPro with memo file"
+  end
+  
+  it "should determine the number of records" do
+    @table.record_count.should == 975
+  end
+end

data/spec/dbf/record_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe DBF::Record do
+  
+  describe '#to_a' do
+    it 'should return an ordered array of attribute values' do
+      table = DBF::Table.new "#{DB_PATH}/dbase_8b.dbf"
+      
+      record = table.record(0)
+      record.to_a.should == ["One", 1.0, Date.new(1970, 1, 1), true, 1.23456789012346, "First memo\r\n\037 \037 \037 \037 "]
+      
+      record = table.record(9)
+      record.to_a.should == ["Ten records stored in this database", 10.0, nil, false, 0.1, nil]
+    end
+  end
+  
+  describe '#==' do
+    before do
+      table = DBF::Table.new "#{DB_PATH}/dbase_8b.dbf"
+      @record = table.record(9)
+    end
+    
+    it 'should be false if other does not have attributes' do
+      (@record == mock('other')).should be_false
+    end
+    
+    it 'should be true if other attributes match' do
+      attributes = {:x => 1, :y => 2}
+      @record.stub!(:attributes).and_return(attributes)
+      other = mock('object', :attributes => attributes)
+      (@record == other).should be_true
+    end
+  end
+  
+  describe 'column accessors' do
+    let(:table) { DBF::Table.new "#{DB_PATH}/dbase_8b.dbf"}
+    
+    it 'should define accessor methods for each column' do
+      record = table.find(0)
+      record.should respond_to(:character)
+      record.character.should == 'One'
+    end
+  end
+
+end

data/spec/{unit → dbf}/table_spec.rb

@@ -1,67 +1,18 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "../spec_helper"))
+require "spec_helper"
 
-describe DBF::Table do
-  context "when initialized" do
-    before do
-      @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-    end
-
-    it "should load the data file" do
-      @table.data.should be_kind_of(File)
-    end
-
-    it "should load the memo file" do
-      @table.has_memo_file?.should be_true
-      @table.instance_eval("@memo").should be_kind_of(File)
-    end
-
-    it "should determine the memo file format" do
-      @table.memo_file_format.should == :dbt
-    end
-
-    it "should determine the correct memo block size" do
-      @table.memo_block_size.should == 512
-    end
-
-    it "should determine the number of columns in each record" do
-      @table.columns.size.should == 15
-    end
-
-    it "should determine the number of records in the database" do
-      @table.record_count.should == 67
-    end
-
-    it "should determine the database version" do
-      @table.version.should == "83"
-    end
-  end
-  
+describe DBF::Table do  
   context "when closed" do
     before do
       @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      @table.close
     end
     
     it "should close the data file" do
-      @table.close
-      lambda { @table.record(1) }.should raise_error(IOError)
-    end
-  end
-  
-  describe "#column" do
-    it "should accept a string or symbol as input" do
-      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      table.column(:IMAGE).should be_kind_of(DBF::Column)
-      table.column("IMAGE").should be_kind_of(DBF::Column)
+      @table.instance_eval { @data }.should be_closed
     end
     
-    it "should return a DBF::Field object when the column_name exists" do
-      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      table.column(:IMAGE).should be_kind_of(DBF::Column)
-    end
-  
-    it "should return nil when the column_name does not exist" do
-      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      table.column(:NOTANIMAGE).should be_nil
+    it "should close the memo file" do
+      @table.instance_eval { @memo }.instance_eval { @data }.should be_closed
     end
   end
   
@@ -74,33 +25,6 @@ describe DBF::Table do
     end
   end
   
-  describe "#version_description" do
-    it "should return a text description of the database type" do
-      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      table.version_description.should == "dBase III with memo file"
-    end
-  end
-  
-  describe '#replace_extname' do
-    it "should change the file extension" do
-      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      table.send(:replace_extname, 'dbase_83.dbf', 'fpt').should == 'dbase_83.fpt'
-    end
-  end
-  
-  describe '#to_a' do
-    before do
-      @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      
-      @records = []
-      @table.each {|record| @records << record}
-    end
-    
-    it 'should return an array of records' do
-      @table.to_a.should == @records
-    end
-  end
-  
   describe '#to_csv' do
     before do
       @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
@@ -115,22 +39,21 @@ describe DBF::Table do
       @table.to_csv
       File.exists?('dbase_83.csv').should be_true
     end
-    
-    it 'should create custom csv file' do
-      @table.to_csv('test.csv')
-      File.exists?('test.csv').should be_true
+
+    describe 'when path param passed' do
+      it 'should create custom csv file' do
+        @table.to_csv('test.csv')
+        File.exists?('test.csv').should be_true
+      end
     end
   end
   
   describe "#record" do
     before do
       @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-      
-      @records = []
-      @table.each {|record| @records << record}
     end
     
-    it "should nullify deleted records" do
+    it "return nil for deleted records" do
       @table.stub!(:deleted_record?).and_return(true)
       @table.record(5).should be_nil
     end
@@ -145,10 +68,6 @@ describe DBF::Table do
       @table.stub!(:deleted_record?).and_return(true)
       @table.record(0).should be_nil
     end
-    
-    it 'should return a DBF::Record' do
-      @table.record(0).should be_kind_of(DBF::Record)
-    end
   end
   
   describe "#find" do
@@ -175,9 +94,6 @@ describe DBF::Table do
     describe "with :all" do
       before do
         @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-        
-        @records = []
-        @table.each {|record| @records << record}
       end
       
       it "should accept a block" do
@@ -189,11 +105,11 @@ describe DBF::Table do
       end
 
       it "should return all records if options are empty" do
-        @table.find(:all).should == @records
+        @table.find(:all).should == @table.to_a
       end
 
       it "should return matching records when used with options" do
-        @table.find(:all, "WEIGHT" => 0.0).should == @records.select {|r| r.attributes["weight"] == 0.0}
+        @table.find(:all, "WEIGHT" => 0.0).should == @table.select {|r| r.attributes["weight"] == 0.0}
       end
 
       it "should AND multiple search terms" do
@@ -220,17 +136,14 @@ describe DBF::Table do
     describe "with :first" do
       before do
         @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
-        
-        @records = []
-        @table.each {|record| @records << record}
       end
 
       it "should return the first record if options are empty" do
-        @table.find(:first).should == @records.first
+        @table.find(:first).should == @table.first
       end
 
       it "should return the first matching record when used with options" do
-        @table.find(:first, "CODE" => "C").should == @records[5]
+        @table.find(:first, "CODE" => "C").should == @table.record(5)
       end
 
       it "should AND multiple search terms" do