roda 3.11.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fc4e03ddcb9b4e5fa37af6c0a151aef49965ef251d8ab177e7b530ec034529
-  data.tar.gz: 78ab54340363d9b963496e143809ca9f809c619d25f98faa08b08f9e3790ae19
+  metadata.gz: '0839d9d46fb688ab858d224dff6293be6572d9fc2938ea0696cb34bc6cb14949'
+  data.tar.gz: c3cbc4adc620b1f4776d8258e44751f7206837ba12a6a8e4917e5bf6d5a7efec
 SHA512:
-  metadata.gz: 56b9bb6e1e03cfa079457238d532d9223fdd6adef8438954dfd601afb68b384945b528c2606a3100881f3154e94024ae46f286364c41fce4c23af624a1ebcee3
-  data.tar.gz: 3856d03202576bd35465b29e975bb84fe23780695b87442c3ba8b09b7e36deb19cddf6a4ea5299249baf21c9e7b62b61e681221580b6d7a5af6b84858395d8a0
+  metadata.gz: 7e595d7c11c1486131b3e46b596c6d38a65dac41bb72e686fdbc260f629ce4a639543501e30754412d6252942204d8fa906579bb54a6ff224233dfb333610bfd
+  data.tar.gz: 97f598575e2a13907021cb9024cfa4c6c7c6e1ce68c69639794f89db068a7ee2c27b35bace18b568ae841ae51b6ebf6404c611f3f3f1692b48b95bf1207073a4

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.12.0 (2018-09-14)
+
+* Add common_logger plugin for common log support (jeremyevans)
+
 = 3.11.0 (2018-08-15)
 
 * Disable default compression of sessions over 128 bytes in the sessions plugin (jeremyevans)

data/doc/release_notes/3.12.0.txt

@@ -0,0 +1,19 @@
+= New Features
+
+* A common_logger plugin has been added for common log support. This
+  offers about 30% better performance than Rack::CommonLogger, with
+  the following differences:
+
+  * When timing requests, doesn't consider middleware or proxy the
+    body, so timing information is just the time that Roda takes
+    to process the request.
+  * Only looks for "Content-Length" as a header, not different
+    capitalizations (Roda only uses "Content-Length" internally).
+  * Logs to $stderr instead of rack.errors in request environment
+    if a logger object is not explicitly passed.
+
+= Other Improvements
+
+* Internal before/after hook methods now use more descriptive names
+  for easier debugging, with a naming format designed to not
+  conflict with hook methods in external plugins.

data/lib/roda/plugins/_after_hook.rb

@@ -13,7 +13,7 @@ class Roda
         # have added a _roda_after_* method.
         def include(*)
           res = super
-          meths = private_instance_methods.grep(/\A_roda_after_\d\d\z/).sort.map{|s| "#{s}(res)"}.join(';')
+          meths = private_instance_methods.grep(/\A_roda_after_\d\d/).sort.map{|s| "#{s}(res)"}.join(';')
           class_eval("def _roda_after(res); #{meths} end", __FILE__, __LINE__)
           private :_roda_after
           res

data/lib/roda/plugins/_before_hook.rb

@@ -31,7 +31,7 @@ class Roda
         # Build a _roda_before method that calls each _roda_before_* method
         # in order.
         def def_roda_before
-          meths = private_instance_methods.grep(/\A_roda_before_\d\d\z/).sort.join(';')
+          meths = private_instance_methods.grep(/\A_roda_before_\d\d/).sort.join(';')
           class_eval("def _roda_before; #{meths} end", __FILE__, __LINE__)
           private :_roda_before
         end

data/lib/roda/plugins/class_level_routing.rb

@@ -89,7 +89,7 @@ class Roda
 
         # If the normal routing tree doesn't handle an action, try each class level route
         # to see if it matches.
-        def _roda_after_10(result)
+        def _roda_after_10__class_level_routing(result)
           if result && result[0] == 404 && (v = result[2]).is_a?(Array) && v.empty?
             # Reset the response so it doesn't inherit the status or any headers from
             # the original response.

data/lib/roda/plugins/common_logger.rb

