heavylog 0.0.14 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28311750ff2fdcc2dcb08226faf88a2b655c1b3e61d44e590c47c9bb389037d2
-  data.tar.gz: 1524b0b67c35da8d3d9edec17b0cceb040ffc77752610d919e04f1ee90dca90f
+  metadata.gz: 817f124071c11b74c359b8ce78ec24cc8778bfab7c3d3ee79da64847e30f1f66
+  data.tar.gz: 80ecb337b3e34dc5a50419f31d3a9bb20fdddbe7da23ffefc52b9b2197eee757
 SHA512:
-  metadata.gz: ce3b240f7f9b75ac07d1d3ffccb71f024a1dda45183816b996d99aed4df89557337e564847f25041d2d7ce7b0c819c179b859906165215b3bcfab8ab4093acf5
-  data.tar.gz: 57af42b8052b55fe3e74f6f2cc6cb739c1cf0aaa906b5082c408fd362239f73b4a6b90f0534a4e15c3358f7e6e543e0f0642a52306ce74e678684c2b50668e29
+  metadata.gz: 54e8d27f4dd9c4e69bd4e2a8103a085e246f0e9067bdd056c328efd5edf73d6c9158626bd68245bc7ace3bedfe58ef6a8c821de034d3737d0670231f2cbf47e1
+  data.tar.gz: ade91b07e69e29c288b5cda82b3dd00717248099bbf7da75e9f375e08732d53a506f9345f2565ea349853eff66a1c1de65219160c70949fba532e6a49323d463

data/.editorconfig

@@ -0,0 +1,14 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = true

data/.github/workflows/test.yml

@@ -0,0 +1,36 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        uses: paambaati/codeclimate-action@v2.4.0
+        env:
+          CI: true
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: bundle exec rspec

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -2,46 +2,42 @@ require:
   - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
 
 # # Commonly used screens these days easily fit more than 80 characters.
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 # Too short methods lead to extraction of single-use methods, which can make
 # the code easier to read (by naming things), but can also clutter the class
 Metrics/MethodLength:
-  Max: 125
+  Enabled: false
 
 # The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
 Metrics/ClassLength:
-  Max: 1500
+  Enabled: false
 
 Metrics/AbcSize:
-  Max: 160
+  Enabled: false
 
 Metrics/CyclomaticComplexity:
-  Max: 45
+  Enabled: false
 
 Metrics/PerceivedComplexity:
-  Max: 45
+  Enabled: false
 
 Metrics/ParameterLists:
-  Max: 6
+  Enabled: false
 
 Metrics/ModuleLength:
-  Max: 125
+  Enabled: false
 
 Metrics/BlockLength:
-  Max: 45
-  Exclude:
-    - 'spec/**/*'
+  Enabled: false
 
 # Mixing the styles looks just silly.
 Style/HashSyntax:
   EnforcedStyle: ruby19_no_mixed_keys
-  Exclude:
-    - 'config/routes.rb'
 
 # Single quotes being faster is hardly measurable and only affects parse time.
 # Enforcing double quotes reduces the times where you need to change them
@@ -103,8 +99,11 @@ Style/ClassAndModuleChildren:
 Style/DoubleNegation:
   Enabled: false
 
+Style/AsciiComments:
+  Enabled: false
+
 # Most readable form.
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 
@@ -125,14 +124,14 @@ Layout/MultilineMethodCallIndentation:
 # Suppressing exceptions can be perfectly fine, and be it to avoid to
 # explicitly type nil into the rescue since that's what you want to return,
 # or suppressing LoadError for optional dependencies
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 # This is just silly. Calling the argument `other` in all cases makes no sense.
 Naming/BinaryOperatorParameterName:
   Enabled: false
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - io
     - id
@@ -148,3 +147,6 @@ Naming/UncommunicativeMethodParamName:
 
 Bundler/OrderedGems:
   Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heavylog (0.0.13)
+    heavylog (0.0.19)
       actionpack (>= 5)
       activesupport (>= 5)
       railties (>= 5)
@@ -10,88 +10,137 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    ast (2.4.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    i18n (1.6.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    backport (1.1.2)
+    benchmark (0.1.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    connection_pool (2.2.3)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    e2mmap (0.1.0)
+    erubi (1.10.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    loofah (2.2.3)
+    jaro_winkler (1.5.4)
+    json (2.5.1)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.4)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    rack (2.0.7)
+    method_source (1.0.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    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.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
-    request_store (1.4.1)
+    rake (13.0.3)
+    redis (4.2.5)
+    regexp_parser (2.1.1)
+    request_store (1.5.0)
       rack (>= 1.4)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.4)
+    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-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.11.0)
+    sidekiq (6.2.0)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    solargraph (0.40.4)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.1.0)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    yard (0.9.26)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -99,9 +148,13 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   heavylog!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.71)
+  rubocop-performance (~> 1.5.2)
+  sidekiq (>= 5.0)
+  simplecov (~> 0.17.1)
+  solargraph
 
 BUNDLED WITH
