libis-tools 0.9.39 → 0.9.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99a025dd1a95a529ed53e29b81a3c0ff23623d50
-  data.tar.gz: c093966869098dcbf5ab5b6e05e93bfe32ec68e7
+  metadata.gz: a5148788cf3b8e6f14ab072a09ccaaec0d6698cd
+  data.tar.gz: f69d737f7c8cbd7af69c949feffd7074acc4cb91
 SHA512:
-  metadata.gz: 1439274e6eca11c1b29acdc038d7965355cc7799abf21323cd95611d5387ca2f15aa59b2c5b6e88a8f34f1c622ef4a3a0945e94e1e12569b0f66cb9fa2ed134b
-  data.tar.gz: ec3ecdff82f61d6c0df261219cbb499e69e160647fc182b8cba565b5c68f7c7c4f56e9439846ef4f12254713aa2e666ad2e6f9bb636aa3aa16892d1ce0b92dc9
+  metadata.gz: d4d53232d21d1ea99ab69b6d0302e735787c61d09c977b986f46870baa5bf4c2aa7937e47f496cb9250bcf520f3343d025d50c4369b08caaab74dccdba174987
+  data.tar.gz: 6ff44a80101faa634c66a12d54aaae86055218e96eca8a9b739a97aca1edd5d3bdd54f82f41228e8a5fb070352f9ae2c624c3170223c4f602056ca209f6e4cb5

data/lib/libis/tools/csv.rb

@@ -0,0 +1,38 @@
+require 'csv'
+
+module Libis
+  module Tools
+    module Csv
+
+      # @param [String] file_name
+      # @param [Hash] options
+      # @return [CSV] Open CSV object
+      def self.open(file_name, options = {})
+        options = {
+            mode: 'rb:UTF-8',
+            required: %w'',
+            optional: %w'',
+            col_sep: ',',
+            quote_char: '"'
+        }.merge options
+        mode = options.delete(:mode)
+        required_headers = options.delete(:required)
+        optional_headers = options.delete(:optional)
+        options[:headers] = true
+        options[:return_headers] = true
+        csv = CSV.open(file_name, mode, options)
+        line = csv.shift
+        found_headers = required_headers & line.headers
+        return csv if found_headers.size == required_headers.size
+        raise RuntimeError, "CSV headers not found: #{required_headers - found_headers}" unless found_headers.empty?
+        csv.close
+        options[:headers] = (required_headers + optional_headers)[0...line.size]
+        raise RuntimeError, 'CSV does not contain enough columns' if required_headers.size > line.size
+        options[:return_headers] = true
+        csv = CSV.open(file_name, mode, options)
+        csv.shift
+        csv
+      end
+    end
+  end
+end

data/lib/libis/tools/version.rb

@@ -1,5 +1,5 @@
 module Libis
   module Tools
-    VERSION = '0.9.39'
+    VERSION = '0.9.40'
   end
 end

data/spec/csv_spec.rb

