loga 2.8.0 → 2.8.1

data/spec/integration/sinatra_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 class MySinatraApp < Sinatra::Base
@@ -21,7 +23,7 @@ class MySinatraApp < Sinatra::Base
   end
 end
 
-RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
+RSpec.describe 'Structured logging with Sinatra', :timecop, :with_hostname do
   let(:io) { StringIO.new }
   let(:format) {}
   let(:last_log_entry) do
@@ -69,12 +71,12 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
     let(:data) do
       {
         'method' => 'GET',
-        'path'   => '/ok',
+        'path' => '/ok',
         'params' => { 'username'=>'yoshi' },
         'request_id' => '700a6a01',
         'request_ip' => '127.0.0.1',
         'user_agent' => nil,
-        'duration'   => 0,
+        'duration' => 0,
         'status' => 200,
       }
     end
@@ -97,7 +99,7 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
       let(:data) do
         super().merge(
           'status' => 302,
-          'path'   => '/new',
+          'path' => '/new',
           'params' => {},
         )
       end
@@ -112,14 +114,15 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
       let(:data) do
         super().merge(
           'status' => 500,
-          'path'   => '/error',
+          'path' => '/error',
           'params' => {},
         )
       end
 
       it 'logs the request with the exception' do
         get '/error', {}, 'HTTP_X_REQUEST_ID' => '700a6a01'
-        expect(last_log_entry).to eql("E, #{time_pid_tags} GET /error 500 in 0ms type=request #{data_as_text} exception=undefined method `name' for nil:NilClass\n")
+
+        expect(last_log_entry).to start_with("E, #{time_pid_tags} GET /error 500 in 0ms type=request #{data_as_text} exception=undefined method `name' for nil")
       end
     end
   end

data/spec/loga/sidekiq5/job_logger_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'loga/sidekiq5/job_logger'
 

data/spec/loga/sidekiq6/job_logger_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'loga/sidekiq6/job_logger'
 
@@ -24,7 +26,7 @@ RSpec.describe Loga::Sidekiq6::JobLogger do
 
   # https://github.com/mperham/sidekiq/blob/v6.1.2/lib/sidekiq/job_logger.rb
   it 'inherits from ::Sidekiq::JobLogger' do
-    expect(subject).to be_a(::Sidekiq::JobLogger)
+    expect(subject).to be_a(Sidekiq::JobLogger)
   end
 
   describe '#call' do

data/spec/loga/sidekiq7/job_logger_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'loga/sidekiq7/job_logger'
 
@@ -26,7 +28,7 @@ RSpec.describe Loga::Sidekiq7::JobLogger do
 
   # https://github.com/mperham/sidekiq/blob/v6.1.2/lib/sidekiq/job_logger.rb
   it 'inherits from ::Sidekiq::JobLogger' do
-    expect(subject).to be_a(::Sidekiq::JobLogger)
+    expect(subject).to be_a(Sidekiq::JobLogger)
   end
 
   describe '#call' do

data/spec/loga/sidekiq_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Loga::Sidekiq do
@@ -32,9 +34,9 @@ RSpec.describe Loga::Sidekiq do
 
         case m['version']
         when '51'
-          expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq5::JobLogger)
+          expect(Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq5::JobLogger)
         when '6'
-          expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq6::JobLogger)
+          expect(Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq6::JobLogger)
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'byebug'
 require 'pry'
 require 'support/gethostname_shared'
@@ -8,16 +10,17 @@ require 'rack/test'
 require 'simplecov'
 
 SimpleCov.start do
-  command_name "ruby-#{RUBY_VERSION}-#{File.basename(ENV['BUNDLE_GEMFILE'], '.gemfile')}"
+  command_name "ruby-#{RUBY_VERSION}-#{File.basename(ENV.fetch('BUNDLE_GEMFILE', nil),
+                                                     '.gemfile')}"
 
   # Exclude specs from showing up in the code coverage report.
   add_filter 'spec/'
 end
 
-case ENV['BUNDLE_GEMFILE']
+case ENV.fetch('BUNDLE_GEMFILE', nil)
 when /rails/
   rspec_pattern = 'integration/rails/**/*_spec.rb'
-  /(?<appraisal>rails\d{2})\.gemfile/ =~ ENV['BUNDLE_GEMFILE']
+  /(?<appraisal>rails\d{2})\.gemfile/ =~ ENV.fetch('BUNDLE_GEMFILE', nil)
   require 'rails'
   require 'action_mailer'
   require File.expand_path("../fixtures/#{appraisal}.rb",  __FILE__)

