memolog 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97630c7e390e26c97872776f9c6b142fcb18cafaf05ceb937a8ee4a10537212c
-  data.tar.gz: 568faf40b03bc8488d651b7e09eda247f5f22e399d583d97b671868618b91e4c
+  metadata.gz: d8cb342892f52d20fa06101e203aa4d4d1c5efea05696c48bb7a30804b66befb
+  data.tar.gz: 4e7f8721ae37487cc8d88316432d2897f269c1817e75d66e562c5b846521cbd6
 SHA512:
-  metadata.gz: fb3b455425fa4e68c68620248e1cf3493e1888e7023e62cb1179b31b1a316def07c0b918ae1fa4ba3b3ff6b23c339a9f481a340fcd784a712405622ad87a77b1
-  data.tar.gz: 8cde0d72453487d056a4e507a06943bc21d2a5c5d52a8c6298b85bdc81375c189fd39904be27fb5304757cbba70493650b9a14ec4f0482846ae7ae587fe11572
+  metadata.gz: 806d71859e439c83417ad71f5c97f53358405e55243f982e79ce5f28b6736f1ae0175c6bf25822bbd30c27dea0f04584b4eb820df8ec8a8632c5487d48667a31
+  data.tar.gz: fbf2765dcf76597eba069a9d627e5728306043962bb92b3e23aab8e253cc948be10a4bbc4220b3d66bcb48d62ca3f9b9e362c88e03ea98a8f268dc51160b2926

data/.github/workflows/test.yml

@@ -24,7 +24,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7, 3.0]
+        ruby: [2.7, 3.0]
 
     steps:
     - uses: actions/checkout@v2

data/Gemfile.lock

@@ -1,206 +1,225 @@
 PATH
   remote: .
   specs:
-    memolog (0.3.2)
+    memolog (0.4.0)
+      json (~> 2)
       logger (~> 1.4.3)
       securerandom (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actioncable (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activestorage (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionmailbox (7.0.1)
+      actionpack (= 7.0.1)
+      activejob (= 7.0.1)
+      activerecord (= 7.0.1)
+      activestorage (= 7.0.1)
+      activesupport (= 7.0.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      actionview (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.1)
+      actionpack (= 7.0.1)
+      actionview (= 7.0.1)
+      activejob (= 7.0.1)
+      activesupport (= 7.0.1)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.1)
+      actionview (= 7.0.1)
+      activesupport (= 7.0.1)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activestorage (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actiontext (7.0.1)
+      actionpack (= 7.0.1)
+      activerecord (= 7.0.1)
+      activestorage (= 7.0.1)
+      activesupport (= 7.0.1)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    activejob (7.0.1)
+      activesupport (= 7.0.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activerecord (6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activestorage (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      marcel (~> 1.0.0)
+    activemodel (7.0.1)
+      activesupport (= 7.0.1)
+    activerecord (7.0.1)
+      activemodel (= 7.0.1)
+      activesupport (= 7.0.1)
+    activestorage (7.0.1)
+      actionpack (= 7.0.1)
+      activejob (= 7.0.1)
+      activerecord (= 7.0.1)
+      activesupport (= 7.0.1)
+      marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (6.1.4.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
     erubi (1.10.0)
-    globalid (0.5.2)
+    globalid (1.0.0)
       activesupport (>= 5.0)
-    i18n (1.8.10)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
+    io-wait (0.2.1)
+    json (2.6.1)
     logger (1.4.4)
-    loofah (2.12.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.1.1)
-    minitest (5.14.4)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.2)
+      io-wait
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
     nio4r (2.5.8)
-    nokogiri (1.12.5-x86_64-darwin)
+    nokogiri (1.13.1-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-linux)
+    nokogiri (1.13.1-x86_64-linux)
       racc (~> 1.4)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.4.1)
-      actioncable (= 6.1.4.1)
-      actionmailbox (= 6.1.4.1)
-      actionmailer (= 6.1.4.1)
-      actionpack (= 6.1.4.1)
-      actiontext (= 6.1.4.1)
-      actionview (= 6.1.4.1)
-      activejob (= 6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activerecord (= 6.1.4.1)
-      activestorage (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    rails (7.0.1)
+      actioncable (= 7.0.1)
+      actionmailbox (= 7.0.1)
+      actionmailer (= 7.0.1)
+      actionpack (= 7.0.1)
+      actiontext (= 7.0.1)
+      actionview (= 7.0.1)
+      activejob (= 7.0.1)
+      activemodel (= 7.0.1)
+      activerecord (= 7.0.1)
+      activestorage (= 7.0.1)
+      activesupport (= 7.0.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.4.1)
-      sprockets-rails (>= 2.0.0)
+      railties (= 7.0.1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    railties (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
     rake (13.0.6)
-    redis (4.4.0)
-    regexp_parser (2.1.1)
+    redis (4.6.0)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.17.0)
+    rspec-support (3.10.3)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-config-umbrellio (1.17.0.53)
-      rubocop (= 1.17.0)
-      rubocop-performance (= 1.10.0)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.2.0)
-      rubocop-sequel (= 0.2.0)
-    rubocop-performance (1.10.0)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-config-umbrellio (1.25.0.61)
+      rubocop (~> 1.25.0)
+      rubocop-performance (~> 1.13.0)
+      rubocop-rails (~> 2.13.0)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.7.0)
+      rubocop-sequel (~> 0.3.3)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.13.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
+    rubocop-sequel (0.3.3)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     securerandom (0.1.1)
-    sidekiq (6.2.2)
+    sidekiq (6.4.1)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       redis (>= 4.2.0)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (1.1.0)
+    strscan (3.0.1)
+    thor (1.2.1)
+    timeout (0.2.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   x86_64-darwin-20

data/README.md

@@ -26,21 +26,28 @@ Use this example during application initialization process (this example impleme
 ```ruby
 Memolog.configure do |config|
   config.debug = false
-  config.formatter = ::Memolog::Formatter.new
-  config.initializers = %i[rails sidekiq]
+  config.formatter = ::Logger::Formatter.new
+  config.middlewares = %i[rails sidekiq]
+  config.log_json = false
   config.log_size_limit = 50_000
-  config.uuid_callable = -> { SecureRandom.uuid }
 end
 
-Memolog.init!
+Memolog.init_middlewares!
 ```
 
 Available options are:
 - `debug` - set it to true if you need to leave Memolog.dump result outside `Memolog.run {}` block.
 - `formatter` - setup your own formatter.
-- `initializers` - define here what you want to initialize in `#init!` call.
+- `middlewares` - define here what you want to initialize in `#init_middlewares!` call.
+- `log_json` - `#dump` will try to parse dump with `JSON.parse()`. Default is `false`
 - `log_size_limit` - max log length in `#dump`.
-- `uuid_callable` - Memolog add unique value to logs, here you can redefine uuid generation.
+
+If you want to apply Sentry monkey patch that call `Memolog.dump` before `Sentry.capture_exception`
+and `Sentry.capture_message` you can implement it via this code:
+
+```ruby
+Sentry.prepend(Memolog::SentryExtension)
+```
 
 ## Usage
 

data/lib/memolog/config.rb

@@ -3,15 +3,15 @@
 Memolog::Config = Struct.new(
   :debug,
   :formatter,
-  :initializers,
+  :middlewares,
+  :parse_json,
   :log_size_limit,
-  :uuid_callable,
 ) do
   def initialize
     self.debug = false
-    self.formatter = ::Memolog::Formatter.new
-    self.initializers = %i[rails sidekiq]
+    self.formatter = ::Logger::Formatter.new
+    self.middlewares = %i[rails sidekiq]
+    self.parse_json = false
     self.log_size_limit = 50_000
-    self.uuid_callable = -> { SecureRandom.uuid }
   end
 end

data/lib/memolog/init.rb

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-class Memolog::Init
-  def call
+module Memolog::Init
+  extend self
+
+  def init_middlewares!
     init_rails_middleware!
     init_sidekiq_middleware!
   end
 
-  private
-
   def init_rails_middleware!
-    return unless Memolog.config.initializers.include?(:rails)
-    return unless Object.const_defined?("Rails")
-    return if Object.const_defined?("Sidekiq") && Sidekiq.server?
+    return unless Memolog.config.middlewares.include?(:rails)
+    return unless Object.const_defined?(:Rails)
+    return if Object.const_defined?(:Sidekiq) && Sidekiq.server?
 
     Rails.application.middleware.insert_before(0, Memolog::RailsMiddleware)
   end
 
   def init_sidekiq_middleware!
-    return unless Memolog.config.initializers.include?(:sidekiq)
-    return unless Object.const_defined?("Sidekiq")
+    return unless Memolog.config.middlewares.include?(:sidekiq)
+    return unless Object.const_defined?(:Sidekiq)
 
     Sidekiq.configure_server do |config|
       config.server_middleware do |chain|

data/lib/memolog/{extension.rb → logger_extension.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Memolog::Extension
+module Memolog::LoggerExtension
   def add(*args, &block)
     Memolog.logger.log(*args, &block)
     super

data/lib/memolog/sentry_extension.rb

@@ -18,7 +18,7 @@ module Memolog::SentryExtension
 
     def set_extras_memolog!
       return unless get_current_scope
-      set_extras(Memolog.config.sentry_key => Memolog.dump)
+      set_extras(memolog: Memolog.dump)
     end
   end
 end

data/lib/memolog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Memolog
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/memolog.rb

@@ -3,12 +3,12 @@
 require "logger"
 require "securerandom"
 require "stringio"
+require "json"
 
 require "memolog/version"
 require "memolog/config"
-require "memolog/extension"
-require "memolog/formatter"
 require "memolog/init"
+require "memolog/logger_extension"
 require "memolog/rails_middleware"
 require "memolog/sentry_extension"
 require "memolog/sidekiq_middleware"
@@ -24,17 +24,12 @@ module Memolog
     yield(config) if block_given?
   end
 
-  def init!
-    Memolog::Init.new.call
+  def init_middlewares!
+    Memolog::Init.init_middlewares!
   end
 
   def extend_logger(other_logger)
-    other_logger.extend(Memolog::Extension)
-    other_logger.formatter = config.formatter
-  end
-
-  def uuid
-    Thread.current[:memolog_uuid]
+    other_logger.extend(Memolog::LoggerExtension)
   end
 
   def logger
@@ -46,8 +41,6 @@ module Memolog
   end
 
   def run
-    Thread.current[:memolog_uuid] = config.uuid_callable.call
-
     logdevs.push(StringIO.new)
     logger.instance_variable_set(:@logdev, logdevs.last)
 
@@ -62,6 +55,10 @@ module Memolog
     beginning = logdevs.last.string.length - config.log_size_limit
     beginning = 0 if beginning.negative?
 
-    logdevs.last.string.slice(beginning, config.log_size_limit).presence
+    dump = logdevs.last.string.slice(beginning, config.log_size_limit).presence
+
+    config.parse_json ? JSON.parse(dump) : dump
+  rescue JSON::ParserError
+    dump
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: memolog
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Stepan Kirushkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -61,9 +75,8 @@ files:
 - bin/setup
 - lib/memolog.rb
 - lib/memolog/config.rb
-- lib/memolog/extension.rb
-- lib/memolog/formatter.rb
 - lib/memolog/init.rb
+- lib/memolog/logger_extension.rb
 - lib/memolog/rails_middleware.rb
 - lib/memolog/sentry_extension.rb
 - lib/memolog/sidekiq_middleware.rb

data/lib/memolog/formatter.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-class Memolog::Formatter < Logger::Formatter
-  def call(severity, time, _progname, msg)
-    format(
-      Format,
-      severity[0..0],
-      format_datetime(time),
-      $PID,
-      severity,
-      Memolog.uuid,
-      msg2str(msg),
-    )
-  end
-end