@@ -0,0 +1,70 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The common_logger plugin adds common logger support to Roda
+    # applications, similar to Rack::CommonLogger, with the following
+    # differences:
+    #
+    # * Better performance
+    # * Doesn't include middleware timing
+    # * Doesn't proxy the body
+    # * Doesn't support different capitalization of the Content-Length response header
+    # * Logs to $stderr instead of env['rack.errors'] if explicit logger not passed
+    #
+    # Example:
+    #
+    #   plugin :common_logger
+    #   plugin :common_logger, $stdout
+    #   plugin :common_logger, Logger.new('filename')
+    module CommonLogger
+      def self.load_dependencies(app, _=nil)
+        app.plugin :_after_hook
+        app.plugin :_before_hook
+      end
+
+      def self.configure(app, logger=nil)
+        app.opts[:common_logger] = logger || app.opts[:common_logger] || $stderr
+        app.opts[:common_logger_meth] = app.opts[:common_logger].method(logger.respond_to?(:write) ? :write : :<<)
+      end
+
+      if RUBY_VERSION >= '2.1'
+        # A timer object for calculating elapsed time.
+        def self.start_timer
+          Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+      else
+        # :nocov:
+        def self.start_timer # :nodoc:
+          Time.now
+        end
+        # :nocov:
+      end
+
+      module InstanceMethods
+        private
+
+        # Log request/response information in common log format to logger.
+        def _roda_after_90__common_logger(result)
+          elapsed_time = if timer = @_request_timer
+            '%0.4f' % (CommonLogger.start_timer - timer)
+          else 
+            '-'
+          end
+
+          env = @_request.env
+
+          opts[:common_logger_meth].call("#{env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"} - #{env["REMOTE_USER"] || "-"} [#{Time.now.strftime("%d/%b/%Y:%H:%M:%S %z")}] \"#{env["REQUEST_METHOD"]} #{env["PATH_INFO"]}#{"?#{env["QUERY_STRING"]}" if ((qs = env["QUERY_STRING"]) && !qs.empty?)} #{env["HTTP_VERSION"]}\" #{result[0]} #{((length = result[1]['Content-Length']) && (length unless length == '0')) || '-'} #{elapsed_time}\n")
+        end
+
+        # Create timer instance used for timing
+        def _roda_before_05__common_logger
+          @_request_timer = CommonLogger.start_timer
+        end
+      end
+    end
+
+    register_plugin(:common_logger, CommonLogger)
+  end
+end

data/lib/roda/plugins/flash.rb

@@ -103,7 +103,7 @@ class Roda
 
         # If the routing doesn't raise an error, rotate the flash
         # hash in the session so the next request has access to it.
-        def _roda_after_40(_)
+        def _roda_after_40__flash(_)
           if f = @_flash
             f = f.next
             if f.empty?

data/lib/roda/plugins/head.rb

@@ -63,7 +63,7 @@ class Roda
 
         # Always use an empty response body for head requests, with a
         # content length of 0.
-        def _roda_after_30(res)
+        def _roda_after_30__head(res)
           if res && @_request.head?
             body = res[2]
             if body.respond_to?(:close)

data/lib/roda/plugins/heartbeat.rb

@@ -29,7 +29,7 @@ class Roda
         private
 
         # If the request is for a heartbeat path, return the heartbeat response.
-        def _roda_before_20
+        def _roda_before_20__heartbeat
           if env['PATH_INFO'] == opts[:heartbeat_path]
             response = HEARTBEAT_RESPONSE.dup
             response[1] = Hash[response[1]]

data/lib/roda/plugins/hooks.rb

@@ -79,14 +79,14 @@ class Roda
         private
 
         # Run after hooks.
-        def _roda_after_90(res)
+        def _roda_after_80__hooks(res)
           if b = opts[:after_hook]
             instance_exec(res, &b)
           end
         end
 
         # Run before hooks.
-        def _roda_before_10
+        def _roda_before_10__hooks
           if b = opts[:before_hook]
             instance_exec(&b)
           end

data/lib/roda/plugins/sessions.rb

@@ -208,7 +208,7 @@ class Roda
         # If session information has been set in the request environment,
         # update the rack response headers to set the session cookie in
         # the response.
-        def _roda_after_50(res)
+        def _roda_after_50__sessions(res)
           if res && (session = env['rack.session'])
             @_request.persist_session(res[1], session)
           end

data/lib/roda/plugins/static_routing.rb

@@ -109,7 +109,7 @@ class Roda
 
         # If there is a static routing method for the given path, call it
         # instead having the routing tree handle the request.
