libis-tools 1.0.5-java

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-headers.tsv

@@ -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"

data/spec/data/test-noheaders.tsv

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

data/spec/data/test.data

@@ -0,0 +1,9 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam ultricies condimentum suscipit. Sed nec suscipit sapien. Nullam eget magna fringilla, dignissim justo quis, eleifend sapien. Maecenas quis euismod nunc. Etiam aliquam tellus quis urna pretium ornare. Cras placerat, magna imperdiet vestibulum molestie, sem ante bibendum tortor, nec dapibus augue ligula dictum mauris. In nibh lacus, pellentesque nec posuere non, lacinia et diam. Aliquam dictum, augue sed finibus feugiat, lorem arcu ullamcorper metus, non commodo metus neque sit amet elit. Suspendisse id arcu consequat, euismod leo id, tempus velit. Ut diam leo, pulvinar sed nulla nec, volutpat suscipit ligula. Vestibulum ac erat mauris. Quisque posuere lacus a rutrum faucibus. Sed convallis risus vel congue scelerisque. Vestibulum nec nunc eu massa imperdiet sagittis.
+
+Praesent quis felis congue, consequat odio vitae, rhoncus turpis. Suspendisse potenti. Donec rutrum leo vitae ex imperdiet molestie. Vivamus efficitur mi vitae sem porta, vel pretium lacus auctor. Maecenas ac finibus quam. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Vestibulum magna metus, commodo ac ligula vestibulum, aliquet volutpat lacus. Curabitur faucibus nec erat et laoreet. Suspendisse bibendum a tortor non mattis.
+
+Curabitur odio turpis, tempus in accumsan aliquet, convallis in elit. Nullam in iaculis turpis, nec pulvinar urna. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Integer mattis erat id auctor ultrices. In placerat euismod elit maximus accumsan. Nullam et enim consectetur, interdum libero sit amet, rutrum risus. Donec eleifend nec erat vel tincidunt. Maecenas pellentesque malesuada fermentum. Cras nisi dolor, dictum eu sagittis quis, consectetur suscipit mi. Cras metus ipsum, porttitor sit amet dignissim id, condimentum eget nunc. Suspendisse potenti.
+
+Fusce ante ipsum, tincidunt eget mollis sagittis, consectetur ut ligula. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam augue felis, dictum eget felis non, euismod pharetra libero. Nunc bibendum sollicitudin est vel vulputate. Maecenas et convallis erat. Nullam rutrum molestie justo, sit amet vulputate ligula commodo a. Quisque quis neque id ex sodales aliquam ac id nulla. Nunc ut ligula ut augue placerat vulputate. Donec sed volutpat nibh, et aliquam sapien. Quisque scelerisque et augue faucibus venenatis. Sed viverra, mi ut vestibulum egestas, ante metus pulvinar justo, at aliquet enim nulla eu elit. Aliquam malesuada lectus in tellus euismod, id semper metus tristique.
+
+Pellentesque tincidunt nisl ac dolor ornare feugiat. Vivamus dignissim iaculis nunc. Suspendisse et odio velit. Vivamus urna odio, tincidunt id elementum sit amet, dictum vel tortor. Vivamus rutrum magna at nibh sodales, eu venenatis lorem malesuada. Sed bibendum eros eros, vitae aliquam nunc iaculis ac. Maecenas facilisis ipsum in tellus ultricies ornare. Integer finibus eget ante eu consectetur. Nullam rutrum nunc quis sollicitudin pellentesque.

data/spec/data/test.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<patron>
+  <name>Harry Potter</name>
+  <barcode library="Hogwarts Library">1234567890</barcode>
+  <access_level>student</access_level>
+  <email>harry.potter@hogwarts.edu</email>
+  <email>hpotter@JKRowling.com</email>
+</patron>

data/spec/data/test.yml

@@ -0,0 +1,2 @@
+process: 'Test Configuration'
+

data/spec/data/test_config.yml

@@ -0,0 +1,15 @@
+:a:
+  :x: 0
+  :y: 0
+  :z: 0
+:b:
+  :x: 10
+  :y: -5
+  :z: 2.5
+:c:
+  -
+    -
+      :a:
+       -
+        :a1: 1
+        :a2: 2

