berkeley_library-logging 0.2.3 → 0.2.6

data/spec/rails/ucblit/logging/formatters_spec.rb

@@ -9,7 +9,7 @@ module BerkeleyLibrary
       describe :new_json_formatter do
         attr_reader :out, :logger
 
-        before(:each) do
+        before do
           @out = StringIO.new
           @logger = Logger.new(out)
           logger.formatter = Formatters.new_json_formatter
@@ -68,6 +68,7 @@ module BerkeleyLibrary
           expect(additional_data['more_strings']).to eq([expected_string, expected_string])
         end
 
+        # rubocop:disable Layout/LineLength
         it 'removes ANSI formatting from ActiveRecord logs' do
           original = "  \e[1m\e[36mLendingItem Load (2.0ms)\e[0m  \e[1m\e[34mSELECT \"lending_items\".* FROM \"lending_items\" WHERE \"lending_items\".\"directory\" = $1 LIMIT $2\e[0m  [[\"directory\", \"b135297126_C068087930\"], [\"LIMIT\", 1]]"
           expected = '  LendingItem Load (2.0ms)  SELECT "lending_items".* FROM "lending_items" WHERE "lending_items"."directory" = $1 LIMIT $2  [["directory", "b135297126_C068087930"], ["LIMIT", 1]]'
@@ -76,6 +77,7 @@ module BerkeleyLibrary
           msg = logged_json['msg']
           expect(msg).to eq(expected)
         end
+        # rubocop:enable Layout/LineLength
       end
 
       describe :ensure_hash do

data/spec/rails/ucblit/logging/loggers_spec.rb

@@ -6,11 +6,11 @@ module BerkeleyLibrary
     describe Loggers do
       attr_reader :orig_rails_env
 
-      before(:each) do
+      before do
         @orig_rails_env = Rails.env
       end
 
-      after(:each) do
+      after do
         Rails.env = orig_rails_env
       end
 
@@ -46,8 +46,9 @@ module BerkeleyLibrary
       end
 
       describe :default_logger do
-        before(:each) { @rails_logger = Rails.logger }
-        after(:each) { Rails.logger = @rails_logger }
+        before { @rails_logger = Rails.logger }
+
+        after { Rails.logger = @rails_logger }
 
         it 'returns the Rails logger' do
           expected_logger = double(::Logger)
@@ -86,7 +87,7 @@ module BerkeleyLibrary
       describe :new_default_logger do
         attr_reader :config
 
-        before(:each) do
+        before do
           app = Class.new(Rails::Application).new
           @config = app.config
         end

data/spec/rails/ucblit/logging/railtie_spec.rb

@@ -6,7 +6,7 @@ module BerkeleyLibrary
       attr_reader :app
       attr_reader :config
 
-      before(:each) do
+      before do
         @app = Class.new(Rails::Application).new
         allow(Rails).to receive(:application).and_return(app)
         @config = app.config
@@ -16,7 +16,7 @@ module BerkeleyLibrary
         attr_reader :logging_initializer
         attr_reader :bootstrap_logger_initializer
 
-        before(:each) do
+        before do
           expected_file, _line = Module.const_source_location(BerkeleyLibrary::Logging::Railtie.name)
           @logging_initializer = app.initializers.find do |init|
             block = init.block

data/spec/rails/ucblit/logging/safe_serializer_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+require 'active_support/time'
+
+module BerkeleyLibrary
+  module Logging
+    describe SafeSerializer do
+      describe :serialize do
+        it 'handles ActiveSupport::TimeWithZone' do
+          Time.zone = 'America/Los_Angeles'
+
+          t = Time.current
+          expect(t).to be_a(ActiveSupport::TimeWithZone) # just to be sure
+
+          expect(SafeSerializer.serialize(t)).to be(t)
+
+          h = { time: t }
+          expect(SafeSerializer.serialize(h)).to eq(h)
+        end
+      end
+    end
+  end
+end

data/spec/rails/ucblit/logging_spec.rb

@@ -25,7 +25,7 @@ module BerkeleyLibrary
       mock_logger_class.new
     end
 
-    before(:each) do
+    before do
       @rails_logger_orig = Rails.logger
       Rails.logger = new_mock_logger
 
@@ -35,7 +35,7 @@ module BerkeleyLibrary
       end
     end
 
