rails_custom_logging 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a8cf2972315f37dc34b1a93b0a35c9f16fcf5a4446c1be943185976aa8b4ded
-  data.tar.gz: 77b245d3dd1cc94996f9c2192efaf3bd05e53c3d2a0011b1e0979ca940c7fa16
+  metadata.gz: 30e889ddb6c1d71e3d4421e86b1dd75f14abb92c8e06da9718f7faf2f4e00796
+  data.tar.gz: e912f4562b9d71502284fd19101eff6b30cb988d08e58ab60cbf9ac31626bc4f
 SHA512:
-  metadata.gz: 93e886789b96665662ad93e05f166f5fff1bc5ef1d68dd45e84c501273db2b9f413f4f13b812c92017f6c370777e7ae72bdb8ab12f6d6d171d8b9a1dd7072944
-  data.tar.gz: 40490845dda83e4a27d6d340426441d1a9a410629d0a602c91f5b8dea83775d3be4d499826a22d410cbda1ed683da45038d500570e046a3734dd0e712defc360
+  metadata.gz: 136e2d7325bbe61f219b16f0b7603e306cda5687d0ddb87cf08b771660685652f228527ac1307738d711aaffdf1929cc28c802c2f3ece40286602065e7a677af
+  data.tar.gz: 8a7d941f7b6c870fa71fc8679e7d81d3b1e85811f21509e5f9c8e39c2ca491b9fadc47c8018562eb8115ad3d4d0c18a6dfdfa6d58ad3c031d75de5a52c4eb00c

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+/.byebug_history
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+env:
+  - "RAILS_VERSION=6.0.0"
+  - "RAILS_VERSION=6.1.0"
+  - "RAILS_VERSION=7.0.0"
+rvm:
+  - 2.6.5
+  - 2.7.2
+  - 3.0.0
+before_install: gem update bundler
+jobs:
+  exclude:
+  - rvm: 2.6.5
+    env: "RAILS_VERSION=7.0.0"

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+## 0.2.0
+  * Drop support for Rails 5.2
+  * Add support for Rails 7
+  * Add travis configuration
+  * Remove `request` and `response` from the default formatter's result
+
+## 0.1.0
+  * Initial release

data/Gemfile

@@ -5,5 +5,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rails_custom_logging.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+version = case rails_version
+when 'master'
+  { github: 'rails/rails' }
+when "default"
+  '~> 6.1.3'
+else
+  "~> #{rails_version}"
+end
+
+gem 'activerecord', version
+gem 'activesupport', version

data/README.md

@@ -1,8 +1,9 @@
-# RailsCustomLogging
+# Rails Custom Logging
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_custom_logging`. To experiment with that code, run `bin/console` for an interactive prompt.
+An oponionated yet fully customizable way to tranform your Rails logs into useful data.
 
-TODO: Delete this and the text above, and describe your gem
+Currently supported Ruby versions: 2.6, 2.7, 3.0.
+Currently supported Rails versions: 6.0, 6.1, 7.0
 
 ## Installation
 
@@ -12,23 +13,21 @@ Add this line to your application's Gemfile:
 gem 'rails_custom_logging'
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install rails_custom_logging
-
 ## Usage
 
-TODO: Write usage instructions here
+Enable the gem in an initializer or in any environment config:
 
-## Development
+```ruby
+# config/initializers/logging.rb
+
+RailsCustomLogging.configure do |config|
+  config.enabled = Rails.env.production?
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Customization
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+TODO
 
 ## Contributing
 

data/lib/rails_custom_logging/formatters/key_value.rb

@@ -7,10 +7,12 @@ module RailsCustomLogging
       # MRI trick to force the order of the payload keys with a very light cost of a single
       # merge. MRI hash's `to_a` method will return values in the order in which they are
       # defined by implemention. `merge` follows the same pattern.
-      #
       # If you're using another implemention of Ruby (jRuby/truffleruby) you might end up
       # with unordered keys.
       #
