dbf 5.1.1 → 5.3.0

data/lib/dbf/table.rb

@@ -13,42 +13,9 @@ module DBF
     extend Forwardable
     include Enumerable
     include ::DBF::Schema
+    include ::DBF::Find
 
-    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
+    attr_reader :encoding
 
     def_delegator :header, :header_length
     def_delegator :header, :record_count
@@ -76,10 +43,12 @@ module DBF
     # @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 || Encoding.default_external
-      @memo = open_memo(data, memo)
+    def initialize(data, memo = nil, encoding = nil, name: nil)
+      @data = FileHandler.open_data(data)
+      @user_encoding = encoding
+      @encoding = determine_encoding
+      @memo = FileHandler.open_memo(data, memo, version_config.memo_class, version)
+      @name = name
       yield self if block_given?
     end
 
@@ -93,11 +62,7 @@ module DBF
 
     # @return [TrueClass, FalseClass]
     def closed?
-      if @memo
-        @data.closed? && @memo.closed?
-      else
-        @data.closed?
-      end
+      @data.closed? && (!@memo || @memo.closed?)
     end
 
     # Column names
@@ -107,6 +72,20 @@ module DBF
       @column_names ||= columns.map(&:name)
     end
 
+    # Cumulative byte offsets for each column within a record
+    #
+    # @return [Array<Integer>]
+    def column_offsets
+      @column_offsets ||= begin
+        sum = 0
+        columns.map { |col| sum.tap { sum += col.length } }
+      end
+    end
+
+    def record_context
+      @record_context ||= RecordContext.new(columns:, version:, memo: @memo, column_offsets:)
+    end
+
     # All columns
     #
     # @return [Array]
@@ -118,53 +97,16 @@ module DBF
     # if the record has been marked as deleted.
     #
     # @yield [nil, DBF::Record]
-    def each
-      record_count.times { |i| yield record(i) }
+    def each(&)
+      return enum_for(:each) unless block_given?
+      return if columns.empty?
+
+      RecordIterator.new(@data, record_context, header_length, record_length, record_count).each(&)
     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
+      File.basename(@data.path) if @data.is_a?(File)
     end
 
     # @return [TrueClass, FalseClass]
@@ -190,7 +132,7 @@ module DBF
       return nil if deleted_record?
 
       record_data = @data.read(record_length)
-      DBF::Record.new(record_data, columns, version, @memo)
+      DBF::Record.new(record_data, record_context)
     end
 
     alias row record
@@ -198,10 +140,14 @@ module DBF
     # 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)
+    # @param [optional String, IO] path_or_io String path, IO-like object, or nil for STDOUT
+    def to_csv(path_or_io = nil)
+      io = case path_or_io
+      when nil then $stdout
+      when String then File.open(path_or_io, 'w')
+      else path_or_io
+      end
+      csv = CSV.new(io, force_quotes: true)
       csv << column_names
       each { |record| csv << record.to_a }
     end
@@ -210,7 +156,7 @@ module DBF
     #
     # @return [String]
     def version_description
-      VERSIONS[version]
+      version_config.version_description
     end
 
     # Encode string
@@ -218,7 +164,7 @@ module DBF
     # @param [String] string
     # @return [String]
     def encode_string(string) # :nodoc:
-      string.force_encoding(@encoding).encode(Encoding.default_external, undef: :replace, invalid: :replace)
+      Encoder.encode(string, @encoding)
     end
 
     # Encoding specified in the file header
@@ -230,104 +176,27 @@ module DBF
 
     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
+    def version_config
+      @version_config ||= VersionConfig.new(version)
     end
 
-    def header_size
-      case version
-      when '02'
-        DBASE2_HEADER_SIZE
-      when '04', '8c'
-        DBASE7_HEADER_SIZE
-      else 
-        DBASE3_HEADER_SIZE
-      end
+    def determine_encoding
+      @user_encoding || header.encoding || Encoding.default_external
     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) }
+    def build_columns # :nodoc:
+      ColumnBuilder.new(self, @data, version_config).build
     end
 
-    def foxpro? # :nodoc:
-      FOXPRO_VERSIONS.key?(version)
+    def deleted_record? # :nodoc:
+      flag = @data.read(1)
+      flag ? flag.getbyte(0) == 0x2A : true
     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:
-      case data
-      when StringIO
-        data
-      when String
-        File.open(data, 'rb')
-      else
-        raise ArgumentError, 'data must be a file path or StringIO object'
-      end
-    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
+        Header.new(@data.read(VersionConfig::DBASE3_HEADER_SIZE))
       end
     end
 

data/lib/dbf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DBF
-  VERSION = '5.1.1'.freeze
+  VERSION = '5.3.0'
 end

data/lib/dbf/version_config.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module DBF
+  class VersionConfig
+    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_reader :version
+
+    def initialize(version)
+      @version = version
+    end
+
+    def version_description
+      VERSIONS[version]
+    end
+
+    def header_size
+      case version
+      when '02'
+        DBASE2_HEADER_SIZE
+      when '04', '8c'
+        DBASE7_HEADER_SIZE
+      else
+        DBASE3_HEADER_SIZE
+      end
+    end
+
+    def foxpro?
+      FOXPRO_VERSIONS.key?(version)
+    end
+
+    def memo_class
+      if foxpro?
+        Memo::Foxpro
+      else
+        version == '83' ? Memo::Dbase3 : Memo::Dbase4
+      end
+    end
+
+    def read_column_args(table, io)
+      case version
+      when '02' then [table, *io.read(header_size * 2).unpack('A11 a C'), 0]
+      when '04', '8c' then [table, *io.read(48).unpack('A32 a C C x13')]
+      else [table, *io.read(header_size).unpack('A11 a x4 C2')]
+      end
+    end
+  end
+end

