mdb 0.0.2 → 0.0.3.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3480b9c2fc35ed39f57547a63d49b16fd9d30acb
+  data.tar.gz: 4325aff61e2ba6ea7e7fbd7bcfb9007464c07868
+SHA512:
+  metadata.gz: 239876d157dbaa9ed429b1a832f1a0a83a12ef17c8e796e4cd09b185dfcde35fc4159f3e618d37fe105fe37590b8ad0374bf07d6c8acf93ea8ad2c7987bfb403
+  data.tar.gz: 294d967caecee1bb7b0081ae500d60e3e21f009240d783c748cfcb71970a4b1b06ae9a8e7e0042e101e1b544f8cbba0ecc24474d30edb0b7fd741f70b6fcf022

data/.travis.yml

@@ -0,0 +1,8 @@
+# .travis.yml
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake test
+before_install:
+  - sudo apt-get install mdbtools

data/README.md

@@ -1,5 +1,8 @@
 # Mdb
 
+[![Build Status](https://travis-ci.org/concordia-publishing-house/mdb.png?branch=master)](https://travis-ci.org/concordia-publishing-house/mdb)
+[![Code Climate](https://codeclimate.com/github/concordia-publishing-house/mdb.png)](https://codeclimate.com/github/concordia-publishing-house/mdb)
+
 Wraps [mdb-tools](https://github.com/brianb/mdbtools) for reading Microsoft Access databases
 
 ## Installation

data/lib/mdb.rb

@@ -5,6 +5,11 @@ module Mdb
   
   class FileDoesNotExistError < ArgumentError; end
   class TableDoesNotExistError < ArgumentError; end
+  class MdbToolsNotInstalledError < ArgumentError
+    def message
+      "mdbtools is not installed"
+    end
+  end
   class Error < RuntimeError; end
   
   def self.open(file)

data/lib/mdb/database.rb

@@ -1,20 +1,24 @@
 require 'tempfile'
+require 'shellwords'
+require 'open3'
+require 'csv'
+
 
 module Mdb
   class Database
     
     
     
-    def initialize(file)
+    def initialize(file, options={})
       raise FileDoesNotExistError, "\"#{file}\" does not exist" unless File.exist?(file)
       
       @file = file
-      @delim = '|' # We're going to assume no pipes in data
+      @delimiter = options.fetch :delimiter, '|'
     end
     
     
     
-    attr_reader :file
+    attr_reader :file, :delimiter
     
     
     
@@ -25,32 +29,27 @@ module Mdb
     
     
     def columns(table)
-      csv = read_csv(table)
-      first_line = csv[/^(.*)$/]
-      parse_columns(first_line)
+      open_csv(table) { |csv| csv.readline.map(&:to_sym) }
     end
     
     
     
     def read_csv(table)
       csv = execute "mdb-export -d \\| #{file_name} #{table}"
-      if csv.empty?
-        raise TableDoesNotExistError, "#{table.inspect} does not exist in #{file_name.inspect}" if !tables.member?(table.to_s)
-        raise Error, "An error occurred when reading #{table.inspect} in #{file_name.inspect}"
-      end
+      empty_table!(table) if csv.empty?
       csv
     end
     
     
     
-    # Returns an array of hashes. Each hash represents a record
+    # Yields a hash for each record
     def each_record(table, &block)
       columns = nil
       read_each(table) do |line|
         if columns
-          yield map_to_hash(line.split(@delim), columns)
+          yield Hash[columns.zip(line)]
         else
-          columns = parse_columns(line)
+          columns = line.map(&:to_sym)
         end
       end
     end
@@ -73,61 +72,50 @@ module Mdb
     
     
     
-    def parse_columns(line)
-      line.split(@delim).map {|name| name.empty? ? nil : name.to_sym }
-    end
-    
-    
-    
-    def map_to_hash(values, columns)
-      hash = {}
-      (0...columns.length).each do |i|
-        column = columns[i]
-        next if column.nil?
-        value = values[i]
-        hash[column] = value && value.delete("\"")
+    def read_each(table, &block)
+      count = 0
+      
+      open_csv(table) do |csv|
+        while line = csv.readline
+          yield line
+          count += 1
+        end
       end
-      hash
+      
+      empty_table!(table) if count == 0
+      
+      count
     end
     
     
     
-    def read_each(table, &block)
-      count = 0
-      read_csv(table).each_line do |line|
-        yield line.chomp
-        count += 1
-      end
-      count # don't return the result of read_csv; discard it
+    def empty_table!(table)
+      raise MdbToolsNotInstalledError if `which mdb-export 2> /dev/null`.empty?
+      raise TableDoesNotExistError, "#{table.inspect} does not exist in #{file_name.inspect}" if !tables.member?(table.to_s)
+      raise Error, "An error occurred when reading #{table.inspect} in #{file_name.inspect}"
     end
     
     
     
-    def parse(csv)
-      csv.split /\n/
+    def file_name
+      Shellwords.escape(file)
     end
     
     
     
-    def file_name
-      @file.gsub(' ', '\ ')
+    def open_csv(table)
+      command = "mdb-export -d #{Shellwords.escape(delimiter)} #{file_name} #{table}"
+      Open3.popen3(command) do |stdin, stdout, stderr|
+        yield CSV.new(stdout, col_sep: delimiter)
+      end
     end
     
     
     
     def execute(command)
-      stdout = ""
-      (1..5).each do |try|
-        Tempfile.open(rand(99999999).to_s) do |t|
-          stdout = `#{command} 2> #{t.path}`
-          t.rewind
-          stderr = t.read.strip
-          break if stderr.empty?
-          
-          # Rails.logger.error("[mdb-tools] executed `#{command}`; got \"#{stderr}\"")
-        end
-      end
+      stdout = `#{command} 2> /dev/null`
       
+      # !todo: add fixture data and a test to prove this code
       if stdout.respond_to?(:force_encoding)
         stdout.force_encoding("Windows-1252")
         stdout.encode!("utf-8")

data/lib/mdb/version.rb

@@ -1,3 +1,3 @@
 module Mdb
-  VERSION = "0.0.2"
+  VERSION = "0.0.3.rc1"
 end

data/mdb.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rails", ">= 3.2.0"
   spec.add_development_dependency "turn"
   spec.add_development_dependency "pry"
 end

data/test/database_test.rb

@@ -32,6 +32,18 @@ class MdbTest < ActiveSupport::TestCase
     end
   end
   
+  test "should raise an exception when mdb-tools is not installed" do
+    assert_raises(Mdb::MdbToolsNotInstalledError) do
+      database = Mdb.open "#{File.dirname(__FILE__)}/data/Example2000.mdb"
+      
+      # This test assumes that the tool `which` is in `/usr/bin`
+      # while `mdb-export` et al are installed elsewhere.
+      with_env "PATH" => "/usr/bin" do
+        database.read :Villains
+      end
+    end
+  end
+  
   test "should raise an exception if a table is not found" do
     database = Mdb.open "#{File.dirname(__FILE__)}/data/Example2000.mdb"
     assert_raises(Mdb::TableDoesNotExistError) do
@@ -46,4 +58,29 @@ class MdbTest < ActiveSupport::TestCase
   
   
   
+  test "should return an array of columns for at able" do
+    database = Mdb.open "#{File.dirname(__FILE__)}/data/Example2000.mdb"
+    assert_equal [:ID, :FirstName, :LastName], database.columns(:Actors)
+  end
+  
+  test "should treat quotation marks correctly" do
+    database = Mdb.open "#{File.dirname(__FILE__)}/data/Example2000.mdb"
+    actor = database.read(:Actors).first
+    assert_equal "Chris", actor[:FirstName] # as opposed to "\"Chris\""
+  end
+  
+  
+  
+private
+  
+  def with_env(new_env)
+    begin
+      old_env = ENV.to_hash
+      ENV.replace(old_env.merge(new_env))
+      yield
+    ensure
+      ENV.replace(old_env)
+    end
+  end
+  
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: mdb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3.rc1
 platform: ruby
 authors:
 - Robert Lail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,65 +27,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A library for reading Microsoft Access databases
@@ -99,7 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- Example2003.mdb
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -115,33 +104,26 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3387175660756308767
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3387175660756308767
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wraps mdb-tools for reading and Microsoft Access databases (MDB)
 test_files:
 - test/data/Example2000.mdb