1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
|
module DBF
class FileNotFoundError < StandardError
end
class NoColumnsDefined < StandardError
end
# DBF::Table is the primary interface to a single DBF file and provides
# methods for enumerating and searching the records.
class Table
extend Forwardable
include Enumerable
include ::DBF::Schema
DBASE2_HEADER_SIZE = 8
DBASE3_HEADER_SIZE = 32
DBASE7_HEADER_SIZE = 68
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',
'32' => 'Visual FoxPro with field type Varchar or Varbinary',
'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',
'8c' => 'dBase 7',
'8e' => 'dBase IV with SQL table',
'cb' => 'dBASE IV SQL table files, with memo',
'f5' => 'FoxPro with memo file',
'fb' => 'FoxPro without memo file'
}.freeze
FOXPRO_VERSIONS = {
'30' => 'Visual FoxPro',
'31' => 'Visual FoxPro with AutoIncrement field',
'f5' => 'FoxPro with memo file',
'fb' => 'FoxPro without memo file'
}.freeze
attr_accessor :encoding
attr_writer :name
def_delegator :header, :header_length
def_delegator :header, :record_count
def_delegator :header, :record_length
def_delegator :header, :version
# 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
#
# @param data [String, StringIO] data Path to the dbf file or a StringIO object
# @param memo [optional String, StringIO] memo Path to the memo file or a StringIO object
# @param encoding [optional String, Encoding] encoding Name of the encoding or an Encoding object
def initialize(data, memo = nil, encoding = nil)
@data = open_data(data)
@encoding = encoding || header.encoding
@memo = open_memo(data, memo)
yield self if block_given?
end
# Closes the table and memo file
#
# @return [TrueClass, FalseClass]
def close
@data.close
@memo&.close
end
# @return [TrueClass, FalseClass]
def closed?
if @memo
@data.closed? && @memo.closed?
else
@data.closed?
end
end
# Column names
#
# @return [String]
def column_names
@column_names ||= columns.map(&:name)
end
# All columns
#
# @return [Array]
def columns
@columns ||= build_columns
end
# Calls block once for each record in the table. The record may be nil
# if the record has been marked as deleted.
#
# @yield [nil, DBF::Record]
def each
record_count.times { |i| yield record(i) }
end
# @return [String]
def filename
return unless @data.respond_to?(:path)
File.basename(@data.path)
end
# 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 <b>command</b> may be a record index, :all, or :first.
# <b>options</b> 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'".
#
# @param command [Integer, Symbol] command
# @param options [optional, Hash] options Hash of search parameters
# @yield [optional, DBF::Record, NilClass]
def find(command, options = {}, &block)
case command
when Integer
record(command)
when Array
command.map { |i| record(i) }
when :all
find_all(options, &block)
when :first
find_first(options)
end
end
# @return [TrueClass, FalseClass]
def has_memo_file?
!!@memo
end
# @return [String]
def name
@name ||= filename && File.basename(filename, '.*')
end
# Retrieve a record by index number.
# The record will be nil if it has been deleted, but not yet pruned from
# the database.
#
# @param [Integer] index
# @return [DBF::Record, NilClass]
def record(index)
raise DBF::NoColumnsDefined, 'The DBF file has no columns defined' if columns.empty?
seek_to_record(index)
return nil if deleted_record?
record_data = @data.read(record_length)
DBF::Record.new(record_data, columns, version, @memo)
end
alias row record
# Dumps all records to a CSV file. If no filename is given then CSV is
# output to STDOUT.
#
# @param [optional String] path Defaults to STDOUT
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
# Human readable version description
#
# @return [String]
def version_description
VERSIONS[version]
end
private
def build_columns # :nodoc:
safe_seek do
@data.seek(header_size)
[].tap do |columns|
until end_of_record?
args = case version
when '02'
[self, *@data.read(header_size * 2).unpack('A11 a C'), 0]
when '04', '8c'
[self, *@data.read(48).unpack('A32 a C C x13')]
else
[self, *@data.read(header_size).unpack('A11 a x4 C2')]
end
columns << Column.new(*args)
end
end
end
end
def header_size
case version
when '02'
DBASE2_HEADER_SIZE
when '04', '8c'
DBASE7_HEADER_SIZE
else
DBASE3_HEADER_SIZE
end
end
def deleted_record? # :nodoc:
flag = @data.read(1)
flag ? flag.unpack1('a') == '*' : true
end
def end_of_record? # :nodoc:
safe_seek { @data.read(1).ord == 13 }
end
def find_all(options) # :nodoc:
select do |record|
next unless record&.match?(options)
yield record if block_given?
record
end
end
def find_first(options) # :nodoc:
detect { |record| record&.match?(options) }
end
def foxpro? # :nodoc:
FOXPRO_VERSIONS.key?(version)
end
def header # :nodoc:
@header ||= safe_seek do
@data.seek(0)
Header.new(@data.read(DBASE3_HEADER_SIZE))
end
end
def memo_class # :nodoc:
@memo_class ||= if foxpro?
Memo::Foxpro
else
version == '83' ? Memo::Dbase3 : Memo::Dbase4
end
end
def memo_search_path(io) # :nodoc:
dirname = File.dirname(io)
basename = File.basename(io, '.*')
"#{dirname}/#{basename}*.{fpt,FPT,dbt,DBT}"
end
def open_data(data) # :nodoc:
data.is_a?(StringIO) ? data : File.open(data, 'rb')
rescue Errno::ENOENT
raise DBF::FileNotFoundError, "file not found: #{data}"
end
def open_memo(data, memo = nil) # :nodoc:
if memo
meth = memo.is_a?(StringIO) ? :new : :open
memo_class.send(meth, memo, version)
elsif !data.is_a?(StringIO)
files = Dir.glob(memo_search_path(data))
files.any? ? memo_class.open(files.first, version) : nil
end
end
def safe_seek # :nodoc:
original_pos = @data.pos
yield.tap { @data.seek(original_pos) }
end
def seek(offset) # :nodoc:
@data.seek(header_length + offset)
end
def seek_to_record(index) # :nodoc:
seek(index * record_length)
end
end
end
|