dbf 1.3.0 → 1.5.0

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 1.5.0
+
+- Significant internal restructuring and performance improvements. Initial
+  testing shows 4x faster performance.
+
+## 1.3.0
+
+- Only load what's needed from activesupport 3.0
+- Updatate fastercsv dependency to 1.5.3
+- Remove use of 'returning' method
+- Remove jeweler in favor of manual gemspec creation
+- Move Table#all_values_match? to Record#match?
+- Add attr_reader for Record#table
+- Use method_defined? instead of respond_to? when defining attribute accessors
+- Move memo file check into get_memo_header_info
+- Remove unnecessary seek_to_record in Table#each
+- Add rake console task
+- New Attribute class
+- Add a helper method for memo column type
+- Move constants into the classes where they are used
+- Use bundler
+
 ## 1.2.9
 
 - Retain trailing whitespace in memos

data/Gemfile

@@ -1,5 +1,2 @@
+gemspec
 source :rubygems
-
-gem 'activesupport', '3.0.0'
-gem 'i18n', '0.4.1'
-gem 'rspec', '1.3.0'

data/Gemfile.lock

@@ -1,14 +1,91 @@
+PATH
+  remote: .
+  specs:
+    dbf (1.3.0)
+      activesupport (= 3.0.1)
+      fastercsv (= 1.5.3)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.0)
-    i18n (0.4.1)
-    rspec (1.3.0)
+    Saikuro (1.1.0)
+    activesupport (3.0.1)
+    arrayfields (4.7.4)
+    chronic (0.2.3)
+      hoe (>= 1.2.1)
+    churn (0.0.12)
+      chronic (~> 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.0.4)
+      sexp_processor (~> 3.0.3)
+    colored (1.2)
+    diff-lcs (1.1.2)
+    fastercsv (1.5.3)
+    fattr (2.2.0)
+    flay (1.4.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.0)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    hirb (0.3.5)
+    hoe (2.6.2)
+      rake (>= 0.8.7)
+      rubyforge (>= 2.0.4)
+    json_pure (1.4.6)
+    main (4.3.0)
+      arrayfields (>= 4.7.4)
+      fattr (>= 2.1.0)
+    metric_fu (2.0.1)
+      Saikuro (>= 1.1.0)
+      activesupport (>= 2.0.0)
+      chronic (~> 0.2.3)
+      churn (>= 0.0.7)
+      flay (>= 1.2.1)
+      flog (>= 2.2.0)
+      rails_best_practices (>= 0.3.16)
+      rcov (>= 0.8.3.3)
+      reek (>= 1.2.6)
+      roodi (>= 2.1.0)
+    progressbar (0.9.0)
+    rails_best_practices (0.5.0)
+      activesupport
+      colored (~> 1.2)
+      progressbar (~> 0.9.0)
+      ruby_parser (~> 2.0.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.5)
+      sexp_processor (~> 3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sexp_processor (3.0.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (= 3.0.0)
-  i18n (= 0.4.1)
-  rspec (= 1.3.0)
+  activesupport (= 3.0.1)
+  dbf!
+  fastercsv (= 1.5.3)
+  metric_fu (= 2.0.1)
+  rspec (= 2.1.0)

data/README.md

@@ -4,14 +4,14 @@ DBF is a small fast library for reading dBase, xBase, Clipper and FoxPro
 database files
 
 * Project page: <http://github.com/infused/dbf>
-* API Documentation: <http://rdoc.info/projects/infused/dbf>
+* API Documentation: <http://rubydoc.info/github/infused/dbf/frames>
 * Report bugs: <http://github.com/infused/dbf/issues>
 * Questions: Email <mailto:keithm@infused.org> and put DBF somewhere in the 
   subject line
 
 ## Compatibility
 
-DBF is tested to work with Ruby 1.8.6, 1.8.7, 1.9.1 and 1.9.2
+DBF works with Ruby 1.8.6, 1.8.7, and 1.9.2
 
 ## Installation
   
@@ -23,46 +23,45 @@ Load a DBF file:
 
     require 'dbf'
 
-    table = DBF::Table.new("widgets.dbf")
+    widgets = DBF::Table.new("widgets.dbf")
 
 Enumerate all records
 
-    table.each do |record|
-      puts record.name
-      puts record.email
+    widgets.each do |record|
+      puts widget.name
+      puts widget.email
     end
     
-Load a single record using <tt>record</tt> or <tt>find</tt>
+Load a single record using <tt>find</tt>
 
-    table.record(6)
-    table.find(6)
+    widget.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. (Note
-that record() will return nil if the requested record has been deleted and not
+that find() will return nil if the requested record has been deleted and not
 yet pruned from the database)
 
-    table.record(4).attributes["PhoneBook"]
-    table.record(4).attributes["phone_book"]
-    table.record(4).phone_book
+    widget.find(4).attributes["SlotNumber"]
+    widget.find(4).attributes["slot_number"]
+    widget.find(4).slot_number
   
 Search for records using a simple hash format. Multiple search criteria are
 ANDed. Use the block form 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|
+    # find all records with slot_number equal to s42
+    widgets.find(:all, :slot_number => 's42') do |widget|
       # the record will be nil if deleted, but not yet pruned from the database
-      if record
-        puts record.last_name
+      if widget
+        puts widget.serial_number
       end
     end
     
-    # find the first record with first_name equal to Keith
-    table.find :first, :first_name => 'Keith'
+    # find the first record with slot_number equal to s42
+    widgets.find :first, :slot_number => 's42'
     
     # find record number 10
-    table.find(10)
+    widgets.find(10)
   
 ## Migrating to ActiveRecord
 
@@ -100,7 +99,7 @@ A small command-line utility called dbf is installed along with the gem.
 
 The basic dBase data types are generally supported well. Support for the
 advanced data types in dbase V and FoxPro are still experimental or not
-supported. If you have insight into how any of unsupported data types are
+supported. If you have insight into how any of the unsupported data types are
 implemented, please give me a shout. FoxBase/dBase II files are not supported
 at this time.
 

data/Rakefile

@@ -1,42 +1,10 @@
 # encoding: utf-8
 
 require 'rubygems'
-require 'rubygems/specification'
 
-def gemspec
-  @gemspec ||= begin
-    file = File.expand_path('../dbf.gemspec', __FILE__)
-    eval(File.read(file), binding, file)
-  end
-end
-
-begin
-  require 'rake/gempackagetask'
-rescue LoadError
-  task(:gem) { $stderr.puts '`gem install rake` to package gems' }
-else
-  Rake::GemPackageTask.new(gemspec) do |pkg|
-    pkg.gem_spec = gemspec
-  end
-  task :gem => :gemspec
-end
-
-begin
-  require 'spec/rake/spectask'
-rescue LoadError
-  raise 'Run `gem install rspec` to be able to run specs'
-else
-  task :clear_tmp do
-    FileUtils.rm_rf(File.expand_path("../tmp", __FILE__))
-  end
-
-  desc "Run specs"
-  Spec::Rake::SpecTask.new do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.spec_opts  = %w(-fs --color)
-    t.warning    = true
-  end
-  task :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec do |t|
+  t.rspec_opts = %w(-fs --color)
 end
 
 require 'rake'
@@ -49,20 +17,15 @@ Rake::RDocTask.new { |rdoc|
   rdoc.rdoc_files.include('README.md', 'docs/supported_types.markdown', 'lib/**/*.rb')
 }
 
-desc "install the gem locally"
-task :install => :package do
-  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
-end
-
-desc "validate the gemspec"
-task :gemspec do
-  gemspec.validate
-end
-
-task :package => :gemspec
 task :default => :spec
 
 desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -I lib -r dbf.rb"
+end
+
+require 'metric_fu'
+MetricFu::Configuration.run do |config|
+  config.rcov[:test_files] = ['spec/**/*_spec.rb']  
+  config.rcov[:rcov_opts] << "-Ispec"
 end

data/lib/dbf.rb

@@ -1,5 +1,5 @@
 require 'date'
-gem 'activesupport', '=3.0.0'
+gem 'activesupport'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/date/conversions'
 require 'active_support/core_ext/time/conversions'
@@ -7,20 +7,15 @@ require 'active_support/core_ext/date_time/conversions'
 require 'active_support/core_ext/string/conversions'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/enumerable'
 
-if RUBY_VERSION > '1.9'    
- require 'csv'  
- unless defined? FCSV
-   class Object  
-     FCSV = CSV 
-     alias_method :FCSV, :CSV
-   end  
- end
-else
- require 'fastercsv'
+require 'csv'
+if CSV.const_defined? :Reader
+  require 'fastercsv'
 end
 
 require 'dbf/attributes'
 require 'dbf/record'
 require 'dbf/column'
+require 'dbf/memo'
 require 'dbf/table'

data/lib/dbf/column.rb

@@ -14,7 +14,7 @@ module DBF
     # @param [Fixnum] length
     # @param [Fixnum] decimal
     def initialize(name, type, length, decimal)
-      @name, @type, @length, @decimal = strip_non_ascii_chars(name), type, length, decimal
+      @name, @type, @length, @decimal = clean(name), type, length, decimal
       
       raise ColumnLengthError, "field length must be greater than 0" unless length > 0
       raise ColumnNameError, "column name cannot be empty" if @name.length == 0
@@ -26,95 +26,67 @@ module DBF
     # @return [Fixnum, Float, Date, DateTime, Boolean, String] 
     def type_cast(value)
       case type
-      when 'N' # number
-        unpack_number(value)
-      when 'I' # integer
-        unpack_unsigned_long(value)
-      when 'F' # float
-        unpack_float(value)
-      when 'D' # date
-        decode_date(value)
-      when 'T' # datetime
-        decode_datetime(value)
-      when 'L' # logical
-        boolean(value)
-      else
-        value.to_s.strip
+        when 'N' then unpack_number(value)
+        when 'I' then unpack_unsigned_long(value)
+        when 'F' then unpack_float(value)
+        when 'D' then decode_date(value)
+        when 'T' then decode_datetime(value)
+        when 'L' then boolean(value)
+        else          value.to_s.strip
       end
     end
     
-    # Decode a Date value
+    def memo?
+      @memo ||= type == 'M'
+    end
+    
+    # Schema definition
     #
-    # @param [String] value
-    # @return [Date]
-    def decode_date(value)
-      return nil if value.blank?
-      value.is_a?(String) ? value.gsub(' ', '0').to_date : value.to_date
+    # @return [String]
+    def schema_definition
+      "\"#{name.underscore}\", #{schema_data_type}\n"
+    end
+    
+    def underscored_name
+      @underscored_name ||= name.underscore
+    end
+    
+    private
+    
+    def decode_date(value) #nodoc
+      value.gsub!(' ', '0')
+      value.blank? ? nil : value.to_date
     rescue
       nil
     end
     
-    # Decode a DateTime value
-    #
-    # @param [String] value
-    # @return [DateTime]
-    def decode_datetime(value)
+    def decode_datetime(value) #nodoc
       days, milliseconds = value.unpack('l2')
       seconds = milliseconds / 1000
       DateTime.jd(days, seconds/3600, seconds/60 % 60, seconds % 60) rescue nil
     end
     
-    # Decode a number value
-    #
-    # @param [String] value
-    # @return [Fixnum, Float]
-    def unpack_number(value)
+    def unpack_number(value) #nodoc
       decimal.zero? ? unpack_integer(value) : value.to_f
     end
     
-    # Decode a float value
-    #
-    # @param [String] value
-    # @return [Float]
-    def unpack_float(value)
+    def unpack_float(value) #nodoc
       value.to_f
     end
     
-    # Decode an integer
-    #
-    # @param [String] value
-    # @return [Fixnum]
-    def unpack_integer(value)
+    def unpack_integer(value) #nodoc
       value.to_i
     end
     
-    # Decode an unsigned long
-    #
-    # @param [String] value
-    # @return [Fixnum]
-    def unpack_unsigned_long(value)
+    def unpack_unsigned_long(value) #nodoc
       value.unpack('V')[0]
     end
     
-    # Decode a boolean value
-    #
-    # @param [String] value
-    # @return [Boolean]
-    def boolean(value)
+    def boolean(value) #nodoc
       value.strip =~ /^(y|t)$/i ? true : false
     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
+    def schema_data_type #nodoc
       case type
       when "N", "F"
         decimal > 0 ? ":float" : ":integer"
@@ -133,20 +105,12 @@ module DBF
       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]/,"")
+    def clean(s) #nodoc
+      first_null = s.index("\x00")
+      s = s[0, first_null] if first_null
+      s.gsub(/[^\x20-\x7E]/, "")
     end
     
-    def memo?
-      type == 'M'
-    end
   end
   
 end