dbf 3.1.1 → 3.1.2

data/lib/dbf/memo/dbase3.rb

@@ -1,7 +1,7 @@
 module DBF
   module Memo
     class Dbase3 < Base
-      def build_memo(start_block) # nodoc
+      def build_memo(start_block) # :nodoc:
         @data.seek offset(start_block)
         memo_string = ''
         loop do

data/lib/dbf/memo/dbase4.rb

@@ -1,7 +1,7 @@
 module DBF
   module Memo
     class Dbase4 < Base
-      def build_memo(start_block) # nodoc
+      def build_memo(start_block) # :nodoc:
         @data.seek offset(start_block)
         @data.read(@data.read(BLOCK_HEADER_SIZE).unpack('x4L').first)
       end

data/lib/dbf/memo/foxpro.rb

@@ -3,7 +3,7 @@ module DBF
     class Foxpro < Base
       FPT_HEADER_SIZE = 512
 
-      def build_memo(start_block) # nodoc
+      def build_memo(start_block) # :nodoc:
         @data.seek offset(start_block)
 
         memo_type, memo_size, memo_string = @data.read(block_size).unpack('NNa*')
@@ -22,7 +22,7 @@ module DBF
 
       private
 
-      def block_size # nodoc
+      def block_size # :nodoc:
         @block_size ||= begin
           @data.rewind
           @data.read(FPT_HEADER_SIZE).unpack('x6n').first || 0

data/lib/dbf/record.rb

@@ -49,15 +49,6 @@ module DBF
       options.all? { |key, value| self[key] == value }
     end
 
-    # Overrides standard Object.respond_to? to return true if a
-    # matching column name is found.
-    #
-    # @param [String, Symbol] method
-    # @return [Boolean]
-    def respond_to?(method, *args)
-      underscored_column_names.include?(method.to_s) || super
-    end
-
     # Maps a row to an array of values
     #
     # @return [Array]
@@ -67,15 +58,15 @@ module DBF
 
     private
 
-    def attribute_map # nodoc
+    def attribute_map # :nodoc:
       @columns.map { |column| [column.name, init_attribute(column)] }
     end
 
-    def get_data(column) # nodoc
+    def get_data(column) # :nodoc:
       @data.read(column.length)
     end
 
-    def get_memo(column) # nodoc
+    def get_memo(column) # :nodoc:
       if @memo
         @memo.get(memo_start_block(column))
       else
@@ -85,20 +76,18 @@ module DBF
       end
     end
 
-    def init_attribute(column) # nodoc
+    def init_attribute(column) # :nodoc:
       value = column.memo? ? get_memo(column) : get_data(column)
       column.type_cast(value)
     end
 
-    def memo_start_block(column) # nodoc
+    def memo_start_block(column) # :nodoc:
       data = get_data(column)
-      if %w(30 31).include?(@version)
-        data = data.unpack('V').first
-      end
+      data = data.unpack('V').first if %w[30 31].include?(@version)
       data.to_i
     end
 
-    def method_missing(method, *args) # nodoc
+    def method_missing(method, *args) # :nodoc:
       if (index = underscored_column_names.index(method.to_s))
         attributes[@columns[index].name]
       else
@@ -106,7 +95,11 @@ module DBF
       end
     end
 
-    def underscored_column_names # nodoc
+    def respond_to_missing?(method, *) # :nodoc:
+      underscored_column_names.include?(method.to_s) || super
+    end
+
+    def underscored_column_names # :nodoc:
       @underscored_column_names ||= @columns.map(&:underscored_name)
     end
   end

data/lib/dbf/schema.rb

@@ -1,6 +1,17 @@
 module DBF
   # The Schema module is mixin for the Table class
   module Schema
+    FORMATS = [:activerecord, :json, :sequel].freeze
+
+    OTHER_DATA_TYPES = {
+      'Y' => ':decimal, :precision => 15, :scale => 4',
+      'D' => ':date',
+      'T' => ':datetime',
+      'L' => ':boolean',
+      'M' => ':text',
+      'B' => ':binary'
+    }.freeze
+
     # Generate an ActiveRecord::Schema
     #
     # xBase data types are converted to generic types as follows:
@@ -24,15 +35,17 @@ module DBF
     # @param [Symbol] format Valid options are :activerecord and :json
     # @return [String]
     def schema(format = :activerecord, table_only = false)
-      supported_formats = [:activerecord, :json, :sequel]
-      if supported_formats.include?(format)
-        send("#{format}_schema", table_only)
-      else
-        raise ArgumentError
-      end
+      schema_method_name = schema_name(format)
+      send(schema_method_name, table_only)
+    rescue NameError
+      raise ArgumentError, ":#{format} is not a valid schema. Valid schemas are: #{FORMATS.join(', ')}."
+    end
+
+    def schema_name(format) # :nodoc:
+      "#{format}_schema"
     end
 