data/spec/support/gethostname_shared.rb

@@ -1,4 +1,6 @@
-shared_context 'gethostname', with_hostname: true do
+# frozen_string_literal: true
+
+shared_context 'gethostname', :with_hostname do
   let(:hostname) { 'bird.example.com' }
 
   before do

data/spec/support/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 
 module Helpers

data/spec/support/request_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.shared_examples 'request logger' do
   describe 'get request' do
     it 'logs the request' do
@@ -6,23 +8,23 @@ RSpec.shared_examples 'request logger' do
           'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
       expect(last_log_entry).to include(
-        'version'             => '1.1',
-        'host'                => 'bird.example.com',
-        'short_message'       => 'GET /ok?username=yoshi 200 in 0ms',
-        'timestamp'           => 1_450_150_205.123,
-        'level'               => 6,
-        '_type'               => 'request',
-        '_service.name'       => 'hello_world_app',
-        '_service.version'    => '1.0',
-        '_request.method'     => 'GET',
-        '_request.path'       => '/ok',
-        '_request.params'     => { 'username' => 'yoshi' },
+        'version' => '1.1',
+        'host' => 'bird.example.com',
+        'short_message' => 'GET /ok?username=yoshi 200 in 0ms',
+        'timestamp' => 1_450_150_205.123,
+        'level' => 6,
+        '_type' => 'request',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_request.method' => 'GET',
+        '_request.path' => '/ok',
+        '_request.params' => { 'username' => 'yoshi' },
         '_request.request_ip' => '127.0.0.1',
         '_request.user_agent' => 'Chrome',
-        '_request.status'     => 200,
+        '_request.status' => 200,
         '_request.request_id' => '471a34dc',
-        '_request.duration'   => 0,
-        '_tags'               => '471a34dc TEST_TAG',
+        '_request.duration' => 0,
+        '_tags' => '471a34dc TEST_TAG',
       )
     end
   end
@@ -36,23 +38,23 @@ RSpec.shared_examples 'request logger' do
            'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
       expect(last_log_entry).to include(
-        'version'             => '1.1',
-        'host'                => 'bird.example.com',
-        'short_message'       => 'POST /users?username=yoshi 200 in 0ms',
-        'timestamp'           => 1_450_150_205.123,
-        'level'               => 6,
-        '_type'               => 'request',
-        '_service.name'       => 'hello_world_app',
-        '_service.version'    => '1.0',
-        '_request.method'     => 'POST',
-        '_request.path'       => '/users',
-        '_request.params'     => { 'username' => 'yoshi', 'email' => 'hello@world.com' },
+        'version' => '1.1',
+        'host' => 'bird.example.com',
+        'short_message' => 'POST /users?username=yoshi 200 in 0ms',
+        'timestamp' => 1_450_150_205.123,
+        'level' => 6,
+        '_type' => 'request',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_request.method' => 'POST',
+        '_request.path' => '/users',
+        '_request.params' => { 'username' => 'yoshi', 'email' => 'hello@world.com' },
         '_request.request_ip' => '127.0.0.1',
         '_request.user_agent' => 'Chrome',
-        '_request.status'     => 200,
+        '_request.status' => 200,
         '_request.request_id' => '471a34dc',
-        '_request.duration'   => 0,
-        '_tags'               => '471a34dc TEST_TAG',
+        '_request.duration' => 0,
+        '_tags' => '471a34dc TEST_TAG',
       )
     end
 
@@ -68,23 +70,23 @@ RSpec.shared_examples 'request logger' do
       get '/new', {}, 'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
       expect(last_log_entry).to include(
-        'version'             => '1.1',
-        'host'                => 'bird.example.com',
-        'short_message'       => 'GET /new 302 in 0ms',
-        'timestamp'           => 1_450_150_205.123,
-        'level'               => 6,
-        '_type'               => 'request',
-        '_service.name'       => 'hello_world_app',
-        '_service.version'    => '1.0',
-        '_request.method'     => 'GET',
-        '_request.path'       => '/new',
-        '_request.params'     => {},
+        'version' => '1.1',
+        'host' => 'bird.example.com',
+        'short_message' => 'GET /new 302 in 0ms',
+        'timestamp' => 1_450_150_205.123,
+        'level' => 6,
+        '_type' => 'request',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_request.method' => 'GET',
+        '_request.path' => '/new',
+        '_request.params' => {},
         '_request.request_ip' => '127.0.0.1',
         '_request.user_agent' => 'Chrome',
-        '_request.status'     => 302,
+        '_request.status' => 302,
         '_request.request_id' => '471a34dc',
-        '_request.duration'   => 0,
-        '_tags'               => '471a34dc TEST_TAG',
+        '_request.duration' => 0,
+        '_tags' => '471a34dc TEST_TAG',
       )
     end
   end
