paul_bunyan 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b7d9fd1c7ac8e2b72e82b72171ea627c9597196
-  data.tar.gz: 270c98aa6aa254836aa244db96847b432204df92
+SHA256:
+  metadata.gz: 99a1d7f5e1bca7051329fba1b48a4b948bec14fc627d67104628eb8518b030c9
+  data.tar.gz: 1baa56a528d8e90f60160241d1fc2201d3d9e9fe047ad089afbbee915ca16902
 SHA512:
-  metadata.gz: 7cd3fb82d143d9b6fba0d2f4949ad5a15b52459a6b85fa2ff273a3d13f17754d3bf212a6c133a554a222691e2a6adc90a16a62dc5cfa325513a4e8099e869488
-  data.tar.gz: 19f8c7c07ac6027f48302882a814b7426dcd3dad228bf4be858075aeccb32d94db72feaddfcdb2cd3019991f775d8969447c1ceb57a6cb0f7485422577bae276
+  metadata.gz: 9f42e5e066c935ee873ffd6ebdd1219987d62df649c99b6183492eb18bfaece06350260f33599ee3011b2c944b7186e0bc46bd357139224b0874ed83f8d9c2ac
+  data.tar.gz: 478483be7bd4535bc0e8a88e26e51cea389e60361b16d89db092109e8c97956684226a02f66e3889854c31561352f3585d739e13cbff90d0fc931ad5df32b584

data/.travis.yml

@@ -1,17 +1,17 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4
+  - 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/42.gemfile
-  - spec/gemfiles/50.gemfile
-  - spec/gemfiles/51.gemfile
+  - spec/gemfiles/52.gemfile
+  - spec/gemfiles/60.gemfile
+  - spec/gemfiles/61.gemfile
 script: bundle exec rspec
 notifications:
   email:

data/Dockerfile

@@ -2,18 +2,14 @@ FROM instructure/rvm
 MAINTAINER Instructure
 
 WORKDIR /usr/src/app
-RUN /bin/bash -l -c "rvm use --default 2.4"
+# Everyone use the same bundler version
+RUN /bin/bash -l -c "rvm use 2.5 && gem install bundler"
+RUN /bin/bash -l -c "rvm use 2.6 && gem install bundler"
+RUN /bin/bash -l -c "rvm use --default 2.7 && gem install bundler"
 
-COPY paul_bunyan.gemspec Gemfile /usr/src/app/
-COPY lib/paul_bunyan/version.rb /usr/src/app/lib/paul_bunyan/
-
-USER root
-RUN chown -R docker:docker /usr/src/app
-USER docker
+COPY --chown=docker:docker paul_bunyan.gemspec Gemfile /usr/src/app/
+COPY --chown=docker:docker lib/paul_bunyan/version.rb /usr/src/app/lib/paul_bunyan/
 RUN /bin/bash -l -c "bundle install"
 