@@ -0,0 +1,159 @@
+# encoding: utf-8
+require_relative 'spec_helper'
+require 'rspec/matchers'
+require 'libis/tools/csv'
+
+describe 'CSV File' do
+
+  let(:path) { File.absolute_path('data', File.dirname(__FILE__)) }
+  let(:csv) {
+    Libis::Tools::Csv.open(
+        File.join(path, csv_file),
+        required: required_headers,
+        optional: optional_headers
+    )
+  }
+
+  let(:optional_headers) { [] }
+
+  after(:example) { csv.close rescue nil }
+
+  context 'with headers' do
+    let(:csv_file) { 'test-headers.csv' }
+
+    context 'well-formed' do
+
+      let(:required_headers) { %w'FirstName LastName' }
+
+      it 'opens correctly' do
+        expect{ csv }.not_to raise_error
+      end
+
+      it 'contains expected headers' do
+        required_headers.each do |header|
+          expect(csv.headers).to include header
+        end
+        expect(csv.headers).to eq %w'FirstName LastName address'
+      end
+
+      it '#shift returns Row object' do
+        row = csv.shift
+        expect(row).to be_a CSV::Row
+        expect(row['FirstName']).to eq 'John'
+        expect(row['LastName']).to eq 'Smith'
+        expect(row['address']).to eq 'mystreet 1, myplace'
+        expect(row['phone']).to be_nil
+      end
+
+    end
+
+    context 'not well-formed' do
+
+      let(:required_headers) { %w'FirstName LastName address phone'}
+
+      it 'throws error when opened' do
+        expect { csv }.to raise_error(RuntimeError, 'CSV headers not found: ["phone"]')
+      end
+    end
+
+  end
+
+  context 'without headers' do
+    let(:csv_file) { 'test-noheaders.csv' }
+
+    context 'well-formed and strict' do
+      let(:required_headers) { %w'FirstName LastName' }
+
+      it 'opens correctly' do
+        expect { csv }.not_to raise_error
+      end
+
+      it 'contains only required headers' do
+        required_headers.each do |header|
+          expect(csv.headers).to include header
+        end
+        expect(csv.headers).to eq %w'FirstName LastName'
+      end
+
+      it '#shift returns Row object' do
+        row = csv.shift
+        expect(row).to be_a CSV::Row
+        expect(row['FirstName']).to eq 'John'
+        expect(row['LastName']).to eq 'Smith'
+        expect(row['address']).to be_nil
+        expect(row['phone']).to be_nil
+      end
+
+    end
+
+    context 'well-formed with optional headers' do
+      let(:required_headers) { %w'FirstName LastName' }
+      let(:optional_headers) { %w'address' }
+
+      it 'opens correctly' do
+        expect { csv }.not_to raise_error
+      end
+
+      it 'contains required and optional headers' do
+        required_headers.each do |header|
+          expect(csv.headers).to include header
+        end
+        optional_headers.each do |header|
+          expect(csv.headers).to include header
+        end
+        expect(csv.headers).to eq %w'FirstName LastName address'
+      end
+
+      it '#shift returns Row object' do
+        row = csv.shift
+        expect(row).to be_a CSV::Row
+        expect(row['FirstName']).to eq 'John'
+        expect(row['LastName']).to eq 'Smith'
+        expect(row['address']).to eq 'mystreet 1, myplace'
+        expect(row['phone']).to be_nil
+      end
+
+    end
+
+    context 'missing optional headers' do
+
+      let(:required_headers) { %w'FirstName LastName address' }
+      let(:optional_headers) { %w'phone' }
+
+      it 'opens correctly' do
+        expect { csv }.not_to raise_error
+      end
+
+      it 'contains only required headers' do
+        required_headers.each do |header|
+          expect(csv.headers).to include header
+        end
+        optional_headers.each do |header|
+          expect(csv.headers).not_to include header
+        end
+        expect(csv.headers).to eq %w'FirstName LastName address'
+      end
+
+      it '#shift returns Row object' do
+        row = csv.shift
+        expect(row).to be_a CSV::Row
+        expect(row['FirstName']).to eq 'John'
+        expect(row['LastName']).to eq 'Smith'
+        expect(row['address']).to eq 'mystreet 1, myplace'
+        expect(row['phone']).to be_nil
+      end
+
+    end
+
+    context 'missing required header' do
+      let(:required_headers) { %w'FirstName LastName address phone'}
+
+      it 'throws error when opened' do
+        expect { csv }.to raise_error(RuntimeError, 'CSV does not contain enough columns')
+      end
+
+    end
+
+  end
+
+end

data/spec/data/test-headers.csv

@@ -0,0 +1,2 @@
+FirstName,LastName,address
+John,Smith,"mystreet 1, myplace"

data/spec/data/test-noheaders.csv

@@ -0,0 +1 @@
+John,Smith,"mystreet 1, myplace"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-tools
 version: !ruby/object:Gem::Version
-  version: 0.9.39
+  version: 0.9.40
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -255,6 +255,7 @@ files:
 - lib/libis/tools/command.rb
 - lib/libis/tools/config.rb
 - lib/libis/tools/config_file.rb
+- lib/libis/tools/csv.rb
 - lib/libis/tools/deep_struct.rb
 - lib/libis/tools/extend/empty.rb
 - lib/libis/tools/extend/hash.rb
@@ -297,7 +298,10 @@ files:
 - spec/command_spec.rb
 - spec/config_file_spec.rb
 - spec/config_spec.rb
+- spec/csv_spec.rb
 - spec/data/MetadataMapping.xlsx
+- spec/data/test-headers.csv
+- spec/data/test-noheaders.csv
 - spec/data/test.data
 - spec/data/test.xml
 - spec/data/test.yml
@@ -351,7 +355,10 @@ test_files:
 - spec/command_spec.rb
 - spec/config_file_spec.rb
 - spec/config_spec.rb
+- spec/csv_spec.rb
 - spec/data/MetadataMapping.xlsx
+- spec/data/test-headers.csv
+- spec/data/test-noheaders.csv
 - spec/data/test.data
 - spec/data/test.xml
 - spec/data/test.yml