rack-contrib 1.8.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee6a82e9e3cd0238bfc695f9d18a74045235f86
-  data.tar.gz: a340facd62eb27f47bbce5e5e02f15c949454946
+  metadata.gz: b545ac91ebc6596e463da4596aa475e98f170759
+  data.tar.gz: 7185814a488ba9dfc59071569d9ae7175e2f5eb3
 SHA512:
-  metadata.gz: 6f3bee839cd6955789228948379912610ac8c9ea8dd2cfd2339f43b2e15e311ee0aacd65f71304977c2fb78624cd374a1b8e071e9129da0db2cde9e61828b64a
-  data.tar.gz: 5c0ce1dc50158e6790db66d758f7a9a16f6d5b0fa87a50f759e00c17d9a7ea5226ebc16e275f3f9e687306867d937bf1cadff224f763481f0991aa0650b58dc2
+  metadata.gz: 6b8b85e0c0d7541825991235ec8b20057d9d8965d031540f056741fb99b9bd6ac524096988066ba717221ec6f6f134db76f9bf5f6325794f28d6a8f2b8831a0f
+  data.tar.gz: 3413f89de71509f68b16b21d4e40dc0eb7fbd98c5210a5fa9e0512521f630f044a75933ce05eca29f19536f052184722c79ca37ba443d49f8161a3702054ac40

data/README.md

