berkeley_library-logging 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88d32f15e7f95d27b1ec0ba158068a7d2950a22e89ae2b169fccc4aa385c3f6
-  data.tar.gz: '07193aef296c9b347993c02304ff506b9789ec45e6362b86180ab9da00c84519'
+  metadata.gz: 1c60520b7195f791061df89827e2a6c7b00ac1352262d7cf750511a125d30c02
+  data.tar.gz: bcb3ddb18cb7bfa442a52bbe5116316b74ae7f6d7c4e2e414812a5838e4a84fa
 SHA512:
-  metadata.gz: a1d6d0b7d9692ef52ea6b266d2cdf782d90bea3caa1cacc785191445b21b1fdf0daf6126ebdf0f45278635c3d9abed4f5b239dc4d013aab91410a2cb949165d5
-  data.tar.gz: 8eba0dc24f2d163827d415ccbbe780d0f3b23c3d5b6e583573b55c15a48d11e1c1ab6098c33cdc18b98461945f9ca19fad8c7158b572c9c8ec2825e35fd52a69
+  metadata.gz: '085e7cc941c61021cfa90d6c2f2cb7c53d05d8900dc067aa87cc2ba6302e96032e31683ff3e9d1d2ba62770556569ebda96566f81c8eee0eec50c7683ed00b36'
+  data.tar.gz: 0ca861efeca0e9b7c94cf87bbf410a0d826cfd9a1918e5b351148f102a9b8bbc64e4e7979aeb6044ab122def7d6bf82e798447ed19fe36ef7a34b47fa502ad61

data/.github/workflows/build.yml

@@ -6,7 +6,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest, macos-latest ]
-        ruby-version: [ '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0' ]
     runs-on: ${{ matrix.os }}
 
     steps:

data/.simplecov

@@ -1,4 +1,15 @@
 SimpleCov.start 'rails' do
   add_filter 'module_info.rb'
