libis-tools 0.9.21 → 0.9.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc18f91c7fdaf317168eb91966d598fff6fd0252
-  data.tar.gz: 43d8f7c0f51f7e5e32b28680f53bb6f6dbb17658
+  metadata.gz: 2fa0a518d621cbae23b3f00c8653a6668a3c8ec6
+  data.tar.gz: feb47f3885d7d24105b430fe0b3dbb41113dc5bb
 SHA512:
-  metadata.gz: db2e5d1f92574eaefab41674b23aac4aa116b01206eb5eeb1304482de6dba8213a00b3c3ccfd79a83be1523b7d947d07112dd445ddadfeb781176f0fefacf65d
-  data.tar.gz: 5983fc775104c2d592fdeacdec3c86489215275ab9f138bf72211696e049e21f093e2f25e197a722d854962753652c469972e22a4dd123af58b9dd951ce8b782
+  metadata.gz: 6b21a0123262220156aed3a31cdcd1a5dd9314fb560a6953b1d37c331e6d8ca5bc81092eb608eab1fd784fe5b34ab541ac668928446a10536f85a1297d3ee85e
+  data.tar.gz: 61eb864a41ce4685515fc68fb1289e2c4ef1e2218f060bdfc91e2550c42342ad832a56b4f64627ed90bc40f1a2058518a73d264f51068b57e3e78f07ec6da0da

data/lib/libis/tools/config.rb

@@ -110,11 +110,13 @@ module Libis
         ::Logging::Layouts::Pattern.new(DEFAULT_LOG_LAYOUT_PARAMETERS)
       end
 
-      def logger(name = nil)
+      def logger(name = nil, appenders = nil)
         sync do
           name ||= :root
           logger = ::Logging.logger[name]
-          logger.appenders = ::Logging.appenders.stdout(DEFAULT_LOG_LAYOUT_PARAMETERS) if logger.appenders.empty?
+          if logger.appenders.empty?
+            logger.appenders = appenders || ::Logging.appenders.stdout(layout: get_log_formatter)
+          end
           logger
         end
       end
@@ -136,7 +138,7 @@ module Libis
       ::Logging::init
       # noinspection RubyResolve
       DEFAULT_LOG_LAYOUT_PARAMETERS = {
-          pattern: "%.1l, [%d #%p.%t] %#{::Logging::MAX_LEVEL_LENGTH}l : %m\n",
+          pattern: "%.1l, [%d #%p.%t] %5l%X{Application}%X{Subject} : %m\n",
           date_pattern: '%Y-%m-%dT%H:%M:%S.%L'
       }
 

data/lib/libis/tools/logger.rb

@@ -47,6 +47,15 @@ module Libis
         Config.logger
       end
 
+      def set_application(name = nil)
+        name ||= self.class.name
+        ::Logging.mdc['Application'] = name.blank? ? '' : " -- #{name}"
+      end
+
+      def set_subject(name = nil)
+        ::Logging.mdc['Subject'] = name.blank? ? '' : " - #{name}"
+      end
+
       # Send a debug message to the logger.
       #
       # If the optional extra parameters are supplied, the first parameter will be interpreted as a format

data/lib/libis/tools/version.rb

@@ -1,5 +1,5 @@
 module Libis
   module Tools
-    VERSION = '0.9.21'
+    VERSION = '0.9.22'
   end
 end

data/libis-tools.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'equivalent-xml', '~> 0.5'
-  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'awesome_print', '~> 0'
 
   spec.add_runtime_dependency 'backports', '~> 3.6'
   spec.add_runtime_dependency 'nokogiri', '~> 1.6'

data/spec/logger_spec.rb

@@ -9,82 +9,157 @@ describe 'Logger' do
     include ::Libis::Tools::Logger
   end
 
-  before(:context) do
-  end
-
-  before(:example) do
-    appender = ::Logging::Appenders.string_io('StringIO', layout: ::Libis::Tools::Config.get_log_formatter)
-    ::Libis::Tools::Config.logger.add_appenders(appender)
-    @logoutput = appender.sio
+  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
-    @test_logger = TestLogger.new
-  end
-  
-  let(:timestamp_regex) { '\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3} #\d+\.\d+\]'}
-
-  it 'should log debug output' do
-    @test_logger.debug 'Debug message'
-    puts "LOG OUTPUT: #{@logoutput.string}"
-    output = @logoutput.string.lines.map(&:chomp)
-    expect(output.size).to eq 1
-    expect(output.first).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.first).to match /^I, #{timestamp_regex}  INFO : Info message$/
-  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 '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 'Fatal message'
+      output = logoutput.string.lines.map(&:chomp)
+      # noinspection RubyResolve
+      expect(output).not_to be_empty
+    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.first).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.first).to match /^E, #{timestamp_regex} ERROR : Error message$/
-  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
 
-  it 'should log fatal output' do
-    @test_logger.fatal 'Fatal message'
-    output = @logoutput.string.lines.map(&:chomp)
-    expect(output.size).to eq 1
-    expect(output.first).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 'Fatal message'
-    output = @logoutput.string.lines.map(&:chomp)
-    # noinspection RubyResolve
-    expect(output).not_to be_empty
+  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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-tools
 version: !ruby/object:Gem::Version
-  version: 0.9.21
+  version: 0.9.22
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,14 +84,14 @@ dependencies:
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -246,7 +246,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/libis-tools.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 LIBIS
-
-MIT License
-
-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.