-    def activerecord_schema(_table_only = false) # nodoc
+    def activerecord_schema(_table_only = false) # :nodoc:
       s = "ActiveRecord::Schema.define do\n"
       s << "  create_table \"#{name}\" do |t|\n"
       columns.each do |column|
@@ -42,7 +55,7 @@ module DBF
       s
     end
 
-    def sequel_schema(table_only = false) # nodoc
+    def sequel_schema(table_only = false) # :nodoc:
       s = ''
       s << "Sequel.migration do\n" unless table_only
       s << "  change do\n " unless table_only
@@ -51,12 +64,12 @@ module DBF
         s << "      column #{sequel_schema_definition(column)}"
       end
       s << "    end\n"
-      s << "  end\n"  unless table_only
-      s << "end\n"  unless table_only
+      s << "  end\n" unless table_only
+      s << "end\n" unless table_only
       s
     end
 
-    def json_schema(_table_only = false) # nodoc
+    def json_schema(_table_only = false) # :nodoc:
       columns.map(&:to_hash).to_json
     end
 
@@ -76,30 +89,26 @@ module DBF
       ":#{column.underscored_name}, #{schema_data_type(column, :sequel)}\n"
     end
 
-    def schema_data_type(column, format = :activerecord) # nodoc
+    def schema_data_type(column, format = :activerecord) # :nodoc:
       case column.type
-      when 'N', 'F'
-        column.decimal > 0 ? ':float' : ':integer'
-      when 'I'
-        ':integer'
-      when 'Y'
-        ':decimal, :precision => 15, :scale => 4'
-      when 'D'
-        ':date'
-      when 'T'
-        ':datetime'
-      when 'L'
-        ':boolean'
-      when 'M'
-        ':text'
-      when 'B'
-        ':binary'
+      when *%w[N F I]
+        number_data_type(column)
+      when *%w[Y D T L M B]
+        OTHER_DATA_TYPES[column.type]
+      else
+        string_data_format(format, column)
+      end
+    end
+
+    def number_data_type(column)
+      column.decimal > 0 ? ':float' : ':integer'
+    end
+
+    def string_data_format(format, column)
+      if format == :sequel
+        ":varchar, :size => #{column.length}"
       else
-        if format == :sequel
-          ":varchar, :size => #{column.length}"
-        else
-          ":string, :limit => #{column.length}"
-        end
+        ":string, :limit => #{column.length}"
       end
     end
   end

data/lib/dbf/table.rb

@@ -28,14 +28,14 @@ module DBF
       '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
@@ -157,7 +157,7 @@ module DBF
 
     # @return [String]
     def name
-      @name ||= filename && File.basename(filename, ".*")
+      @name ||= filename && File.basename(filename, '.*')
     end
 
     # Retrieve a record by index number.
@@ -172,7 +172,7 @@ module DBF
       DBF::Record.new(@data.read(header.record_length), columns, version, @memo)
     end
 
-    alias_method :row, :record
+    alias row record
 
     # Total number of records
     #
@@ -208,30 +208,29 @@ module DBF
 
     private
 
-    def build_columns # nodoc
-      @data.seek(DBF_HEADER_SIZE)
-      columns = []
-      until end_of_record?
-        column_data = @data.read(DBF_HEADER_SIZE)
-        name, type, length, decimal = column_data.unpack('a10 x a x4 C2')
-        columns << Column.new(self, name, type, length, decimal)
+    def build_columns # :nodoc:
+      safe_seek do
+        @data.seek(DBF_HEADER_SIZE)
+        columns = []
+        until end_of_record?
+          column_data = @data.read(DBF_HEADER_SIZE)
+          name, type, length, decimal = column_data.unpack('a10 x a x4 C2')
+          columns << Column.new(self, name, type, length, decimal)
+        end
+        columns
       end
-      columns
     end
 
-    def deleted_record? # nodoc
+    def deleted_record? # :nodoc:
       flag = @data.read(1)
       flag ? flag.unpack('a') == ['*'] : true
     end
 
-    def end_of_record? # nodoc
-      original_pos = @data.pos
-      byte = @data.read(1)
-      @data.seek(original_pos)
-      byte.ord == 13
+    def end_of_record? # :nodoc:
+      safe_seek { @data.read(1).ord == 13 }
     end
 
-    def find_all(options) # nodoc
+    def find_all(options) # :nodoc:
       map do |record|
         if record && record.match?(options)
           yield record if block_given?
@@ -240,19 +239,22 @@ module DBF
       end.compact
     end
 
-    def find_first(options) # nodoc
+    def find_first(options) # :nodoc:
       detect { |record| record && record.match?(options) }
     end
 
-    def foxpro? # nodoc
+    def foxpro? # :nodoc:
       FOXPRO_VERSIONS.keys.include? version
     end
 
