filum 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc7fea2cacec8aaaa40b2017b9af8fc54c2aa224
-  data.tar.gz: d93d4e4bca152a0569e2d88be143c508a7fedaa1
+  metadata.gz: 83e02d7327a627863f95dbdbb6ace5b57e889223
+  data.tar.gz: 0ff4c2261899b313fa192e947ce5acf71de8884f
 SHA512:
-  metadata.gz: 23153c103796478843318c97a3bb5753ffca5b824f62c42106e9f518b43a4c614cf5f976699d3d043736ca7e8b5ca764150e983724b197f36271543e55f50daa
-  data.tar.gz: 7e6d5ce623f159cadefcdc63ffcd11e8e5629dcbf92d70a75125a95d377eeb339bf56b186c933287a989514a4246bba394df4b716d4dfa5dfec661f10567e426
+  metadata.gz: 2acc99b793fd25de85715a9011a142ebba8d71641125e6a46181d03e9ee17358bb60c7caf9b1014f58ad93e3e5bfc8c10ce16510c3df3a1611bdd04a4f976ef9
+  data.tar.gz: 3dd343497653597debccddecae5751cd585af9f52b50fa682eeda9dbe43425518fa21362b051acdb6b09698f5726e5327340646da86dd1cbaf84393a91e3c4f7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+0.1.0 / 2013-12-11
+[FEATURE] Use formatter for logging
+
+0.0.3 / Unreleased
+[FEATURE] Improving log format

data/lib/filum/configuration.rb

@@ -5,11 +5,14 @@ module Filum
 
   class Configuration
 
-    SETTINGS = [
-      :logfile
-    ]
+    SETTINGS = [ :logfile, :context_id_length, :filename_length ]
     attr_accessor *SETTINGS
 
+    def initialize
+      self.context_id_length = 6
+      self.filename_length   = 20
+    end
+
   end
 end
 

data/lib/filum/logger.rb

@@ -2,28 +2,42 @@ require 'logger'
 
 module Filum
   class Logger < ::Logger
+
+    def initialize(*args)
+      super
+      self.formatter = Filum::Logger::Formatter.new
+    end
+
     def context_id=(context_id)
       Thread.current[:context_id] = context_id
     end
 
-    def info(str)
-      super("#{DateTime.now} thread_id-#{Thread.current.object_id} [#{Thread.current[:context_id]}] INFO | #{str} | #{caller[0]}")
-    end
+    class Formatter < Logger::Formatter
+      def call(severity, timestamp, progname, msg)
+        "#{timestamp} thread_id-#{Thread.current.object_id} [#{formatted_context_id}] #{severity} | #{formatted_calling_file_and_line} | #{msg}\n"
+      end
 
-    def fatal(str)
-      super("#{DateTime.now} thread_id-#{Thread.current.object_id} [#{Thread.current[:context_id]}] FATAL | #{str} | #{caller[0]}")
-    end
+      private
+      def formatted_context_id
+        context_id.ljust(Filum.config.context_id_length)
+      end
 
-    def error(str)
-      super("#{DateTime.now} thread_id-#{Thread.current.object_id} [#{Thread.current[:context_id]}] ERROR | #{str} | #{caller[0]}")
-    end
+      def context_id
+        Thread.current[:context_id].to_s
+      end
 
-    def warn(str)
-      super("#{DateTime.now} thread_id-#{Thread.current.object_id} [#{Thread.current[:context_id]}] WARN | #{str} | #{caller[0]}")
-    end
+      def formatted_calling_file_and_line
+        filename_length = Filum.config.filename_length
+        truncated_filename_length = filename_length - 3
+
+        _, file, line = calling_code.match(/([\w\.]+)\:(\d+)\:in /).to_a
+        file = "#{file[0,truncated_filename_length]}..." if file.length >= filename_length 
+        "#{file}:#{line.ljust(3)}".ljust(filename_length + 4)
+      end
 
-    def debug(str)
-      super("#{DateTime.now} thread_id-#{Thread.current.object_id} [#{Thread.current[:context_id]}] DEBUG | #{str} | #{caller[0]}")
+      def calling_code
+        caller[4]
+      end
     end
   end
-end
+end

data/lib/filum/version.rb

@@ -1,3 +1,3 @@
 module Filum
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/integration/logger_test.rb

@@ -11,31 +11,127 @@ module Filum
   class LoggerTest < IntegrationTest
     def test_one_logline
       test_thread = Thread.new do
-        Filum.logger.context_id = " [12345]"
+        Filum.logger.context_id = "123456"
         Worker.process
       end
       test_thread.join
-      assert_logged(/\[12345\]/)
+      assert_logged(/\[123456\]/)
     end
 
     def test_multiple_threads
       test_thread1 = Thread.new do
-        Filum.logger.context_id = " [23456]"
+        Filum.logger.context_id = "23456a"
         Worker.process
       end
       test_thread2 = Thread.new do
