slack_log_device 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 466a2f36071f7d51ec258e3034890b2bf434367b
-  data.tar.gz: fb58589a94ba4f6711775065c747d793b506361e
+  metadata.gz: 825e9f635d6d804f3b3221de1bc7c6f2e8f75702
+  data.tar.gz: 4ec127d12b83a824df28e0ed50c979f5dc71049c
 SHA512:
-  metadata.gz: 467fd9a2582e93b20d8cdf746a99d96dfc3fabfe906a6984ea56048973836ce8719a64852ca3cf6bfeef903103f9de4ac8632f463930ec9ade7946ad7814266a
-  data.tar.gz: 91e38b5d3f0666e0d675bde99bb59e6bacac0304f930ad5c0fdd5ea1207485d8fa85525faaeb9f5337e9706ec37c5e631d1d64e1509f0369e1a0d18962211dd8
+  metadata.gz: 2d42f60c686262a582f5b346f0fa46df4129beaa6cf391ee6fe7e76c776e6f854f4b37c6ac52eee7d79b82656dda1947fa5b63e061c70a68086457207a6ff31e
+  data.tar.gz: 9746e95b665bc59d0dd0db446bc794163e99d755d6274e213b26b73eb8d84bdcf3edc88522e3a95bb5c4f6d4d5ff8c84756804e7155f0e3db3bb4561bfcffe7e

data/README.mdown

@@ -40,6 +40,15 @@ starting with a `@`).
 - `username`: The username to post message as (nil by default).
 - `webhook_url`: The URL of the webhook (mandatory).
 
+## Formatter
+
+`slack_log_device` provides a log formatter to have a pretty output for slack.
+It can be configured like this:
+
+```ruby
+logger.formatter = SlackLogDevice::FORMATTER
+```
+
 ## Rails configuration
 
 For a rails application, it is recommanded to use following configuration into

data/VERSION

@@ -1 +1 @@
-2.1.3
+2.2.0

data/lib/slack_log_device.rb

@@ -6,6 +6,21 @@ require 'logger'
 
 class SlackLogDevice
 
+  FORMATTER = -> (severity, datetime, progname, message) do
+    text = "*`#{severity}`*"
+    text << " (*#{progname}*)" if progname.present?
+    text << ': '
+    if message.is_a?(Exception)
+      text << "A `#{message.class}` occurred: #{message.message}\n\n```"
+      backtrace = message.backtrace.join("\n")
+      backtrace = backtrace[0, MAX_MESSAGE_LENGTH - 7 - text.size] << "\n..." if backtrace.size > MAX_MESSAGE_LENGTH - 3
+      text << backtrace << '```'
+    else
+      text << message
+    end
+  end
+  MAX_MESSAGE_LENGTH = 4000
+
   attr_reader :channel, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url
 
   def initialize(options = {})
@@ -59,7 +74,7 @@ class SlackLogDevice
   end
 
   def flush?
-    auto_flush? || flush_delay.zero? || @buffer.join("\n").size > max_buffer_size
+    auto_flush? || flush_delay.zero? || @buffer.join("\n").bytesize > max_buffer_size
   end
 
   def flush_delay=(value)

data/spec/slack_log_device_spec.rb

@@ -13,6 +13,50 @@ describe SlackLogDevice do
     expect(device).not_to be_a(Logger::LogDevice)
   end
 
+  describe '::FORMATTER' do
+
+    let(:formatter) { SlackLogDevice::FORMATTER }
+
+    it 'returns a proc' do
+      expect(formatter).to be_a(Proc)
+    end
+
+    describe '#call' do
+
+      it 'returns a formatted message' do
+        expect(formatter.call('DEBUG', Time.now, ' ', 'Hello World')).to eq('*`DEBUG`*: Hello World')
+      end
+
+      it 'includes progname if given' do
+        expect(formatter.call('DEBUG', Time.now, 'My App', 'Hello World')).to eq('*`DEBUG`* (*My App*): Hello World')
+      end
+
+      it 'formats exception' do
+        exception = RuntimeError.new('BAM!')
+        exception.set_backtrace(['foo', 'bar'])
+        expect(formatter.call('DEBUG', Time.now, nil, exception)).to eq("*`DEBUG`*: A `RuntimeError` occurred: BAM!\n\n```foo\nbar```")
+      end
+
+      it 'message with trace never exceed 4000 chars' do
+        exception = RuntimeError.new('BAM!')
+        exception.set_backtrace(['a' * 4500])
+        message = formatter.call('DEBUG', Time.now, 'My App', exception)
+        expect(message.size).to eq(4000)
+        expect(message).to end_with("aaaaaa\n...```")
+      end
+
+      it 'can be exactly 4000 chars (without three dots)' do
+        exception = RuntimeError.new('BAM!')
+        exception.set_backtrace(['a' * 3950])
+        message = formatter.call('DEBUG', Time.now, nil, exception)
+        expect(message).to end_with('a```')
+        expect(message.size).to eq(4000)
+      end
+
+    end
+
+  end
+
   describe '#auto_flush?' do
 
     it 'is false by default' do
@@ -159,6 +203,14 @@ describe SlackLogDevice do
       }.to change { device.flush? }.from(false).to(true)
     end
 
+    it 'use byte size to compare max_buffer_size' do
+      options[:max_buffer_size] = 10
+      device.write('0123456é')
+      expect {
+        device.instance_variable_get(:@buffer).push('a')
+      }.to change { device.flush? }.from(false).to(true)
+    end
+
     it 'is true if auto_flush option is present' do
       expect {
         device.auto_flush = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack_log_device
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Alexis Toulotte