low 0.0.10 → 0.0.11

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    low (0.0.2)
+    low (0.0.10)
       bson_ext
       mongo
       rack

data/lib/low/middleware/log_level.rb

@@ -0,0 +1,32 @@
+require 'logger'
+
+module Low
+  module Middleware
+    class LogLevel
+
+      DEFAULT_DEFAULT_LEVEL = Logger::INFO
+
+      def initialize(app, opts = {})
+        @app = app
+        @default_level = opts[:default_level] || DEFAULT_DEFAULT_LEVEL
+      end
+
+      def call(env)
+        env['low.log_level'] = log_level
+        @app.call(env)
+      end
+
+      def log_level
+        # If `LOG_LEVEL` is a valid level
+        if ['FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG'].include? ENV['LOG_LEVEL']
+          # use it;
+          eval "Logger::#{ENV['LOG_LEVEL']}"
+        else
+          # otherwise, use the default
+          @default_level
+        end
+      end
+
+    end
+  end
+end

data/lib/low/middleware/rack_errors.rb

@@ -0,0 +1,33 @@
+module Low
+  module Middleware
+    class RackErrors
+
+      DEFAULT_FS_ENVS = ['development', 'test']
+
+      def initialize(app, opts = {})
+        @app = app
+        @fs_envs = opts[:fs_envs] || DEFAULT_FS_ENVS
+      end
+
+      def call(env)
+        env['rack.errors'] = io
+        @app.call(env)
+      end
+
+      def io
+        # If `RACK_ENV` should log to the FS,
+        if @fs_envs.include? ENV['RACK_ENV']
+          # make sure the log directory exists,
+          Dir.mkdir('log') unless Dir.exists?('log')
+
+          # and log to an eponymous file;
+          File.open("log/#{ENV['RACK_ENV']}.log", 'a')
+        else
+          # otherwise, log to STDOUT (Heroku likes it this way).
+          STDOUT
+        end
+      end
+
+    end
+  end
+end

data/lib/low/middleware/request_logger.rb

@@ -2,67 +2,26 @@ require 'logger'
 
 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 (see the RequestId middleware).
+    # `RequestLogger` sets 'rack.logger' to an instance of
+    # `Low::ScopedLogger`, with `#level` and `#scope` taken from env.
     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 `RequestLogger.io`
-        # (other rack components, such as Sinatra, use this),
-        env['rack.errors'] = RequestLogger.io
+        env['rack.logger'] = logger(env)
+        @app.call(env)
+      end
 
-        # instantiate a new `Useless::Logger`,
+      def logger(env)
         logger = Low::ScopedLogger.new(env['rack.errors'])
-
-        # set the logger level to the above `Logger.level`,
-        logger.level = RequestLogger.level
-
-        # set the request_id if one is available
+        logger.level = env['low.log_level'] || env['log_level']
         logger.scope = env['request_id']
-
-        # add it to the env,
-        env[@key] = logger
-
-        # and call the app
-        @app.call(env)
+        logger
       end
+
     end
   end
 end

data/lib/low/version.rb

@@ -1,3 +1,3 @@
 module Low
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/lib/low.rb

@@ -5,6 +5,8 @@ module Low
   autoload :Mongo,        'low/mongo'
 
   module Middleware
+    autoload :LogLevel,       'low/middleware/log_level'
+    autoload :RackErrors,     'low/middleware/rack_errors'
     autoload :RequestId,      'low/middleware/request_id'
     autoload :RequestLogger,  'low/middleware/request_logger'
     autoload :SubdomainMap,   'low/middleware/subdomain_map'