-        Filum.logger.context_id = " [34567]"
+        Filum.logger.context_id = "34567a"
         Worker.process
       end
       test_thread1.join
       test_thread2.join
-      assert_logged(/\[23456\]/)
-      assert_logged(/\[34567\]/)
+      assert_logged(/\[23456a\]/)
+      assert_logged(/\[34567a\]/)
     end
 
+    def test_info_string_is_correct
+      Filum.logger.info "Foobar"
+      assert_logged(/Foobar$/)
+    end
 
+    private
     def assert_logged(regex)
       assert File.readlines(Filum.config.logfile).grep(regex).size == 1
     end
   end
+
+  class LogFormatterTest < IntegrationTest
+    def test_string_format
+      formatter = Filum::Logger::Formatter.new
+      severity = "SEV123"
+      timestamp = "Timestamp123"
+      msg = "My Message"
+      context_id = "context_id"
+      object_id = Thread.current.object_id
+      file_and_line = "file_and_line"
+      formatter.stubs(calling_file_and_line: file_and_line)
+      Thread.current[:context_id] = context_id
+
+      output = formatter.call(severity, timestamp, nil, msg)
+      desired = "#{timestamp} thread_id-#{object_id} [#{context_id}] #{severity} | #{file_and_line} | #{msg}\n"
+      assert_equal desired.strip.hex, output.strip.hex
+    end
+
+    def test_call_calls_formatted_context_id
+      formatter = Filum::Logger::Formatter.new
+      formatter.expects(:formatted_context_id)
+      formatter.call("", "", "", "")
+    end
+
+    def test_formatted_context_id_uses_config
+      Filum.config.context_id_length = 20
+      context_id = "12345"
+      Thread.current[:context_id] = context_id
+      formatter = Filum::Logger::Formatter.new
+      output = formatter.send(:formatted_context_id)
+      assert_equal "#{context_id}               ", output
+    end
+
+    def test_call_calls_formatted_calling_file_and_line
+      formatter = Filum::Logger::Formatter.new
+      formatter.expects(:formatted_calling_file_and_line)
+      formatter.call("", "", "", "")
+    end
+
+    def test_call_should_not_truncate_context_id
+      context_id = "context_id"
+      Thread.current[:context_id] = context_id
+      formatter = Filum::Logger::Formatter.new
+      output = formatter.send(:formatted_context_id)
+      assert_equal context_id, output
+    end
+
+    def test_call_should_return_fixed_width_context_id
+      context_id = "1234"
+      Thread.current[:context_id] = context_id
+      formatter = Filum::Logger::Formatter.new
+      output = formatter.send(:formatted_context_id)
+      assert_equal "#{context_id}  ", output
+    end
+
+    def test_calling_file_and_line_parses_correctly
+      formatter = Filum::Logger::Formatter.new
+      line = "/Users/iHiD/Projects/meducation/filum/lib/filum/logger.rb:30:in `formatted_calling_file_and_line'"
+      formatter.stubs(calling_code: line)
+      output = formatter.send(:formatted_calling_file_and_line)
+      assert output =~ /logger\.rb:30\s*/
+    end
+
+    def test_formatted_calling_file_and_line_uses_config
+      Filum.config.filename_length = 40
+      filename = "abcdefghij"
+      line = "/Users/iHiD/Projects/meducation/filum/lib/filum/#{filename}:30:in `formatted_calling_file_and_line'"
+      formatter = Filum::Logger::Formatter.new
+      formatter.stubs(calling_code: line)
+      output = formatter.send(:formatted_calling_file_and_line)
+      assert_equal "#{filename}:30 #{" " * 30}", output
+    end
+
+    def test_formatted_calling_file_and_line_should_truncate
+      filename = "abcdefghijklmnopqrstuvwxyz1234"
+      line = "/Users/iHiD/Projects/meducation/filum/lib/filum/#{filename}:30:in `formatted_calling_file_and_line'"
+      formatter = Filum::Logger::Formatter.new
+      formatter.stubs(calling_code: line)
+      output = formatter.send(:formatted_calling_file_and_line)
+      assert_equal "abcdefghijklmnopq...:30 ", output
+    end
+
+    def test_formatted_calling_file_and_line_should_pad
+      filename = "foobar.txt"
+      line = "/Users/iHiD/Projects/meducation/filum/lib/filum/#{filename}:30:in `formatted_calling_file_and_line'"
+      formatter = Filum::Logger::Formatter.new
+      formatter.stubs(calling_code: line)
+      output = formatter.send(:formatted_calling_file_and_line)
+      assert_equal "foobar.txt:30           ", output
+    end
+  end
 end

data/test/test_helper.rb

@@ -9,3 +9,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "filum"
 
+class Minitest::Test
+  def setup
+    super
+    Filum.instance_variable_set(:@config, nil)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filum
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - MalcyL
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Identifies the context of log lines using a context id stored in Thread local