data/spec/deep_struct_spec.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+require_relative 'spec_helper'
+require 'libis/tools/deep_struct'
+
+describe 'DeepStruct' do
+
+  context 'default contructor' do
+
+    subject(:ds) { Libis::Tools::DeepStruct.new }
+
+    it 'should initialize' do
+      is_expected.not_to be_nil
+      # noinspection RubyResolve
+      expect(ds.to_hash).to be_empty
+    end
+
+  end
+
+  context 'contructed with hash' do
+
+    let(:hash) { {a: 1, 'b' => '2', c: 3.0} }
+    subject(:ds) { Libis::Tools::DeepStruct.new(hash)}
+
+    it 'has Hash values initialized' do
+      expect(ds[:a]).to eq 1
+      expect(ds[:b]).to eq '2'
+      expect(ds[:c]).to eq 3.0
+      expect(ds.to_hash).to eq hash
+    end
+
+    it 'allows access through methods' do
+      expect(ds.a).to eq 1
+      expect(ds.b).to eq '2'
+      expect(ds.c).to eq 3.0
+
+      ds.a = 5
+      expect(ds.a).to be 5
+      expect(ds[:a]).to be 5
+      expect(ds['a']).to be 5
+    end
+
+    it 'allows access through key strings' do
+      expect(ds['a']).to eq 1
+      expect(ds['b']).to eq '2'
+      expect(ds['c']).to eq 3.0
+
+      ds['a'] = 5
+      expect(ds.a).to be 5
+      expect(ds[:a]).to be 5
+      expect(ds['a']).to be 5
+    end
+
+    it 'allows access through key symbols' do
+      expect(ds[:a]).to eq 1
+      expect(ds[:b]).to eq '2'
+      expect(ds[:c]).to eq 3.0
+
+      ds[:a] = 5
+      expect(ds.a).to be 5
+      expect(ds[:a]).to be 5
+      expect(ds['a']).to be 5
+    end
+
+  end
+
+  context 'initialized with non-hash' do
+
+    subject(:ds) { Libis::Tools::DeepStruct.new 'abc' }
+
+    it 'stores value in hash with :default key' do
+      expect(ds[:default]).to eq 'abc'
+    end
+
+  end
+
+  context 'initialized with nil value' do
+
+    subject(:ds) { Libis::Tools::DeepStruct.new nil }
+
+    it 'has no data' do
+      # noinspection RubyResolve
+      expect(ds.to_hash).to be_empty
+    end
+
+  end
+
+  context 'initialized with recursive hash' do
+
+    let(:recursive_hash) { {
+        a: {x: 0, y: 0, z: 0},
+        b: {x: 10, y: -5, z: 2.5},
+        c: [
+            [
+                {a: [ {a1: 1, a2: 2}] },
+            ]
+        ]
+    } }
+
+    subject(:ds) { Libis::Tools::DeepStruct.new(recursive_hash) }
+
+    it 'stores recursive Hashes as DeepStructs' do
+      expect(ds[:a]).to be_a Libis::Tools::DeepStruct
+      expect(ds.b).to be_a Libis::Tools::DeepStruct
+    end
+
+    it 'recurses over arrays' do
+      expect(ds.c[0][0]).to be_a Libis::Tools::DeepStruct
+      expect(ds.c.first.first.a.first.a1).to eq 1
+      expect(ds.c.first.first.a.first.a2).to eq 2
+    end
+
+    it 'can reproduce original hash' do
+      expect(ds.to_hash).to eq recursive_hash
+      expect(ds.b.to_hash).to eq recursive_hash[:b]
+    end
+
+    it 'clears data and methods' do
+      expect(ds).to respond_to 'a'
+      expect(ds).to respond_to 'b'
+      expect(ds).to respond_to 'c'
+      expect(ds).to respond_to 'a='
+      expect(ds).to respond_to 'b='
+      expect(ds).to respond_to 'c='
+
+      ds.clear!
+      expect(ds.a).to be_nil
+      expect(ds.b).to be_nil
+      expect(ds.c).to be_nil
+      expect(ds).not_to respond_to 'a'
+      expect(ds).not_to respond_to 'b'
+      expect(ds).not_to respond_to 'c'
+      expect(ds).not_to respond_to 'a='
+      expect(ds).not_to respond_to 'b='
+      expect(ds).not_to respond_to 'c='
+    end
+
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+require_relative 'spec_helper'
+require 'libis/tools/config'
+require 'libis/tools/logger'
+
+describe 'Logger' do
+
+  class TestLogger
+    include ::Libis::Tools::Logger
+  end
+
+  before :each do
+    ::Libis::Tools::Config.logger.appenders =
+        ::Logging::Appenders.string_io('StringIO', layout: ::Libis::Tools::Config.get_log_formatter)
+    ::Libis::Tools::Config.logger.level = :all
+  end
+
+  let(:test_logger) { TestLogger.new }
+  let(:logoutput) { ::Libis::Tools::Config.logger.appenders.last.sio }
+
+  let(:timestamp_regex) { '\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3} #\d+\.\d+\]' }
+
+  context 'with default log configuration' do
+
+    it 'should log debug output' do
+      test_logger.debug 'Debug message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^D, #{timestamp_regex} DEBUG : Debug message$/
+    end
+
+    it 'should log info output' do
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO : Info message$/
+    end
+
+    it 'should log warning output' do
+      test_logger.warn 'Warning message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^W, #{timestamp_regex}  WARN : Warning message$/
+    end
+
+    it 'should log error output' do
+      test_logger.error 'Error message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^E, #{timestamp_regex} ERROR : Error message$/
+    end
+
+    it 'should log fatal output' do
+      test_logger.fatal_error 'Fatal message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^F, #{timestamp_regex} FATAL : Fatal message$/
+    end
+
+    it 'should be quiet when asked to' do
+      ::Libis::Tools::Config.logger.level = :error
+
+      test_logger.debug 'Debug message'
+      output = logoutput.string.lines.map(&:chomp)
+      # noinspection RubyResolve
+      expect(output).to be_empty
+
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      # noinspection RubyResolve
+      expect(output).to be_empty
+
+      test_logger.warn 'Warn message'
+      output = logoutput.string.lines.map(&:chomp)
+      # noinspection RubyResolve
+      expect(output).to be_empty
+
+      test_logger.error 'Error message'
+      output = logoutput.string.lines.map(&:chomp)
+      # noinspection RubyResolve
+      expect(output).not_to be_empty
+
+      test_logger.fatal_error 'Fatal message'
+      output = logoutput.string.lines.map(&:chomp)
+      # noinspection RubyResolve
+      expect(output).not_to be_empty
+    end
+
+  end
+
+  context 'with application configuration' do
+
+    it 'should print default application name' do
+      test_logger.set_application
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO -- TestLogger : Info message$/
+    end
+
+    it 'should print custom application name' do
+      test_logger.set_application 'TestApplication'
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO -- TestApplication : Info message$/
+    end
+
+    it 'should allow to turn of application name' do
+      test_logger.set_application 'TestApplication'
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO -- TestApplication : Info message$/
+      # -- revert to default
+      test_logger.set_application
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 2
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO -- TestLogger : Info message$/
+      # -- turn off
+      test_logger.set_application ''
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 3
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO : Info message$/
+    end
+
+  end
+
+  context 'with subject configuration' do
+
+    it 'should print no subject by default' do
+      test_logger.set_subject
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO : Info message$/
+    end
+
+    it 'should print custom subject name' do
+      test_logger.set_subject 'TestSubject'
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO - TestSubject : Info message$/
+    end
+
+    it 'should allow to turn off subject name' do
+      test_logger.set_subject 'TestSubject'
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 1
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO - TestSubject : Info message$/
+      # -- turn off
+      test_logger.set_subject
+      test_logger.info 'Info message'
+      output = logoutput.string.lines.map(&:chomp)
+      expect(output.size).to eq 2
+      expect(output.last).to match /^I, #{timestamp_regex}  INFO : Info message$/
+    end
+
+  end
+
+end