low 0.0.6 → 0.0.7

data/lib/low/middleware/request_logger.rb

@@ -0,0 +1,66 @@
+module Low
+  module Middleware
+    # `RequestLogger` set the env key "logger" to an instance of
+    # `Low::ScopedLogger`, with various attributes set according to the state
+    # of the request:
+    # * _IO_: if RACK_ENV is development or test, use an eponymous file in
+    #   the log directory, otherwise use STDOUT (as Heroku likes).
+    # * _log_level_: If set, use the LOG_LEVEL environment variable value;
+    #   otherwise, use INFO.
+    # * _group_key_: Use request_id env value.
+    class RequestLogger
+      def self.level
+        # If `LOG_LEVEL` is a valid level other than INFO,
+        if ['FATAL', 'ERROR', 'WARN', 'DEBUG'].include? ENV['LOG_LEVEL']
+          # use it;
+          eval "::Logger::#{ENV['LOG_LEVEL']}"
+        else
+          # otherwise, use `::Logger::INFO`
+          ::Logger::INFO
+        end
+      end
+
+      def self.io
+        # If `RACK_ENV` is development or test,
+        if ['development', 'test'].include? ENV['RACK_ENV']
+          # make sure the log directory exists,
+          Dir.mkdir('log') unless Dir.exists?('log')
+
+          # and log to the appropriate file;
+          File.open("log/#{ENV['RACK_ENV']}.log", 'a')
+        else
+          # otherwise, log to STDOUT (Heroku likes it this way).
+          STDOUT
+        end
+      end
+
+      DEFAULT_KEY = 'logger'
+
+      def initialize(app, opts = {})
+        @app = app
+        @key = opts[:key] || DEFAULT_KEY
+      end
+
+      def call(env)
+        # Set the 'rack.errors' environment key to the above `Logger.io`
+        # (other rack components, such as Sinatra, use this),
+        env['rack.errors'] = Logger.io
+
+        # instantiate a new `Useless::Logger`,
+        logger = Useless::Logger.new(env['rack.errors'])
+
+        # set the logger level to the above `Logger.level`,
+        logger.level = Logger.level
+
+        # set the request_id if one is available
+        logger.scope_key = env['request_id']
+
+        # add it to the env,
+        env[@key] = logger
+
+        # and call the app
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/low/scoped_logger.rb

@@ -0,0 +1,48 @@
+require 'logger'
+
+module Low
+  # `Low::ScopedLogger` is a tiny wrapper around `Logger`. It allows
+  # `scope` to be specified, making it easy to grep any messages generated
+  # by a particular instance.
+  class ScopedLogger
+    attr_accessor :scope
+
+    def initialize(io = $stdout)
+      @logger = ::Logger.new(io)
+    end
+
+    def level=(level)
+      @logger.level = level
+    end
+
+    def level
+      @logger.level
+    end
+
+    def fatal(message = nil, progname = nil, &block)
+      add ::Logger::FATAL, message, progname, &block
+    end
+
+    def error(message = nil, progname = nil, &block)
+      add ::Logger::ERROR, message, progname, &block
+    end
+
+    def warn(message = nil, progname = nil, &block)
+      add ::Logger::WARN, message, progname, &block
+    end
+
+    def info(message = nil, progname = nil, &block)
+      add ::Logger::INFO, message, progname, &block
+    end
+
+    def debug(message = nil, progname = nil, &block)
+      add ::Logger::DEBUG, message, progname, &block
+    end
+
+    def add(level, message = nil, progname = nil, &block)
+      formatted_message = message
+      formatted_message = "[#{@scope}] #{formatted_message}" if @scope
+      @logger.add level, formatted_message, progname, &block
+    end
+  end
+end

data/lib/low/version.rb

@@ -1,3 +1,3 @@
 module Low
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/low.rb

@@ -1,9 +1,11 @@
 require 'low/version'
 
 module Low
+  autoload :ScopedLogger, 'low/scoped_logger'
   autoload :Mongo,        'low/mongo'
 
   module Middleware
-    autoload :SubdomainMap, 'low/middleware/subdomain_map'
+    autoload :RequestLogger,  'low/middleware/request_logger'
+    autoload :SubdomainMap,   'low/middleware/subdomain_map'
   end
 end

