dbf 0.5.4 → 1.0.0

data/spec/functional/dbf_shared.rb

@@ -1,38 +1,47 @@
 describe DBF, :shared => true do
-  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}
+  specify "sum of column lengths should equal record length specified in header" do
+    header_record_length = @table.instance_eval {@record_length}
+    sum_of_column_lengths = @table.columns.inject(1) {|sum, column| sum + column.length}
     
-    header_record_length.should == sum_of_field_lengths
+    header_record_length.should == sum_of_column_lengths
   end
 
   specify "records should be instances of DBF::Record" do
-    @reader.records.all? {|record| record.should be_an_instance_of(DBF::Record)}
+    @table.records.all? {|record| record.should be_an_instance_of(DBF::Record)}
   end
   
-  specify "fields should be instances of DBF::Field" do
-    @reader.fields.all? {|field| field.should be_an_instance_of(DBF::Field)}
+  specify "columns should be instances of DBF::Column" do
+    @table.columns.all? {|column| column.should be_an_instance_of(DBF::Column)}
   end
   
-  specify "field names should not be blank" do
-    @reader.fields.all? {|field| field.name.should_not be_empty}
+  specify "column names should not be blank" do
+    @table.columns.all? {|column| column.name.should_not be_empty}
   end
   
-  specify "field types should be valid" do
-    valid_field_types = %w(C N L D M F B G P Y T I V X @ O +)
-    @reader.fields.all? {|field| valid_field_types.should include(field.type)}
+  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 +)
+    @table.columns.all? {|column| valid_column_types.should include(column.type)}
   end
   
-  specify "field lengths should be instances of Fixnum" do
-    @reader.fields.all? {|field| field.length.should be_an_instance_of(Fixnum)}
+  specify "column lengths should be instances of Fixnum" do
+    @table.columns.all? {|column| column.length.should be_an_instance_of(Fixnum)}
   end
   
-  specify "field lengths should be larger than 0" do
-    @reader.fields.all? {|field| field.length.should > 0}
+  specify "column lengths should be larger than 0" do
+    @table.columns.all? {|column| column.length.should > 0}
   end
   
-  specify "field decimals should be instances of Fixnum" do
-    @reader.fields.all? {|field| field.decimal.should be_an_instance_of(Fixnum)}
+  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
+    if @table.options[:accessors]
+      @table.columns do |column|
+        record = table.records.first
+        record.send(column.name).should == record[column.name]
+      end
+    end
   end
   
 end

data/spec/functional/format_03_spec.rb

@@ -3,21 +3,21 @@ require File.dirname(__FILE__) + "/dbf_shared"
 
 describe DBF, "of type 03 (dBase III without memo file)" do
   before(:each) do
-    @reader = DBF::Reader.new "#{DB_PATH}/dbase_03.dbf"
+    @table = DBF::Table.new "#{DB_PATH}/dbase_03.dbf"
   end
   
   it_should_behave_like "DBF"
   
   it "should report the correct version number" do
-    @reader.version.should == "03"
+    @table.version.should == "03"
   end
   
   it "should have a memo file" do
-    @reader.should_not have_memo_file
+    @table.should_not have_memo_file
   end
   
   it "should report the correct memo type" do
-    @reader.memo_file_format.should be_nil
+    @table.memo_file_format.should be_nil
   end
   
 end

data/spec/functional/format_30_spec.rb

@@ -3,21 +3,21 @@ require File.dirname(__FILE__) + "/dbf_shared"
 
 describe DBF, "of type 30 (Visual FoxPro)" do
   before(:each) do
-    @reader = DBF::Reader.new "#{DB_PATH}/dbase_30.dbf"
+    @table = DBF::Table.new "#{DB_PATH}/dbase_30.dbf"
   end
   
   it_should_behave_like "DBF"
   
   it "should report the correct version number" do
-    @reader.version.should == "30"
+    @table.version.should == "30"
   end
   
   it "should have a memo file" do
-    @reader.should have_memo_file
+    @table.should have_memo_file
   end
   
   it "should report the correct memo type" do
-    @reader.memo_file_format.should == :fpt
+    @table.memo_file_format.should == :fpt
   end
   
 end

data/spec/functional/format_83_spec.rb

@@ -3,21 +3,21 @@ require File.dirname(__FILE__) + "/dbf_shared"
 
 describe DBF, "of type 83 (dBase III with memo file)" do
   before(:each) do
-    @reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf"
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
   end
   
   it_should_behave_like "DBF"
   
   it "should report the correct version number" do
