timber 2.1.0.rc4 → 2.1.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c4de508448203aa02a9dba6eec487ed04d0ffcf
-  data.tar.gz: 8c7e69aad8ab879841ca7d31910e09e86e5c7658
+  metadata.gz: 6bb5abd9ff785281715e45354703c1b9c3f2b25b
+  data.tar.gz: 347d46a12f3880a73e28d595554c5f838bb59eb1
 SHA512:
-  metadata.gz: e91f93d4548d7459c5ecdda73917a1cf188301feaab95de3bcd319e8b779a9f250507046010688c459bbfc1a06de058df9caf3329e834d0f6e49d31fe9099c22
-  data.tar.gz: d944798f07d4b1bb0ee0d07b34ce321b75918aa5c5b23107ca6e6f62ba532837d474f2f625092f513c977fe7362fbfd4831506383945e28419c68c8fe44950a1
+  metadata.gz: 553e015f5deecc539ec6437e7ae661f2e75d0d3bee6e92b095efb05f5ce180a7bc7ba7d710ca5749f022d61e3ed26e1f0b02cb1e778693f1f5553cf15570d9c8
+  data.tar.gz: 979086f4ac6d10bb38276696eed64b3ccf9cb79b2b057c8f83d3e1e045959735e4d9ab0cc47874cd21d2e4ba0bebd87382576436e94aff15204c0d9dcccc2944

data/README.md

