clogger 0.0.4 → 0.0.5

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.0.5 / 2009-09-02
+
+   The following variables are now exposed: $request_method,
+   $content_length and $content_type.  Additionally, attempts
+   to use $http_content_length or $http_content_type will be
+   remapped to use the non-"$http_"-prefixed variable instead
+   since the "$http_"-variants of those variables is not allowed
+   by Rack.
+
 === 0.0.4 / 2009-09-02
 
     The pure Ruby version now escapes with uppercase A-F

data/README.txt

@@ -14,13 +14,14 @@ is customizable so you can specify exactly which fields to log.
 
 * pre-defines Apache Common Log Format, Apache Combined Log Format and
   Rack::CommonLogger (as distributed by Rack 1.0) formats.
+  See Clogger::Format for the predefined formats.
 
 * Untrusted values are escaped (all HTTP headers, request URI components)
   to make life easier for HTTP log parsers. The following bytes are escaped:
 
     ' (single quote)
     " (double quote)
-    all bytes in the range of \x00-\x1f
+    all bytes in the range of \x00-\x1F
 
 == SYNOPSIS
 
@@ -43,6 +44,10 @@ somewhere inside the "Rails::Initializer.run do |config|" block:
 
 * $http_* - HTTP request headers (e.g. $http_user_agent)
 * $sent_http_* - HTTP response headers (e.g. $sent_http_content_length)
+* $content_length - HTTP request body size
+  ($http_content_length is not allowed by Rack)
+* $content_type - HTTP request content type
+  ($http_content_type is not allowed by Rack)
 * $cookie_* - HTTP request cookie (e.g. $cookie_session_id)
   Rack::Request#cookies must have been used by the underlying application
   to parse the cookies into a hash.
@@ -54,8 +59,8 @@ somewhere inside the "Rails::Initializer.run do |config|" block:
   ($request_method $request_uri $http_version)
 * $request_time, $request_time{PRECISION} - time taken for request
   (including response body iteration).  PRECISION defaults to 3
-  (milliseconds) if not specified but may be specified 0(seconds) to
-  6(microseconds).
+  (milliseconds) if not specified but may be specified anywhere from
+  0(seconds) to 6(microseconds).
 * $time_local, $time_local{FORMAT} - current local time, FORMAT defaults to
   "%d/%b/%Y:%H:%M:%S %z" but accepts any strftime(3)-compatible format
 * $time_utc, $time_utc{FORMAT} - like $time_local, except with UTC

data/lib/clogger.rb

@@ -1,6 +1,6 @@
 # -*- encoding: binary -*-
 class Clogger
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 
   OP_LITERAL = 0
   OP_REQUEST = 1
@@ -19,6 +19,8 @@ class Clogger
     '$time_local' => '$time_local{%d/%b/%Y:%H:%M:%S %z}',
     '$msec' => '$time{3}',
     '$usec' => '$time{6}',
+    '$http_content_length' => '$content_length',
+    '$http_content_type' => '$content_type',
   }
 
   SPECIAL_VARS = {
@@ -35,7 +37,8 @@ class Clogger
 private
 
   CGI_ENV = Regexp.new('\A\$(' <<
-      %w(remote_addr remote_ident remote_user
+      %w(request_method content_length content_type
+         remote_addr remote_ident remote_user
          path_info query_string script_name
          server_name server_port).join('|') << ')\z').freeze
 

data/test/test_clogger.rb

@@ -402,4 +402,36 @@ class TestClogger < Test::Unit::TestCase
     assert_equal "GET /hello?goodbye=true\n", str.string
   end
 
+  def test_request_method_only
+    str = StringIO.new
+    app = lambda { |env| [302, [ %w(a) ], []] }
+    cl = Clogger.new(app, :logger => str, :format => '$request_method')
+    cl.call(@req)
+    assert_equal "GET\n", str.string
+  end
+
+  def test_content_length_null
+    str = StringIO.new
+    app = lambda { |env| [302, [ %w(a) ], []] }
+    cl = Clogger.new(app, :logger => str, :format => '$content_length')
+    cl.call(@req)
+    assert_equal "-\n", str.string
+  end
+
+  def test_content_length_set
+    str = StringIO.new
+    app = lambda { |env| [302, [ %w(a) ], []] }
+    cl = Clogger.new(app, :logger => str, :format => '$content_length')
+    cl.call(@req.merge('CONTENT_LENGTH' => '5'))
+    assert_equal "5\n", str.string
+  end
+
+  def test_http_content_type_fallback
+    str = StringIO.new
+    app = lambda { |env| [302, [ %w(a) ], []] }
+    cl = Clogger.new(app, :logger => str, :format => '$http_content_type')
+    cl.call(@req.merge('CONTENT_TYPE' => 'text/plain'))
+    assert_equal "text/plain\n", str.string
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clogger
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Eric Wong