@@ -61,6 +61,17 @@ use Rack::MailExceptions
 run theapp
 ```
 
+#### Versioning
+
+This package is [semver compliant](https://semver.org); you should use a
+pessimistic version constraint (`~>`) against the relevant `2.x` version of
+this gem.
+
+This version of `rack-contrib` is only compatible with `rack` 2.x.  If you
+are using `rack` 1.x, you will need to use `rack-contrib` 1.x.  A suitable
+pessimistic version constraint (`~>`) is recommended.
+
+
 ### Testing
 
 To contribute to the project, begin by cloning the repo and installing the necessary gems:

data/lib/rack/contrib.rb

@@ -14,7 +14,6 @@ module Rack
     end
   end
 
-  autoload :AcceptFormat,               "rack/contrib/accept_format"
   autoload :Access,                     "rack/contrib/access"
   autoload :BounceFavicon,              "rack/contrib/bounce_favicon"
   autoload :Cookies,                    "rack/contrib/cookies"
@@ -34,7 +33,6 @@ module Rack
   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"

data/lib/rack/contrib/jsonp.rb

@@ -53,7 +53,7 @@ module Rack
 
         # Set new Content-Length, if it was set before we mutated the response body
         if headers['Content-Length']
-          length = response.to_ary.inject(0) { |len, part| len + bytesize(part) }
+          length = response.to_ary.inject(0) { |len, part| len + part.bytesize }
           headers['Content-Length'] = length.to_s
         end
       end

data/lib/rack/contrib/nested_params.rb

@@ -1,5 +1,4 @@
-require 'cgi'
-require 'strscan'
+require 'rack/utils'
 
 module Rack
   # Rack middleware for parsing POST/PUT body data into nested parameters
@@ -20,130 +19,14 @@ module Rack
 
     def call(env)
       if form_vars = env[FORM_VARS]
-        env[FORM_HASH] = parse_query_parameters(form_vars)
+        Rack::Utils.parse_nested_query(form_vars)
       elsif env[CONTENT_TYPE] == URL_ENCODED
         post_body = env[POST_BODY]
         env[FORM_INPUT] = post_body
-        env[FORM_HASH] = parse_query_parameters(post_body.read)
+        env[FORM_HASH] = Rack::Utils.parse_nested_query(post_body.read)
         post_body.rewind if post_body.respond_to?(:rewind)
       end
       @app.call(env)
     end
-
-    ## the rest is nabbed from Rails ##
-
-    def parse_query_parameters(query_string)
-      return {} if query_string.nil? or query_string.empty?
-
-      pairs = query_string.split('&').collect do |chunk|
-        next if chunk.empty?
-        key, value = chunk.split('=', 2)
-        next if key.empty?
-        value = value.nil? ? nil : CGI.unescape(value)
-        [ CGI.unescape(key), value ]
-      end.compact
-
-      UrlEncodedPairParser.new(pairs).result
-    end
-
-    class UrlEncodedPairParser < StringScanner
-      attr_reader :top, :parent, :result
-
-      def initialize(pairs = [])
-        super('')
-        @result = {}
-        pairs.each { |key, value| parse(key, value) }
-      end
-
-      KEY_REGEXP = %r{([^\[\]=&]+)}
-      BRACKETED_KEY_REGEXP = %r{\[([^\[\]=&]+)\]}
-
-      # Parse the query string
-      def parse(key, value)
-        self.string = key
-        @top, @parent = result, nil
-
-        # First scan the bare key
-        key = scan(KEY_REGEXP) or return
-        key = post_key_check(key)
-
-        # Then scan as many nestings as present
-        until eos?
-          r = scan(BRACKETED_KEY_REGEXP) or return
-          key = self[1]
-          key = post_key_check(key)
-        end
-
-        bind(key, value)
-      end
-
-      private
-        # After we see a key, we must look ahead to determine our next action. Cases:
-        #
-        #   [] follows the key. Then the value must be an array.
-        #   = follows the key. (A value comes next)
-        #   & or the end of string follows the key. Then the key is a flag.
-        #   otherwise, a hash follows the key.
-        def post_key_check(key)
-          if scan(/\[\]/) # a[b][] indicates that b is an array
-            container(key, Array)
-            nil
-          elsif check(/\[[^\]]/) # a[b] indicates that a is a hash
-            container(key, Hash)
-            nil
-          else # End of key? We do nothing.
-            key
-          end
-        end
-
-        # Add a container to the stack.
-        def container(key, klass)
-          type_conflict! klass, top[key] if top.is_a?(Hash) && top.key?(key) && ! top[key].is_a?(klass)
-          value = bind(key, klass.new)
-          type_conflict! klass, value unless value.is_a?(klass)
-          push(value)
-        end
-
-        # Push a value onto the 'stack', which is actually only the top 2 items.
-        def push(value)
-          @parent, @top = @top, value
-        end
-
-        # Bind a key (which may be nil for items in an array) to the provided value.
-        def bind(key, value)
-          if top.is_a? Array
-            if key
-              if top[-1].is_a?(Hash) && ! top[-1].key?(key)
-                top[-1][key] = value
-              else
-                top << {key => value}
-              end
-              push top.last
-              return top[key]
-            else
-              top << value
-              return value
-            end
-          elsif top.is_a? Hash
-            key = CGI.unescape(key)
-            parent << (@top = {}) if top.key?(key) && parent.is_a?(Array)
-
-            if top.include?(key) && value.is_a?(String)
-              warn "Rack::NestedParams' parsing behavior will change in rack-contrib 2.0"
-              warn "Currently 'foo=1&foo=2' is parsed to {'foo' => '1'}, in 2.0 it will be parsed to {'foo' => '2'}"
-            end
-
-            top[key] ||= value
-            return top[key]
-          else
-            raise ArgumentError, "Don't know what to do: top is #{top.inspect}"
-          end
-        end
-
-        def type_conflict!(klass, value)
-          raise TypeError, "Conflicting types for parameter containers. Expected an instance of #{klass} but found an instance of #{value.class}. This can be caused by colliding Array and Hash parameters like qs[]=value&qs[key]=value. (The parameters received were #{value.inspect}.)"
-        end
-    end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-contrib
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 2.0.0
 platform: ruby
 authors:
 - rack-devel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,54 +72,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.8
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +149,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -162,6 +159,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.4
 - !ruby/object:Gem::Dependency
   name: nbio-csshttprequest
   requirement: !ruby/object:Gem::Requirement
@@ -202,14 +202,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +236,6 @@ files:
 - COPYING
 - README.md
 - lib/rack/contrib.rb
-- lib/rack/contrib/accept_format.rb
 - lib/rack/contrib/access.rb
 - lib/rack/contrib/backstage.rb
 - lib/rack/contrib/bounce_favicon.rb
@@ -267,7 +266,6 @@ files:
 - lib/rack/contrib/response_headers.rb
 - lib/rack/contrib/route_exceptions.rb
 - lib/rack/contrib/runtime.rb
-- lib/rack/contrib/sendfile.rb
 - lib/rack/contrib/signals.rb
 - lib/rack/contrib/simple_endpoint.rb
 - lib/rack/contrib/static_cache.rb
@@ -291,7 +289,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rack/contrib/accept_format.rb

@@ -1,66 +0,0 @@
-module Rack
-  #
-  # CAUTION: THIS MIDDLEWARE IS DEPRECATED.  DO NOT USE IT.
-  #
-  # This middleware is slated for removal as of rack-contrib 2.0.0, because
-  # it is terribad.  Applications should *always* use the `Accept` header to
-  # detect response formats (when it is available), rather than ignoring
-  # that and instead examining the extension of the request.  We recommend
-  # using the `rack-accept` gem for handling the `Accept` family of entity
-  # request headers.
-  #
-  # A Rack middleware for automatically adding a <tt>format</tt> token at the end of the request path
-  # when there is none. It can detect formats passed in the HTTP_ACCEPT header to populate this token.
-  #
-  # e.g.:
-  #   GET /some/resource HTTP/1.1
-  #   Accept: application/json
-  # ->
-  #   GET /some/resource.json HTTP/1.1
-  #   Accept: application/json
-  #
-  # You can add custom types with this kind of function (taken from sinatra):
-  #   def mime(ext, type)
-  #     ext = ".#{ext}" unless ext.to_s[0] == ?.
-  #     Rack::Mime::MIME_TYPES[ext.to_s] = type
-  #   end
-  # and then:
-  #   mime :json, 'application/json'
-  #
-  # Note: it does not take into account multiple media types in the Accept header.
-  # The first media type takes precedence over all the others.
-  #
-  # MIT-License - Cyril Rohr
-  #
-  class AcceptFormat
-    def self.deprecation_acknowledged
-      @deprecation_acknowledged
-    end
-
-    def self.acknowledge_deprecation
-      @deprecation_acknowledged = true
-    end
-
-    def initialize(app, default_extention = '.html')
-      unless self.class.deprecation_acknowledged
-        warn "Rack::AcceptFormat is DEPRECATED and will be removed in rack-contrib 2.0.0"
-        warn "Please see this middleware's documentation for more info."
-      end
-      @ext = default_extention.to_s.strip
-      @ext = ".#{@ext}" unless @ext[0] == ?.
-      @app = app
-    end
-
-    def call(env)
-      req = Rack::Request.new(env)
-
-      if ::File.extname(req.path_info).empty?
-        accept = env['HTTP_ACCEPT'].to_s.scan(/[^;,\s]*\/[^;,\s]*/)[0].to_s
-        extension =  Rack::Mime::MIME_TYPES.invert[accept] || @ext
-        req.path_info = req.path_info.chomp('/') << "#{extension}"
-      end
-
-      @app.call(env)
-    end
-  end
-end

data/lib/rack/contrib/sendfile.rb

@@ -1,138 +0,0 @@
-require 'rack/file'
-
-warn "rack-contrib deprecation warning: the rack-contrib version of Rack::Sendfile is deprecated and will be removed in rack-contrib 2.0.  Please use the Rack::Sendfile from Rack 2.x instead."
-
-module Rack
-
-  #
-  # The Sendfile middleware intercepts responses whose body is being
-  # served from a file and replaces it with a server specific X-Sendfile
-  # header. The web server is then responsible for writing the file contents
-  # to the client. This can dramatically reduce the amount of work required
-  # by the Ruby backend and takes advantage of the web servers optimized file
-  # delivery code.
-  #
-  # In order to take advantage of this middleware, the response body must
-  # respond to +to_path+ and the request must include an X-Sendfile-Type
-  # header. Rack::File and other components implement +to_path+ so there's
-  # rarely anything you need to do in your application. The X-Sendfile-Type
-  # header is typically set in your web servers configuration. The following
-  # sections attempt to document
-  #
-  # === Nginx
-  #
-  # Nginx supports the X-Accel-Redirect header. This is similar to X-Sendfile
-  # but requires parts of the filesystem to be mapped into a private URL
-  # hierarachy.
-  #
-  # The following example shows the Nginx configuration required to create
-  # a private "/files/" area, enable X-Accel-Redirect, and pass the special
-  # X-Sendfile-Type and X-Accel-Mapping headers to the backend:
-  #
-  #   location /files/ {
-  #     internal;
-  #     alias /var/www/;
-  #   }
-  #
-  #   location / {
-  #     proxy_redirect     false;
-  #
-  #     proxy_set_header   Host                $host;
-  #     proxy_set_header   X-Real-IP           $remote_addr;
-  #     proxy_set_header   X-Forwarded-For     $proxy_add_x_forwarded_for;
-  #
-  #     proxy_set_header   X-Sendfile-Type     X-Accel-Redirect
-  #     proxy_set_header   X-Accel-Mapping     /files/=/var/www/;
-  #
-  #     proxy_pass         http://127.0.0.1:8080/;
-  #   }
-  #
-  # Note that the X-Sendfile-Type header must be set exactly as shown above. The
-  # X-Accel-Mapping header should specify the name of the private URL pattern,
-  # followed by an equals sign (=), followed by the location on the file system
-  # that it maps to. The middleware performs a simple substitution on the
-  # resulting path.
-  #
-  # See Also: http://wiki.codemongers.com/NginxXSendfile
-  #
-  # === lighttpd
-  #
-  # Lighttpd has supported some variation of the X-Sendfile header for some
-  # time, although only recent version support X-Sendfile in a reverse proxy
-  # configuration.
-  #
-  #   $HTTP["host"] == "example.com" {
-  #      proxy-core.protocol = "http"
-  #      proxy-core.balancer = "round-robin"
-  #      proxy-core.backends = (
-  #        "127.0.0.1:8000",
-  #        "127.0.0.1:8001",
-  #        ...
-  #      )
-  #
-  #      proxy-core.allow-x-sendfile = "enable"
-  #      proxy-core.rewrite-request = (
-  #        "X-Sendfile-Type" => (".*" => "X-Sendfile")
-  #      )
-  #    }
-  #
-  # See Also: http://redmine.lighttpd.net/wiki/lighttpd/Docs:ModProxyCore
-  #
-  # === Apache
-  #
-  # X-Sendfile is supported under Apache 2.x using a separate module:
-  #
-  # http://tn123.ath.cx/mod_xsendfile/
-  #
-  # Once the module is compiled and installed, you can enable it using
-  # XSendFile config directive:
-  #
-  #   RequestHeader Set X-Sendfile-Type X-Sendfile
-  #   ProxyPassReverse / http://localhost:8001/
-  #   XSendFile on
-
-  class Sendfile
-    def initialize(app, variation=nil)
-      @app = app
-      @variation = variation
-    end
-
-    def call(env)
-      status, headers, body = @app.call(env)
-      if body.respond_to?(:to_path)
-        case type = variation(env)
-        when 'X-Accel-Redirect'
-          path = ::File.expand_path(body.to_path)
-          if url = map_accel_path(env, path)
-            headers[type] = url
-            body = []
-          else
-            env['rack.errors'] << "X-Accel-Mapping header missing"
-          end
-        when 'X-Sendfile', 'X-Lighttpd-Send-File'
-          path = ::File.expand_path(body.to_path)
-          headers[type] = path
-          body = []
-        when '', nil
-        else
-          env['rack.errors'] << "Unknown x-sendfile variation: '#{variation}'.\n"
-        end
-      end
-      [status, headers, body]
-    end
-
-  private
-    def variation(env)
-      @variation ||
-        env['sendfile.type'] ||
-        env['HTTP_X_SENDFILE_TYPE']
-    end
-
-    def map_accel_path(env, file)
-      if mapping = env['HTTP_X_ACCEL_MAPPING']
-        internal, external = mapping.split('=', 2).map{ |p| p.strip }
-        file.sub(/^#{internal}/i, external)
-      end
-    end
-  end
-end