timber 2.0.22 → 2.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb727abf7308983fedd10e2b44e661ce337a5fed
-  data.tar.gz: 4dd342bfd405154dc7e2cc670789745c8879f01b
+  metadata.gz: dcda9ae1986cc2ba1cc86941ab161e98cbf87267
+  data.tar.gz: 0dd221e5f41253700dc08a47edd24c9d5097ff6c
 SHA512:
-  metadata.gz: 1e781929108c46a6a4a6979ed4255bb57e2bb8ee86397f95b8da4a517e795778dd715347d993ab627eefe951a565d9890b91d2729c73717c8a8224ce125f2c2c
-  data.tar.gz: ac45f8c6b93f67b1829b0771e74b37968ea22e2f413e9bf4ac7952e0c2b292536ebd18f82b807a9721708ba5f20b15be50e85ca7710fa0d96d76287f87d4a7cf
+  metadata.gz: e11eff7209118ea8b0e0731e80ec3e1c24deed610a17eddc13d6becd282c66f906fc5cf48dd065ec07df41d2d174273c6695aaea903110d6fa7e29e8b1fe11ee
+  data.tar.gz: 163e16d153963b5e2d13ce2da63ff70c3158bfd70f7c29f04a72ea6bf5cecb2d5d50380bf70a83cb10a23344c249d125816db574a864b6170d3709a214fb6d2a

data/.travis.yml

@@ -16,6 +16,7 @@ gemfile:
 - gemfiles/rails-4.2.gemfile
 - gemfiles/rails-4.2.gemfile
 - gemfiles/rails-5.0.gemfile
+- gemfiles/rails-5.1.gemfile
 - gemfiles/rails-edge.gemfile
 env:
   global: RAILS_ENV=test
@@ -38,6 +39,8 @@ matrix:
   - rvm: 2.4.0
   - rvm: jruby
     gemfile: gemfiles/rails-5.0.gemfile
+  - rvm: jruby
+    gemfile: gemfiles/rails-5.1.gemfile
   - rvm: jruby
     gemfile: gemfiles/rails-edge.gemfile
 notifications:

data/gemfiles/rails-5.1.gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/lib/timber/config.rb

@@ -37,7 +37,7 @@ module Timber
     # This is useful for debugging. This Sets a debug_logger to view internal Timber library
     # log messages. The default is `nil`. Meaning log to nothing.
     #
-    # See `debug_to_file` and `debug_to_stdout` for convenience methods that handle creating
+    # See {#debug_to_file} and {#debug_to_stdout} for convenience methods that handle creating
     # and setting the logger.
     #
     # @example Rails

data/lib/timber/contexts.rb

@@ -9,7 +9,7 @@ require "timber/contexts/user"
 module Timber
   # Namespace for all Timber supported Contexts.
   module Contexts
-    # Protocol for casting objects into a `Timber::Context`.
+    # Protocol for casting objects into a {Timber::Context}.
     #
     # @example Casting a hash
     #   Timber::Contexts.build(deploy: {version: "1.0.0"})

data/lib/timber/contexts/session.rb

@@ -2,7 +2,7 @@ module Timber
   module Contexts
     # The session context tracks the current session for the given user.
     #
-    # @note This is tracked automatically with the `Integrations::Rack::SessionContext` rack
+    # @note This is tracked automatically with the {Integrations::Rack::SessionContext} rack
     #   middleware.
     class Session < Context
       @keyspace = :session

data/lib/timber/contexts/user.rb

@@ -2,7 +2,7 @@ module Timber
   module Contexts
     # The user context tracks the currently authenticated user.
     #
-    # @note This is tracked automatically with the `Integrations::Rack::UserContext` rack
+    # @note This is tracked automatically with the {Integrations::Rack::UserContext} rack
     #   middleware.
     class User < Context
       @keyspace = :user

data/lib/timber/log_entry.rb

@@ -17,7 +17,7 @@ module Timber
     # @param context_snapshot [Hash] structured data representing a snapshot of the context at
     #   the given point in time.
     # @param event [Timber.Event] structured data representing the log line event. This should be