@@ -96,26 +98,26 @@ RSpec.shared_examples 'request logger' do
           'HTTP_USER_AGENT' => 'Chrome', 'HTTP_X_REQUEST_ID' => '471a34dc'
 
       expect(last_log_entry).to include(
-        'version'              => '1.1',
-        'host'                 => 'bird.example.com',
-        'short_message'        => 'GET /error?username=yoshi 500 in 0ms',
-        'timestamp'            => 1_450_150_205.123,
-        'level'                => 3,
-        '_type'                => 'request',
-        '_service.name'        => 'hello_world_app',
-        '_service.version'     => '1.0',
-        '_request.method'      => 'GET',
-        '_request.path'        => '/error',
-        '_request.params'      => { 'username' => 'yoshi' },
-        '_request.request_ip'  => '127.0.0.1',
-        '_request.user_agent'  => 'Chrome',
-        '_request.status'      => 500,
-        '_request.request_id'  => '471a34dc',
-        '_request.duration'    => 0,
-        '_exception.klass'     => 'NoMethodError',
-        '_exception.message'   => "undefined method `name' for nil:NilClass",
+        'version' => '1.1',
+        'host' => 'bird.example.com',
+        'short_message' => 'GET /error?username=yoshi 500 in 0ms',
+        'timestamp' => 1_450_150_205.123,
+        'level' => 3,
+        '_type' => 'request',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_request.method' => 'GET',
+        '_request.path' => '/error',
+        '_request.params' => { 'username' => 'yoshi' },
+        '_request.request_ip' => '127.0.0.1',
+        '_request.user_agent' => 'Chrome',
+        '_request.status' => 500,
+        '_request.request_id' => '471a34dc',
+        '_request.duration' => 0,
+        '_exception.klass' => 'NoMethodError',
+        '_exception.message' => start_with("undefined method `name' for nil"),
         '_exception.backtrace' => be_a(String),
-        '_tags'               => '471a34dc TEST_TAG',
+        '_tags' => '471a34dc TEST_TAG',
       )
     end
   end
@@ -125,23 +127,23 @@ RSpec.shared_examples 'request logger' do
       get '/not_found', {}, 'HTTP_X_REQUEST_ID' => '471a34dc'
 
       expect(last_log_entry).to include(
-        'version'              => '1.1',
-        'host'                 => 'bird.example.com',
-        'short_message'        => 'GET /not_found 404 in 0ms',
-        'timestamp'            => 1_450_150_205.123,
-        'level'                => 6,
-        '_type'                => 'request',
-        '_service.name'        => 'hello_world_app',
-        '_service.version'     => '1.0',
-        '_request.method'      => 'GET',
-        '_request.path'        => '/not_found',
-        '_request.params'      => {},
-        '_request.request_ip'  => '127.0.0.1',
-        '_request.user_agent'  => nil,
-        '_request.status'      => 404,
-        '_request.request_id'  => '471a34dc',
-        '_request.duration'    => 0,
-        '_tags'               => '471a34dc TEST_TAG',
+        'version' => '1.1',
+        'host' => 'bird.example.com',
+        'short_message' => 'GET /not_found 404 in 0ms',
+        'timestamp' => 1_450_150_205.123,
+        'level' => 6,
+        '_type' => 'request',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_request.method' => 'GET',
+        '_request.path' => '/not_found',
+        '_request.params' => {},
+        '_request.request_ip' => '127.0.0.1',
+        '_request.user_agent' => nil,
+        '_request.status' => 404,
+        '_request.request_id' => '471a34dc',
+        '_request.duration' => 0,
+        '_tags' => '471a34dc TEST_TAG',
       )
     end
   end