-  formatter SimpleCov::Formatter::SimpleFormatter
+
+  if ENV['GITHUB_ACTION']
+    formatter SimpleCov::Formatter::SimpleFormatter
+  else
+    # TODO: figure out why this doesn't work in CI
+    require 'simplecov-rcov'
+    coverage_dir 'artifacts'
+
+    SimpleCov.collate Dir['artifacts/simplecov/**/.resultset.json'] do
+      formatter SimpleCov::Formatter::RcovFormatter
+    end
+  end
 end

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.2.2 (2021-09-02)
+
+- JSON formatter now strips ANSI color escapes from strings
+  (fixes [#1](https://github.com/BerkeleyLibrary/logging/issues/1))
+
 # 0.2.1 (2021-08-19)
 
 - Recursively log error cause

data/berkeley_library-logging.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '~> 6.0'
   spec.add_dependency 'amazing_print', '~> 1.1'
+  spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_dependency 'lograge', '~> 0.11'
   spec.add_dependency 'ougai', '~> 1.8'
 

data/lib/berkeley_library/logging/formatters.rb

@@ -23,6 +23,15 @@ module BerkeleyLibrary
 
           { msg: message }
         end
+
+        def decolorize(message)
+          return unless message
+          return message.uncolorize if message.is_a?(String)
+          return message.map { |v| decolorize(v) } if message.is_a?(Array)
+          return message.transform_values { |v| decolorize(v) } if message.is_a?(Hash)
+
+          message
+        end
       end
 
       # ------------------------------------------------------------
@@ -78,11 +87,12 @@ module BerkeleyLibrary
 
         def _call(severity, time, progname, data)
           original_data = Formatters.ensure_hash(data)
+          decolorized_data = Formatters.decolorize(original_data)
 
           # Ougai::Formatters::Bunyan replaces the human-readable severity string
           # with a numeric level, so we add it here as a separate attribute
           severity = ensure_human_readable(severity)
-          merged_data = { severity: severity }.merge(original_data)
+          merged_data = { severity: severity }.merge(decolorized_data)
           super(severity, time, progname, merged_data)
         end
 

data/lib/berkeley_library/logging/module_info.rb

@@ -7,7 +7,7 @@ module BerkeleyLibrary
       SUMMARY = 'Opinionated Ruby/Rails logging for UC Berkeley Library'.freeze
       DESCRIPTION = 'A gem providing shared logging code for UC Berkeley Library gems and Rails applications'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.2.1'.freeze
+      VERSION = '0.2.2'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/logging'.freeze
 
       private_class_method :new

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

@@ -1,27 +1,72 @@
 require 'rails_helper'
 require 'json'
+require 'colorize'
 require 'berkeley_library/logging'
 
 module BerkeleyLibrary
   module Logging
     describe Formatters do
       describe :new_json_formatter do
-        it 'supports tagged logging' do
-          out = StringIO.new
-          logger = Logger.new(out)
+        attr_reader :out, :logger
+
+        before(:each) do
+          @out = StringIO.new
+          @logger = Logger.new(out)
           logger.formatter = Formatters.new_json_formatter
+        end
 
-          logger = ActiveSupport::TaggedLogging.new(logger)
+        it 'supports tagged logging' do
+          tagged_logger = ActiveSupport::TaggedLogging.new(logger)
 
           expected_tag = 'hello'
           expected_msg = 'this is a test'
 
-          logger.tagged(expected_tag) { logger.info(expected_msg) }
+          tagged_logger.tagged(expected_tag) { tagged_logger.info(expected_msg) }
 
           logged_json = JSON.parse(out.string)
           expect(logged_json['msg']).to eq(expected_msg)
           expect(logged_json['tags']).to eq([expected_tag])
         end
+
+        it 'decolorizes ANSI-colored strings' do
+          colors = %i[red green yellow blue magenta cyan]
+          colorized_string = colors.map { |c| c.to_s.colorize(c) }.join(' ')
+          expect(colorized_string).to include("\u001b") # just to be sure
+
+          expected_string = colors.map(&:to_s).join(' ')
+
+          logger.info(colorized_string)
+          logged_json = JSON.parse(out.string)
+          msg = logged_json['msg']
+          expect(msg).not_to include("\u001b")
+          expect(msg).to eq(expected_string)
+        end
+
+        it 'decolorizes ANSI-colored strings in attached data' do
+          colors = %i[red green yellow blue magenta cyan]
+          colorized_string = colors.map { |c| c.to_s.colorize(c) }.join(' ')
+          expect(colorized_string).to include("\u001b") # just to be sure
+
+          expected_string = colors.map(&:to_s).join(' ')
+
+          data = {
+            the_string: colorized_string,
+            additional_data: {
+              not_a_string: 12,
+              another_string: colorized_string,
+              more_strings: [colorized_string, colorized_string]
+            }
+          }
+          logger.info('a colorized string', data)
+
+          logged_json = JSON.parse(out.string)
+          data = logged_json
+          expect(data['the_string']).to eq(expected_string)
+          additional_data = data['additional_data']
+          expect(additional_data['not_a_string']).to eq(12)
+          expect(additional_data['another_string']).to eq(expected_string)
+          expect(additional_data['more_strings']).to eq([expected_string, expected_string])
+        end
       end
 
       describe :ensure_hash do

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

@@ -14,6 +14,20 @@ module BerkeleyLibrary
         Rails.env = orig_rails_env
       end
 
+      describe :new_readable_logger do
+        it 'logs ANSI colors' do
+          out = StringIO.new
+
+          logger = Loggers.new_readable_logger(out)
+          colors = %i[red green yellow blue magenta cyan]
+          colorized_string = colors.map { |c| c.to_s.colorize(c) }.join(' ')
+          expect(colorized_string).to include("\u001b") # just to be sure
+
+          logger.info(colorized_string)
+          expect(out.string).to include(colorized_string)
+        end
+      end
+
       describe :new_json_logger do
         it 'supports tagged logging' do
           out = StringIO.new

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

@@ -1,27 +1,70 @@
 require 'standalone_helper'
 require 'json'
+require 'colorize'
 require 'berkeley_library/logging'
 
 module BerkeleyLibrary
   module Logging
     describe Formatters do
       describe :new_json_formatter do
-        it 'supports tagged logging' do
-          out = StringIO.new
-          logger = Logger.new(out)
+        attr_reader :out, :logger
+
+        before(:each) do
+          @out = StringIO.new
+          @logger = Logger.new(out)
           logger.formatter = Formatters.new_json_formatter
+        end
 
-          logger = ActiveSupport::TaggedLogging.new(logger)
+        it 'supports tagged logging' do
+          tagged_logger = ActiveSupport::TaggedLogging.new(logger)
 
           expected_tag = 'hello'
           expected_msg = 'this is a test'
 
-          logger.tagged(expected_tag) { logger.info(expected_msg) }
+          tagged_logger.tagged(expected_tag) { tagged_logger.info(expected_msg) }
 
           logged_json = JSON.parse(out.string)
           expect(logged_json['msg']).to eq(expected_msg)
           expect(logged_json['tags']).to eq([expected_tag])
         end
+
+        it 'decolorizes ANSI-colored strings' do
+          colors = %i[red green yellow blue magenta cyan]
+          colorized_string = colors.map { |c| c.to_s.colorize(c) }.join(' ')
+          expect(colorized_string).to include("\u001b") # just to be sure
+
+          expected_string = colors.map(&:to_s).join(' ')
+
+          logger.info(colorized_string)
+          logged_json = JSON.parse(out.string)
+          msg = logged_json['msg']
+          expect(msg).not_to include("\u001b")
+          expect(msg).to eq(expected_string)
+        end
+
+        it 'decolorizes ANSI-colored strings in attached data' do
+          colors = %i[red green yellow blue magenta cyan]
+          colorized_string = colors.map { |c| c.to_s.colorize(c) }.join(' ')
+          expect(colorized_string).to include("\u001b") # just to be sure
+
+          expected_string = colors.map(&:to_s).join(' ')
+
+          data = {
+            the_string: colorized_string,
+            additional_data: {
+              another_string: colorized_string,
+              more_strings: [colorized_string, colorized_string]
+            }
+          }
+          logger.info('a colorized string', data)
+
+          logged_json = JSON.parse(out.string)
+          data = logged_json
+          expect(data['the_string']).to eq(expected_string)
+          additional_data = data['additional_data']
+          expect(additional_data['another_string']).to eq(expected_string)
+          expect(additional_data['more_strings']).to eq([expected_string, expected_string])
+        end
       end
 
       describe :ensure_hash do

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

@@ -1,5 +1,6 @@
 require 'standalone_helper'
 require 'json'
+require 'colorize'
 
 module BerkeleyLibrary
   module Logging
@@ -23,6 +24,18 @@ module BerkeleyLibrary
         Object.send(:remove_const, :TestError)
       end
 
+      describe :new_readable_logger do
+        it 'logs ANSI colors' do
+          logger = Loggers.new_readable_logger(out)
+          colors = %i[red green yellow blue magenta cyan]
+          colorized_string = colors.map { |c| c.to_s.colorize(c) }.join(' ')
+          expect(colorized_string).to include("\u001b") # just to be sure
+
+          logger.info(colorized_string)
+          expect(out.string).to include(colorized_string)
+        end
+      end
+
       describe :new_json_logger do
 
         # TODO: rewrite this as a matcher

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-logging
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: lograge
   requirement: !ruby/object:Gem::Requirement