+      # Additional keys in the payload will be added at the end, ordering being left at
+      # your discretion.
+      #
       ORDERED_HASH = {
         method: nil, path: nil, params: nil, format: nil, status: nil, controller: nil,
         action: nil, duration: nil, db_runtime: nil, view_runtime: nil, allocations: nil

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

@@ -1,6 +1,6 @@
 module RailsCustomLogging
   module Rack
-    # Replace `Rails::Rack::Logger` middleware with this one to avoid pesky Rack logs
+    # Replaces `Rails::Rack::Logger` middleware with this one to avoid pesky Rack logs
     # lines like `Started GET /`.
     #
     class Logger

data/lib/rails_custom_logging/railtie.rb

@@ -1,22 +1,14 @@
-require_relative 'rails_ext/rack/logger'
-
 module RailsCustomLogging
   class Railtie < Rails::Railtie
     initializer 'rails_custom_logging.middleware', after: :load_config_initializers do |app|
       if RailsCustomLogging.enabled?
+        require_relative 'rails_ext/rack/logger'
         app.middleware.swap Rails::Rack::Logger, RailsCustomLogging::Rack::Logger
       end
     end
 
     config.after_initialize do |app|
-      if RailsCustomLogging.enabled?
-        if Rails::VERSION::MAJOR < 6
-          # Adds missing `detach_from` method in subscriber
-          require 'rails_custom_logging/rails_ext/active_support/subscriber'
-        end
-
-        RailsCustomLogging.setup(app)
-      end
+      RailsCustomLogging.setup(app) if RailsCustomLogging.enabled?
     end
   end
 end

data/lib/rails_custom_logging/transformers/default.rb

@@ -2,17 +2,43 @@
 
 module RailsCustomLogging
   module Transformers
+    # Transforms a ActiveSupport::Notifications::Event into a Hash with
+    # basic values any application could use.
+    #
     module Default
-      def self.call(event)
-        payload = event.payload.dup
+      class << self
+        def call(event)
+          payload = event.payload.dup
 
-        payload[:params]    = payload[:params]&.except('action', 'controller', 'id')
-        payload[:duration]  = event.duration
+          if payload.key?(:params)
+            payload[:params] = payload[:params].except('action', 'controller', 'id')
+            payload.delete(:params) if payload[:params].empty?
+          end
 
-        payload.delete(:headers)
-        payload.delete(:params) if payload[:params]&.empty?
+          payload[:duration] = event.duration
+          payload[:allocations] = event.allocations
 
-        payload
+          payload.delete(:headers)
+          payload.delete(:response)
+          payload[:path] = extract_path(payload)
+          payload.delete(:request)
+
+          payload
+        end
+
+        private
+
+        if ::ActionPack::VERSION::MAJOR == 6 && ::ActionPack::VERSION::MINOR == 0
+          def extract_path(payload)
+            path  = payload[:path]
+            index = path.index("?")
+            index ? path.slice(0, index) : path
+          end
+        else
+          def extract_path(payload)
+            payload[:request].path
+          end
+        end
       end
     end
   end

data/lib/rails_custom_logging/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsCustomLogging
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rails_custom_logging.gemspec

@@ -31,6 +31,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 5.2", "< 7"
-  spec.add_dependency "actionpack", ">= 5.2", "< 7"
+  spec.add_dependency "activesupport", ">= 6.0", "< 8"
+  spec.add_dependency "actionpack", ">= 6.0", "< 8"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_custom_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christopher Cocchi-Perrier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,40 +16,68 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 'Replace Rails'' verbose logs with anything you like, from one-liner
   keys/values to even more verbose logging (it you think that''s possible).
 
@@ -61,9 +89,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -72,7 +101,6 @@ files:
 - lib/rails_custom_logging.rb
 - lib/rails_custom_logging/configuration.rb
 - lib/rails_custom_logging/formatters/key_value.rb
-- lib/rails_custom_logging/rails_ext/active_support/subscriber.rb
 - lib/rails_custom_logging/rails_ext/rack/logger.rb
 - lib/rails_custom_logging/railtie.rb
 - lib/rails_custom_logging/subscribers/action_controller.rb

data/Gemfile.lock

@@ -1,64 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rails_custom_logging (0.1.0)
-      actionpack (>= 5.2, < 7)
-      activesupport (>= 5.2, < 7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (5.2.4.4)
-      actionview (= 5.2.4.4)
-      activesupport (= 5.2.4.4)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.4.4)
-      activesupport (= 5.2.4.4)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.4.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    builder (3.2.4)
-    concurrent-ruby (1.1.8)
-    crass (1.0.6)
-    erubi (1.10.0)
-    i18n (1.8.7)
-      concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    minitest (5.14.3)
-    nokogiri (1.11.1-x86_64-darwin)
-      racc (~> 1.4)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    rake (13.0.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  x86_64-darwin-19
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  rails_custom_logging!
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.2.5

data/lib/rails_custom_logging/rails_ext/active_support/subscriber.rb

@@ -1,49 +0,0 @@
-# Backport `detach_from` method added in Rails 6
-# https://github.com/rails/rails/blob/v6.1.1/activesupport/lib/active_support/subscriber.rb
-#
-module RailsCustomLogging
-  module ActiveSupport
-    module Subscriber
-      def detach_from(namespace, notifier = ::ActiveSupport::Notifications)
-        @namespace  = namespace
-        @subscriber = subscribers.find { |s| s.instance_of?(self) }
-        @notifier   = notifier
-
-        return unless subscriber
-
-        subscribers.delete(subscriber)
-
-        # Remove event subscriber for all existing methods on the class.
-        subscriber.public_methods(false).each do |event|
-          remove_event_subscriber(event)
-        end
-
-        # Reset notifier so that event subscribers will not add for new methods added to the class.
-        @notifier = nil
-      end
-
-      private
-
-      def invalid_event?(event)
-        %i[start finish].include?(event.to_sym)
-      end
-
-      def remove_event_subscriber(event)
-        return if invalid_event?(event)
-
-        pattern = "#{event}.#{namespace}"
-
-        return unless subscriber.patterns.include?(pattern)
-
-        subscriber.patterns.delete(pattern)
-        ::ActiveSupport::Notifications.notifier.listeners_for(pattern).each do |li|
-          if li.instance_variable_get(:@delegate) == subscriber
-            notifier.unsubscribe(li)
-          end
-        end
-      end
-    end
-  end
-end
-
-::ActiveSupport::Subscriber.extend(RailsCustomLogging::ActiveSupport::Subscriber)