-    @reader.version.should == "83"
+    @table.version.should == "83"
   end
   
   it "should have a memo file" do
-    @reader.should have_memo_file
+    @table.should have_memo_file
   end
   
   it "should report the correct memo type" do
-    @reader.memo_file_format.should == :dbt
+    @table.memo_file_format.should == :dbt
   end
   
 end

data/spec/functional/format_8b_spec.rb

@@ -3,21 +3,21 @@ require File.dirname(__FILE__) + "/dbf_shared"
 
 describe DBF, "of type 8b (dBase IV with memo file)" do
   before(:each) do
-    @reader = DBF::Reader.new "#{DB_PATH}/dbase_8b.dbf"
+    @table = DBF::Table.new "#{DB_PATH}/dbase_8b.dbf"
   end
   
   it_should_behave_like "DBF"
   
   it "should report the correct version number" do
-    @reader.version.should == "8b"
+    @table.version.should == "8b"
   end
   
   it "should have a memo file" do
-    @reader.should have_memo_file
+    @table.should have_memo_file
   end
   
   it "should report the correct memo type" do
-    @reader.memo_file_format.should == :dbt
+    @table.memo_file_format.should == :dbt
   end
   
 end

data/spec/functional/format_f5_spec.rb

@@ -3,21 +3,21 @@ require File.dirname(__FILE__) + "/dbf_shared"
 
 describe DBF, "of type f5 (FoxPro with memo file)" do
   before(:each) do
-    @reader = DBF::Reader.new "#{DB_PATH}/dbase_f5.dbf"
+    @table = DBF::Table.new "#{DB_PATH}/dbase_f5.dbf"
   end
   
   it_should_behave_like "DBF"
   
   it "should report the correct version number" do
-    @reader.version.should == "f5"
+    @table.version.should == "f5"
   end
   
   it "should have a memo file" do
-    @reader.should have_memo_file
+    @table.should have_memo_file
   end
   
   it "should report the correct memo type" do
-    @reader.memo_file_format.should == :fpt
+    @table.memo_file_format.should == :fpt
   end
   
 end

data/spec/unit/column_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe DBF::Column, "when initialized" do
+  
+  before(:each) do
+    @column = DBF::Column.new "ColumnName", "N", 1, 0
+  end
+  
+  it "should set the #name accessor" do
+    @column.name.should == "ColumnName"
+  end
+  
+  it "should set the #type accessor" do
+    @column.type.should == "N"
+  end
+  
+  it "should set the #length accessor" do
+    @column.length.should == 1
+  end
+  
+  it "should set the #decimal accessor" do
+    @column.decimal.should == 0
+  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)
+  end
+  
+  it "should strip null characters from the name" do
+    column = DBF::Column.new "Column\0Name\0", "N", 1, 0
+    column.name.should == "ColumnName"
+  end
+  
+end

data/spec/unit/record_spec.rb

@@ -2,30 +2,30 @@ require File.dirname(__FILE__) + "/../spec_helper"
 
 describe DBF::Record, "when initialized" do
 
-  it "should typecast number fields with decimals == 0 to Integer" do
-    reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf"
-    reader.field("ID").type.should == "N"
-    reader.field("ID").decimal.should == 0
-    reader.records.all? {|record| record["ID"].should be_kind_of(Integer)}
+  it "should typecast number columns with decimals == 0 to Integer" do
+    table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+    table.column("ID").type.should == "N"
+    table.column("ID").decimal.should == 0
+    table.records.all? {|record| record.attributes['ID'].should be_kind_of(Integer)}
   end
   
-  it "should typecast number fields with decimals > 0 to Float" do
-    reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf"
-    reader.field("ID").type.should == "N"
-    reader.field("COST").decimal.should == 2
-    reader.records.all? {|record| record["COST"].should be_kind_of(Float)}
+  it "should typecast number columns with decimals > 0 to Float" do
+    table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+    table.column("ID").type.should == "N"
+    table.column("COST").decimal.should == 2
+    table.records.all? {|record| record.attributes['COST'].should be_kind_of(Float)}
   end
   
-  it "should typecast memo fields to String" do
-    reader = DBF::Reader.new "#{DB_PATH}/dbase_83.dbf"
-    reader.field("DESC").type.should == "M"
-    reader.records.all? {|record| record["DESC"].should be_kind_of(String)}
+  it "should typecast memo columns to String" do
+    table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+    table.column("DESC").type.should == "M"
+    table.records.all? {|record| record.attributes['DESC'].should be_kind_of(String)}
   end
   