-    #   an instance of `Timber.Event`.
+    #   an instance of {Timber.Event}.
     # @return [LogEntry] the resulting LogEntry object
     def initialize(level, time, progname, message, context_snapshot, event, options = {})
       @level = level
@@ -92,9 +92,9 @@ module Timber
         event_type = event_hash.keys.first
 
         event_type = if event.is_a?(Events::Custom)
-          "event:#{event_type}.#{event.type}"
+          "#{event_type}.#{event.type}"
         else
-          "event:#{event_type}"
+          "#{event_type}"
         end
 
         log_message = "#{message} [#{event_type}]"

data/lib/timber/overrides.rb

@@ -1,3 +1,4 @@
+require "timber/overrides/active_support_tagged_logging"
 require "timber/overrides/lograge"
 require "timber/overrides/rails_stdout_logging"
 

data/lib/timber/overrides/active_support_tagged_logging.rb

@@ -0,0 +1,103 @@
+# This patch is specifically for Rails 3. The legacy approach to wrapping the logger in
+# ActiveSupport::TaggedLogging is rather poor, hence the reason it was changed entirely
+# for Rails 4 and 5. The problem is that ActiveSupport::TaggedLogging is a wrapping
+# class that entirely redefines the public API for the logger. As a result, any deviations
+# from this API in the logger are not exposed (such as accepting event data as a second argument).
+# This is assuming, so we're fixing it here.
+
+begin
+  require "active_support/tagged_logging"
+
+  # Instead of patching the class we're pulling the code from Rails master. This brings in
+  # a number of improvements while also addressing the issue above.
+  if ActiveSupport::TaggedLogging.instance_of?(Class)
+    ActiveSupport.send(:remove_const, :TaggedLogging)
+
+    require "active_support/core_ext/module/delegation"
+    require "active_support/core_ext/object/blank"
+    require "logger"
+
+    module ActiveSupport
+      # Wraps any standard Logger object to provide tagging capabilities.
+      #
+      #   logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
+      #   logger.tagged('BCX') { logger.info 'Stuff' }                            # Logs "[BCX] Stuff"
+      #   logger.tagged('BCX', "Jason") { logger.info 'Stuff' }                   # Logs "[BCX] [Jason] Stuff"
+      #   logger.tagged('BCX') { logger.tagged('Jason') { logger.info 'Stuff' } } # Logs "[BCX] [Jason] Stuff"
+      #
+      # This is used by the default Rails.logger as configured by Railties to make
+      # it easy to stamp log lines with subdomains, request ids, and anything else
+      # to aid debugging of multi-user production applications.
+      module TaggedLogging
+        module Formatter # :nodoc:
+          # This method is invoked when a log event occurs.
+          def call(severity, timestamp, progname, msg)
+            super(severity, timestamp, progname, "#{tags_text}#{msg}")
+          end
+
+          def tagged(*tags)
+            new_tags = push_tags(*tags)
+            yield self
+          ensure
+            pop_tags(new_tags.size)
+          end
+
+          def push_tags(*tags)
+            tags.flatten.reject(&:blank?).tap do |new_tags|
+              current_tags.concat new_tags
+            end
+          end
+
+          def pop_tags(size = 1)
+            current_tags.pop size
+          end
+
+          def clear_tags!
+            current_tags.clear
+          end
+
+          def current_tags
+            # We use our object ID here to avoid conflicting with other instances
+            thread_key = @thread_key ||= "activesupport_tagged_logging_tags:#{object_id}".freeze
+            Thread.current[thread_key] ||= []
+          end
+
+          def tags_text
+            tags = current_tags
+            if tags.any?
+              tags.collect { |tag| "[#{tag}] " }.join
+            end
+          end
+        end
+
+        # Simple formatter which only displays the message.
+        class SimpleFormatter < ::Logger::Formatter
+          # This method is invoked when a log event occurs
+          def call(severity, timestamp, progname, msg)
+            "#{String === msg ? msg : msg.inspect}\n"
+          end
+        end
+
+        def self.new(logger)
+          # Ensure we set a default formatter so we aren't extending nil!
+          logger.formatter ||= SimpleFormatter.new
+          logger.formatter.extend Formatter
+          logger.extend(self)
+        end
+
+        delegate :push_tags, :pop_tags, :clear_tags!, to: :formatter
+
+        def tagged(*tags)
+          formatter.tagged(*tags) { yield self }
+        end
+
+        def flush
+          clear_tags!
+          super if defined?(super)
+        end
+      end
+    end
+  end
+
+rescue Exception
+end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.0.22"
+  VERSION = "2.0.23"
 end

