Class: DBF::Table

Inherits:
Object
  • Object
show all
Includes:
Schema, Enumerable
Defined in:
lib/dbf/table.rb

Overview

DBF::Table is the primary interface to a single DBF file and provides methods for enumerating and searching the records.

Direct Known Subclasses

Database::Table

Constant Summary collapse

DBF_HEADER_SIZE = 
32
VERSIONS = 
{
  '02' => 'FoxBase',
  '03' => 'dBase III without memo file',
  '04' => 'dBase IV without memo file',
  '05' => 'dBase V without memo file',
  '07' => 'Visual Objects 1.x',
  '30' => 'Visual FoxPro',
  '31' => 'Visual FoxPro with AutoIncrement field',
  '43' => 'dBASE IV SQL table files, no memo',
  '63' => 'dBASE IV SQL system files, no memo',
  '7b' => 'dBase IV with memo file',
  '83' => 'dBase III with memo file',
  '87' => 'Visual Objects 1.x with memo file',
  '8b' => 'dBase IV with memo file',
  '8e' => 'dBase IV with SQL table',
  'cb' => 'dBASE IV SQL table files, with memo',
  'f5' => 'FoxPro with memo file',
  'fb' => 'FoxPro without memo file'
}
FOXPRO_VERSIONS = 
{
  '30' => 'Visual FoxPro',
  '31' => 'Visual FoxPro with AutoIncrement field',
  'f5' => 'FoxPro with memo file',
  'fb' => 'FoxPro without memo file'
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Schema

#activerecord_schema, #json_schema, #schema, #sequel_schema

Constructor Details

#initialize(data, memo = nil, encoding = nil) ⇒ Table

Opens a DBF::Table Examples:

# working with a file stored on the filesystem
table = DBF::Table.new 'data.dbf'

# working with a misnamed memo file
table = DBF::Table.new 'data.dbf', 'memo.dbt'

# working with a dbf in memory
table = DBF::Table.new StringIO.new(dbf_data)

# working with a dbf and memo in memory
table = DBF::Table.new StringIO.new(dbf_data), StringIO.new(memo_data)

# working with a dbf overriding specified in the dbf encoding
table = DBF::Table.new 'data.dbf', nil, 'cp437'
table = DBF::Table.new 'data.dbf', 'memo.dbt', Encoding::US_ASCII

Parameters:

  • data (String, StringIO) —

    Path to the dbf file or a StringIO object

  • memo (optional String, StringIO) (defaults to: nil) —

    Path to the memo file or a StringIO object

  • encoding (optional String, Encoding) (defaults to: nil) —

    Name of the encoding or an Encoding object



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/dbf/table.rb', line 65

def initialize(data, memo = nil, encoding = nil)
  @data = open_data(data)
  @data.rewind
  @header = Header.new(@data.read DBF_HEADER_SIZE)
  @encoding = encoding || header.encoding
  @memo = open_memo(data, memo)
  yield self if block_given?
rescue Errno::ENOENT
  raise DBF::FileNotFoundError, "file not found: #{data}"
end

Instance Attribute Details

#encoding ⇒ Object

Returns the value of attribute encoding.



41
42
43
 
# File 'lib/dbf/table.rb', line 41

def encoding
  @encoding
end

#header ⇒ Object (readonly)

Returns the value of attribute header.



40
41
42
 
# File 'lib/dbf/table.rb', line 40

def header
  @header
end

#name ⇒ Object

Returns String.

Returns:

  • String



104
105
106
 
# File 'lib/dbf/table.rb', line 104

def name
  @name ||= filename && File.basename(filename, ".*")
end

Instance Method Details

#close ⇒ TrueClass, FalseClass

Closes the table and memo file

Returns:

  • (TrueClass, FalseClass) 


84
85
86
87
 
# File 'lib/dbf/table.rb', line 84

def close
  @data.close
  @memo && @memo.close
end

#closed? ⇒ TrueClass, FalseClass

Returns:

  • (TrueClass, FalseClass) 


90
91
92
93
94
95
96
 
# File 'lib/dbf/table.rb', line 90

def closed?
  if @memo
    @data.closed? && @memo.closed?
  else
    @data.closed?
  end
end

#column_names ⇒ String

Column names

Returns:

  • (String) 


210
211
212
 
# File 'lib/dbf/table.rb', line 210

def column_names
  columns.map(&:name)
end

#columns ⇒ Array

All columns

Returns:

  • (Array) 


203
204
205
 
# File 'lib/dbf/table.rb', line 203

def columns
  @columns ||= build_columns
end

#each {|nil, DBF::Record| ... } ⇒ Object

Calls block once for each record in the table. The record may be nil if the record has been marked as deleted.

Yields:



112
113
114
 
# File 'lib/dbf/table.rb', line 112

def each
  header.record_count.times { |i| yield record(i) }
end

#filename ⇒ Object

Returns String.

Returns:

  • String



99
100
101
 
# File 'lib/dbf/table.rb', line 99

def filename
  File.basename @data.path if @data.respond_to?(:path)
end

#find(command, options = {}) {|optional, DBF::Record, NilClass| ... } ⇒ Object

Find records using a simple ActiveRecord-like syntax.

Examples:

table = DBF::Table.new 'mydata.dbf'

# Find record number 5
table.find(5)

# Find all records for Keith Morrison
table.find :all, first_name: "Keith", last_name: "Morrison"

# Find first record
table.find :first, first_name: "Keith"

The command may be a record index, :all, or :first. options is optional and, if specified, should be a hash where the keys correspond to column names in the database. The values will be matched exactly with the value in the database. If you specify more than one key, all values must match in order for the record to be returned. The equivalent SQL would be “WHERE key1 = ‘value1’ AND key2 = ‘value2’”.

Parameters:

  • command (Fixnum, Symbol)
  • options (optional, Hash) (defaults to: {}) —

    Hash of search parameters

Yields:



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/dbf/table.rb', line 187

def find(command, options = {}, &block)
  case command
  when Fixnum
    record(command)
  when Array
    command.map { |i| record(i) }
  when :all
    find_all(options, &block)
  when :first
    find_first(options)
  end
end

#has_memo_file? ⇒ TrueClass, FalseClass

Returns:

  • (TrueClass, FalseClass) 


77
78
79
 
# File 'lib/dbf/table.rb', line 77

def has_memo_file?
  !!@memo
end

#record(index) ⇒ DBF::Record, NilClass Also known as: row

Retrieve a record by index number. The record will be nil if it has been deleted, but not yet pruned from the database.

Parameters:

  • index (Fixnum)

Returns:



122
123
124
125
126
 
# File 'lib/dbf/table.rb', line 122

def record(index)
  seek_to_record(index)
  return nil if deleted_record?
  DBF::Record.new(@data.read(header.record_length), columns, version, @memo)
end

#record_count ⇒ Fixnum

Total number of records

Returns:

  • (Fixnum) 


140
141
142
 
# File 'lib/dbf/table.rb', line 140

def record_count
  @record_count ||= header.record_count
end

#to_csv(path = nil) ⇒ Object

Dumps all records to a CSV file. If no filename is given then CSV is output to STDOUT.

Parameters:

  • path (optional String) (defaults to: nil) —

    Defaults to STDOUT



155
156
157
158
159
160
 
# File 'lib/dbf/table.rb', line 155

def to_csv(path = nil)
  out_io = path ? File.open(path, 'w') : $stdout
  csv = CSV.new(out_io, force_quotes: true)
  csv << column_names
  each { |record| csv << record.to_a }
end

#version ⇒ String

Internal dBase version number

Returns:

  • (String) 


133
134
135
 
# File 'lib/dbf/table.rb', line 133

def version
  @version ||= header.version
end

#version_description ⇒ String

Human readable version description

Returns:

  • (String) 


147
148
149
 
# File 'lib/dbf/table.rb', line 147

def version_description
  VERSIONS[version]
end