-COPY . /usr/src/app
-USER root
-RUN chown -R docker:docker /usr/src/app/*
-USER docker
+COPY --chown=docker:docker . /usr/src/app
 CMD /bin/bash -l -c "wwtd --parallel"

data/Jenkinsfile

@@ -0,0 +1,14 @@
+pipeline {
+  agent {
+    label "docker"
+  }
+  stages {
+    stage('Build') {
+      steps {
+        ansiColor('xterm') {
+          sh './build.sh'
+        }
+      }
+    }
+  }
+}

data/README.md

@@ -43,9 +43,7 @@ Or install it yourself as:
 ```
 require 'paul_bunyan'
 
-include PaulBunyan::Logger
-
-PaulBunyan.set_logger(STDOUT)
+include PaulBunyan
 
 logger.warn "blah"
 ```
@@ -62,3 +60,7 @@ the request host to the metadata in the examples directory. There are a few
 keys that are used internally that will be overwritten when added to user
 supplied metadata, this list can be found in the `#call` method of
 `PaulBunyan::JSONFormatter`.
+
+### Seeing what your server logs will look like in the console
+To do this set `PB_DISABLE_CONSOLE_OVERRIDE` in your environment:
+`PB_DISABLE_CONSOLE_OVERRIDE=1 bundle exec rails c`

data/lib/paul_bunyan/metadata_logging.rb

@@ -1,11 +1,31 @@
 module PaulBunyan
   module MetadataLogging
     def clear_metadata!
-      formatter.clear_metadata!
+      formatter.clear_metadata! if formatter.respond_to?(:clear_metadata!)
     end
 
     def with_metadata(metadata)
-      formatter.with_metadata(metadata) { yield self }
+      if formatter.respond_to?(:with_metadata)
+        formatter.with_metadata(metadata) { yield self }
+      else
+        yield self
+      end
+    end
+
+    def add_metadata(metadata)
+      formatter.add_metadata(metadata) if formatter.respond_to?(:add_metadata)
+    end
+
+    def remove_metadata(metadata)
+      formatter.remove_metadata(metadata) if formatter.respond_to?(:remove_metadata)
+    end
+
+    def current_metadata
+      if formatter.respond_to?(:current_metadata)
+        return formatter.current_metadata
+      else
+        return {}
+      end
     end
 
     def flush

data/lib/paul_bunyan/railtie.rb

@@ -17,6 +17,16 @@ module PaulBunyan
       Rails.env.development? || Rails.env.test?
     end
 
+    def self.rake_task?
+      File.basename($0) == 'rake'
+    end
+
+    def self.migrating?
+      rake_task? && ARGV.include?('db:migrate')
+    end
+
+    delegate :rake_task?, :migrating?, to: :class
+
     # Set up the config and some defaults
     config.logging = ActiveSupport::OrderedOptions.new
     config.logging.override_location = !Rails.env.test?
@@ -27,22 +37,24 @@ module PaulBunyan
     initializer 'initalize_logger.logging', group: :all, before: :initialize_logger do |app|
       logging_config = config.logging
 
-      new_logger = PaulBunyan.add_logger(ActiveSupport::Logger.new(log_target(app.config)))
-      new_logger.level = PaulBunyan::Level.coerce_level(ENV['LOG_LEVEL'] || ::Rails.application.config.log_level || 'INFO')
-      new_logger.formatter = logging_config.formatter
-      new_logger.extend(ActiveSupport::TaggedLogging) if logging_config.formatter.respond_to?(:tagged)
-      new_logger.extend(PaulBunyan::MetadataLogging) if logging_config.formatter.respond_to?(:with_metadata)
+      unless migrating?
+        new_logger = PaulBunyan.add_logger(ActiveSupport::Logger.new(log_target(app.config)))
+        new_logger.level = PaulBunyan::Level.coerce_level(ENV['LOG_LEVEL'] || ::Rails.application.config.log_level || 'INFO')
+        new_logger.formatter = logging_config.formatter
+        new_logger.extend(ActiveSupport::TaggedLogging) if logging_config.formatter.respond_to?(:tagged)
+        new_logger.extend(PaulBunyan::MetadataLogging) if logging_config.formatter.respond_to?(:with_metadata)
 
-      if logging_config.handle_request_logging
-        unsubscribe_default_log_subscribers
-        LogSubscriber.subscribe_to_events
-      end
+        if logging_config.handle_request_logging
+          unsubscribe_default_log_subscribers
+          LogSubscriber.subscribe_to_events
+        end
 
-      Rails.logger = PaulBunyan.logger
+        Rails.logger = PaulBunyan.logger
+      end
     end
 
     console do
-      PaulBunyan.logger.formatter = TextFormatter.new(include_metadata: false)
+      PaulBunyan.logger.formatter = TextFormatter.new(include_metadata: false) unless ENV['PB_DISABLE_CONSOLE_OVERRIDE']
     end
 
     def conditionally_unsubscribe(listener)

data/lib/paul_bunyan/railtie/log_subscriber.rb

@@ -66,8 +66,12 @@ module PaulBunyan
       subscribers << subscriber
 
       event_patterns.each do |pattern|
-        subscriber.patterns << pattern
-        notifier.subscribe(pattern, subscriber)
+        if Rails::VERSION::MAJOR >= 6
+          subscriber.patterns[pattern] = notifier.subscribe(pattern, subscriber)
+        else
+          subscriber.patterns << pattern
+          notifier.subscribe(pattern, subscriber)
+        end
       end
     end
 

data/lib/paul_bunyan/text_formatter.rb

@@ -5,7 +5,7 @@ end
 
 module PaulBunyan
   class TextFormatter < Logger::Formatter
-    include ActiveSupport::TaggedLogging::Formatter if defined?(ActiveSupport::TaggedLogging)
+    include ActiveSupport::TaggedLogging::Formatter if defined?(ActiveSupport::TaggedLogging::Formatter)
 
     def initialize(include_metadata: true)
       @include_metadata = include_metadata

data/lib/paul_bunyan/version.rb

@@ -1,3 +1,3 @@
 module PaulBunyan
-  VERSION = '1.5.0'
+  VERSION = '2.0.0'
 end

data/paul_bunyan.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'request_store'
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'wwtd'
-  spec.add_development_dependency 'rails', '>= 4.2'
+  spec.add_development_dependency 'rails', '>= 5.2'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'byebug'
 end

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy/config/application.rb

@@ -19,9 +19,8 @@ module Dummy
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
 
-    # Do not swallow errors in after_commit/after_rollback callbacks.
-    if Rails.version > '4.2' && Rails.version < '5.0'
-      config.active_record.raise_in_transactional_callbacks = true
+    if Rails.version < '6.0'
+      config.active_record.sqlite3.represent_boolean_as_integer = true
     end
   end
 end

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

@@ -18,7 +18,6 @@ Dummy::Application.configure do
     config.static_cache_control = 'public, max-age=3600'
   end
 
-
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
@@ -42,4 +41,13 @@ Dummy::Application.configure do
 
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
+
+  # Simulate default production logging configuration
+  if Rails.version < '5.1'
+    config.log_formatter = ::Logger::Formatter.new
+  else
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
 end

data/spec/gemfiles/{42.gemfile → 52.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '../../'
 
-gem 'rails', '~> 4.2.0'
+gem 'rails', '~> 5.2.0'

data/spec/gemfiles/{50.gemfile → 60.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '../../'
 
-gem 'rails', '~> 5.0.0'
+gem 'rails', '~> 6.0.0'

data/spec/gemfiles/{51.gemfile → 61.gemfile}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '../../'
 
-gem 'rails', '~> 5.1.0'
+gem 'rails', '~> 6.1.0'

data/spec/lib/paul_bunyan/metadata_logging_spec.rb

@@ -1,47 +1,108 @@
 require 'spec_helper'
 
 describe PaulBunyan::MetadataLogging do
-  subject { Object.new }
-  let(:formatter) { double('formatter') }
+  context "with a formatter that supports metadata" do
+    subject { Object.new }
+    let(:formatter) { double('formatter') }
 
-  before do
-    subject.extend(PaulBunyan::MetadataLogging)
-    allow(subject).to receive(:formatter).and_return(formatter)
-  end
+    before do
+      subject.extend(PaulBunyan::MetadataLogging)
+      allow(subject).to receive(:formatter).and_return(formatter)
+    end
 
-  it 'must delegate clear_metadata! to the formatter' do
-    expect(formatter).to receive(:clear_metadata!)
-    subject.clear_metadata!
-  end
+    it 'must delegate clear_metadata! to the formatter' do
+      expect(formatter).to receive(:clear_metadata!)
+      subject.clear_metadata!
+    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(subject).to eq logger
+    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(subject).to eq logger
+      end
     end
-  end
 
-  context '#flush' do
-    it 'clears metadata on the formatter' do
-      expect(formatter).to receive(:clear_metadata!)
-      subject.flush
+    it 'must delegate add_metadata to the formatter' do
+      expect(formatter).to receive(:add_metadata).with(foo: 'bar')
+      subject.add_metadata(foo: 'bar')
     end
 
-    it 'sends flush to a parent' do
-      klass = Class.new
-      klass.class_eval do
-        def flush
-          flush_behavior()
+    it 'must delegate current_metadata to the formatter' do
+      expect(formatter).to receive(:current_metadata).and_return({})
+      subject.current_metadata
+    end
+
+    it 'must delegate remove_metadata to the formatter' do
+      expect(formatter).to receive(:remove_metadata).with(foo: 'bar')
+      subject.remove_metadata(foo: 'bar')
+    end
+
+    context '#flush' do
+      it 'clears metadata on the formatter' do
+        expect(formatter).to receive(:clear_metadata!)
+        subject.flush
+      end
+
+      it 'sends flush to a parent' do
+        klass = Class.new
+        klass.class_eval do
+          def flush
+            flush_behavior()
+          end
         end
+
+        metadata_logger = klass.new
+        metadata_logger.extend(PaulBunyan::MetadataLogging)
+        allow(metadata_logger).to receive(:formatter).and_return(formatter)
+        allow(formatter).to receive(:clear_metadata!)
+
+        expect(metadata_logger).to receive(:flush_behavior)
+        metadata_logger.flush
       end
+    end
+  end
+
+  context "with a formatter that does not support metadata" do
+    subject { Object.new }
+    let(:formatter) { PaulBunyan::TextFormatter.new }
+
+    before do
+      subject.extend(PaulBunyan::MetadataLogging)
+      allow(subject).to receive(:formatter).and_return(formatter)
+    end
+
+    it 'must not call clear_metadata! on the formatter' do
+      expect(formatter).to_not respond_to(:clear_metadata!)
+      subject.clear_metadata!
+    end
+
+    it 'must delegate with_metadata to the formatter' do
+      expect(formatter).to_not respond_to(:with_metadata)
+      subject.with_metadata(foo: 'bar') do |logger|
+        expect(subject).to eq logger
+      end
+    end
+
+    it 'must delegate add_metadata to the formatter' do
+      expect(formatter).to_not respond_to(:add_metadata)
+      subject.add_metadata(foo: 'bar')
+    end
 
-      metadata_logger = klass.new
-      metadata_logger.extend(PaulBunyan::MetadataLogging)
-      allow(metadata_logger).to receive(:formatter).and_return(formatter)
-      allow(formatter).to receive(:clear_metadata!)
+    it 'must delegate current_metadata to the formatter' do
+      expect(formatter).to_not respond_to(:current_metadata)
+      subject.current_metadata
+    end
+
+    it 'must delegate remove_metadata to the formatter' do
+      expect(formatter).to_not respond_to(:remove_metadata)
+      subject.remove_metadata(foo: 'bar')
+    end
 
-      expect(metadata_logger).to receive(:flush_behavior)
-      metadata_logger.flush
+    context '#flush' do
+      it 'clears metadata on the formatter' do
+        expect(formatter).to_not respond_to(:clear_metadata!)
+        subject.flush
+      end
     end
   end
 end

data/spec/lib/paul_bunyan/railtie_spec.rb

@@ -32,10 +32,10 @@ module PaulBunyan
       end
 
       it 'must leave the ActionController::LogSubscriber subscription to deep_munge.action_controller in place' do
-        # I don't expect that we'll ever care to unsubcribe the logger
-        # non-event so we'll use it as a check to ensure we don't
-        # clobber all of the listeners, only the ones we care about
-        expect(subscriber_classes_for('logger.action_controller')).
+        # We do not currently support fragment cache logging so we'll use it as
+        # a check to ensure we don't clobber all of the listeners, only the
+        # ones we care about
+        expect(subscriber_classes_for('write_fragment.action_controller')).
           to include ActionController::LogSubscriber
       end
     end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: paul_bunyan
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Duane Johnson
 - Kenneth Romney
 - Mark Severson
 - Tyler Pickett
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -31,16 +31,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -89,14 +89,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +144,7 @@ files:
 - Dockerfile
 - Gemfile
 - Guardfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -169,6 +170,7 @@ files:
 - lib/tasks/paul_bunyan_tasks.rake
 - paul_bunyan.gemspec
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/images/.keep
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -209,9 +211,9 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/gemfiles/42.gemfile
-- spec/gemfiles/50.gemfile
-- spec/gemfiles/51.gemfile
+- 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
@@ -227,7 +229,7 @@ homepage: https://github.com/instructure/paul_bunyan
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -242,13 +244,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Logging for all the things
 test_files:
 - spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/images/.keep
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -289,9 +291,9 @@ test_files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/gemfiles/42.gemfile
-- spec/gemfiles/50.gemfile
-- spec/gemfiles/51.gemfile
+- 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