sinatra-log 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74bad9e3793d9e6ea15b20cb1d885db8e8b9ab16
-  data.tar.gz: 032e9d08ce73ad442b93e53f1ad2b661bc651dcc
+  metadata.gz: d330d9392783361671201bbfd7edd7896a428038
+  data.tar.gz: fe9491f7f176995b96ead97d92fb817430d2018c
 SHA512:
-  metadata.gz: 384f29484e66a4054fcf75349f73145e6eade5ea53e3be730b5e1ed74a6a80587e39e6ba0f7ddc63573bdcf2a51163597325ddff828a74435a6b17b07c83543f
-  data.tar.gz: 17dfd01b9926d36c0cce08bd039c52772874ea0873ad29c264c124da40481faf33854120b3d407f6c27e95d7b388755b0aa7fa2234f86feaec4688fe7c7c86de
+  metadata.gz: 98a409b0fa7bbc3f053ecb42572ab353c13825df433a4564b33ee1ec67e96da9ef7248e7909beea08d753622e6252a58ed9539f81d8362e2dc7b31fc0bf2c007
+  data.tar.gz: 8058cd7f3c28ebf9083cc0a90227ccdc46b9c7e0deff7309ceafe02ee9c196339a14222ee5a55b7dcee02673c7ed3d80faa6d44d7891e8b4af1e0bcda8326015

data/README.md

@@ -0,0 +1,24 @@
+# A Sinatra Logger ![Build Status][1]
+
+### History
+
+I wrote this wrapper around log4r in 2014 for a small Sinatra project at
+[Lookout][4]. As the project ended, the code was pulled out
+and open sourced by [ismith][3] and included in [lookout-rack-utils][2].
+
+### Changes
+
+It is mostly unchanged here, though configuration is done through the logging
+constructor, not through configatron. Graphite logging was also thrown out,
+though that could be re-added if desired. And of course there was a namespace
+change.
+
+### Purpose
+
+This was written for usage in Sinatra -- as logging isn't provide outside of
+request context. But it could be used in any Ruby project.
+
+[1]: https://api.travis-ci.org/svrana/sinatra-log.svg?branch=master
+[2]: https://github.com/lookout/lookout-rack-utils.git
+[3]: https://github.com/ismith
+[4]: https://lookout.com

data/lib/sinatra/log.rb

@@ -3,38 +3,53 @@ require 'log4r'
 require 'time'
 
 module Sinatra
-  # Logging.  Logs to log/<project_name>.log with the format:
+  # Logs to specified filename with the format:
   #
   #   [Log Level]: [Timestamp (ISO-8601)]: [File:linenum]: [Log Message]
   #
-  # Use through the helper:
-  #   log.warn 'This is my log message'
+  # Access is usually wrapped in a class helper:
   #
+  # class MyProject
+  #   self.log
+  #     @logger ||= Sinatra::Log.new(:logger_name => 'myproject',
+  #                                  :log_filename => 'myproject/dev.log',
+  #                                  :loglevel => 'WARN',
+  #                                  :enabled => true,
+  #                                  :project_dir => '/var/opt/myproj')
+  #   end
+  # end
   class Log
     include Log4r
 
+    REQUIRED_CONFIG_SYMBOLS = [:logger_name, :loglevel, :log_filename,
+                               :enabled].freeze
+
     # Formatter that include the filename and relative path, and line number in
     # output of the caller.
     #
     # Since all callers go through the methods defined in this class to log, we
     # look at the second line of the tracer output, removing everything but the
     # directories after the project directory.
-    #
     class DefaultFormatter < Log4r::Formatter
-      # Return the project base directory for filtering to help with
-      # identifiying the filename and line number when formatting the log
-      # message
-      #
-      # @return [String] Base directory for the project
-      def basedir
-        @basedir ||= File.expand_path(File.join(File.dirname(__FILE__), ".."))
+      attr_reader :basedir
+
+      # @param [String] basedir   The base project directory; this directory
+      #   will be filtered out from each log entry if specified.
+      def initialize(basedir = nil)
+        super
+        @basedir = basedir
       end
 
       # Return a trimmed version of the filename from where a LogEvent occurred
+      #
       # @param [String] tracer A line from the LogEvent#tracer Array
       # @return [String] Trimmed and parsed version of the file ane line number
       def event_filename(tracer)