data/lib/dbf.rb

@@ -8,14 +8,22 @@ require 'time'
 
 require 'dbf/version'
 require 'dbf/schema'
+require 'dbf/find'
 require 'dbf/record'
+require 'dbf/record_context'
 require 'dbf/column_type'
 require 'dbf/column'
 require 'dbf/encodings'
+require 'dbf/encoder'
 require 'dbf/header'
+require 'dbf/version_config'
+require 'dbf/file_handler'
+require 'dbf/column_builder'
+require 'dbf/record_iterator'
 require 'dbf/table'
 require 'dbf/memo/base'
 require 'dbf/memo/dbase3'
 require 'dbf/memo/dbase4'
 require 'dbf/memo/foxpro'
 require 'dbf/database/foxpro'
+require 'dbf/cli'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbf
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.3.0
 platform: ruby
 authors:
 - Keith Morrison
@@ -29,10 +29,7 @@ email: keithm@infused.org
 executables:
 - dbf
 extensions: []
-extra_rdoc_files:
-- CHANGELOG.md
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
@@ -40,93 +37,49 @@ files:
 - bin/dbf
 - dbf.gemspec
 - lib/dbf.rb
+- lib/dbf/cli.rb
 - lib/dbf/column.rb
+- lib/dbf/column_builder.rb
 - lib/dbf/column_type.rb
 - lib/dbf/database/foxpro.rb
+- lib/dbf/encoder.rb
 - lib/dbf/encodings.rb
+- lib/dbf/file_handler.rb
+- lib/dbf/find.rb
 - lib/dbf/header.rb
 - lib/dbf/memo/base.rb
 - lib/dbf/memo/dbase3.rb
 - lib/dbf/memo/dbase4.rb
 - lib/dbf/memo/foxpro.rb
 - lib/dbf/record.rb
+- lib/dbf/record_context.rb
+- lib/dbf/record_iterator.rb
 - lib/dbf/schema.rb
 - lib/dbf/table.rb
 - lib/dbf/version.rb
-- spec/dbf/column_spec.rb
-- spec/dbf/database/foxpro_spec.rb
-- spec/dbf/encoding_spec.rb
-- spec/dbf/file_formats_spec.rb
-- spec/dbf/record_spec.rb
-- spec/dbf/table_spec.rb
-- spec/fixtures/cp1251.dbf
-- spec/fixtures/cp1251_summary.txt
-- spec/fixtures/dbase_02.dbf
-- spec/fixtures/dbase_02_summary.txt
-- spec/fixtures/dbase_03.dbf
-- spec/fixtures/dbase_03_cyrillic.dbf
-- spec/fixtures/dbase_03_cyrillic_summary.txt
-- spec/fixtures/dbase_03_summary.txt
-- spec/fixtures/dbase_30.dbf
-- spec/fixtures/dbase_30.fpt
-- spec/fixtures/dbase_30_summary.txt
-- spec/fixtures/dbase_31.dbf
-- spec/fixtures/dbase_31_summary.txt
-- spec/fixtures/dbase_32.dbf
-- spec/fixtures/dbase_32_summary.txt
-- spec/fixtures/dbase_83.dbf
-- spec/fixtures/dbase_83.dbt
-- spec/fixtures/dbase_83_missing_memo.dbf
-- spec/fixtures/dbase_83_missing_memo_record_0.yml
-- spec/fixtures/dbase_83_record_0.yml
-- spec/fixtures/dbase_83_record_9.yml
-- spec/fixtures/dbase_83_schema_ar.txt
-- spec/fixtures/dbase_83_schema_sq.txt
-- spec/fixtures/dbase_83_schema_sq_lim.txt
-- spec/fixtures/dbase_83_summary.txt
-- spec/fixtures/dbase_8b.dbf
-- spec/fixtures/dbase_8b.dbt
-- spec/fixtures/dbase_8b_summary.txt
-- spec/fixtures/dbase_8c.dbf
-- spec/fixtures/dbase_f5.dbf
-- spec/fixtures/dbase_f5.fpt
-- spec/fixtures/dbase_f5_summary.txt
-- spec/fixtures/foxprodb/FOXPRO-DB-TEST.DBC
-- spec/fixtures/foxprodb/FOXPRO-DB-TEST.DCT
-- spec/fixtures/foxprodb/FOXPRO-DB-TEST.DCX
-- spec/fixtures/foxprodb/calls.CDX
-- spec/fixtures/foxprodb/calls.FPT
-- spec/fixtures/foxprodb/calls.dbf
-- spec/fixtures/foxprodb/contacts.CDX
-- spec/fixtures/foxprodb/contacts.FPT
-- spec/fixtures/foxprodb/contacts.dbf
-- spec/fixtures/foxprodb/setup.CDX
-- spec/fixtures/foxprodb/setup.dbf
-- spec/fixtures/foxprodb/types.CDX
-- spec/fixtures/foxprodb/types.dbf
-- spec/fixtures/polygon.dbf
-- spec/spec_helper.rb
-homepage: http://github.com/infused/dbf
+- lib/dbf/version_config.rb
+homepage: https://github.com/infused/dbf
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-rdoc_options:
-- "--charset=UTF-8"
+  source_code_uri: https://github.com/infused/dbf
+  changelog_uri: https://github.com/infused/dbf/blob/main/CHANGELOG.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.3
+      version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Read xBase files
 test_files: []