@@ -59,7 +59,7 @@ Sent 200 in 45.2ms @metadata {"dt": "2017-02-02T01:33:21.154345Z", "level": "inf
 ```
 
 Notice that instead of completely replacing your log messages,
-Timber _augments_ your logs with structured metadata. Turning turns them into
+Timber _augments_ your logs with structured metadata. Turning them into
 [rich events with context](https://timber.io/docs/ruby/events-and-context) without sacrificing
 readability. And you have [complete control over which data is captured](#configuration).
 
@@ -213,7 +213,13 @@ logger.info("Processed background job", background_job: {time_ms: timer})
 # => Processed background job in 54.2ms @metadata {"level": "info", "event": {"background_job": {"time_ms": 54.2}}}
 ```
 
-Or capture any metric you want:
+And of course, `time_ms` can also take a `Float`:
+
+```ruby
+logger.info("Processed background job", background_job: {time_ms: 45.6})
+```
+
+Lastly, metrics aren't limited to timings. You can capture any metric you want:
 
 ```ruby
 logger = Timber::Logger.new(STDOUT)

data/lib/timber/frameworks/rails.rb

@@ -3,47 +3,6 @@ module Timber
     # Module for Rails specific code, such as the Railtie and any methods that assist
     # with Rails setup.
     module Rails
-      # Because of the crazy way Rails sorts it's initializers, it is
-      # impossible for Timber to be inserted after Devise's omnitauth
-      # middlewares.
-      # See: https://github.com/plataformatec/devise/blob/master/lib/devise/rails.rb#L22
-      # As such, we take a brute force approach here, ensuring we are inserted last
-      # no matter what. This ensures that we come after authentication so that we can
-      # properly set the user context.
-      #
-      # @private
-      module MiddlewareStackProxyFix
-        def self.included(klass)
-          klass.class_eval do
-            attr_accessor :timber_operations
-
-            alias old_merge_into merge_into
-
-            # This method does not exist for older versions of rails
-            begin
-              alias old_plus +
-            rescue NameError
-            end
-
-            def +(*args)
-              result = old_plus(*args)
-              result.timber_operations = timber_operations
-              result
-            end
-
-            def merge_into(*args)
-              if timber_operations
-                @operations -= timber_operations
-                @operations += timber_operations
-              end
-              old_merge_into(*args)
-            end
-          end
-        end
-      end
-
-      ::Rails::Configuration::MiddlewareStackProxy.send(:include, MiddlewareStackProxyFix)
-
       # Installs Timber into your Rails app automatically.
       class Railtie < ::Rails::Railtie
         config.timber = Config.instance
@@ -52,20 +11,26 @@ module Timber
           Timber::Config.instance.logger = Proc.new { ::Rails.logger }
         end
 
+        after =
+          begin
+            require 'devise'
+            'devise.omniauth'
+          rescue LoadError
+            :load_config_initializers
+          end
+
         # Must be loaded after initializers so that we respect any Timber configuration
         # set
-        initializer(:timber, after: :load_config_initializers) do
+        initializer(:timber, before: :build_middleware_stack, after: after) do
           Integrations.integrate!
 
           # Install the Rack middlewares so that we capture structured data instead of
           # raw text logs.
-          timber_operations = Integrations::Rack.middlewares.collect do |middleware_class|
-            [:use, [middleware_class], nil]
+          Integrations::Rack.middlewares.collect do |middleware_class|
+            config.app_middleware.use middleware_class
           end
-
-          config.app_middleware.timber_operations = timber_operations
         end
       end
     end
   end
-end
+end

data/lib/timber/integrations/rails/rack_logger.rb

@@ -19,10 +19,19 @@ module Timber
           def self.included(klass)
             klass.class_eval do
               private
-                # Rails 3.2 calls Rails.logger directly, so this is the first place
-                # we can mute the logger calls.
-                def started_request_message(*args)
-                  ""
+                if ::Rails::VERSION::MAJOR == 3
+                  # Rails 3.2 calls Rails.logger directly in call_app, so we
+                  # will just replace it with a version that doesn't
+                  def call_app(_, env)
+                    # Put some space between requests in development logs.
+                    if ::Rails.env.development?
+                      ::Rails.logger.info ''
+                      ::Rails.logger.info ''
+                    end
+                    @app.call(env)
+                  ensure
+                    ActiveSupport::LogSubscriber.flush_all!
+                  end
                 end
 
                 # Rails > 3.2 uses a logger method. Muting logs is accomplished by

data/lib/timber/logger.rb

@@ -232,6 +232,13 @@ module Timber
       super
     end
 
+    def level=(value)
+      if value.is_a?(Symbol)
+        value = level_from_symbol(value)
+      end
+      super
+    end
+
     # Convenience method for adding context. Please see {{Timber::CurrentContext.with}} for
     # a more detailed description and examples.
     def with_context(context, &block)
@@ -270,5 +277,17 @@ module Timber
         level = ([ENV['LOG_LEVEL'].to_s.upcase, "DEBUG"] & %w[DEBUG INFO WARN ERROR FATAL UNKNOWN]).compact.first
         self.class.const_get(level)
       end
+
+      def level_from_symbol(value)
+        case value
+        when :debug; DEBUG
+        when :info;  INFO
+        when :warn;  WARN
+        when :error; ERROR
+        when :fatal; FATAL
+        when :unknown; UNKNOWN
+        else; raise ArgumentError.new("level #{value.inspect} is not a valid logger level")
+        end
+      end
   end
 end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.1.0.rc4"
+  VERSION = "2.1.0.rc5"
 end

data/spec/timber/logger_spec.rb

@@ -15,7 +15,7 @@ describe Timber::Logger, :rails_23 => true do
         Timber::Config.instance.environment = old_env
       end
 
-      it "shoud select the augmented formatter" do
+      it "shoud select the message only formatter" do
         logger = described_class.new(nil)
         expect(logger.formatter).to be_kind_of(Timber::Logger::MessageOnlyFormatter)
       end
@@ -31,6 +31,32 @@ describe Timber::Logger, :rails_23 => true do
       Timecop.freeze(time) { example.run }
     end
 
+    it "should respect the level via Logger constants" do
+      logger.formatter = Timber::Logger::MessageOnlyFormatter.new
+
+      logger.level = ::Logger::DEBUG
+      logger.info("message")
+      expect(io.string).to eq("message\n")
+
+      io.string = ""
+      logger.level = ::Logger::WARN
+      logger.info("message")
+      expect(io.string).to eq("")
+    end
+
+    it "should respect the level via level symbols" do
+      logger.formatter = Timber::Logger::MessageOnlyFormatter.new
+
+      logger.level = :debug
+      logger.info("message")
+      expect(io.string).to eq("message\n")
+
+      io.string = ""
+      logger.level = :warn
+      logger.info("message")
+      expect(io.string).to eq("")
+    end
+
     context "with the AugmentedFormatter" do
       before(:each) { logger.formatter = Timber::Logger::AugmentedFormatter.new }
 
@@ -39,7 +65,7 @@ describe Timber::Logger, :rails_23 => true do
         expect(io.string).to start_with("this is a test @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"")
       end
 
-      it "should non-strings" do
+      it "should accept non-strings" do
         logger.info(true)
         expect(io.string).to start_with("true @metadata")
       end
@@ -76,7 +102,7 @@ describe Timber::Logger, :rails_23 => true do
         expect(io.string).to include("\"event\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}")
       end
 
-      it "should log properly when an event is passed" do
+      it "should log properly when a Timber::Event object is passed" do
         message = Timber::Events::SQLQuery.new(sql: "select * from users", time_ms: 56, message: "select * from users")
         logger.info(message)
         expect(io.string).to start_with("select * from users @metadata {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",")
@@ -94,8 +120,12 @@ describe Timber::Logger, :rails_23 => true do
       end
 
       it "should allow :tags" do
-        logger.info("event complete", tags: ["tag1", "tag2"])
+        tags = ["tag1", "tag2"]
+        logger.info("event complete", tags: tags)
         expect(io.string).to include("\"tags\":[\"tag1\",\"tag2\"]")
+
+        # Ensure the tags object is not modified
+        expect(tags).to eq(["tag1", "tag2"])
       end
 
       it "should allow functions" do
@@ -130,6 +160,24 @@ describe Timber::Logger, :rails_23 => true do
     end
   end
 
+  describe "#error" do
+    let(:io) { StringIO.new }
+    let(:logger) { Timber::Logger.new(io) }
+
+    it "should allow default usage" do
+      logger.error("message")
+      expect(io.string).to start_with("message @metadata")
+      expect(io.string).to include('"level":"error"')
+    end
+
+    it "should allow messages with options" do
+      logger.error("message", tag: "tag")
+      expect(io.string).to start_with("message @metadata")
+      expect(io.string).to include('"level":"error"')
+      expect(io.string).to include('"tags":["tag"]')
+    end
+  end
+
   describe "#formatter=" do
     it "should not allow changing the formatter when the device is HTTP" do
       http_device = Timber::LogDevices::HTTP.new("api_key")
@@ -145,6 +193,29 @@ describe Timber::Logger, :rails_23 => true do
     end
   end
 
+  describe "#info" do
+    let(:io) { StringIO.new }
+    let(:logger) { Timber::Logger.new(io) }
+
+    it "should allow default usage" do
+      logger.info("message")
+      expect(io.string).to start_with("message @metadata")
+      expect(io.string).to include('"level":"info"')
+    end
+
+    it "should allow messages with options" do
+      logger.info("message", tag: "tag")
+      expect(io.string).to start_with("message @metadata")
+      expect(io.string).to include('"level":"info"')
+      expect(io.string).to include('"tags":["tag"]')
+    end
+
+    it "should accept non-string messages" do
+      logger.info(true)
+      expect(io.string).to start_with("true @metadata")
+    end
+  end
+
   describe "#silence" do
     let(:io) { StringIO.new }
     let(:logger) { Timber::Logger.new(io) }
@@ -178,45 +249,4 @@ describe Timber::Logger, :rails_23 => true do
       expect(Timber::CurrentContext.instance.send(:hash)[:custom]).to be_nil
     end
   end
-
-  describe "#info" do
-    let(:io) { StringIO.new }
-    let(:logger) { Timber::Logger.new(io) }
-
-    it "should allow default usage" do
-      logger.info("message")
-      expect(io.string).to start_with("message @metadata")
-      expect(io.string).to include('"level":"info"')
-    end
-
-    it "should allow messages with options" do
-      logger.info("message", tag: "tag")
-      expect(io.string).to start_with("message @metadata")
-      expect(io.string).to include('"level":"info"')
-      expect(io.string).to include('"tags":["tag"]')
-    end
-
-    it "should accept non-string messages" do
-      logger.info(true)
-      expect(io.string).to start_with("true @metadata")
-    end
-  end
-
-  describe "#error" do
-    let(:io) { StringIO.new }
-    let(:logger) { Timber::Logger.new(io) }
-
-    it "should allow default usage" do
-      logger.error("message")
-      expect(io.string).to start_with("message @metadata")
-      expect(io.string).to include('"level":"error"')
-    end
-
-    it "should allow messages with options" do
-      logger.error("message", tag: "tag")
-      expect(io.string).to start_with("message @metadata")
-      expect(io.string).to include('"level":"error"')
-      expect(io.string).to include('"tags":["tag"]')
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc4
+  version: 2.1.0.rc5
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-04 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack