rack-contrib 1.4.0 → 2.5.0

data/lib/rack/contrib/profiler.rb

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 require 'ruby-prof'
 
 module Rack
   # Set the profile=process_time query parameter to download a
   # calltree profile of the request.
   #
-  # Pass the :printer option to pick a different result format.
+  # Pass the :printer option to pick a different result format.  Note that
+  # some printers (such as CallTreePrinter) have broken the
+  # `AbstractPrinter` API, and thus will not work.  Bug reports to
+  # `ruby-prof`, please, not us.
   #
   # You can cause every request to be run multiple times by passing the
   # `:times` option to the `use Rack::Profiler` call.  You can also run a
@@ -27,10 +32,14 @@ module Rack
     # option defaulting to :call_stack.
     def initialize(app, options = {})
       @app = app
+      @profile = nil
       @printer = parse_printer(options[:printer] || DEFAULT_PRINTER)
       @times = (options[:times] || 1).to_i
+      @maximum_runs = options.fetch(:maximum_runs, 10)
     end
 
+    attr :maximum_runs
+
     def call(env)
       if mode = profiling?(env)
         profile(env, mode)
@@ -41,28 +50,46 @@ module Rack
 
     private
       def profiling?(env)
-        unless ::RubyProf.running?
-          request = Rack::Request.new(env.clone)
-          if mode = request.params.delete('profile')
-            if ::RubyProf.const_defined?(mode.upcase)
-              mode
-            else
-              env['rack.errors'].write "Invalid RubyProf measure_mode: " +
-                "#{mode}. Use one of #{MODES.to_a.join(', ')}"
-              false
-            end
+        return if @profile && @profile.running?
+
+        request = Rack::Request.new(env.clone)
+        if mode = request.params.delete('profile')
+          if ::RubyProf.const_defined?(mode.upcase)
+            mode
+          else
+            env['rack.errors'].write "Invalid RubyProf measure_mode: " +
+              "#{mode}. Use one of #{MODES.to_a.join(', ')}"
+            false
           end
         end
       end
 
+      # How many times to run the request within the profiler.
+      # If the profiler_runs query parameter is set, use that.
+      # Otherwise, use the :times option passed to `#initialize`.
+      # If the profiler_runs query parameter is greater than the
+      # :maximum option passed to `#initialize`, use the :maximum
+      # option.
+      def runs(request)
+        if profiler_runs = request.params['profiler_runs']
+          profiler_runs = profiler_runs.to_i
+          if profiler_runs > @maximum_runs
+            return @maximum_runs
+          else
+            return profiler_runs
+          end
+        else
+          return @times
+        end
+      end
+
       def profile(env, mode)
-        ::RubyProf.measure_mode = ::RubyProf.const_get(mode.upcase)
+        @profile = ::RubyProf::Profile.new(measure_mode: ::RubyProf.const_get(mode.upcase))
 
         GC.enable_stats if GC.respond_to?(:enable_stats)
         request = Rack::Request.new(env.clone)
-        runs = (request.params['profiler_runs'] || @times).to_i
-        result = ::RubyProf.profile do
-          runs.times { @app.call(env) }
+        result = @profile.profile do
+          runs(request).times { @app.call(env) }
         end
         GC.disable_stats if GC.respond_to?(:disable_stats)
 
@@ -77,10 +104,10 @@ module Rack
       end
 
       def headers(printer, env, mode)
-        headers = { 'Content-Type' => CONTENT_TYPES[printer.name] }
+        headers = { 'content-type' => CONTENT_TYPES[printer.name] }
         if printer == ::RubyProf::CallTreePrinter
           filename = ::File.basename(env['PATH_INFO'])
-          headers['Content-Disposition'] =
+          headers['content-disposition'] =
             %(attachment; filename="#{filename}.#{mode}.tree")
         end
         headers

data/lib/rack/contrib/relative_redirect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack'
 
 # Rack::RelativeRedirect is a simple middleware that converts relative paths in
@@ -30,15 +32,19 @@ class Rack::RelativeRedirect
   # and use that to make the Location header an absolute url.  If the Location
   # does not start with a slash, make location relative to the path requested.
   def call(env)
