ruby-adt 0.5.0

data/README.markdown

@@ -0,0 +1,123 @@
+# NOTICE
+This is an early version and I don't expect it to work in all cases.
+
+Currently, the biggest item that I am working on is getting dates extracted correctly.
+
+If you have suggestions or an .adt file that has issues being read then let me know and I might be able to work on it.
+
+# Ruby-ADT
+
+Ruby ADT is a small fast library for reading Advantage Database Server database files (.ADT)
+
+* Project page: <http://github.com/chasemgray/Ruby-ADT>
+* Report bugs: <http://github.com/chasemgray/Ruby-ADT/issues>
+* Questions: Email <mailto:chase@ratchetsoftware.com> and put ADT somewhere in the subject line
+
+## Installation
+  
+    gem install ruby-adt
+  
+## Basic Usage
+
+Load an ADT file:
+
+    require 'rubygems'
+    require 'ruby-adt'
+
+    table = ADT::Table.new("test.adt")
+
+Enumerate all records
+
+    table.each do |record|
+      puts record.name
+      puts record.email
+    end
+    
+Load a single record using <tt>record</tt> or <tt>find</tt>
+
+    table.record(6)
+    table.find(6)
+
+Attributes can also be accessed through the attributes hash in original or
+underscored form or as an accessor method using the underscored name.
+
+    table.record(4).attributes["PhoneBook"]
+    table.record(4).attributes["phone_book"]
+    table.record(4).phone_book
+  
+Search for records using a simple hash format.  Multiple search criteria are
+ANDed. Use the block form of find if the resulting recordset could be large
+otherwise all records will be loaded into memory.
+    
+    # find all records with first_name equal to Keith
+    table.find(:all, :first_name => 'Keith') do |record|
+      puts record.last_name
+    end
+    
+    # find all records with first_name equal to Keith and last_name equal
+    # to Morrison
+    table.find(:all, :first_name => 'Keith', :last_name => 'Morrison') do |record|
+      puts record.last_name
+    end
+    
+    # find the first record with first_name equal to Keith
+    table.find :first, :first_name => 'Keith'
+    
+    # find record number 10
+    table.find(10)
+  
+## Migrating to ActiveRecord
+
+An example of migrating a DBF book table to ActiveRecord using a migration:
+
+    require 'adt'
+
+    class CreateBooks < ActiveRecord::Migration
+      def self.up
+        table = ADT::Table.new('db/adt/books.adt')
+        eval(table.schema)
+
+        table.each do |record|
+          Book.create(record.attributes)
+        end
+      end
+
+      def self.down
+        drop_table :books
+      end
+    end
+  
+## Limitations and known bugs
+  
+* ADT is read-only
+* External index files are not used
+
+## Acknowledgements 
+
+
+## License
+
+(The MIT Licence)
+
+Copyright (c) 2010-2010 Chase Gray <mailto:chase@ratchetsoftware.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,32 @@
+PROJECT_ROOT = File.expand_path(File.dirname(__FILE__))
+$: << File.join(PROJECT_ROOT, 'lib')
+ 
+require 'rubygems'
+require 'jeweler'
+require 'spec/rake/spectask'
+ 
+Jeweler::Tasks.new do |s|
+  s.name = 'ruby-adt'
+  s.description = 'A small fast library for reading Advantage Database Server database files (ADT).'
+  s.summary = 'Read ADT files'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Chase Gray']
+  s.email = 'chase@ratchetsoftware.com'
+  s.add_dependency('activesupport', ['>= 2.1.0'])
+  s.homepage = 'http://github.com/chasemgray/Ruby-ADT'
+end
+
+Jeweler::GemcutterTasks.new
+ 
+task :default => :spec
+ 
+desc "Run specs"
+Spec::Rake::SpecTask.new :spec do |t|
+  t.spec_files = FileList['spec/**/*spec.rb']
+end
+ 
+desc "Run spec docs"
+Spec::Rake::SpecTask.new :specdoc do |t|
+  t.spec_opts = ["-f specdoc"]
+  t.spec_files = FileList['spec/**/*spec.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/adt_format_notes.txt

@@ -0,0 +1,36 @@
+04 followed by 32-bit zero (00 00 00 00) seem to precede each new row of data.
+
+Seems like for each column we have to know how long each data set is because there is no separator between data.
+
+The actual data is stored at the end of the file. 
+There is a header with unknown information followed by information about the columns.
+There doesn't seem to be a footer
+
+400 byte header
+
+byte 24 in the header specifies the number of rows. 32-bits I believe
+byte 33 in the header specifies the number of columns - 16-bits - the previous bytes also change when columns are added and removed but I don't know why.  It doesn't matter for my purposes.
+
+
+column names follow header
+
+Column names have a reserved 128 characters (bytes)  
+column names are followed by 72 bytes of information about the column.
+
+2 bytes after the 128 byte column name is the column type:
+00 04 - character
+00 0A - double
+00 0B - integer
+00 0C - shortint
+00 14 - cicharacter
+00 03 - date
+00 0D - time
+00 0E - timestamp
+00 0F - autoinc
+
+8th byte after 128 byte column name specifies the length in bytes
+
+
+how to parse integers? 
+how to parse doubles?
+how to parse dates and times?

data/lib/adt.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'date'
+require 'active_support'
+
+if RUBY_VERSION > '1.9'
+ require 'csv'
+ unless defined? FCSV
+   class Object
+     FCSV = CSV
+     alias_method :FCSV, :CSV
+   end
+ end
+else
+ require 'fastercsv'
+end
+
+require 'adt/globals'
+require 'adt/record'
+require 'adt/column'
+require 'adt/table'
+
+

data/lib/adt/column.rb

@@ -0,0 +1,91 @@
+module ADT
+	class ColumnLengthError < ADTError; end
+	class ColumnNameError < ADTError; end
+
+  TYPES = {4 => 'character', 10 => 'double', 11 => 'integer', 12 => 'short', 20 => 'cicharacter', 3 => 'date', 13 => 'time', 14 => 'timestamp', 15 => 'autoinc'}
+  FLAGS = {'character' => 'A', 'double' => 'D', 'integer' => 'i', 'short' => 'S', 'cicharacter' => 'A', 'date' => '?', 'time' => '?', 'timestamp' => '?', 'autoinc' => 'I'}
+
+
+	class Column
+	  attr_reader :name, :type, :length
+  
+	  # Initialize a new ADT::Column
+	  #
+	  # @param [String] name
+	  # @param [String] type
+	  # @param [Fixnum] length
+	  def initialize(name, type, length)
+	    @name, @type, @length = strip_non_ascii_chars(name), type, length
+    
+	    raise ColumnLengthError, "field length must be greater than 0" unless length > 0
+	    raise ColumnNameError, "column name cannot be empty" if @name.length == 0
+	  end
+
+    def data_type(id)
+      TYPES[id]
+    end
+
+    def flag(type, length = 0)
+      data_type = data_type(type)
+      flag = FLAGS[data_type]
+      if flag.eql? 'A'
+        return flag + length.to_s
+      end
+      return flag
+    end
+ 
+	  # Decode a DateTime value
+	  #
+	  # @param [String] value
+	  # @return [DateTime]
+	  def decode_datetime(value)
+	    days, milliseconds = value.unpack('l2')
+	    seconds = milliseconds / 1000
+	    DateTime.jd(days, seconds/3600, seconds/60 % 60, seconds % 60) rescue nil
+	  end
+  
+	  # Schema definition
+	  #
+	  # @return [String]
+	  def schema_definition
+	    "\"#{name.underscore}\", #{schema_data_type}\n"
+	  end
+  
+	  # Column type for schema definition
+	  #
+	  # @return [String]
+	  def schema_data_type
+	    case data_type(type)
+	    when "character"
+	      ":string, :limit => #{length}"
+	    when "cicharacter"
+	      ":string, :limit => #{length}"
+	    when "double"
+	      ":float"
+	    when "date"
+	      ":date"
+	    when "time"
+	      ":timestamp"
+	    when "timestamp"
+	      ":timestamp"
+      when "integer"
+        ":integer"
+      when "autoinc"
+        ":integer"
+	    else
+	      ":string, :limit => #{length}"
+	    end
+	  end
+  
+	  # Strip all non-ascii and non-printable characters
+	  #
+	  # @param [String] s
+	  # @return [String]
+	  def strip_non_ascii_chars(s)
+	    # truncate the string at the first null character
+	    s = s[0, s.index("\x00")] if s.index("\x00")
+    
+	    s.gsub(/[^\x20-\x7E]/,"")
+	  end
+	end
+end

data/lib/adt/globals.rb

@@ -0,0 +1,13 @@
+module ADT
+  class ADTError < StandardError; end
+  
+
+  
+  MS_PER_SECOND = 1000
+  MS_PER_MINUTE = MS_PER_SECOND * 60
+  MS_PER_HOUR = MS_PER_MINUTE * 60
+  
+  HEADER_LENGTH = 400
+
+  COLUMN_LENGTH = 200
+end

data/lib/adt/record.rb

@@ -0,0 +1,65 @@
+module ADT
+  # An instance of ADT::Record represents a row in the ADT file
+  class Record
+    attr_reader :attributes
+    
+    delegate :columns, :to => :@table
+    
+    # Initialize a new ADT::Record
+    #
+    # @param [ADT::Table] table
+    def initialize(table)
+      @table, @data = table, table.data
+      
+      initialize_values
+      define_accessors
+    end
+    
+    # Equality
+    #
+    # @param [ADT::Record] other
+    # @return [Boolean]
+    def ==(other)
+      other.respond_to?(:attributes) && other.attributes == attributes
+    end
+    
+    # Maps a row to an array of values
+    #
+    # @return [Array]
+    def to_a
+      columns.map { |column| @attributes[column.name.underscore] }
+    end
+    
+    private
+    
+    # Defined attribute accessor methods
+    def define_accessors
+      columns.each do |column|
+        underscored_column_name = column.name.underscore
+        unless respond_to?(underscored_column_name)
+          self.class.send :define_method, underscored_column_name do
+            @attributes[column.name.underscore]
+          end
+        end
+      end
+    end
+    
+    # Initialize values for a row
+    def initialize_values
+      #skip the first 5 bytes, don't know what they are for and they don't contain the data.
+      @data.read(5)
+      
+      @attributes = columns.inject({}) do |hash, column|
+        
+        #get the unpack flag to get this data.
+        value = @data.read(column.length).unpack("#{column.flag(column.type, column.length)}").first
+        hash[column.name] = value
+        hash[column.name.underscore] = value
+      
+        hash
+      end
+    end
+    
+    
+  end
+end

data/lib/adt/table.rb

@@ -0,0 +1,259 @@
+module ADT
+ 
+  # ADT::Table is the primary interface to a single ADT file and provides
+  # methods for enumerating and searching the records.
+  class Table
+    attr_reader :column_count # The total number of columns
+    attr_reader :columns # An array of DBF::Column
+    attr_reader :options # The options hash used to initialize the table
+    attr_reader :data # ADT file handle
+    attr_reader :record_count # Total number of records
+    
+    # Opens a ADT:Table
+    # Example:
+    # table = ADT::Table.new 'data.adt'
+    #
+    # @param [String] path Path to the adt file
+    def initialize(path)
+      @data = File.open(path, 'rb')
+      reload!
+    end
+    
+    # Closes the table 
+    def close
+      @data.close
+    end
+    
+    # Reloads the database
+    def reload!
+      @records = nil
+      get_header_info
+      get_column_descriptors
+    end
+  
+    
+    # Retrieve a Column by name
+    #
+    # @param [String, Symbol] column_name
+    # @return [ADT::Column]
+    def column(column_name)
+      @columns.detect {|f| f.name == column_name.to_s}
+    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, ADT::Record]
+    def each
+      0.upto(@record_count - 1) do |n|
+        seek_to_record(n)
+        yield ADT::Record.new(self)
+      end
+    end
+    
+    # Retrieve a record by index number
+    #
+    # @param [Fixnum] index
+    # @return [ADT::Record]
+    def record(index)
+      seek_to_record(index)
+      ADT::Record.new(self)
+    end
+    
+    alias_method :row, :record
+    
+    
+    # Generate an ActiveRecord::Schema
+    #
+    # xBase data types are converted to generic types as follows:
+    # - Number columns with no decimals are converted to :integer
+    # - Number columns with decimals are converted to :float
+    # - Date columns are converted to :datetime
+    # - Logical columns are converted to :boolean
+    # - Memo columns are converted to :text
+    # - Character columns are converted to :string and the :limit option is set
+    # to the length of the character column
+    #
+    # Example:
+    # create_table "mydata" do |t|
+    # t.column :name, :string, :limit => 30
+    # t.column :last_update, :datetime
+    # t.column :is_active, :boolean
+    # t.column :age, :integer
+    # t.column :notes, :text
+    # end
+    #
+    # @param [optional String] path
+    # @return [String]
+    def schema(path = nil)
+      s = "ActiveRecord::Schema.define do\n"
+      s << " create_table \"#{File.basename(@data.path, ".*")}\" do |t|\n"
+      columns.each do |column|
+        s << " t.column #{column.schema_definition}"
+      end
+      s << " end\nend"
+      
+      if path
+        File.open(path, 'w') {|f| f.puts(s)}
+      end
+        
+      s
+    end
+    
+    def to_a
+      records = []
+      each {|record| records << record if record}
+      records
+    end
+    
+    # Dumps all records to a CSV file. If no filename is given then CSV is
+    # output to STDOUT.
+    #
+    # @param [optional String] path Defaults to basename of adt file
+    def to_csv(path = nil)
+      path = File.basename(@data.path, '.adt') + '.csv' if path.nil?
+      FCSV.open(path, 'w', :force_quotes => true) do |csv|
+        each do |record|
+          csv << record.to_a
+        end
+      end
+    end
+    
+    # Find records using a simple ActiveRecord-like syntax.
+    #
+    # Examples:
+    # table = ADT::Table.new 'mydata.adt'
+    #
+    # # Find record number 5
+    # table.find(5)
+    #
+    # # Find all records for Chase Gray
+    # table.find :all, :first_name => "Chase", :last_name => "Gray"
+    #
+    # # Find first record
+    # table.find :first, :first_name => "Chase"
+    #
+    # 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 [Fixnum, Symbol] command
+    # @param [optional, Hash] options Hash of search parameters
+    # @yield [optional, ADT::Record]
+    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
+    
+    private
+    
+    # Find all matching
+    #
+    # @param [Hash] options
+    # @yield [optional ADT::Record]
+    # @return [Array]
+    def find_all(options, &block)
+      results = []
+      each do |record|
+        if all_values_match?(record, options)
+          if block_given?
+            yield(record)
+          else
+            results << record
+          end
+        end
+      end
+      results
+    end
+    
+    # Find first matching
+    #
+    # @param [Hash] options
+    # @return [ADT::Record, nil]
+    def find_first(options)
+      each do |record|
+        return record if all_values_match?(record, options)
+      end
+      nil
+    end
+    
+    # Do all search parameters match?
+    #
+    # @param [ADT::Record] record
+    # @param [Hash] options
+    # @return [Boolean]
+    def all_values_match?(record, options)
+      options.all? {|key, value| record.attributes[key.to_s.underscore] == value}
+    end
+    
+    
+    # Replace the file extension
+    #
+    # @param [String] path
+    # @param [String] extension
+    # @return [String]
+    def replace_extname(path, extension)
+      path.sub(/#{File.extname(path)[1..-1]}$/, extension)
+    end
+
+    
+    # Determine record count, record_count, and record length
+    def get_header_info
+      @data.rewind
+    
+      #column_count_offset = 33, record_count_offset = 24, record_length_offset = 36
+      @record_count, @data_offset, @record_length = data.read(HEADER_LENGTH).unpack("@24 I x4 I I")
+      @column_count = (@data_offset-400)/200
+    end
+    
+    
+    # Retrieves column information from the database
+    def get_column_descriptors
+      #skip past header to get to column information
+      @data.seek(HEADER_LENGTH)
+      
+      # column names are the first 128 bytes and column info takes up the last 72 bytes.  
+      # byte 130 contains a 16-bit column type
+      # byte 136 contains a 16-bit length field
+      @columns = []
+      @column_count.times do
+        name, type, length = @data.read(200).unpack('A128 x S x4 S')
+        if length > 0
+          @columns << Column.new(name.strip, type, length)
+        end
+      end
+      # Reset the column count in case any were skipped
+      @column_count = @columns.size
+      
+      @columns
+    end
+    
+    
+    # Seek to a byte offset in the record data
+    #
+    # @params [Fixnum] offset
+    def seek(offset)
+      @data.seek(@data_offset + offset)
+    end
+  
+    # Seek to a record
+    #
+    # @param [Fixnum] index
+    def seek_to_record(index)
+      seek(index * @record_length)
+    end
+    
+  end
+  
+end

data/spec/functional/adt_shared.rb

@@ -0,0 +1,54 @@
+describe DBF, :shared => true do
+  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_column_lengths
+  end
+ 
+  specify "records should be instances of DBF::Record" do
+    @table.each do |record|
+      record.should be_an_instance_of(DBF::Record)
+    end
+  end
+  
+  specify "columns should be instances of DBF::Column" do
+    @table.columns.all? {|column| column.should be_an_instance_of(DBF::Column)}
+  end
+  
+  specify "column names should not be blank" do
+    @table.columns.all? {|column| column.name.should_not be_empty}
+  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 +)
+    @table.columns.all? {|column| valid_column_types.should include(column.type)}
+  end
+  
+  specify "column lengths should be instances of Fixnum" do
+    @table.columns.all? {|column| column.length.should be_an_instance_of(Fixnum)}
+  end
+  
+  specify "column lengths should be larger than 0" do
+    @table.columns.all? {|column| column.length.should > 0}
+  end
+  
+  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
+    @table.columns do |column|
+      record = @table.records.first
+      record.send(column.name).should == record[column.name]
+    end
+  end
+  
+  specify "column attributes should be accessible in underscored form" do
+    @table.columns do |column|
+      record = @table.records.first
+      record.send(column_name).should == record.send(column_name.underscore)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+require 'rubygems'
+require 'spec'
+require 'adt'
+require 'fileutils'
+ 
+DB_PATH = File.dirname(__FILE__) + '/fixtures' unless defined?(DB_PATH)
+ 
+Spec::Runner.configure do |config|
+  
+end
+ 
+self.class.send :remove_const, 'Test' if defined? Test