-    def header
-      @header ||= Header.new(@data.read DBF_HEADER_SIZE)
+    def header # :nodoc:
+      @header ||= safe_seek do
+        @data.seek(0)
+        Header.new(@data.read DBF_HEADER_SIZE)
+      end
     end
 
-    def memo_class # nodoc
+    def memo_class # :nodoc:
       @memo_class ||= begin
         if foxpro?
           Memo::Foxpro
@@ -262,33 +264,38 @@ module DBF
       end
     end
 
-    def memo_search_path(io) # nodoc
+    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
+    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
+    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 = Dir.glob(memo_search_path(data))
         files.any? ? memo_class.open(files.first, version) : nil
       end
     end
 
-    def seek(offset) # nodoc
+    def safe_seek # :nodoc:
+      original_pos = @data.pos
+      yield.tap { @data.seek(original_pos) }
+    end
+
+    def seek(offset) # :nodoc:
       @data.seek(header.header_length + offset)
     end
 
-    def seek_to_record(index) # nodoc
+    def seek_to_record(index) # :nodoc:
       seek(index * header.record_length)
     end
   end

data/lib/dbf/version.rb

@@ -1,3 +1,3 @@
 module DBF
-  VERSION = '3.1.1'
+  VERSION = '3.1.2'
 end

data/spec/dbf/column_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe DBF::Column do
-  let(:table) { DBF::Table.new fixture('dbase_30.dbf')}
+  let(:table) { DBF::Table.new fixture('dbase_30.dbf') }
 
   context 'when initialized' do
     let(:column) { DBF::Column.new table, 'ColumnName', 'N', 1, 0 }

data/spec/dbf/database_spec.rb

@@ -19,13 +19,13 @@ RSpec.describe DBF::Database::Foxpro do
 
     describe 'it loads the example db correctly' do
       it 'shows a correct list of tables' do
-        expect(db.table_names.sort).to eq(%w(contacts calls setup types).sort)
+        expect(db.table_names.sort).to eq(%w[contacts calls setup types].sort)
       end
     end
   end
 
   describe '#table' do
-    describe "when accessing related tables" do
+    describe 'when accessing related tables' do
       let(:db) { DBF::Database::Foxpro.new(dbf_path) }
 
       it 'loads an existing related table' do

data/spec/dbf/file_formats_spec.rb

@@ -1,167 +1,167 @@
-require "spec_helper"
+require 'spec_helper'
 
 RSpec.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 {@header.record_length}
-    sum_of_column_lengths = table.columns.inject(1) {|sum, column| sum += column.length}
+  specify 'sum of column lengths should equal record length specified in header plus one' do
+    header_record_length = table.instance_eval { @header.record_length }
+    sum_of_column_lengths = table.columns.inject(1) { |sum, column| sum += column.length }
 
     expect(header_record_length).to eq sum_of_column_lengths
   end
 
-  specify "records should be instances of DBF::Record" do
+  specify 'records should be instances of DBF::Record' do
     table.each do |record|
       expect(record).to be_kind_of(DBF::Record)
     end
   end
 
-  specify "record count should be the same as reported in the header" do
+  specify 'record count should be the same as reported in the header' do
     expect(table.entries.size).to eq table.record_count
   end
 
-  specify "column names should not be blank" do
+  specify 'column names should not be blank' do
     table.columns.each do |column|
       expect(column.name).not_to be_empty
     end
   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)
+  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.each do |column|
       expect(valid_column_types).to include(column.type)
     end
   end
 
-  specify "column lengths should be instances of Integer" do
+  specify 'column lengths should be instances of Integer' do
     table.columns.each do |column|
       expect(column.length).to be_kind_of(Integer)
     end
   end
 
-  specify "column lengths should be larger than 0" do
+  specify 'column lengths should be larger than 0' do
     table.columns.each do |column|
       expect(column.length).to be > 0
     end
   end
 
-  specify "column decimals should be instances of Integer" do
+  specify 'column decimals should be instances of Integer' do
     table.columns.each do |column|
       expect(column.decimal).to be_kind_of(Integer)
     end
   end
 end
 
-RSpec.describe DBF, "of type 03 (dBase III without memo file)" do
+RSpec.describe DBF, 'of type 03 (dBase III without memo file)' do
   let(:table) { DBF::Table.new fixture('dbase_03.dbf') }
 
-  it_should_behave_like "DBF"
+  it_should_behave_like 'DBF'
 
-  it "should report the correct version number" do
-    expect(table.version).to eq "03"
+  it 'should report the correct version number' do
+    expect(table.version).to eq '03'
   end
 
-  it "should report the correct version description" do
-    expect(table.version_description).to eq "dBase III without memo file"
+  it 'should report the correct version description' do
+    expect(table.version_description).to eq 'dBase III without memo file'
   end
 