data/spec/rails/tagged_logging_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+# ActiveSupport::TaggedLogging is not defined in <= 3.1
+if defined?(::ActiveSupport::TaggedLogging)
+  describe ActiveSupport::TaggedLogging, :rails_23 => true do
+    describe "#info" do
+      let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+      let(:io) { StringIO.new }
+      let(:logger) { ActiveSupport::TaggedLogging.new(Timber::Logger.new(io)) }
+
+      around(:each) do |example|
+        Timecop.freeze(time) { example.run }
+      end
+
+      it "should format properly with events" do
+        event = Timber::Events::SQLQuery.new(sql: "select * from users", time_ms: 56, message: "select * from users")
+        logger.tagged("tag") do
+          logger.info(event)
+        end
+        expect(io.string).to include("\"tags\":[\"tag\"]")
+      end
+
+      it "should accept events as the second argument" do
+        logger.info("SQL query", payment_rejected: {customer_id: "abcd1234", amount: 100, reason: "Card expired"})
+        expect(io.string).to start_with("SQL query @metadata")
+        expect(io.string).to include("\"event\":{\"custom\":{\"payment_rejected\":")
+      end
+    end
+  end
+end

data/spec/timber/logger_spec.rb

@@ -100,20 +100,6 @@ describe Timber::Logger, :rails_23 => true do
       end
     end
 
-    if defined?(ActiveSupport::TaggedLogging)
-      context "with TaggedLogging", :rails_23 => false do
-        let(:logger) { ActiveSupport::TaggedLogging.new(Timber::Logger.new(io)) }
-
-        it "should format properly with events" do
-          message = Timber::Events::SQLQuery.new(sql: "select * from users", time_ms: 56, message: "select * from users")
-          logger.tagged("tag") do
-            logger.info(message)
-          end
-          expect(io.string).to include("\"tags\":[\"tag\"]")
-        end
-      end
-    end
-
     context "with the HTTP log device" do
       let(:io) { Timber::LogDevices::HTTP.new("my_key") }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.22
+  version: 2.0.23
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -146,6 +146,7 @@ files:
 - gemfiles/rails-4.1.gemfile
 - gemfiles/rails-4.2.gemfile
 - gemfiles/rails-5.0.gemfile
+- gemfiles/rails-5.1.gemfile
 - gemfiles/rails-edge.gemfile
 - lib/timber.rb
 - lib/timber/cli.rb
@@ -200,6 +201,7 @@ files:
 - lib/timber/log_entry.rb
 - lib/timber/logger.rb
 - lib/timber/overrides.rb
+- lib/timber/overrides/active_support_tagged_logging.rb
 - lib/timber/overrides/lograge.rb
 - lib/timber/overrides/rails_stdout_logging.rb
 - lib/timber/util.rb
@@ -212,6 +214,7 @@ files:
 - lib/timber/util/struct.rb
 - lib/timber/version.rb
 - spec/README.md
+- spec/rails/tagged_logging_spec.rb
 - spec/spec_helper.rb
 - spec/support/action_controller.rb
 - spec/support/active_record.rb
@@ -270,6 +273,7 @@ specification_version: 4
 summary: Log Better. Solve Problems Faster. https://timber.io
 test_files:
 - spec/README.md
+- spec/rails/tagged_logging_spec.rb
 - spec/spec_helper.rb
 - spec/support/action_controller.rb
 - spec/support/active_record.rb