data/spec/low/middleware/request_logger_spec.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'logger'
+
+describe Low::Middleware::RequestLogger do
+  describe '.level' do
+    it 'should return Logger::FATAL if the LOG_LEVEL evironment var is \'FATAL\'' do
+      ENV['LOG_LEVEL'] = 'FATAL'
+      Low::Middleware::RequestLogger.level.should == Logger::FATAL
+    end
+
+    it 'should return Logger::ERROR if the LOG_LEVEL evironment var is \'ERROR\'' do
+      ENV['LOG_LEVEL'] = 'ERROR'
+      Low::Middleware::RequestLogger.level.should == Logger::ERROR
+    end
+
+    it 'should return Logger::WARN if the LOG_LEVEL evironment var is \'WARN\'' do
+      ENV['LOG_LEVEL'] = 'WARN'
+      Low::Middleware::RequestLogger.level.should == Logger::WARN
+    end
+
+    it 'should return Logger::INFO if the LOG_LEVEL evironment var is \'INFO\'' do
+      ENV['LOG_LEVEL'] = 'INFO'
+      Low::Middleware::RequestLogger.level.should == Logger::INFO
+    end
+
+    it 'should return Logger::DEBUG if the LOG_LEVEL evironment var is \'DEBUG\'' do
+      ENV['LOG_LEVEL'] = 'DEBUG'
+      Low::Middleware::RequestLogger.level.should == Logger::DEBUG
+    end
+
+    it 'should return Logger::INFO if the LOG_LEVEL evironment var is not set' do
+      ENV['LOG_LEVEL'] = nil
+      Low::Middleware::RequestLogger.level.should == Logger::INFO
+    end
+  end
+
+  describe '.io' do
+    it 'should return \'log/development.log\' if the RACK_ENV evironment var is \'development\'' do
+      begin
+        ENV['RACK_ENV'] = 'development'
+        Low::Middleware::RequestLogger.io.path.should == 'log/development.log'
+      ensure
+        ENV['RACK_ENV'] = 'test'
+      end
+    end
+
+    it 'should return \'log/test.log\' if the RACK_ENV evironment var is \'test\'' do
+      ENV['RACK_ENV'] = 'test'
+      Low::Middleware::RequestLogger.io.path.should == 'log/test.log'
+    end
+
+    it 'should return STDOUT if the RACK_ENV evironment var is \'production\'' do
+      begin
+        ENV['RACK_ENV'] = 'production'
+        Low::Middleware::RequestLogger.io.should == STDOUT
+      ensure
+        ENV['RACK_ENV'] = 'test'
+      end
+    end
+  end
+end

data/spec/low/scoped_logger_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Low::ScopedLogger do
+  describe '#fatal' do
+    it 'should emit a fatal message' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.fatal 'Oh noes!'
+
+      io.rewind; message = io.read
+      message.should =~ /FATAL/
+      message.should =~ /Oh noes!$/
+    end
+  end
+
+  describe '#error' do
+    it 'should emit an error message' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.error 'Wrong!'
+
+      io.rewind; message = io.read
+      message.should =~ /ERROR/
+      message.should =~ /Wrong!$/
+    end
+  end
+
+  describe '#warn' do
+    it 'should emit a warn message' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.warn 'Watchout!'
+
+      io.rewind; message = io.read
+      message.should =~ /WARN/
+      message.should =~ /Watchout!$/
+    end
+  end
+
+  describe '#info' do
+    it 'should emit an info message' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.info 'Such and such'
+
+      io.rewind; message = io.read
+      message.should =~ /INFO/
+      message.should =~ /Such and such$/
+    end
+  end
+
+  describe '#debug' do
+    it 'should emit a debug message' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.debug '101011'
+
+      io.rewind; message = io.read
+      message.should =~ /DEBUG/
+      message.should =~ /101011$/
+    end
+
+    it 'should emit nothing if the level is too high' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.level = ::Logger::INFO
+      logger.debug '101011'
+
+      io.rewind; message = io.read
+      message.should == ''
+    end
+  end
+
+  describe '#group_key' do
+    it 'should append the specified key to all messages' do
+      io = StringIO.new
+      logger = Low::ScopedLogger.new(io)
+      logger.scope = 'abc123'
+      logger.info 'Yadda'
+
+      io.rewind; message = io.read
+      message.should =~ /abc123/
+      message.should =~ /Yadda$/
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -105,15 +105,19 @@ files:
 - README.md
 - Rakefile
 - lib/low.rb
+- lib/low/middleware/request_logger.rb
 - lib/low/middleware/subdomain_map.rb
 - lib/low/mongo.rb
 - lib/low/mongo/heroku.rb
 - lib/low/mongo/util.rb
+- lib/low/scoped_logger.rb
 - lib/low/version.rb
 - low.gemspec
+- spec/low/middleware/request_logger_spec.rb
 - spec/low/middleware/subdomain_map_spec.rb
 - spec/low/mongo/util_spec.rb
 - spec/low/mongo_spec.rb
+- spec/low/scoped_logger_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -140,7 +144,9 @@ signing_key:
 specification_version: 3
 summary: A low-level utility library.
 test_files:
+- spec/low/middleware/request_logger_spec.rb
 - spec/low/middleware/subdomain_map_spec.rb
 - spec/low/mongo/util_spec.rb
 - spec/low/mongo_spec.rb
+- spec/low/scoped_logger_spec.rb
 - spec/spec_helper.rb