-    after(:each) do
+    after do
       @logger_was_defined ? reset_logger! : undefine_logger!
       Rails.logger = @rails_logger_orig
     end
@@ -74,7 +74,7 @@ module BerkeleyLibrary
     describe 'included' do
       attr_reader :logificator
 
-      before(:each) do
+      before do
         @logificator = Object.new
         @logificator.singleton_class.include(Logging)
       end

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ if ENV['COVERAGE']
   spec_group_re = %r{(?<=^#{spec_root}/)[^/]+(?=/)}
 
   RSpec.configure do |config|
-    config.before(:each) do |example|
+    config.before do |example|
       abs_path = File.realpath(example.metadata[:absolute_file_path])
       match_data = spec_group_re.match(abs_path)
       raise ArgumentError, "Unable to determine group for example at #{abs_path}" unless match_data

data/spec/standalone/ucblit/logging/configurator_spec.rb

@@ -8,7 +8,7 @@ module BerkeleyLibrary
       describe :configure! do
         attr_reader :config
 
-        before(:each) do
+        before do
           @stdout_orig = $stdout
           $stdout = StringIO.new
 
@@ -16,7 +16,7 @@ module BerkeleyLibrary
           config.lograge = Lograge::OrderedOptions.new
         end
 
-        after(:each) do
+        after do
           $stdout = @stdout_orig
         end
 

data/spec/standalone/ucblit/logging/formatters_spec.rb

@@ -9,7 +9,7 @@ module BerkeleyLibrary
       describe :new_json_formatter do
         attr_reader :out, :logger
 
-        before(:each) do
+        before do
           @out = StringIO.new
           @logger = Logger.new(out)
           logger.formatter = Formatters.new_json_formatter
@@ -66,6 +66,7 @@ module BerkeleyLibrary
           expect(additional_data['more_strings']).to eq([expected_string, expected_string])
         end
 
+        # rubocop:disable Layout/LineLength
         it 'removes ANSI formatting from ActiveRecord logs' do
           original = "  \e[1m\e[36mLendingItem Load (2.0ms)\e[0m  \e[1m\e[34mSELECT \"lending_items\".* FROM \"lending_items\" WHERE \"lending_items\".\"directory\" = $1 LIMIT $2\e[0m  [[\"directory\", \"b135297126_C068087930\"], [\"LIMIT\", 1]]"
           expected = '  LendingItem Load (2.0ms)  SELECT "lending_items".* FROM "lending_items" WHERE "lending_items"."directory" = $1 LIMIT $2  [["directory", "b135297126_C068087930"], ["LIMIT", 1]]'
@@ -74,6 +75,7 @@ module BerkeleyLibrary
           msg = logged_json['msg']
           expect(msg).to eq(expected)
         end
+        # rubocop:enable Layout/LineLength
       end
 
       describe :ensure_hash do

data/spec/standalone/ucblit/logging/loggers_spec.rb

@@ -8,7 +8,7 @@ module BerkeleyLibrary
       attr_reader :out
 
       # rubocop:disable Lint/ConstantDefinitionInBlock
-      before(:each) do
+      before do
         @out = StringIO.new
         class ::TestError < StandardError
           attr_writer :cause
@@ -20,7 +20,7 @@ module BerkeleyLibrary
       end
       # rubocop:enable Lint/ConstantDefinitionInBlock
 
-      after(:each) do
+      after do
         Object.send(:remove_const, :TestError)
       end
 
@@ -39,7 +39,6 @@ module BerkeleyLibrary
       describe :new_json_logger do
 
         # TODO: rewrite this as a matcher
-        # rubocop:disable Metrics/AbcSize
         def assert_serialized_error(err_json, err)
           expect(err_json).to be_a(Hash)
           expect(err_json['name']).to eq(TestError.name)
@@ -52,8 +51,6 @@ module BerkeleyLibrary
             expect(err_stack).to include(line)
           end
         end
-        # rubocop:enable Metrics/AbcSize
-
         it 'supports tagged logging' do
           logger = Loggers.new_json_logger(out)
           logger = ActiveSupport::TaggedLogging.new(logger)
@@ -127,7 +124,14 @@ module BerkeleyLibrary
           end
         end
 
-        expect { Loggers.new_json_logger(out).error(ex_outer) }.not_to raise_error(SystemStackError)
+        begin
+          Loggers.new_json_logger(out).error(ex_outer)
+        rescue SystemStackError => e
+          RSpec::Expectations.fail_with("Expected no SystemStackError, but got #{e}: #{e.backtrace[0]}")
+        end
+
+        expect(out.string).to include(msg_outer)
+        expect(out.string).to include(msg_inner)
       end
       # rubocop:enable Naming/RescuedExceptionsVariableName
 
@@ -322,11 +326,11 @@ module BerkeleyLibrary
       describe :new_default_logger do
         attr_reader :config
 
-        before(:each) do
+        before do
           @config = OpenStruct.new
         end
 
-        after(:each) do
+        after do
           BerkeleyLibrary::Logging.instance_variable_set(:@env, nil)
         end
 

data/spec/standalone/ucblit/logging/safe_serializer_spec.rb

@@ -0,0 +1,137 @@
+require 'standalone_helper'
+
+module BerkeleyLibrary
+  module Logging
+    describe SafeSerializer do
+      describe :serialize do
+        it 'returns primitives unchanged' do
+          values = [
+            nil,
+            false,
+            true,
+            1,
+            1.0,
+            '1/3'.to_r,
+            'a string',
+            :a_symbol,
+            Date.today,
+            Time.now
+          ]
+
+          aggregate_failures do
+            values.each do |original|
+              actual = SafeSerializer.serialize(original)
+              expect(actual).to be(original)
+            end
+          end
+        end
+
+        it 'returns an object as a string' do
+          value = Object.new
+          expect(SafeSerializer.serialize(value)).to eq(value.to_s)
+        end
+
+        it 'returns a hash as a hash' do
+          hash = { a: 1, b: 2 }
+          expect(SafeSerializer.serialize(hash)).to eq(hash)
+        end
+
+        it 'returns an array as an array' do
+          arr = [0, 1, 2, 'elvis', false]
+          expect(SafeSerializer.serialize(arr)).to eq(arr)
+        end
+
+        it 'cleans nested values' do
+          b_value = Object.new
+          c_key = Object.new
+          d_value = Object.new
+
+          d_array = ['d', :d, { d: "\ud7ff", 'd' => d_value }]
+
+          h = {
+            a: 1,
+            b: b_value,
+            c_key => 'c value',
+            0xd => d_array,
+            "\uEEEE" => 0xe
+          }
+
+          expected = {
+            a: 1,
+            b: b_value.to_s,
+            c_key.to_s => 'c value',
+            0xd => ['d', :d, { d: "\ud7ff", 'd' => d_value.to_s }],
+            "\uEEEE" => 0xe
+          }
+
+          actual = SafeSerializer.serialize(h)
+          expect(actual).to eq(expected)
+        end
+
+        it 'handles recursive structures' do
+          a = []
+          h = { a: a }
+          a << h
+
+          h_expected = { a: [SafeSerializer.placeholder_for(h)] }
+          a_expected = [{ a: SafeSerializer.placeholder_for(a) }]
+
+          expect(SafeSerializer.serialize(h)).to eq(h_expected)
+          expect(SafeSerializer.serialize(a)).to eq(a_expected)
+        end
+
+        context 'exceptions' do
+          # rubocop:disable Lint/ConstantDefinitionInBlock
+          before do
+            class ::TestError < StandardError
+              attr_writer :cause
+
+              def cause
+                @cause || super
+              end
+            end
+          end
+          # rubocop:enable Lint/ConstantDefinitionInBlock
+
+          after do
+            Object.send(:remove_const, :TestError)
+          end
+
+          # rubocop:disable Naming/RescuedExceptionsVariableName
+          it 'handles exceptions' do
+            msg_outer = 'Help I am trapped in the outer part of a unit test'
+            msg_inner = 'Help I am trapped in the inner part of a unit test'
+
+            begin
+              raise TestError, msg_inner
+            rescue TestError => ex_inner
+              begin
+                raise TestError, msg_outer
+              rescue TestError => ex_outer
+                ex_inner.cause = ex_outer
+              end
+            end
+
+            expect(ex_outer.cause).to eq(ex_inner) # just to be sure
+            expect(ex_inner.cause).to eq(ex_outer) # just to be sure
+
+            expected = {
+              name: 'TestError',
+              message: msg_outer,
+              stack: ex_outer.backtrace,
+              cause: {
+                name: 'TestError',
+                message: msg_inner,
+                stack: ex_inner.backtrace
+              }
+            }
+
+            expect(SafeSerializer.serialize(ex_outer)).to eq(expected)
+          end
+          # rubocop:enable Naming/RescuedExceptionsVariableName
+
+        end
+      end
+    end
+  end
+end

data/spec/standalone/ucblit/logging_spec.rb

@@ -25,7 +25,7 @@ module BerkeleyLibrary
       mock_logger_class.new
     end
 
-    before(:each) do
+    before do
       if (@logger_was_defined = logger_defined?)
         @logging_logger_orig = Logging.instance_variable_get(:@logger)
         undefine_logger!
@@ -37,7 +37,7 @@ module BerkeleyLibrary
       allow(Logging::Loggers).to receive(:default_logger).and_return(persistent_default_logger)
     end
 
-    after(:each) do
+    after do
       @logger_was_defined ? reset_logger! : undefine_logger!
     end
 
@@ -75,7 +75,7 @@ module BerkeleyLibrary
     describe 'included' do
       attr_reader :logificator
 
-      before(:each) do
+      before do
         @logificator = Object.new
         @logificator.singleton_class.include(Logging)
       end

data/spec/standalone_helper.rb

@@ -7,7 +7,7 @@ require 'spec_helper'
 # RSpec
 
 RSpec.configure do |config|
-  config.around(:example) do |example|
+  config.around do |example|
     next example.run unless defined?(Rails)
 
     rails_orig = Object.send(:remove_const, :Rails)

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-logging
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -174,14 +174,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -218,14 +218,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: 1.26.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -290,17 +304,20 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- artifacts/.keep
 - berkeley_library-logging.gemspec
 - docker-compose.yml
 - lib/berkeley_library/logging.rb
 - lib/berkeley_library/logging/configurator.rb
 - lib/berkeley_library/logging/env.rb
 - lib/berkeley_library/logging/events.rb
+- lib/berkeley_library/logging/exception_serializer.rb
 - lib/berkeley_library/logging/formatters.rb
 - lib/berkeley_library/logging/logger.rb
 - lib/berkeley_library/logging/loggers.rb
 - lib/berkeley_library/logging/module_info.rb
 - lib/berkeley_library/logging/railtie.rb
+- lib/berkeley_library/logging/safe_serializer.rb
 - lib/berkeley_library/logging/tagged_logging_extensions.rb
 - rakelib/.rubocop.yml
 - rakelib/bundle.rake
@@ -314,18 +331,21 @@ files:
 - spec/rails/ucblit/logging/formatters_spec.rb
 - spec/rails/ucblit/logging/loggers_spec.rb
 - spec/rails/ucblit/logging/railtie_spec.rb
+- spec/rails/ucblit/logging/safe_serializer_spec.rb
 - spec/rails/ucblit/logging_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/standalone/ucblit/logging/configurator_spec.rb
 - spec/standalone/ucblit/logging/formatters_spec.rb
 - spec/standalone/ucblit/logging/loggers_spec.rb
+- spec/standalone/ucblit/logging/safe_serializer_spec.rb
 - spec/standalone/ucblit/logging_spec.rb
 - spec/standalone_helper.rb
 homepage: https://github.com/BerkeleyLibrary/logging
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -341,22 +361,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Opinionated Ruby/Rails logging for UC Berkeley Library
 test_files:
+- artifacts/.keep
 - spec/.rubocop.yml
 - spec/rails/ucblit/logging/configurator_spec.rb
 - spec/rails/ucblit/logging/env_spec.rb
 - spec/rails/ucblit/logging/formatters_spec.rb
 - spec/rails/ucblit/logging/loggers_spec.rb
 - spec/rails/ucblit/logging/railtie_spec.rb
+- spec/rails/ucblit/logging/safe_serializer_spec.rb
 - spec/rails/ucblit/logging_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/standalone/ucblit/logging/configurator_spec.rb
 - spec/standalone/ucblit/logging/formatters_spec.rb
 - spec/standalone/ucblit/logging/loggers_spec.rb
+- spec/standalone/ucblit/logging/safe_serializer_spec.rb
 - spec/standalone/ucblit/logging_spec.rb
 - spec/standalone_helper.rb