-    res = @app.call(env)
-    if [301,302,303, 307,308].include?(res[0]) and loc = res[1]['Location'] and !%r{\Ahttps?://}o.match(loc)
-      absolute = @absolute_proc.call(env, res)
-      res[1]['Location'] = if %r{\A/}.match(loc)
+    status, headers, body = @app.call(env)
+    headers_klass = Rack.release < "3" ? Rack::Utils::HeaderHash : Rack::Headers
+    headers = headers_klass.new.merge(headers)
+
+    if [301,302,303, 307,308].include?(status) and loc = headers['Location'] and !%r{\Ahttps?://}o.match(loc)
+      absolute = @absolute_proc.call(env, [status, headers, body])
+      headers['Location'] = if %r{\A/}.match(loc)
         "#{absolute}#{loc}"
       else
         "#{absolute}#{File.dirname(Rack::Utils.unescape(env['PATH_INFO']))}/#{loc}"
       end
     end
-    res
+
+    [status, headers, body]
   end
 end

data/lib/rack/contrib/response_cache.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'rack'
 
 # Rack::ResponseCache is a Rack middleware that caches responses for successful
 # GET requests with no query string to disk or any ruby object that has an
-# []= method (so it works with memcached).  When caching to disk, it works similar to
-# Rails' page caching, allowing you to cache dynamic pages to static files that can
-# be served directly by a front end webserver.
+# []= method (so it works with memcached). As with Rails' page caching, this
+# middleware only writes to the cache -- it never reads. The logic of whether a
+# cached response should be served is left either to your web server, via
+# something like the <tt>try_files</tt> directive in nginx, or to your
+# cache-reading middleware of choice, mounted before Rack::ResponseCache in the
+# stack.
 class Rack::ResponseCache
   # The default proc used if a block is not provided to .new
   # It unescapes the PATH_INFO of the environment, and makes sure that it doesn't
@@ -15,7 +20,10 @@ class Rack::ResponseCache
   # of the path to index.html.
   DEFAULT_PATH_PROC = proc do |env, res|
     path = Rack::Utils.unescape(env['PATH_INFO'])
-    if !path.include?('..') and match = /text\/((?:x|ht)ml|css)/o.match(res[1]['Content-Type'])
+    headers = res[1]
+    content_type = headers['Content-Type']
+
+    if !path.include?('..') and match = /text\/((?:x|ht)ml|css)/o.match(content_type)
       type = match[1]
       path = "#{path}.#{type}" unless /\.#{type}\z/.match(path)
       path = File.join(File.dirname(path), 'index.html') if type == 'html' and File.basename(path) == '.html'
@@ -23,7 +31,7 @@ class Rack::ResponseCache
     end
   end
 
-  # Initialize a new ReponseCache object with the given arguments.  Arguments:
+  # Initialize a new ResponseCache object with the given arguments.  Arguments:
   # * app : The next middleware in the chain.  This is always called.
   # * cache : The place to cache responses.  If a string is provided, a disk
   #   cache is used, and all cached files will use this directory as the root directory.
@@ -42,18 +50,22 @@ class Rack::ResponseCache
   # Call the next middleware with the environment.  If the request was successful (response status 200),
   # was a GET request, and had an empty query string, call the block set up in initialize to get the path.
   # If the cache is a string, create any necessary middle directories, and cache the file in the appropriate
-  # subdirectory of cache.  Otherwise, cache the body of the reponse as the value with the path as the key.
+  # subdirectory of cache.  Otherwise, cache the body of the response as the value with the path as the key.
   def call(env)
-    res = @app.call(env)
-    if env['REQUEST_METHOD'] == 'GET' and env['QUERY_STRING'] == '' and res[0] == 200 and path = @path_proc.call(env, res)
+    status, headers, body = @app.call(env)
+    headers_klass = Rack.release < "3" ? Rack::Utils::HeaderHash : Rack::Headers
+    headers = headers_klass.new.merge(headers)
+
+    if env['REQUEST_METHOD'] == 'GET' and env['QUERY_STRING'] == '' and status == 200 and path = @path_proc.call(env, [status, headers, body])
       if @cache.is_a?(String)
         path = File.join(@cache, path) if @cache
         FileUtils.mkdir_p(File.dirname(path))
-        File.open(path, 'wb'){|f| res[2].each{|c| f.write(c)}}
+        File.open(path, 'wb'){|f| body.each{|c| f.write(c)}}
       else
-        @cache[path] = res[2]
+        @cache[path] = body
       end
     end
-    res
+
+    [status, headers, body]
   end
 end

data/lib/rack/contrib/response_headers.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Rack
   # Allows you to tap into the response headers. Yields a Rack::Utils::HeaderHash
-  # of current response headers to the block. Example:
+  # (Rack 2) or a Rack::Headers (Rack 3) of current response headers to the block.
+  # Example:
   #
   #   use Rack::ResponseHeaders do |headers|
   #     headers['X-Foo'] = 'bar'
@@ -8,6 +11,9 @@ module Rack
   #   end
   #
   class ResponseHeaders
+    HEADERS_KLASS = Rack.release < "3" ? Utils::HeaderHash : Headers
+    private_constant :HEADERS_KLASS
+
     def initialize(app, &block)
       @app = app
       @block = block
@@ -15,7 +21,7 @@ module Rack
 
     def call(env)
       response = @app.call(env)
-      headers = Utils::HeaderHash.new(response[1])
+      headers = HEADERS_KLASS.new.merge(response[1])
       @block.call(headers)
       response[1] = headers
       response

data/lib/rack/contrib/route_exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   class RouteExceptions
     ROUTES = [

data/lib/rack/contrib/runtime.rb

@@ -1,31 +1,4 @@
+# frozen_string_literal: true
 
-module Rack
-  # Sets an "X-Runtime" response header, indicating the response
-  # time of the request, in seconds
-  #
-  # You can put it right before the application to see the processing
-  # time, or before all the other middlewares to include time for them,
-  # too.
-  class Runtime
-    def initialize(app, name = nil)
-      @app = app
-      @header_name = "X-Runtime"
-      @header_name << "-#{name}" if name
-    end
-
-    def call(env)
-      start_time = Time.now
-      status, headers, body = @app.call(env)
-      request_time = Time.now - start_time
-
-      if !headers.has_key?(@header_name)
-        headers[@header_name] = "%0.6f" % request_time
-      end
-
-      [status, headers, body]
-    end
-  end
-end
-
-
-
+require 'rack'
+require 'rack/runtime'

data/lib/rack/contrib/signals.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   # Installs signal handlers that are safely processed after a request
   #
@@ -24,6 +26,10 @@ module Rack
         @body.each(&block)
         @callback.call
       end
+
+      def close
+        @body.close if @body.respond_to?(:close)
+      end
     end
 
     def initialize(app, &block)

data/lib/rack/contrib/simple_endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   # Create simple endpoints with routing rules, similar to Sinatra actions.
   #
@@ -78,4 +80,4 @@ module Rack
         @verbs.empty? || @verbs.include?(method)
       end
   end
-end
+end

data/lib/rack/contrib/static_cache.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'time'
+
 module Rack
 
   #
@@ -16,7 +20,7 @@ module Rack
   #
   # Another way to bypass the cache is adding the version number in a field-value pair in the
   # URL query string. As an example, http://yoursite.com/images/test.png?v=1.0.0
-  # In that case, set the option :versioning to false to avoid unneccessary regexp calculations.
+  # In that case, set the option :versioning to false to avoid unnecessary regexp calculations.
   #
   # It's better to keep the current version number in some config file and use it in every static
   # content's URL. So each time we modify our static contents, we just have to change the version
@@ -40,7 +44,7 @@ module Rack
   #     default headers.
   #
   #     use Rack::StaticCache, :urls => ["/images"], :duration => 2, :versioning => false
-  #     will serve all requests begining with /images under the current directory (default for the option :root
+  #     will serve all requests beginning with /images under the current directory (default for the option :root
   #     is current directory). All the contents served will have cache expiration duration set to 2 years in headers
   #     (default for :duration is 1 year), and StaticCache will not compute any versioning logics (default for
   #     :versioning is true)
@@ -48,6 +52,8 @@ module Rack
 
 
   class StaticCache
+    HEADERS_KLASS = Rack.release < "3" ? Utils::HeaderHash : Headers
+    private_constant :HEADERS_KLASS
 
     def initialize(app, options={})
       @app = app
@@ -55,20 +61,21 @@ module Rack
       @no_cache = {}
       @urls.collect! do |url|
         if url  =~ /\*$/
-          url.sub!(/\*$/, '')
-          @no_cache[url] = 1
+          url_prefix = url.sub(/\*$/, '')
+          @no_cache[url_prefix] = 1
+          url_prefix
+        else
+          url
         end
-        url
       end
       root = options[:root] || Dir.pwd
-      @file_server = Rack::File.new(root)
+      @file_server = Rack::Files.new(root)
       @cache_duration = options[:duration] || 1
       @versioning_enabled = options.fetch(:versioning, true)
       if @versioning_enabled
         @version_regex = options.fetch(:version_regex, /-[\d.]+([.][a-zA-Z][\w]+)?$/)
       end
       @duration_in_seconds = self.duration_in_seconds
-      @duration_in_words    = self.duration_in_words
     end
 
     def call(env)
@@ -80,17 +87,21 @@ module Rack
         if @versioning_enabled
           path.sub!(@version_regex, '\1')
         end
+
         status, headers, body = @file_server.call(env)
+        headers = HEADERS_KLASS.new.merge(headers)
+
         if @no_cache[url].nil?
           headers['Cache-Control'] ="max-age=#{@duration_in_seconds}, public"
-          headers['Expires'] = @duration_in_words
+          headers['Expires'] = duration_in_words
         end
+        headers['Date'] = Time.now.httpdate
         [status, headers, body]
       end
     end
 
     def duration_in_words
-      (Time.now + self.duration_in_seconds).strftime '%a, %d %b %Y %H:%M:%S GMT'
+      (Time.now.utc + self.duration_in_seconds).httpdate
     end
 
     def duration_in_seconds

data/lib/rack/contrib/time_zone.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   class TimeZone
     Javascript = <<-EOJ

data/lib/rack/contrib/try_static.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
 
   # The Rack::TryStatic middleware delegates requests to Rack::Static middleware

data/lib/rack/contrib/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Contrib
+    VERSION = '2.5.0'
+  end
+end

data/lib/rack/contrib.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
 require 'rack'
-require 'git-version-bump'
 
 module Rack
   module Contrib
     def self.release
+      require "git-version-bump"
       GVB.version
+    rescue LoadError
+      begin
+        Gem::Specification.find_by_name("rack-contrib").version.to_s
+      rescue Gem::LoadError
+        "0.0.0.1.ENOGEM"
+      end
     end
   end
 
-  autoload :AcceptFormat,               "rack/contrib/accept_format"
   autoload :Access,                     "rack/contrib/access"
   autoload :BounceFavicon,              "rack/contrib/bounce_favicon"
   autoload :Cookies,                    "rack/contrib/cookies"
@@ -19,6 +26,7 @@ module Rack
   autoload :HostMeta,                   "rack/contrib/host_meta"
   autoload :GarbageCollector,           "rack/contrib/garbagecollector"
   autoload :JSONP,                      "rack/contrib/jsonp"
+  autoload :JSONBodyParser,             "rack/contrib/json_body_parser"
   autoload :LazyConditionalGet,         "rack/contrib/lazy_conditional_get"
   autoload :LighttpdScriptNameFix,      "rack/contrib/lighttpd_script_name_fix"
   autoload :Locale,                     "rack/contrib/locale"
@@ -27,8 +35,6 @@ module Rack
   autoload :ProcTitle,                  "rack/contrib/proctitle"
   autoload :Profiler,                   "rack/contrib/profiler"
   autoload :ResponseHeaders,            "rack/contrib/response_headers"
-  autoload :Runtime,                    "rack/contrib/runtime"
-  autoload :Sendfile,                   "rack/contrib/sendfile"
   autoload :Signals,                    "rack/contrib/signals"
   autoload :SimpleEndpoint,             "rack/contrib/simple_endpoint"
   autoload :TimeZone,                   "rack/contrib/time_zone"