paul_bunyan 2.0.0 → 2.1.0

data/spec/dummy/app/models/widget.rb

@@ -0,0 +1,2 @@
+class Widget < ApplicationRecord
+end

data/spec/dummy/config/environments/development.rb

@@ -22,20 +22,6 @@ Rails.application.configure do
   # Raise an error on page load if there are pending migrations.
   config.active_record.migration_error = :page_load
 
-  # Debug mode disables concatenation and preprocessing of assets.
-  # This option may cause significant delays in view rendering with a large
-  # number of complex assets.
-  config.assets.debug = true
-
-  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
-  # yet still be able to expire them through the digest params.
-  config.assets.digest = true
-
-  # Adds additional error checking when serving assets at runtime.
-  # Checks for improperly declared sprockets dependencies.
-  # Raises helpful error messages.
-  config.assets.raise_runtime_errors = true
-
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 end

data/spec/dummy/db/migrate/20230301183442_create_widgets.rb

@@ -0,0 +1,10 @@
+class CreateWidgets < ActiveRecord::Migration[7.0]
+  def change
+    create_table :widgets do |t|
+      t.string :name
+      t.integer :quantity
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,21 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.0].define(version: 2023_03_01_183442) do
+  create_table "widgets", force: :cascade do |t|
+    t.string "name"
+    t.integer "quantity"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end

data/spec/lib/paul_bunyan/log_relayer_spec.rb

@@ -337,6 +337,10 @@ describe PaulBunyan::LogRelayer do
     end
   end
 
+  # The funny `, **({})` bit can be removed once we don't test on ruby 2.7
+  # It ensures that the spec considers the arg to be a hash arg and not a kwarg
+  # on ruby < 3.0.  The methods treat actual hashes and kwargs identically so
+  # it doesn't really matter which one it passes through as
   context 'logging metadata' do
     let(:my_metadata) { {foo: 'bar'} }
 
@@ -350,7 +354,7 @@ describe PaulBunyan::LogRelayer do
       it 'delegates to all child loggers that support it' do
         expect(primary).to receive(:add_metadata).with(my_metadata)
         expect(secondary).to_not receive(:add_metadata)
-        double_relayer.add_metadata(my_metadata)
+        double_relayer.add_metadata(my_metadata, **({}))
       end
     end
 
@@ -376,29 +380,29 @@ describe PaulBunyan::LogRelayer do
       it 'delegates to all child loggers' do
         expect(primary).to receive(:remove_metadata).with(my_metadata)
         expect(secondary).to_not receive(:remove_metadata)
-        double_relayer.remove_metadata(my_metadata)
+        double_relayer.remove_metadata(my_metadata, **({}))
       end
     end
 
     describe '#with_metadata' do
       before do
-        allow(single_relayer).to receive(:add_metadata).with(my_metadata)
-        allow(single_relayer).to receive(:remove_metadata).with(my_metadata)
+        allow(single_relayer).to receive(:add_metadata).with(my_metadata, **({}))
+        allow(single_relayer).to receive(:remove_metadata).with(my_metadata, **({}))
       end
 
       it 'must call #add_metadata with the supplied hash' do
-        expect(single_relayer).to receive(:add_metadata).with(my_metadata)
-        expect { |b| single_relayer.with_metadata(my_metadata, &b) }.to yield_control
+        expect(single_relayer).to receive(:add_metadata).with(my_metadata, **({}))
+        expect { |b| single_relayer.with_metadata(my_metadata, **({}), &b) }.to yield_control
       end
 
       it 'must call #remove_metadata with the supplied hash' do
-        expect(single_relayer).to receive(:remove_metadata).with(my_metadata)
-        expect { |b| single_relayer.with_metadata(my_metadata, &b) }.to yield_control
+        expect(single_relayer).to receive(:remove_metadata).with(my_metadata, **({}))
+        expect { |b| single_relayer.with_metadata(my_metadata, **({}), &b) }.to yield_control
       end
 
       it 'must call #remove_metadata when the block raises an exception' do