data/spec/unit/column_spec.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+ 
+describe DBF::Column do
+  
+  context "when initialized" do
+    before 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 { DBF::Column.new "ColumnName", "N", -1, 0 }.should raise_error(DBF::ColumnLengthError)
+    end
+    
+    it "should raise error on emtpy column names" do
+      lambda { DBF::Column.new "\xFF\xFC", "N", 1, 0 }.should raise_error(DBF::ColumnNameError)
+    end
+    
+  end
+  
+  context "#type_cast" do
+    it "should cast numbers with decimals to Float" do
+      value = "13.5"
+      column = DBF::Column.new "ColumnName", "N", 2, 1
+      column.type_cast(value).should == 13.5
+    end
+    
+    it "should cast numbers with no decimals to Integer" do
+      value = "135"
+      column = DBF::Column.new "ColumnName", "N", 3, 0
+      column.type_cast(value).should == 135
+    end
+    
+    it "should cast :integer to Integer" do
+      value = "135"
+      column = DBF::Column.new "ColumnName", "I", 3, 0
+      column.type_cast(value).should == 135
+    end
+    
+    it "should cast boolean to True" do
+      value = "y"
+      column = DBF::Column.new "ColumnName", "L", 1, 0
+      column.type_cast(value).should == true
+    end
+    
+    it "should cast boolean to False" do
+      value = "n"
+      column = DBF::Column.new "ColumnName", "L", 1, 0
+      column.type_cast(value).should == false
+    end
+    
+    it "should cast datetime columns to DateTime" do
+      value = "Nl%\000\300Z\252\003"
+      column = DBF::Column.new "ColumnName", "T", 16, 0
+      column.type_cast(value).should == "2002-10-10T17:04:56+00:00"
+    end
+    
+    it "should cast invalid datetime columns to nil" do
+      value = "Nl%\000\000A\000\999"
+      column = DBF::Column.new "ColumnName", "T", 16, 0
+      column.type_cast(value).should be_nil
+    end
+    
+    it "should cast date columns to Date" do
+      value = "20050712"
+      column = DBF::Column.new "ColumnName", "D", 8, 0
+      column.type_cast(value).should == Date.new(2005,7,12)
+    end
+  end
+  
+  context "#schema_definition" do
+    it "should define an integer column if type is (N)umber with 9 decimals" do
+      column = DBF::Column.new "ColumnName", "N", 1, 0
+      column.schema_definition.should == "\"column_name\", :integer\n"
+    end
+    
+    it "should define a float colmn if type is (N)umber with more than 0 decimals" do
+      column = DBF::Column.new "ColumnName", "N", 1, 2
+      column.schema_definition.should == "\"column_name\", :float\n"
+    end
+    
+    it "should define a date column if type is (D)ate" do
+      column = DBF::Column.new "ColumnName", "D", 8, 0
+      column.schema_definition.should == "\"column_name\", :date\n"
+    end
+    
+    it "should define a datetime column if type is (D)ate" do
+      column = DBF::Column.new "ColumnName", "T", 16, 0
+      column.schema_definition.should == "\"column_name\", :datetime\n"
+    end
+    
+    it "should define a boolean column if type is (L)ogical" do
+      column = DBF::Column.new "ColumnName", "L", 1, 0
+      column.schema_definition.should == "\"column_name\", :boolean\n"
+    end
+    
+    it "should define a text column if type is (M)emo" do
+      column = DBF::Column.new "ColumnName", "M", 1, 0
+      column.schema_definition.should == "\"column_name\", :text\n"
+    end
+    
+    it "should define a string column with length for any other data types" do
+      column = DBF::Column.new "ColumnName", "X", 20, 0
+      column.schema_definition.should == "\"column_name\", :string, :limit => 20\n"
+    end
+  end
+  
+  context "#strip_non_ascii_chars" do
+    before do
+      @column = DBF::Column.new "ColumnName", "N", 1, 0
+    end
+    
+    it "should strip characters below decimal 32 and above decimal 127" do
+      @column.strip_non_ascii_chars("--\x1F-\x68\x65\x6C\x6C\x6F world-\x80--").should == "---hello world---"
+    end
+ 
+    it "should truncate characters with decimal 0" do
+      @column.strip_non_ascii_chars("--\x1F-\x68\x65\x6C\x6C\x6F \x00 world-\x80--").should == "---hello "
+    end
+  end
+  
+end