-  it "should typecast logical fields to True or False" do
-    reader = DBF::Reader.new "#{DB_PATH}/dbase_30.dbf"
-    reader.field("WEBINCLUDE").type.should == "L"
-    reader.records.all? {|record| record["WEBINCLUDE"].should satisfy {|v| v == true || v == false}}
+  it "should typecast logical columns to True or False" do
+    table = DBF::Table.new "#{DB_PATH}/dbase_30.dbf"
+    table.column("WEBINCLUDE").type.should == "L"
+    table.records.all? {|record| record.attributes["WEBINCLUDE"].should satisfy {|v| v == true || v == false}}
   end
 
 end

data/spec/unit/table_spec.rb

@@ -0,0 +1,168 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe DBF::Table, "when initialized" do
+  
+  before(:all) 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 locate 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 memo block size" do
+    @table.memo_block_size.should == 512
+  end
+  
+  it "should default to loading all records into memory" do
+    @table.options[:in_memory].should be_true
+  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
+  
+  it "should set the in_memory option" do
+    table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf", :in_memory => false
+    table.options[:in_memory].should be_false
+  end
+  
+end
+
+describe DBF::Table, "when the in_memory flag is true" do
+  
+  before(:each) do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+  end
+  
+  it "should build the records array from disk only on the first request" do
+    @table.expects(:get_all_records_from_file).at_most_once.returns([])
+    3.times { @table.records }
+  end
+  
+  it "should read from the records array when using the record() method" do
+    @table.expects(:get_all_records_from_file).at_most_once.returns([])
+    @table.expects(:get_record_from_file).never
+    @table.expects(:records).times(2).returns([])
+    @table.record(1)
+    @table.record(10)
+  end
+  
+end
+
+describe DBF::Table, "when the in_memory flag is false" do
+  
+  it "should read the records from disk on every request" do
+    table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf", :in_memory => false
+    table.expects(:get_all_records_from_file).times(3).returns([])
+    3.times { table.records }
+  end
+end
+
+describe DBF::Table, "schema" do
+  
+  it "should match test schema " do
+    table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+    control_schema = File.read(File.dirname(__FILE__) + '/../fixtures/dbase_83_schema.txt')
+    
+    table.schema.should == control_schema
+  end
+  
+end
+
+describe DBF::Table, "find(index)" do
+  
+  before(:all) do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+  end
+  
+  it "should return the correct record" do
+    @table.find(5).should == @table.record(5)
+  end
+  
+end
+
+describe DBF::Table, "find(:all)" do
+  
+  before(:all) do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+  end
+  
+  it "should return all records if options are empty" do
+    @table.find(:all).should == @table.records
+  end
+  
+  it "should return matching records when used with options" do
+    @table.find(:all, "WEIGHT" => 0.0).should == @table.records.select {|r| r.attributes["WEIGHT"] == 0.0}
+  end
+  
+  it "with multiple options should search for all search terms as if using AND" do
+    @table.find(:all, "ID" => 30, "IMAGE" => "graphics/00000001/TBC01.jpg").should == []
+  end
+end
+
+describe DBF::Table, "find(:first)" do
+  
+  before(:all) do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+  end
+  
+  it "should return the first record if options are empty" do
+    @table.find(:first).should == @table.records.first
+  end
+  
+  it "should return the first matching record when used with options" do
+    @table.find(:first, "CODE" => "C").should == @table.record(5)
+  end
+  
+  it "with multiple options should search for all search terms as if using AND" do
+    @table.find(:first, "ID" => 30, "IMAGE" => "graphics/00000001/TBC01.jpg").should be_nil
+  end
+end
+
+describe DBF::Table do
+  
+  before(:each) do
+    @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+  end
+  
+  it "should reload all data when sent #reload!" do
+    @table.records
+    @table.instance_eval("@records").should be_kind_of(Array)
+    @table.reload!
+    @table.instance_eval("@records").should be_nil
+  end
+  
+  it "should return a DBF::Field object when sent #column with a valid column_name given as a string or symbol" do
+    @table.column("IMAGE").should be_kind_of(DBF::Column)
+    @table.column(:IMAGE).should be_kind_of(DBF::Column)
+  end
+  
+  it "should return nil when sent #column with an invalid column_name given as a string or symbol" do
+    @table.column("NOTANIMAGE").should be_nil
+    @table.column(:NOTANIMAGE).should be_nil
+  end
+  
+  it "should return a text description of the database type when sent #version_description" do
+    @table.version_description.should == "dBase III with memo file"
+  end
+
+end
+