lograge 0.11.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b182acc461273304ebb8b5395f65c4eeec4a170639d0b52b0d608a1aa786c03
-  data.tar.gz: e558ad86b2ae007d24c18d3e15ca2262f61432058508c22feba1c0f63d5ec9be
+  metadata.gz: 0d989dce1202da74220c6ac7926c3ef413502644e6f456589a334278ea357a4d
+  data.tar.gz: be68c46645948d5cc157a475b8820f50453fecaf9cc5e0f23bc842ec432eaa48
 SHA512:
-  metadata.gz: d9bda7af87bbd4020194aae53d44f29585eadf590d03e490276f025dadbb5bc189d94e9e270437bbb857c0b3da91b9a91f1ba7c833d84d19f835bae7b1960c09
-  data.tar.gz: 125e9f98472208bc85f5fe2f810ccfae3b26c53511204fc96a808bfdf2fd1fa8046ada14a4c001abf7d59cf5c2b81eb3a5a5020eddc994fb22e8b68eb9b632af
+  metadata.gz: 273878d74ebdf36f2e703f6c4f0c70e6e17633f13dfc82bc7297ee5b209bb640a09da601768d16d4ca839bb22dfad7f0b8ee832676e4d94d4a96a90b1b5bfadc
+  data.tar.gz: c8503e3b547652a44076a858d0d566b1c75a273ef3efc6357398f7d5c41be7b656cf09687f96c1fe2437d16e4d8c8a657bfb7665055dab16e3a05230adf80e40

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Mathias Meyer
+Copyright (c) Mathias Meyer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/lograge/formatters/cee.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Cee

data/lib/lograge/formatters/graylog2.rb

@@ -1,23 +1,15 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Graylog2
       include Lograge::Formatters::Helpers::MethodAndPath
 
       def call(data)
-        # Cloning because we don't want to mess with the original when mutating keys.
-        data_clone = data.clone
-
-        base = {
-          short_message: short_message(data_clone)
-        }
-
         # Add underscore to every key to follow GELF additional field syntax.
-        data_clone.keys.each do |key|
-          data_clone[underscore_prefix(key)] = data_clone[key]
-          data_clone.delete(key)
-        end
-
-        data_clone.merge(base)
+        data.transform_keys { |k| underscore_prefix(k) }.merge(
+          short_message: short_message(data)
+        )
       end
 
       def underscore_prefix(key)

data/lib/lograge/formatters/helpers/method_and_path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     module Helpers

data/lib/lograge/formatters/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 module Lograge
   module Formatters

data/lib/lograge/formatters/key_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class KeyValue

data/lib/lograge/formatters/key_value_deep.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lograge
+  module Formatters
+    class KeyValueDeep < KeyValue
+      def call(data)
+        super flatten_keys(data)
+      end
+
+      protected
+
+      def flatten_keys(data, prefix = '')
+        return flatten_object(data, prefix) if [Hash, Array].include? data.class
+
+        data
+      end
+
+      def flatten_object(data, prefix)
+        result = {}
+        loop_on_object(data) do |key, value|
+          key = "#{prefix}_#{key}" unless prefix.empty?
+          if [Hash, Array].include? value.class
+            result.merge!(flatten_keys(value, key))
+          else
+            result[key] = value
+          end
+        end
+        result
+      end
+
+      def loop_on_object(data, &block)
+        if data.instance_of? Array
+          data.each_with_index do |value, index|
+            yield index, value
+          end
+          return
+        end
+        data.each(&block)
+      end
+    end
+  end
+end

data/lib/lograge/formatters/l2met.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 require 'lograge/formatters/key_value'
 
 module Lograge
   module Formatters
     class L2met < KeyValue