-        expect(single_relayer).to receive(:remove_metadata).with(my_metadata)
-        expect { single_relayer.with_metadata(my_metadata) do
+        expect(single_relayer).to receive(:remove_metadata).with(my_metadata, **({}))
+        expect { single_relayer.with_metadata(my_metadata, **({})) do
           fail StandardError, ':('
         end
         }.to raise_error(StandardError)

data/spec/lib/paul_bunyan/metadata_logging_spec.rb

@@ -16,15 +16,15 @@ describe PaulBunyan::MetadataLogging do
     end
 
     it 'must delegate with_metadata to the formatter' do
-      expect(formatter).to receive(:with_metadata).with(foo: 'bar').and_yield
-      subject.with_metadata(foo: 'bar') do |logger|
+      expect(formatter).to receive(:with_metadata).with({hash: 123}, foo: 'bar').and_yield
+      subject.with_metadata({hash: 123}, foo: 'bar') do |logger|
         expect(subject).to eq logger
       end
     end
 
     it 'must delegate add_metadata to the formatter' do
-      expect(formatter).to receive(:add_metadata).with(foo: 'bar')
-      subject.add_metadata(foo: 'bar')
+      expect(formatter).to receive(:add_metadata).with({hash: 123}, foo: 'bar')
+      subject.add_metadata({hash: 123}, foo: 'bar')
     end
 
     it 'must delegate current_metadata to the formatter' do
@@ -33,8 +33,8 @@ describe PaulBunyan::MetadataLogging do
     end
 
     it 'must delegate remove_metadata to the formatter' do
-      expect(formatter).to receive(:remove_metadata).with(foo: 'bar')
-      subject.remove_metadata(foo: 'bar')
+      expect(formatter).to receive(:remove_metadata).with({hash: 123}, foo: 'bar')
+      subject.remove_metadata({hash: 123}, foo: 'bar')
     end
 
     context '#flush' do

data/spec/lib/paul_bunyan/railtie/log_subscriber_spec.rb

@@ -61,6 +61,11 @@ module PaulBunyan
     end
 
     describe '#process_action(event)' do
+      let(:request) {
+        req = instance_double("ActionDispatch::Request", ip: "127.0.0.1", env: {
+          "action_dispatch.request_id" => "dfa6f7b5-8400-4572-a2f7-80504ed9d09a"
+        })
+      }
       let(:event) {
         ActiveSupport::Notifications::Event.new(
           'process_action.action_controller',
@@ -74,8 +79,7 @@ module PaulBunyan
             :format => :html,
             :method => "GET",
             :path => "/foos/42",
-            :request_id => "dfa6f7b5-8400-4572-a2f7-80504ed9d09a",
-            :ip => '127.0.0.1',
+            :request => request,
             :status => 200,
             :view_runtime => 220.038,
             :db_runtime => 10.177,

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: paul_bunyan
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Duane Johnson
 - Kenneth Romney
 - Mark Severson
 - Tyler Pickett
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -28,21 +28,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,7 +56,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,7 +70,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,14 +89,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,7 @@ extra_rdoc_files: []
 files:
 - ".dockerignore"
 - ".gitignore"
-- ".travis.yml"
+- Appraisals
 - Dockerfile
 - Gemfile
 - Guardfile
@@ -153,15 +153,15 @@ files:
 - docker-compose.override.yml.example
 - docker-compose.yml
 - examples/host_middleware.rb
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_6.1.gemfile.lock
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.0.gemfile.lock
 - lib/paul_bunyan.rb
 - lib/paul_bunyan/json_formatter.rb
 - lib/paul_bunyan/level.rb
 - lib/paul_bunyan/log_relayer.rb
 - lib/paul_bunyan/metadata_logging.rb
-- lib/paul_bunyan/rails_ext.rb
-- lib/paul_bunyan/rails_ext/active_support_logger.rb
-- lib/paul_bunyan/rails_ext/instrumentation.rb
-- lib/paul_bunyan/rails_ext/rack_logger.rb
 - lib/paul_bunyan/railtie.rb
 - lib/paul_bunyan/railtie/log_subscriber.rb
 - lib/paul_bunyan/tagged_logging.rb
@@ -179,7 +179,9 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
+- spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/widget.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -193,7 +195,6 @@ files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
@@ -205,20 +206,18 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20230301183442_create_widgets.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/gemfiles/52.gemfile
-- spec/gemfiles/60.gemfile
-- spec/gemfiles/61.gemfile
 - spec/lib/paul_bunyan/json_formatter_spec.rb
 - spec/lib/paul_bunyan/level_spec.rb
 - spec/lib/paul_bunyan/log_relayer_spec.rb
 - spec/lib/paul_bunyan/metadata_logging_spec.rb
-- spec/lib/paul_bunyan/rails_ext/instrumentation_spec.rb
 - spec/lib/paul_bunyan/railtie/log_subscriber_spec.rb
 - spec/lib/paul_bunyan/railtie_spec.rb
 - spec/lib/paul_bunyan/tagged_logging_spec.rb
@@ -229,7 +228,7 @@ homepage: https://github.com/instructure/paul_bunyan
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -244,8 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Logging for all the things
 test_files:
@@ -259,7 +258,9 @@ test_files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
+- spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/widget.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -273,7 +274,6 @@ test_files:
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
@@ -285,20 +285,18 @@ test_files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
+- spec/dummy/db/migrate/20230301183442_create_widgets.rb
+- spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/gemfiles/52.gemfile
-- spec/gemfiles/60.gemfile
-- spec/gemfiles/61.gemfile
 - spec/lib/paul_bunyan/json_formatter_spec.rb
 - spec/lib/paul_bunyan/level_spec.rb
 - spec/lib/paul_bunyan/log_relayer_spec.rb
 - spec/lib/paul_bunyan/metadata_logging_spec.rb
-- spec/lib/paul_bunyan/rails_ext/instrumentation_spec.rb
 - spec/lib/paul_bunyan/railtie/log_subscriber_spec.rb
 - spec/lib/paul_bunyan/railtie_spec.rb
 - spec/lib/paul_bunyan/tagged_logging_spec.rb

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-matrix:
-  fast_finish: true
-  # WWTD doesn't support allow_failures... yet
-  # allow_failures:
-  #   - rvm: ruby-head
-gemfile:
-  - spec/gemfiles/52.gemfile
-  - spec/gemfiles/60.gemfile
-  - spec/gemfiles/61.gemfile
-script: bundle exec rspec
-notifications:
-  email:
-    on_success: never
-    on_failure: never

data/lib/paul_bunyan/rails_ext/active_support_logger.rb

@@ -1,11 +0,0 @@
-require 'active_support/logger'
-
-# Sad hax but ActiveRecord insists on using this method for console sessions
-# and everything uses it in development causing us to get double log lines :-(
-module ActiveSupport
-  class Logger
-    def self.broadcast(_)
-      Module.new
-    end
-  end
-end

data/lib/paul_bunyan/rails_ext/instrumentation.rb

@@ -1,41 +0,0 @@
-require 'action_controller/metal/instrumentation'
-
-module ActionController
-  module Instrumentation
-    def process_action(*args)
-      raw_payload = base_payload.merge(custom_payload)
-
-      ActiveSupport::Notifications.instrument('start_processing.action_controller', raw_payload.dup)
-
-      ActiveSupport::Notifications.instrument('process_action.action_controller', raw_payload) do |payload|
-        begin
-          result = super
-          payload[:status] = response.status
-          result
-        ensure
-          append_info_to_payload(payload)
-        end
-      end
-    end
-
-    private
-
-    def base_payload
-      {
-        controller: self.class.name,
-        action: self.action_name,
-        params: request.filtered_parameters,
-        format: request.format.try(:ref),
-        method: request.request_method,
-        path: (request.filtered_path rescue 'unknown'),
-      }
-    end
-
-    def custom_payload
-      {
-        request_id: request.env['action_dispatch.request_id'],
-        ip: request.ip,
-      }
-    end
-  end
-end

data/lib/paul_bunyan/rails_ext/rack_logger.rb

@@ -1,24 +0,0 @@
-require 'rails/rack/logger'
-
-module Rails
-  module Rack
-    class Logger
-
-      # This was copied directly from the rails source and had
-      # the logging lines removed. N.B. this may break in future
-      # versions of rails.
-      def call_app(request, env)
-        instrumenter = ActiveSupport::Notifications.instrumenter
-        instrumenter.start 'request.action_dispatch', request: request
-        resp = @app.call(env)
-        resp[2] = ::Rack::BodyProxy.new(resp[2]) { finish(request) }
-        resp
-      rescue
-        finish(request)
-        raise
-      ensure
-        ActiveSupport::LogSubscriber.flush_all!
-      end
-    end
-  end
-end

data/lib/paul_bunyan/rails_ext.rb

@@ -1,8 +0,0 @@
-module PaulBunyan
-  module RailsExt
-  end
-end
-
-require 'paul_bunyan/rails_ext/rack_logger'
-require 'paul_bunyan/rails_ext/instrumentation'
-require 'paul_bunyan/rails_ext/active_support_logger'

data/spec/dummy/config/initializers/assets.rb

@@ -1,11 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = '1.0'
-
-# Add additional assets to the asset load path
-# Rails.application.config.assets.paths << Emoji.images_path
-
-# Precompile additional assets.
-# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
-# Rails.application.config.assets.precompile += %w( search.js )

data/spec/gemfiles/52.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '../../'
-
-gem 'rails', '~> 5.2.0'

data/spec/gemfiles/60.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '../../'
-
-gem 'rails', '~> 6.0.0'

data/spec/gemfiles/61.gemfile

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '../../'
-
-gem 'rails', '~> 6.1.0'

data/spec/lib/paul_bunyan/rails_ext/instrumentation_spec.rb

@@ -1,103 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe ActionController::Base do
-  let(:request_id) { '5ab8b021-71bf-40f9-97cc-136f7b626a66' }
-
-  around :each do |example|
-    begin
-      original_logger = PaulBunyan.logger.primary_logger
-      null_logger = Logger.new('/dev/null')
-      PaulBunyan.add_logger(null_logger)
-      PaulBunyan.remove_logger(original_logger)
-
-      example.run
-    ensure
-      PaulBunyan.add_logger(original_logger)
-      PaulBunyan.remove_logger(null_logger)
-    end
-  end
-
-  before :each do
-    subject.request = build_request({
-      'action_dispatch.request_id' => request_id,
-      'REMOTE_ADDR' => '127.0.0.1',
-    })
-    subject.response = ActionDispatch::TestResponse.new
-
-    def subject.index(*args)
-      head :ok
-    end
-  end
-
-
-  describe '.process_action(*args)' do
-    context 'active support notification events' do
-      before do
-        allow(ActiveSupport::Notifications).to receive(:instrument)
-      end
-
-      it 'must emit a start_processing event in the action_controller namespace' do
-        subject.send(:process_action, :index)
-        expect(ActiveSupport::Notifications).to have_received(:instrument).
-          with('start_processing.action_controller', anything).once
-      end
-
-      it 'must emit a process_action event in the action_controller namespace' do
-        subject.send(:process_action, :index)
-        expect(ActiveSupport::Notifications).to have_received(:instrument).
-          with('process_action.action_controller', anything).once
-      end
-    end
-
-    it 'must include the original rails payload keys in the event payload' do
-      calling_index do |*args|
-        payload = args.last
-        expect(payload.keys).to include(
-          *[:controller, :action, :params, :format, :method, :path]
-        )
-      end
-    end
-
-    it 'must add the request id to the notification payload hash' do
-      calling_index do |*args|
-        payload = args.last
-        expect(payload).to include request_id: request_id
-      end
-    end
-
-    it 'must add the request ip address to the notification payload' do
-      calling_index do |*args|
-        payload = args.last
-        expect(payload).to include ip: '127.0.0.1'
-      end
-    end
-
-    context 'with sensitive info in the query params' do
-      before do
-        subject.request = build_request({
-          'action_dispatch.parameter_filter' => [:password, :baz],
-          'PATH_INFO' => '/somewhere',
-          'QUERY_STRING' => 'password=foo&bar=baz&baz=qux',
-        })
-      end
-
-      it 'filters the sensitive params' do
-        calling_index do |*args|
-          payload = args.last
-          expect(payload).to include path: '/somewhere?password=[FILTERED]&bar=baz&baz=[FILTERED]'
-        end
-      end
-    end
-  end
-
-  def build_request(attrs)
-    factory_method = (Rails.version >= '5.0' ? :create : :new)
-    ActionDispatch::TestRequest.send(factory_method, attrs)
-  end
-
-  def calling_index(&block)
-    with_subscription_to('process_action.action_controller', block) do
-      subject.send(:process_action, :index)
-    end
-  end
-end