-        def _roda_before_30
+        def _roda_before_30__static_routing
           r = @_request
           if route = self.class.static_route_for(r.request_method, r.path_info)
             r.static_route(&route)

data/lib/roda/plugins/status_handler.rb

@@ -48,7 +48,7 @@ class Roda
         private
 
         # If routing returns a response we have a handler for, call that handler.
-        def _roda_after_20(result)
+        def _roda_after_20__status_handler(result)
           if result && (block = opts[:status_handler][result[0]]) && (v = result[2]).is_a?(Array) && v.empty?
             @_response.headers.clear
             result.replace(_call(&block))

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 11
+  RodaMinorVersion = 12
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/common_logger_spec.rb

@@ -0,0 +1,59 @@
+require_relative "../spec_helper"
+
+require 'logger'
+
+describe "common_logger plugin" do
+  def cl_app(&block)
+    app(:common_logger, &block)
+    @logger = StringIO.new
+    @app.plugin :common_logger, @logger
+  end
+
+  it 'logs requests to given logger/stream' do
+    cl_app(&:path_info)
+
+    body.must_equal '/'
+    @logger.rewind
+    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 0.\d\d\d\d\n\z/
+
+    @logger.rewind
+    @logger.truncate(0)
+    body('', 'HTTP_X_FORWARDED_FOR'=>'1.1.1.1', 'REMOTE_USER'=>'je', 'REQUEST_METHOD'=>'POST', 'QUERY_STRING'=>'', "HTTP_VERSION"=>'HTTP/1.1').must_equal ''
+    @logger.rewind
+    @logger.read.must_match /\A1\.1\.1\.1 - je \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "POST  HTTP\/1.1" 200 - 0.\d\d\d\d\n\z/
+
+    @logger.rewind
+    @logger.truncate(0)
+    body('/b', 'REMOTE_ADDR'=>'1.1.1.2', 'QUERY_STRING'=>'foo=bar', "HTTP_VERSION"=>'HTTP/1.0').must_equal '/b'
+    @logger.rewind
+    @logger.read.must_match /\A1\.1\.1\.2 - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/b\?foo=bar HTTP\/1.0" 200 2 0.\d\d\d\d\n\z/
+
+    @app.plugin :common_logger, Logger.new(@logger)
+    @logger.rewind
+    @logger.truncate(0)
+    body.must_equal '/'
+    @logger.rewind
+    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 0.\d\d\d\d\n\z/
+  end
+
+  it 'skips timer information if not available' do
+    cl_app do |r|
+      @_request_timer = nil
+      r.path_info
+    end
+
+    body.must_equal '/'
+    @logger.rewind
+    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 200 1 -\n\z/
+  end
+
+  it 'skips length information if not available' do
+    cl_app do |r|
+      r.halt [500, {}, []]
+    end
+
+    body.must_equal ''
+    @logger.rewind
+    @logger.read.must_match /\A- - - \[\d\d\/[A-Z][a-z]{2}\/\d\d\d\d:\d\d:\d\d:\d\d [-+]\d\d\d\d\] "GET \/ " 500 - 0.\d\d\d\d\n\z/
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -207,6 +207,7 @@ extra_rdoc_files:
 - doc/release_notes/3.9.0.txt
 - doc/release_notes/3.10.0.txt
 - doc/release_notes/3.11.0.txt
+- doc/release_notes/3.12.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -252,6 +253,7 @@ files:
 - doc/release_notes/3.1.0.txt
 - doc/release_notes/3.10.0.txt
 - doc/release_notes/3.11.0.txt
+- doc/release_notes/3.12.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
@@ -273,6 +275,7 @@ files:
 - lib/roda/plugins/chunked.rb
 - lib/roda/plugins/class_level_routing.rb
 - lib/roda/plugins/class_matchers.rb
+- lib/roda/plugins/common_logger.rb
 - lib/roda/plugins/content_for.rb
 - lib/roda/plugins/content_security_policy.rb
 - lib/roda/plugins/cookies.rb
@@ -373,6 +376,7 @@ files:
 - spec/plugin/chunked_spec.rb
 - spec/plugin/class_level_routing_spec.rb
 - spec/plugin/class_matchers_spec.rb
+- spec/plugin/common_logger_spec.rb
 - spec/plugin/content_for_spec.rb
 - spec/plugin/content_security_policy_spec.rb
 - spec/plugin/cookies_spec.rb