data/spec/low/middleware/log_level_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'logger'
+
+describe Low::Middleware::LogLevel do
+  def test_app
+    lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, env['low.log_level']]
+    end
+  end
+
+  before(:all) { @original_log_level = ENV['LOG_LEVEL'] }
+  after(:each) { ENV['LOG_LEVEL'] = @original_log_level }
+
+  it 'should set low.log_level to `Logger::FATAL` if LOG_LEVEL is \'FATAL\'' do
+    ENV['LOG_LEVEL'] = 'FATAL'
+    rack = Low::Middleware::LogLevel.new test_app
+    response = rack.call({})
+    response[2].should == Logger::FATAL
+  end
+
+  it 'should set low.log_level to `Logger::ERROR` if LOG_LEVEL is \'ERROR\'' do
+    ENV['LOG_LEVEL'] = 'ERROR'
+    rack = Low::Middleware::LogLevel.new test_app
+    response = rack.call({})
+    response[2].should == Logger::ERROR
+  end
+
+  it 'should set low.log_level to `Logger::WARN` if LOG_LEVEL is \'WARN\'' do
+    ENV['LOG_LEVEL'] = 'WARN'
+    rack = Low::Middleware::LogLevel.new test_app
+    response = rack.call({})
+    response[2].should == Logger::WARN
+  end
+
+  it 'should set low.log_level to `Logger::INFO` if LOG_LEVEL is \'INFO\'' do
+    ENV['LOG_LEVEL'] = 'INFO'
+    rack = Low::Middleware::LogLevel.new test_app
+    response = rack.call({})
+    response[2].should == Logger::INFO
+  end
+
+  it 'should set low.log_level to `Logger::DEBUG` if LOG_LEVEL is \'DEBUG\'' do
+    ENV['LOG_LEVEL'] = 'DEBUG'
+    rack = Low::Middleware::LogLevel.new test_app
+    response = rack.call({})
+    response[2].should == Logger::DEBUG
+  end
+
+  it 'should set low.log_level to `Logger::INFO` if neither LOG_LEVEL nor `:default_level` is set' do
+    ENV['LOG_LEVEL'] = nil
+    rack = Low::Middleware::LogLevel.new test_app
+    response = rack.call({})
+    response[2].should == Logger::INFO
+  end
+
+  it 'should set low.log_level to the specified `:default_level` if LOG_LEVEL is not set' do
+    ENV['LOG_LEVEL'] = nil
+    rack = Low::Middleware::LogLevel.new test_app, default_level: Logger::DEBUG
+    response = rack.call({})
+    response[2].should == Logger::DEBUG
+  end
+end

data/spec/low/middleware/rack_errors_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+require 'fileutils'
+
+describe Low::Middleware::RackErrors do
+  def test_app
+    lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, env['rack.errors']]
+    end
+  end
+
+  after(:each) do
+    ENV['RACK_ENV'] = 'test'
+  end
+
+  it 'should log to the FS in the development RACK_ENV by default' do
+    ENV['RACK_ENV'] = 'development'
+    rack = Low::Middleware::RackErrors.new test_app
+    response = rack.call({})
+    response[2].path.should == 'log/development.log'
+  end
+
+  it 'should log to the FS in the test RACK_ENV by default' do
+    ENV['RACK_ENV'] = 'test'
+    rack = Low::Middleware::RackErrors.new test_app
+    response = rack.call({})
+    response[2].path.should == 'log/test.log'
+  end
+
+  it 'should log to the FS in the specified RACK_ENV' do
+    ENV['RACK_ENV'] = 'production'
+    rack = Low::Middleware::RackErrors.new test_app, fs_envs: ['production']
+    response = rack.call({})
+    response[2].path.should == 'log/production.log'
+  end
+
+  it 'should log to STDOUT if not in a specified RACK_ENV' do
+    ENV['RACK_ENV'] = 'production'
+    rack = Low::Middleware::RackErrors.new test_app
+    response = rack.call({})
+    response[2].should == STDOUT
+  end
+end

data/spec/low/middleware/request_logger_spec.rb

@@ -2,60 +2,19 @@ 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
+  def test_app
+    lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, env['rack.logger']]
     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
+  it 'should set rack.logger to an instance of `Low::ScopedLogger` with scope set to \'request_id\'
+      and level set to \'low.log_level\'' do
+    rack = Low::Middleware::RequestLogger.new test_app
+    response = rack.call({'request_id' => 'abc123', 'low.log_level' => Logger::FATAL})
+    logger = response[2]
+    logger.should be_a(Low::ScopedLogger)
+    logger.scope.should == 'abc123'
+    logger.level.should == Logger::FATAL
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2012-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -105,6 +105,8 @@ files:
 - README.md
 - Rakefile
 - lib/low.rb
+- lib/low/middleware/log_level.rb
+- lib/low/middleware/rack_errors.rb
 - lib/low/middleware/request_id.rb
 - lib/low/middleware/request_logger.rb
 - lib/low/middleware/subdomain_map.rb
@@ -114,6 +116,8 @@ files:
 - lib/low/scoped_logger.rb
 - lib/low/version.rb
 - low.gemspec
+- spec/low/middleware/log_level_spec.rb
+- spec/low/middleware/rack_errors_spec.rb
 - spec/low/middleware/request_id_spec.rb
 - spec/low/middleware/request_logger_spec.rb
 - spec/low/middleware/subdomain_map_spec.rb
@@ -146,6 +150,8 @@ signing_key:
 specification_version: 3
 summary: A low-level utility library.
 test_files:
+- spec/low/middleware/log_level_spec.rb
+- spec/low/middleware/rack_errors_spec.rb
 - spec/low/middleware/request_id_spec.rb
 - spec/low/middleware/request_logger_spec.rb
 - spec/low/middleware/subdomain_map_spec.rb