@@ -188,9 +190,9 @@ RSpec.shared_examples 'request logger' do
            bob_file: Rack::Test::UploadedFile.new('spec/fixtures/random_bin')
 
       expect(last_log_entry).to include(
-        'short_message'       => 'POST /users?username=yoshi 200 in 0ms',
-        'level'               => 6,
-        '_request.params'     => {
+        'short_message' => 'POST /users?username=yoshi 200 in 0ms',
+        'level' => 6,
+        '_request.params' => {
           'username' => 'yoshi',
           'bob_file' => include(
             'filename' => 'random_bin',

data/spec/support/timecop_shared.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'timecop'
 
-shared_context 'timecop', timecop: true do
+shared_context 'timecop', :timecop do
   # Allows fixed timestamps
   before(:all) { Timecop.freeze(time_anchor) }
 

data/spec/unit/loga/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Loga::Configuration do
@@ -20,8 +22,8 @@ describe Loga::Configuration do
       allow(Loga::ServiceVersionStrategies).to receive(:call).and_return('unknown.sha')
     end
 
-    context 'defaults', with_hostname: true do
-      specify { expect(subject.device).to eq(STDOUT) }
+    context 'defaults', :with_hostname do
+      specify { expect(subject.device).to eq($stdout) }
       specify { expect(subject.filter_exceptions).to eq(framework_exceptions) }
       specify { expect(subject.filter_parameters).to eq([]) }
       specify { expect(subject.format).to eq(:simple) }
@@ -29,7 +31,7 @@ describe Loga::Configuration do
       specify { expect(subject.level).to eq(:info) }
       specify { expect(subject.service_name).to eq('hello_world_app') }
       specify { expect(subject.service_version).to eq('unknown.sha') }
-      specify { expect(subject.sync).to eq(true) }
+      specify { expect(subject.sync).to be(true) }
       specify { expect(subject.tags).to eq([]) }
     end
 
@@ -174,11 +176,11 @@ describe Loga::Configuration do
       let(:logdev) { subject.logger.instance_variable_get(:@logdev) }
 
       {
-        debug:   0,
-        info:    1,
-        warn:    2,
-        error:   3,
-        fatal:   4,
+        debug: 0,
+        info: 1,
+        warn: 2,
+        error: 3,
+        fatal: 4,
         unknown: 5,
       }.each do |sym, level|
         context "when log level is #{sym}" do
@@ -194,7 +196,7 @@ describe Loga::Configuration do
         let(:options) { super().merge(sync: false) }
 
         it 'uses warn log level' do
-          expect(logdev.dev.sync).to eq(false)
+          expect(logdev.dev.sync).to be(false)
         end
       end
     end

data/spec/unit/loga/event_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-RSpec.describe Loga::Event, timecop: true do
+RSpec.describe Loga::Event, :timecop do
   describe 'initialize' do
     context 'when no message is passed' do
       it 'sets message to an empty string' do
@@ -9,7 +11,7 @@ RSpec.describe Loga::Event, timecop: true do
     end
 
     context 'when message is passed' do
-      let(:message) { "stuff \xC2".force_encoding 'ASCII-8BIT' }
+      let(:message) { "stuff \xC2".dup.force_encoding 'ASCII-8BIT' }
       let(:subject) { described_class.new message: message }
 
       it 'sanitizes the input to be UTF-8 convertable' do

data/spec/unit/loga/formatters/gelf_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Loga::Formatters::GELFFormatter do
@@ -8,25 +10,25 @@ describe Loga::Formatters::GELFFormatter do
   let(:host)            { 'www.example.com' }
   let(:params) do
     {
-      service_name:    service_name,
+      service_name: service_name,
       service_version: service_version,
-      host:            host,
+      host: host,
     }
   end
 
   shared_examples 'valid GELF message' do
     it 'includes the required fields' do
-      expect(json).to include('version'       => '1.1',
-                              'host'          => host,
+      expect(json).to include('version' => '1.1',
+                              'host' => host,
                               'short_message' => be_a(String),
-                              'timestamp'     => be_a(Float),
-                              'level'         => 6)
+                              'timestamp' => be_a(Float),
+                              'level' => 6)
     end
 
     it 'includes Loga additional fields' do
-      expect(json).to include('_service.name'    => service_name,
+      expect(json).to include('_service.name' => service_name,
                               '_service.version' => service_version,
-                              '_tags'            => '')
+                              '_tags' => '')
     end
 
     it 'outputs the timestamp in seconds since UNIX epoch' do
@@ -233,11 +235,11 @@ describe Loga::Formatters::GELFFormatter do
     end
 
     {
-      'DEBUG'   => 7,
-      'INFO'    => 6,
-      'WARN'    => 4,
-      'ERROR'   => 3,
-      'FATAL'   => 2,
+      'DEBUG' => 7,
+      'INFO' => 6,
+      'WARN' => 4,
+      'ERROR' => 3,
+      'FATAL' => 2,
       'UNKNOWN' => 1,
     }.each do |ruby_severity, syslog_level|
       context "with severity #{ruby_severity}" do

data/spec/unit/loga/formatters/simple_formatter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'loga/formatters/simple_formatter'
 
@@ -112,11 +114,11 @@ describe Loga::Formatters::SimpleFormatter do
     end
 
     {
-      'DEBUG'   => 'D',
-      'INFO'    => 'I',
-      'WARN'    => 'W',
-      'ERROR'   => 'E',
-      'FATAL'   => 'F',
+      'DEBUG' => 'D',
+      'INFO' => 'I',
+      'WARN' => 'W',
+      'ERROR' => 'E',
+      'FATAL' => 'F',
       'UNKNOWN' => 'U',
     }.each do |ruby_severity, formatted_severity|
       context "with severity #{ruby_severity}" do

data/spec/unit/loga/log_subscribers/action_mailer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'active_support'
 require 'loga/log_subscribers/action_mailer'
@@ -9,7 +11,7 @@ RSpec.describe Loga::LogSubscribers::ActionMailer do
 
   let(:event) do
     instance_double(
-      'ActiveSupport::Notifications::Event',
+      ActiveSupport::Notifications::Event,
       payload: payload,
       duration: 0.0001,
       time: Time.now,
@@ -21,7 +23,7 @@ RSpec.describe Loga::LogSubscribers::ActionMailer do
       let(:payload) do
         {
           mailer: 'FakeMailer',
-          to:     ['user@example.com'],
+          to: ['user@example.com'],
         }
       end
       let(:config) { instance_double Loga::Configuration, hide_pii: hide_pii }
@@ -82,8 +84,8 @@ RSpec.describe Loga::LogSubscribers::ActionMailer do
     context 'when an email is sent' do
       let(:payload) do
         {
-          mailer:  'FakeMailer',
-          from:    'loremipsum@example.com',
+          mailer: 'FakeMailer',
+          from: 'loremipsum@example.com',
           subject: 'Lorem ipsum',
         }
       end

data/spec/unit/loga/parameter_filter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Loga::ParameterFilter do

data/spec/unit/loga/rack/logger_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'rack/test'
 
@@ -40,22 +42,22 @@ describe Loga::Rack::Logger do
       middleware.call(env, started_at)
 
       expect(Loga::Event).to have_received(:new).with(
-        data:      {
+        data: {
           request: {
-            'status'     => response_status,
-            'method'     => 'GET',
-            'path'       => '/about_us',
-            'params'     => { 'limit' => '1' },
+            'status' => response_status,
+            'method' => 'GET',
+            'path' => '/about_us',
+            'params' => { 'limit' => '1' },
             'request_id' => nil,
             'request_ip' => nil,
             'user_agent' => nil,
-            'duration'   => 500,
+            'duration' => 500,
           },
         },
         exception: logged_exception,
-        message:   %r{^GET \/about_us\?limit=1 #{response_status} in \d+ms$},
+        message: %r{^GET /about_us\?limit=1 #{response_status} in \d+ms$},
         timestamp: started_at,
-        type:      'request',
+        type: 'request',
       )
     end
 
@@ -82,22 +84,22 @@ describe Loga::Rack::Logger do
         expect { middleware.call(env, started_at) }.to raise_error(exception_class)
 
         expect(Loga::Event).to have_received(:new).with(
-          data:      {
+          data: {
             request: {
-              'status'     => response_status,
-              'method'     => 'GET',
-              'path'       => '/about_us',
-              'params'     => { 'limit' => '1' },
+              'status' => response_status,
+              'method' => 'GET',
+              'path' => '/about_us',
+              'params' => { 'limit' => '1' },
               'request_id' => nil,
               'request_ip' => nil,
               'user_agent' => nil,
-              'duration'   => 500,
+              'duration' => 500,
             },
           },
           exception: logged_exception,
-          message:   %r{^GET \/about_us\?limit=1 #{response_status} in \d+ms$},
+          message: %r{^GET /about_us\?limit=1 #{response_status} in \d+ms$},
           timestamp: started_at,
-          type:      'request',
+          type: 'request',
         )
       end
     end