data/spec/unit/record_spec.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+ 
+describe DBF::Record do
+  
+  def example_record(data = '')
+    table = mock_table(data)
+    DBF::Record.new(table)
+  end
+  
+  def mock_table(data = '')
+    @column1 = DBF::Column.new 'ColumnName', 'N', 1, 0
+    
+    returning mock('table') do |table|
+      table.stub!(:memo_block_size).and_return(8)
+      table.stub!(:memo).and_return(nil)
+      table.stub!(:columns).and_return([@column1])
+      table.stub!(:data).and_return(data)
+      table.stub!(:has_memo_file?).and_return(true)
+      table.data.stub!(:read).and_return(data)
+    end
+  end
+  
+  context "when initialized" do
+    it "should typecast number columns no decimal places 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.record(1).attributes['id'].should be_kind_of(Integer)
+    end
+  
+    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.record(1).attributes['cost'].should be_kind_of(Float)
+    end
+  
+    it "should typecast memo columns to String" do
+      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      table.column("DESC").type.should == "M"
+      table.record(1).attributes['desc'].should be_kind_of(String)
+    end
+  
+    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.record(1).attributes["webinclude"].should satisfy {|v| v == true || v == false}
+    end
+  end
+  
+  describe '#memo_block_content_size' do
+    it "should equal the difference between the table's memo_block_size and 8" do
+      table = mock_table
+      table.should_receive(:memo_block_size).and_return(128)
+      record = DBF::Record.new(table)
+      
+      record.send(:memo_block_content_size).should == 120
+    end
+  end
+  
+  describe '#memo_content_size' do
+    it "should equal 8 plus the difference between memo_size and the table's memo_block_size" do
+      record = example_record
+      record.should_receive(:memo_block_size).and_return(8)
+      
+      record.send(:memo_content_size, 1024).should == 1024
+    end
+  end
+  
+  describe '#read_memo' do
+    it 'should return nil if start_block is less than 1' do
+      table = mock_table
+      record = DBF::Record.new(table)
+      
+      record.send(:read_memo, 0).should be_nil
+      record.send(:read_memo, -1).should be_nil
+    end
+    
+    it 'should return nil if memo file is missing' do
+      table = mock_table
+      table.should_receive(:has_memo_file?).and_return(false)
+      record = DBF::Record.new(table)
+      
+      record.send(:read_memo, 5).should be_nil
+    end
+  end
+  
+  describe '#to_a' do
+    it 'should return an ordered array of attribute values' do
+      table = DBF::Table.new "#{DB_PATH}/dbase_8b.dbf"
+      record = table.record(9)
+      record.to_a.should == ["Ten records stored in this database", 10.0, nil, false, "0.100000000000000000", nil]
+    end
+  end
+  
+  describe '#==' do
+    before do
+      @record = example_record
+    end
+    
+    it 'should be false if other does not have attributes' do
+      other = mock('object')
+      (@record == other).should be_false
+    end
+    
+    it 'should be true if other attributes match' do
+      attributes = {:x => 1, :y => 2}
+      @record.stub!(:attributes).and_return(attributes)
+      other = mock('object', :attributes => attributes)
+      (@record == other).should be_true
+    end
+  end
+  
+  describe 'unpack_data' do
+    before do
+      @record = example_record('abc')
+    end
+    
+    it 'should unpack the data' do
+      @record.send(:unpack_data, 3).should == 'abc'
+    end
+  end
+ 
+end