-        parts = tracer.match(/#{basedir}\/(.*:[0-9]+).*:/)
+        if basedir.nil?
+          parts = tracer.match(/(.*:[0-9]+).*:/)
+        else
+          parts = tracer.match(/#{basedir}\/(.*:[0-9]+).*:/)
+        end
 
         # If we get no matches back, we're probably in a jar file in which case
         # the format of the tracer is going to be abbreviated
@@ -60,12 +75,12 @@ module Sinatra
 
     def initialize(config={})
       errors = []
-      [:logger_name, :loglevel, :log_filename, :enabled].each do |key|
+      REQUIRED_CONFIG_SYMBOLS.each do |key|
         if !config.include?(key)
           errors << "#{key} required, but not specified in config hash"
         end
-        raise ArgumentError, "#{errors}" if errors.count > 0
       end
+      raise ArgumentError, "#{errors}" if errors.count > 0
 
       logger_name = config[:logger_name].to_s.gsub(/\s+/, '_')
       @logger = Log4r::Logger.new(logger_name)
@@ -82,7 +97,7 @@ module Sinatra
                                      :filename => config[:log_filename],
                                      :trunc => false)
       @logger.trace = true
-      @outputter.formatter = DefaultFormatter
+      @outputter.formatter = DefaultFormatter.new(config[:project_dir])
       @logger.outputters = @outputter
     end
 

data/lib/sinatra/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Logger
-    VERSION = "0.0.1"
+    VERSION = "0.1.1"
   end
 end

data/spec/{logger_spec.rb → formatter_spec.rb}

@@ -2,55 +2,15 @@ require 'spec_helper'
 require 'sinatra/log'
 require 'timecop'
 
-describe Sinatra::Log do
-  let(:myconfig) do
-    {
-      :enabled => true,
-      :logger_name => 'mylogger',
-      :loglevel => 'DEBUG',
-      :log_filename => 'log'
-    }
-  end
-
-  subject(:log) { Sinatra::Log.new(myconfig) }
-  subject(:log_message) { 'foo' }
-
-  [:debug, :info, :warn, :error, :fatal].each do |method|
-    describe ".#{method}" do
-      it 'should invoke the internal logger object with a given block' do
-        log.instance_variable_get(:@logger).should_receive(method).with(log_message).and_call_original
-        processed = false
-        b = Proc.new { processed = true }
-        log.send(method, log_message, &b)
-        expect(processed).to be(true)
-      end
-
-      it 'should invoke the internal logger object w/o a given block' do
-        log.instance_variable_get(:@logger).should_receive(method).with(log_message).and_call_original
-        log.send(method, log_message)
-      end
-    end
-  end
-
-  [:debug?, :info?, :warn?, :error?, :fatal?].each do |method|
-    describe ".#{method}" do
-      it 'returns true when level is debug' do
-        expect(log.send(method)).to eq(true)
-      end
-    end
-  end
-end
-
 describe Sinatra::Log::DefaultFormatter do
-  subject(:formatter) { described_class.new }
+  let(:project_name) { 'some_project' }
+  let(:basedir) { "/home/proj/backend/#{project_name}" }
   let(:logger) do
     logger = double('Mock Logger')
     logger.stub(:name).and_return('RSpec Logger')
     logger.stub(:fullname).and_return('RSpec Logger')
     logger
   end
-  let(:project_name) { 'some_project' }
-  let(:basedir) { "/home/rspec/#{project_name}" }
   let(:tracer) do
     [
         "#{basedir}/log.rb:63:in `warn'",
@@ -58,23 +18,27 @@ describe Sinatra::Log::DefaultFormatter do
     ]
   end
 
+  subject(:formatter) { described_class.new(basedir) }
+
   before :all do
     # The root logger creates the log levels, so making sure it's been
     # created
     Log4r::RootLogger.instance
   end
 
-
-  before :each do
-    formatter.stub(:basedir).and_return(basedir)
-  end
-
-
   describe '#event_filename' do
     subject(:filename) { formatter.event_filename(tracer[1]) }
 
-    context 'with a normal MRI LogEvent' do
-      it { should eql('spec/log_spec.rb:9') }
+    context 'with the project name specified' do
+      context 'with a normal MRI LogEvent' do
+        it { should eql('spec/log_spec.rb:9') }
+      end
+    end
+
+    context 'without the project name specified' do
+      let(:formatter) { described_class.new }
+
+      it { should eql("#{basedir}/spec/log_spec.rb:9") }
     end
 
     # We have slightly different log formats under packaged .jar files
@@ -100,10 +64,7 @@ describe Sinatra::Log::DefaultFormatter do
       let(:level) { 3 }
       let(:data) { 'rspec' }
       let(:timestamp) { Time.now.utc.iso8601 }
-
-      let(:event) do
-        event = Log4r::LogEvent.new(level, logger, tracer, data)
-      end
+      let(:event) { Log4r::LogEvent.new(level, logger, tracer, data) }
 
       it 'should be properly formatted' do
         expect(formatter.format(event)).to eql("WARN: #{timestamp}: spec/log_spec.rb:9: #{data}\n")

data/spec/log_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'sinatra/log'
+
+describe Sinatra::Log do
+  let(:myconfig) do
+    {
+      :enabled => true,
+      :logger_name => 'mylogger',
+      :loglevel => 'DEBUG',
+      :log_filename => 'log'
+    }
+  end
+
+  subject(:log) { Sinatra::Log.new(myconfig) }
+  subject(:log_message) { 'foo' }
+
+  [:debug, :info, :warn, :error, :fatal].each do |method|
+    describe ".#{method}" do
+      it 'should invoke the internal logger object with a given block' do
+        log.instance_variable_get(:@logger).should_receive(method).with(log_message).and_call_original
+        processed = false
+        b = Proc.new { processed = true }
+        log.send(method, log_message, &b)
+        expect(processed).to be(true)
+      end
+
+      it 'should invoke the internal logger object w/o a given block' do
+        log.instance_variable_get(:@logger).should_receive(method).with(log_message).and_call_original
+        log.send(method, log_message)
+      end
+    end
+  end
+
+  [:debug?, :info?, :warn?, :error?, :fatal?].each do |method|
+    describe ".#{method}" do
+      it 'returns true when level is debug' do
+        expect(log.send(method)).to eq(true)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-log
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Shaw Vrana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,11 +106,13 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - lib/sinatra/log.rb
 - lib/sinatra/version.rb
 - sinatra-log.gemspec
-- spec/logger_spec.rb
+- spec/formatter_spec.rb
+- spec/log_spec.rb
 - spec/spec_helper.bak.rb
 - spec/spec_helper.rb
 homepage: http://github.com/svrana/sinatra-log
@@ -138,6 +140,7 @@ signing_key:
 specification_version: 4
 summary: ''
 test_files:
-- spec/logger_spec.rb
+- spec/formatter_spec.rb
+- spec/log_spec.rb
 - spec/spec_helper.bak.rb
 - spec/spec_helper.rb