-  it "should determine the number of records" do
+  it 'should determine the number of records' do
     expect(table.record_count).to eq 14
   end
 end
 
-RSpec.describe DBF, "of type 30 (Visual FoxPro)" do
+RSpec.describe DBF, 'of type 30 (Visual FoxPro)' do
   let(:table) { DBF::Table.new fixture('dbase_30.dbf') }
 
-  it_should_behave_like "DBF"
+  it_should_behave_like 'DBF'
 
-  it "should report the correct version number" do
-    expect(table.version).to eq "30"
+  it 'should report the correct version number' do
+    expect(table.version).to eq '30'
   end
 
-  it "should report the correct version description" do
-    expect(table.version_description).to eq "Visual FoxPro"
+  it 'should report the correct version description' do
+    expect(table.version_description).to eq 'Visual FoxPro'
   end
 
-  it "should determine the number of records" do
+  it 'should determine the number of records' do
     expect(table.record_count).to eq 34
   end
 
-  it "reads memo data" do
+  it 'reads memo data' do
     expect(table.record(3).classes).to match(/\AAgriculture.*Farming\r\n\Z/m)
   end
 end
 
-RSpec.describe DBF, "of type 31 (Visual FoxPro with AutoIncrement field)" do
+RSpec.describe DBF, 'of type 31 (Visual FoxPro with AutoIncrement field)' do
   let(:table) { DBF::Table.new fixture('dbase_31.dbf') }
 
-  it_should_behave_like "DBF"
+  it_should_behave_like 'DBF'
 
-  it "should have a dBase version of 31" do
-    expect(table.version).to eq "31"
+  it 'should have a dBase version of 31' do
+    expect(table.version).to eq '31'
   end
 
-  it "should report the correct version description" do
-    expect(table.version_description).to eq "Visual FoxPro with AutoIncrement field"
+  it 'should report the correct version description' do
+    expect(table.version_description).to eq 'Visual FoxPro with AutoIncrement field'
   end
 
-  it "should determine the number of records" do
+  it 'should determine the number of records' do
     expect(table.record_count).to eq 77
   end
 end
 
-RSpec.describe DBF, "of type 83 (dBase III with memo file)" do
+RSpec.describe DBF, 'of type 83 (dBase III with memo file)' do
   let(:table) { DBF::Table.new fixture('dbase_83.dbf') }
 
-  it_should_behave_like "DBF"
+  it_should_behave_like 'DBF'
 
-  it "should report the correct version number" do
-    expect(table.version).to eq "83"
+  it 'should report the correct version number' do
+    expect(table.version).to eq '83'
   end
 
-  it "should report the correct version description" do
-    expect(table.version_description).to eq "dBase III with memo file"
+  it 'should report the correct version description' do
+    expect(table.version_description).to eq 'dBase III with memo file'
   end
 
-  it "should determine the number of records" do
+  it 'should determine the number of records' do
     expect(table.record_count).to eq 67
   end
 end
 
-RSpec.describe DBF, "of type 8b (dBase IV with memo file)" do
+RSpec.describe DBF, 'of type 8b (dBase IV with memo file)' do
   let(:table) { DBF::Table.new fixture('dbase_8b.dbf') }
 
-  it_should_behave_like "DBF"
+  it_should_behave_like 'DBF'
 
-  it "should report the correct version number" do
-    expect(table.version).to eq "8b"
+  it 'should report the correct version number' do
+    expect(table.version).to eq '8b'
   end
 
-  it "should report the correct version description" do
-    expect(table.version_description).to eq "dBase IV with memo file"
+  it 'should report the correct version description' do
+    expect(table.version_description).to eq 'dBase IV with memo file'
   end
 
-  it "should determine the number of records" do
+  it 'should determine the number of records' do
     expect(table.record_count).to eq 10
   end
 end
 
-RSpec.describe DBF, "of type f5 (FoxPro with memo file)" do
+RSpec.describe DBF, 'of type f5 (FoxPro with memo file)' do
   let(:table) { DBF::Table.new fixture('dbase_f5.dbf') }
 
-  it_should_behave_like "DBF"
+  it_should_behave_like 'DBF'
 
-  it "should report the correct version number" do
-    expect(table.version).to eq "f5"
+  it 'should report the correct version number' do
+    expect(table.version).to eq 'f5'
   end
 
-  it "should report the correct version description" do
-    expect(table.version_description).to eq "FoxPro with memo file"
+  it 'should report the correct version description' do
+    expect(table.version_description).to eq 'FoxPro with memo file'
   end
 
-  it "should determine the number of records" do
+  it 'should determine the number of records' do
     expect(table.record_count).to eq 975
   end
 
-  it "reads memo data" do
+  it 'reads memo data' do
     expect(table.record(3).datn.to_s).to eq '1870-06-30'
   end
 end