data/spec/unit/table_spec.rb

@@ -0,0 +1,227 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+ 
+describe DBF::Table do
+  context "when initialized" do
+    before 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 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 correct memo block size" do
+      @table.memo_block_size.should == 512
+    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
+  end
+  
+  context "when closed" do
+    before do
+      @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+    end
+    
+    it "should close the data file" do
+      @table.close
+      lambda { @table.record(1) }.should raise_error(IOError)
+    end
+  end
+  
+  describe "#column" do
+    it "should accept a string or symbol as input" do
+      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      table.column(:IMAGE).should be_kind_of(DBF::Column)
+      table.column("IMAGE").should be_kind_of(DBF::Column)
+    end
+    
+    it "should return a DBF::Field object when the column_name exists" do
+      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      table.column(:IMAGE).should be_kind_of(DBF::Column)
+    end
+  
+    it "should return nil when the column_name does not exist" do
+      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      table.column(:NOTANIMAGE).should be_nil
+    end
+  end
+  
+  describe "#schema" do
+    it "should match the test schema fixture" 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 "#version_description" do
+    it "should return a text description of the database type" do
+      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      table.version_description.should == "dBase III with memo file"
+    end
+  end
+  
+  describe '#replace_extname' do
+    it "should change the file extension" do
+      table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      table.send(:replace_extname, 'dbase_83.dbf', 'fpt').should == 'dbase_83.fpt'
+    end
+  end
+  
+  describe '#to_a' do
+    before do
+      @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      
+      @records = []
+      @table.each {|record| @records << record}
+    end
+    
+    it 'should return an array of records' do
+      @table.to_a.should == @records
+    end
+  end
+  
+  describe '#to_csv' do
+    before do
+      @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+    end
+    
+    after do
+      FileUtils.rm_f 'dbase_83.csv'
+      FileUtils.rm_f 'test.csv'
+    end
+    
+    it 'should create default dump.csv' do
+      @table.to_csv
+      File.exists?('dbase_83.csv').should be_true
+    end
+    
+    it 'should create custom csv file' do
+      @table.to_csv('test.csv')
+      File.exists?('test.csv').should be_true
+    end
+  end
+  
+  describe "#record" do
+    before do
+      @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      
+      @records = []
+      @table.each {|record| @records << record}
+    end
+    
+    it "should nullify deleted records" do
+      @table.stub!(:deleted_record?).and_return(true)
+      @table.record(5).should be_nil
+    end
+  end
+  
+  describe "#find" do
+    describe "with index" do
+      before 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 'with array of indexes' do
+      before do
+        @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+      end
+      
+      it "should return the correct records" do
+        @table.find([1, 5, 10]).should == [@table.record(1), @table.record(5), @table.record(10)]
+      end
+    end
+    
+    describe "with :all" do
+      before do
+        @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+        
+        @records = []
+        @table.each {|record| @records << record}
+      end
+      
+      it "should accept a block" do
+        records = []
+        @table.find(:all, :weight => 0.0) do |record|
+          records << record
+        end
+        records.should == @table.find(:all, :weight => 0.0)
+      end
+ 
+      it "should return all records if options are empty" do
+        @table.find(:all).should == @records
+      end
+ 
+      it "should return matching records when used with options" do
+        @table.find(:all, "WEIGHT" => 0.0).should == @records.select {|r| r.attributes["weight"] == 0.0}
+      end
+ 
+      it "should AND multiple search terms" do
+        @table.find(:all, "ID" => 30, "IMAGE" => "graphics/00000001/TBC01.jpg").should == []
+      end
+      
+      it "should match original column names" do
+        @table.find(:all, "WEIGHT" => 0.0).should_not be_empty
+      end
+      
+      it "should match symbolized column names" do
+        @table.find(:all, :WEIGHT => 0.0).should_not be_empty
+      end
+      
+      it "should match downcased column names" do
+        @table.find(:all, "weight" => 0.0).should_not be_empty
+      end
+      
+      it "should match symbolized downcased column names" do
+        @table.find(:all, :weight => 0.0).should_not be_empty
+      end
+    end
+    
+    describe "with :first" do
+      before do
+        @table = DBF::Table.new "#{DB_PATH}/dbase_83.dbf"
+        
+        @records = []
+        @table.each {|record| @records << record}
+      end
+ 
+      it "should return the first record if options are empty" do
+        @table.find(:first).should == @records.first
+      end
+ 
+      it "should return the first matching record when used with options" do
+        @table.find(:first, "CODE" => "C").should == @records[5]
+      end
+ 
+      it "should AND multiple search terms" do
+        @table.find(:first, "ID" => 30, "IMAGE" => "graphics/00000001/TBC01.jpg").should be_nil
+      end
+    end
+  end
+ 
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-adt
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Chase Gray
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+description: A small fast library for reading Advantage Database Server database files (ADT).
+email: chase@ratchetsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- adt_format_notes.txt
+- lib/adt.rb
+- lib/adt/column.rb
+- lib/adt/globals.rb
+- lib/adt/record.rb
+- lib/adt/table.rb
+- spec/fixtures/A.ADT
+- spec/fixtures/test.adt
+- spec/functional/adt_shared.rb
+- spec/spec_helper.rb
+- spec/unit/column_spec.rb
+- spec/unit/record_spec.rb
+- spec/unit/table_spec.rb
+has_rdoc: true
+homepage: http://github.com/chasemgray/Ruby-ADT
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Read ADT files
+test_files: 
+- spec/functional/adt_shared.rb
+- spec/spec_helper.rb
+- spec/unit/column_spec.rb
+- spec/unit/record_spec.rb
+- spec/unit/table_spec.rb