-      L2MET_FIELDS = [
-        :method,
-        :path,
-        :format,
-        :source,
-        :status,
-        :error,
-        :duration,
-        :view,
-        :db,
-        :location
+      L2MET_FIELDS = %i[
+        method
+        path
+        format
+        source
+        status
+        error
+        duration
+        view
+        db
+        location
       ].freeze
 
-      UNWANTED_FIELDS = [
-        :controller,
-        :action
+      UNWANTED_FIELDS = %i[
+        controller
+        action
       ].freeze
 
       def call(data)

data/lib/lograge/formatters/lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Lines

data/lib/lograge/formatters/logstash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Logstash

data/lib/lograge/formatters/ltsv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class LTSV

data/lib/lograge/formatters/raw.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module Formatters
     class Raw

data/lib/lograge/log_subscribers/action_cable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Lograge
   module LogSubscribers
     class ActionCable < Base
-      %i(perform_action subscribe unsubscribe connect disconnect).each do |method_name|
+      %i[perform_action subscribe unsubscribe connect disconnect].each do |method_name|
         define_method(method_name) do |event|
           process_main_event(event)
         end
@@ -11,9 +13,9 @@ module Lograge
 
       def initial_data(payload)
         {
-          method: {},
-          path: {},
-          format: {},
+          method: nil,
+          path: nil,
+          format: nil,
           params: payload[:data],
           controller: payload[:channel_class] || payload[:connection_class],
           action: payload[:action]

data/lib/lograge/log_subscribers/action_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
   module LogSubscribers
     class ActionController < Base

data/lib/lograge/log_subscribers/base.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'action_pack'
+require 'active_support'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/log_subscriber'
 require 'request_store'
@@ -26,14 +29,15 @@ module Lograge
       def extract_request(event, payload)
         data = initial_data(payload)
         data.merge!(extract_status(payload))
+        data.merge!(extract_allocations(event))
         data.merge!(extract_runtimes(event, payload))
         data.merge!(extract_location)
         data.merge!(extract_unpermitted_params)
         data.merge!(custom_options(event))
       end
 
-      %i(initial_data extract_status extract_runtimes
-         extract_location extract_unpermitted_params).each do |method_name|
+      %i[initial_data extract_status extract_runtimes
+         extract_location extract_unpermitted_params].each do |method_name|
         define_method(method_name) { |*_arg| {} }
       end
 
@@ -52,9 +56,16 @@ module Lograge
         0
       end
 
-      def get_error_status_code(exception)
-        status = ActionDispatch::ExceptionWrapper.rescue_responses[exception]
-        Rack::Utils.status_code(status)
+      def get_error_status_code(exception_class_name)
+        ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+      end
+
+      def extract_allocations(event)
+        if (allocations = (event.respond_to?(:allocations) && event.allocations))
+          { allocations: allocations }
+        else
+          {}
+        end
       end
 
       def custom_options(event)

data/lib/lograge/ordered_options.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support'
 require 'active_support/ordered_options'
 
 module Lograge

data/lib/lograge/rails_ext/action_cable/channel/base.rb

@@ -1,22 +1,15 @@
-module ActionCable
-  module Channel
-    class Base
-      def subscribe_to_channel
-        ActiveSupport::Notifications.instrument('subscribe.action_cable', notification_payload('subscribe')) do
-          run_callbacks :subscribe do
-            subscribed
-          end
+# frozen_string_literal: true
 
-          reject_subscription if subscription_rejected?
-          ensure_confirmation_sent
-        end
+module Lograge
+  module ActionCable
+    module ChannelInstrumentation
+      def subscribe_to_channel
+        ActiveSupport::Notifications.instrument('subscribe.action_cable', notification_payload('subscribe')) { super }
       end
 
       def unsubscribe_from_channel
         ActiveSupport::Notifications.instrument('unsubscribe.action_cable', notification_payload('unsubscribe')) do
-          run_callbacks :unsubscribe do
-            unsubscribed
-          end
+          super
         end
       end
 
@@ -28,3 +21,5 @@ module ActionCable
     end
   end
 end
+
+ActionCable::Channel::Base.prepend(Lograge::ActionCable::ChannelInstrumentation)

data/lib/lograge/rails_ext/action_cable/connection/base.rb

@@ -1,42 +1,21 @@
-module ActionCable
-  module Connection
-    class Base
-      # rubocop:disable Metrics/MethodLength
-      def handle_open
-        ActiveSupport::Notifications.instrument('connect.action_cable', notification_payload('connect')) do
-          begin
-            @protocol = websocket.protocol
-            connect if respond_to?(:connect)
-            subscribe_to_internal_channel
-            send_welcome_message
+# frozen_string_literal: true
 
-            message_buffer.process!
-            server.add_connection(self)
-          rescue ActionCable::Connection::Authorization::UnauthorizedError
-            respond_to_invalid_request
-          end
-        end
+module Lograge
+  module ActionCable
+    module ConnectionInstrumentation
+      def handle_open
+        ActiveSupport::Notifications.instrument('connect.action_cable', notification_payload('connect')) { super }
       end
-      # rubocop:enable Metrics/MethodLength
 
       def handle_close
-        ActiveSupport::Notifications.instrument('disconnect.action_cable', notification_payload('disconnect')) do
-          logger.info finished_request_message if Lograge.lograge_config.keep_original_rails_log
-
-          server.remove_connection(self)
-
-          subscriptions.unsubscribe_from_all
-          unsubscribe_from_internal_channel
-
-          disconnect if respond_to?(:disconnect)
-        end
+        ActiveSupport::Notifications.instrument('disconnect.action_cable', notification_payload('disconnect')) { super }
       end
 
-      private
-
       def notification_payload(method_name)
         { connection_class: self.class.name, action: method_name, data: request.params }
       end
     end
   end
 end
+
+ActionCable::Connection::Base.prepend(Lograge::ActionCable::ConnectionInstrumentation)

data/lib/lograge/rails_ext/action_cable/server/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Server
     class Base

data/lib/lograge/rails_ext/rack/logger.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support'
 require 'active_support/concern'
 require 'rails/rack/logger'
 
@@ -9,17 +12,19 @@ module Rails
     # that say:
     # Started GET / for 192.168.2.1...
     class Logger
-      # Overwrites Rails 3.2 code that logs new requests
+      # Overwrites Rails code that logs new requests
       def call_app(*args)
         env = args.last
-        @app.call(env)
+        status, headers, body = @app.call(env)
+        # needs to have same return type as the Rails builtins being overridden, see https://github.com/roidrage/lograge/pull/333
+        # https://github.com/rails/rails/blob/be9d34b9bcb448b265114ebc28bef1a5b5e4c272/railties/lib/rails/rack/logger.rb#L37
+        [status, headers, ::Rack::BodyProxy.new(body) {}] # rubocop:disable Lint/EmptyBlock
       ensure
         ActiveSupport::LogSubscriber.flush_all!
       end
 
       # Overwrites Rails 3.0/3.1 code that logs new requests
-      def before_dispatch(_env)
-      end
+      def before_dispatch(_env); end
     end
   end
 end

data/lib/lograge/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'action_view/log_subscriber'
 require 'action_controller/log_subscriber'
@@ -7,6 +9,10 @@ module Lograge
     config.lograge = Lograge::OrderedOptions.new
     config.lograge.enabled = false
 
+    initializer :deprecator do |app|
+      app.deprecators[:lograge] = Lograge.deprecator if app.respond_to?(:deprecators)
+    end
+
     config.after_initialize do |app|
       Lograge.setup(app) if app.config.lograge.enabled
     end

data/lib/lograge/silent_logger.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
 module Lograge
   class SilentLogger < SimpleDelegator
-    def initialize(logger)
-      super
-    end
-
-    %i(debug info warn error fatal unknown).each do |method_name|
+    %i[debug info warn error fatal unknown].each do |method_name|
+      # rubocop:disable Lint/EmptyBlock
       define_method(method_name) { |*_args| }
+      # rubocop:enable Lint/EmptyBlock
     end
   end
 end

data/lib/lograge/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lograge
-  VERSION = '0.11.2'.freeze
+  VERSION = '0.14.0'
 end

data/lib/lograge.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'lograge/version'
 require 'lograge/formatters/helpers/method_and_path'
 require 'lograge/formatters/cee'
 require 'lograge/formatters/json'
 require 'lograge/formatters/graylog2'
 require 'lograge/formatters/key_value'
+require 'lograge/formatters/key_value_deep'
 require 'lograge/formatters/l2met'
 require 'lograge/formatters/lines'
 require 'lograge/formatters/logstash'
@@ -14,10 +17,11 @@ require 'lograge/log_subscribers/action_cable'
 require 'lograge/log_subscribers/action_controller'
 require 'lograge/silent_logger'
 require 'lograge/ordered_options'
+require 'active_support'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 
-# rubocop:disable ModuleLength
+# rubocop:disable Metrics/ModuleLength
 module Lograge
   module_function
 
@@ -116,10 +120,8 @@ module Lograge
   def unsubscribe(component, subscriber)
     events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
     events.each do |event|
-      ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-        if listener.instance_variable_get('@delegate') == subscriber
-          ActiveSupport::Notifications.unsubscribe listener
-        end
+      Lograge.notification_listeners_for("#{event}.#{component}").each do |listener|
+        ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate') == subscriber
       end
     end
   end
@@ -203,7 +205,7 @@ module Lograge
   end
 
   def rack_cache_hashlike?(app)
-    app.config.action_dispatch.rack_cache && app.config.action_dispatch.rack_cache.respond_to?(:[]=)
+    app.config.action_dispatch.rack_cache&.respond_to?(:[]=)
   end
   private_class_method :rack_cache_hashlike?
 
@@ -214,7 +216,7 @@ module Lograge
 
     legacy_log_format = lograge_config.log_format
     warning = 'config.lograge.log_format is deprecated. Use config.lograge.formatter instead.'
-    ActiveSupport::Deprecation.warn(warning, caller)
+    deprecator.warn(warning, caller)
     legacy_log_format = :key_value if legacy_log_format == :lograge
     lograge_config.formatter = "Lograge::Formatters::#{legacy_log_format.to_s.classify}".constantize.new
   end
@@ -222,6 +224,22 @@ module Lograge
   def lograge_config
     application.config.lograge
   end
+
+  def deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'Lograge')
+  end
+
+  if ::ActiveSupport::VERSION::MAJOR >= 8 ||
+     (::ActiveSupport::VERSION::MAJOR >= 7 && ::ActiveSupport::VERSION::MINOR >= 1)
+    def notification_listeners_for(name)
+      ActiveSupport::Notifications.notifier.all_listeners_for(name)
+    end
+  else
+    def notification_listeners_for(name)
+      ActiveSupport::Notifications.notifier.listeners_for(name)
+    end
+  end
 end
+# rubocop:enable Metrics/ModuleLength
 
 require 'lograge/railtie' if defined?(Rails)

metadata

@@ -1,46 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: lograge
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Mathias Meyer
 - Ben Lovell
-autorequire: 
+- Michael Bianco
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '1.23'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -99,6 +114,7 @@ description: Tame Rails' multi-line logging into a single line per request
 email:
 - meyer@paperplanes.de
 - benjamin.lovell@gmail.com
+- mike@mikebian.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,6 +126,7 @@ files:
 - lib/lograge/formatters/helpers/method_and_path.rb
 - lib/lograge/formatters/json.rb
 - lib/lograge/formatters/key_value.rb
+- lib/lograge/formatters/key_value_deep.rb
 - lib/lograge/formatters/l2met.rb
 - lib/lograge/formatters/lines.rb
 - lib/lograge/formatters/logstash.rb
@@ -129,8 +146,10 @@ files:
 homepage: https://github.com/roidrage/lograge
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  changelog_uri: https://github.com/roidrage/lograge/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,16 +157,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Tame Rails' multi-line logging into a single line per request
 test_files: []