-   2.0.2
+   2.2.15

data/heavylog.gemspec

@@ -16,16 +16,20 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|.vscode)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rubocop", "~> 0.71"
+  spec.add_development_dependency "rubocop-performance", "~> 1.5.2"
+  spec.add_development_dependency "simplecov", "~> 0.17.1"
+  spec.add_development_dependency "sidekiq", ">= 5.0"
+  spec.add_development_dependency "solargraph"
 
   spec.add_runtime_dependency "actionpack",    ">= 5"
   spec.add_runtime_dependency "activesupport", ">= 5"

data/lib/heavylog.rb

@@ -138,6 +138,8 @@ module Heavylog
 
     formatted = Heavylog.formatter.call(request)
     Heavylog.logger.send(Heavylog.log_level, formatted)
+  rescue StandardError => e
+    config.error_handler&.(e)
   end
 
   def finish_sidekiq

data/lib/heavylog/railtie.rb

@@ -7,6 +7,9 @@ module Heavylog
     config.heavylog.path = "log/heavylog.log"
     config.heavylog.message_limit = 1024 * 1024 * 50 # 50MB
     config.heavylog.log_sidekiq = false
+    config.heavylog.error_handler = lambda { |e|
+      Kernel.puts "HeavyLog: Error writing to log: #{e.class}: #{e.message}\n  #{e.backtrace.join("\n  ")}"
+    }
 
     initializer "heavylog.insert_middleware" do |app|
       app.config.middleware.insert_before Rails::Rack::Logger, Heavylog::Middleware

data/lib/heavylog/sidekiq_logger.rb

@@ -1,64 +1,20 @@
 # frozen_string_literal: true
 
-module Heavylog
-  class SidekiqLogger
-    def initialize(logger=Sidekiq.logger)
-      @logger = logger
-    end
-
-    def call(item, _queue)
-      # item = {"class"=>"SuspiciousJob", "args"=>[12754545, [3858890], "invoice"], "retry"=>true, "queue"=>"default",
-      #   "jid"=>"5ec968571e358497d70a3cf2", "created_at"=>1540484817.3950138, "enqueued_at"=>1540484817.395076}
-
-      Heavylog.log_sidekiq(item["jid"], item["class"], item["args"])
-
-      begin
-        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-        @logger.info("start")
-
-        yield
-
-        with_elapsed_time_context(start) do
-          @logger.info("done")
-        end
-
+begin
+  require "sidekiq/job_logger"
+
+  module Heavylog
+    class SidekiqLogger < Sidekiq::JobLogger
+      def call(item, _queue)
+        # item = {"class"=>"SuspiciousJob", "args"=>[12754545, [3858890], "invoice"], "retry"=>true, "queue"=>"default",
+        #   "jid"=>"5ec968571e358497d70a3cf2", "created_at"=>1540484817.3950138, "enqueued_at"=>1540484817.395076}
+
+        Heavylog.log_sidekiq(item["jid"], item["class"], item["args"])
+        super
+      ensure
         Heavylog.finish_sidekiq
-      rescue StandardError
-        with_elapsed_time_context(start) do
-          @logger.info("fail")
-        end
-
-        raise
       end
     end
-
-    def with_job_hash_context(job_hash, &block)
-      @logger.with_context(job_hash_context(job_hash), &block)
-    end
-
-    def job_hash_context(job_hash)
-      # If we're using a wrapper class, like ActiveJob, use the "wrapped"
-      # attribute to expose the underlying thing.
-      h = {
-        class: job_hash["wrapped"] || job_hash["class"],
-        jid:   job_hash["jid"],
-      }
-      h[:bid] = job_hash["bid"] if job_hash["bid"]
-      h
-    end
-
-    def with_elapsed_time_context(start, &block)
-      @logger.with_context(elapsed_time_context(start), &block)
-    end
-
-    def elapsed_time_context(start)
-      { elapsed: elapsed(start).to_s }
-    end
-
-    private
-
-    def elapsed(start)
-      (::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - start).round(3)
-    end
   end
+rescue LoadError
 end

data/lib/heavylog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heavylog
-  VERSION = "0.0.14"
+  VERSION = "0.0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heavylog
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.19
 platform: ruby
 authors:
 - Kristjan Rang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.71'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -129,10 +185,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -171,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Format all Rails logging per request

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 2.0.1
-script: bundle exec rspec