rack-contrib 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f6705e8652bd4f9a3de6562f1e637edfa60cc2e
-  data.tar.gz: 07d139793ac41e281c691e0c6afc4ee6e6bebf48
+  metadata.gz: ebb4015dc4f7430d92377b2e07290fce6b77e761
+  data.tar.gz: cf782e8189841d0ea1f1e8172de8eeba99a31b9e
 SHA512:
-  metadata.gz: 30efa3fafccae8fe7a5a3596f4151673c9ec044718670a7a8ba8e2b470868781f4ffff99cd2568407335f3fe498b298b82c7fd1da3bbc1575ce99e2fd3c4e236
-  data.tar.gz: 8c361837181b6e783fc8899f7f0c517cf2ceefbe95ebd671acbc4fa8c8168facc5b78945cbd909cfeb3ad6ddca65f0cef2d39c7aeb7c8fd78645200d2f84601b
+  metadata.gz: 5a652866eeee2c3882f693a54e7aece3b6235cd652ff9851dd06635b353896675e1f8d3a5573ef151ed56bdcb03ad2c93f05461a07adcb0a140b7c2b5ffee7fa
+  data.tar.gz: f4143356a5e113cd337f0a6d32e74564bc109e4cb4d3ad3bc724e53171100df19007357a0e89be91d8cd2301606a180c097d6b4b928b52632bd0b654a64d37fb

data/README.md

@@ -14,6 +14,7 @@ interface:
 * `Rack::Evil` - Lets the rack application return a response to the client from any place.
 * `Rack::HostMeta` - Configures `/host-meta` using a block
 * `Rack::JSONP` - Adds JSON-P support by stripping out the callback param and padding the response with the appropriate callback format.
+* `Rack::LazyConditionalGet` - Caches a global `Last-Modified` date and updates it each time there is a request that is not `GET` or `HEAD`.
 * `Rack::LighttpdScriptNameFix` - Fixes how lighttpd sets the `SCRIPT_NAME` and `PATH_INFO` variables in certain configurations.
 * `Rack::Locale` - Detects the client locale using the Accept-Language request header and sets a `rack.locale` variable in the environment.
 * `Rack::MailExceptions` - Rescues exceptions raised from the app and sends a useful email with the exception, stacktrace, and contents of the environment.

data/lib/rack/contrib.rb

@@ -19,6 +19,7 @@ module Rack
   autoload :HostMeta,                   "rack/contrib/host_meta"
   autoload :GarbageCollector,           "rack/contrib/garbagecollector"
   autoload :JSONP,                      "rack/contrib/jsonp"
+  autoload :LazyConditionalGet,         "rack/contrib/lazy_conditional_get"
   autoload :LighttpdScriptNameFix,      "rack/contrib/lighttpd_script_name_fix"
   autoload :Locale,                     "rack/contrib/locale"
   autoload :MailExceptions,             "rack/contrib/mailexceptions"

data/lib/rack/contrib/accept_format.rb

@@ -1,4 +1,13 @@
 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.
@@ -24,8 +33,19 @@ module Rack
   # 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

data/lib/rack/contrib/lazy_conditional_get.rb

@@ -0,0 +1,113 @@
+module Rack
+
+  ##
+  # This middleware is like Rack::ConditionalGet except that it does
+  # not have to go down the rack stack and build the resource to check
+  # the modification date or the ETag.
+  #
+  # Instead it makes the assumption that only non-reading requests can
+  # potentially change the content, meaning any request which is not
+  # GET or HEAD. Each time you make one of these request, the date is cached
+  # and any resource is considered identical until the next non-reading request.
+  #
+  # Basically you use it this way:
+  #
+  # ``` ruby
+  # use Rack::LazyConditionalGet
+  # ```
+  #
+  # Although if you have multiple instances, it is better to use something like
+  # memcached. An argument can be passed to give the cache object. By default
+  # it is just a Hash. But it can take other objects, including objects which
+  # respond to `:get` and `:set`. Here is how you would use it with Dalli.
+  #
+  # ``` Ruby
+  # dalli_client = Dalli::Client.new
+  # use Rack::LazyConditionalGet, dalli_client
+  # ```
+  #
+  # By default, the middleware only delegates to Rack::ConditionalGet to avoid
+  # any unwanted behaviour. You have to set a header to any resource which you
+  # want to be cached. And it will be cached until the next "potential update"
+  # of your site, that is whenever the next POST/PUT/PATCH/DELETE request
+  # is received.
+  #
+  # The header is `Rack-Lazy-Conditional-Get`. You have to set it to 'yes'
+  # if you want the middleware to set `Last-Modified` for you.
+  #
+  # Bear in mind that if you set `Last-Modified` as well, the middleware will
+  # not change it.
+  #
+  # Regarding the POST/PUT/PATCH/DELETE... requests, they will always reset your
+  # global modification date. But if you have one of these request and you
+  # know for sure that it does not modify the cached content, you can set the
+  # `Rack-Lazy-Conditional-Get` on response to `skip`. This will not update the
+  # global modification date.
+
+  class LazyConditionalGet
+
+    KEY = 'global_last_modified'.freeze
+    READ_METHODS = ['GET','HEAD']
+
+    def self.new(*)
+      # This code automatically uses `Rack::ConditionalGet` before
+      # our middleware. It is equivalent to:
+      #
+      # ``` ruby
+      # use Rack::ConditionalGet
+      # use Rack::LazyConditionalGet
+      # ```
+      ::Rack::ConditionalGet.new(super)
+    end
+
+    def initialize app, cache={}
+      @app = app
+      @cache = cache
+      update_cache
+    end
+
+    def call env
+      if reading? env and fresh? env
+        return [304, {'Last-Modified' => env['HTTP_IF_MODIFIED_SINCE']}, []]
+      end
+      status, headers, body = @app.call env
+      update_cache unless (reading?(env) or skipping?(headers))
+      headers['Last-Modified'] = cached_value if stampable? headers
+      [status, headers, body]
+    end
+
+    private
+
+    def fresh? env
+      env['HTTP_IF_MODIFIED_SINCE'] == cached_value
+    end
+
+    def reading? env
+      READ_METHODS.include?(env['REQUEST_METHOD'])
+    end
+
+    def skipping? headers
+      headers['Rack-Lazy-Conditional-Get'] == 'skip'
+    end
+
+    def stampable? headers
+      !headers.has_key?('Last-Modified') and headers['Rack-Lazy-Conditional-Get'] == 'yes'
+    end
+
+    def update_cache
+      stamp = Time.now.httpdate
+      if @cache.respond_to?(:set)
+        @cache.set(KEY,stamp)
+      else
+        @cache[KEY] = stamp
+      end
+    end
+
+    def cached_value
+      @cache.respond_to?(:get) ? @cache.get(KEY) : @cache[KEY]
+    end
+
+  end
+
+end
+

data/lib/rack/contrib/profiler.rb

@@ -5,6 +5,12 @@ module Rack
   # calltree profile of the request.
   #
   # Pass the :printer option to pick a different result format.
+  #
+  # 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
+  # given request multiple times, by setting the `profiler_runs` query
+  # parameter in the request URL.
+  #
   class Profiler
     MODES = %w(process_time wall_time cpu_time
                allocations memory gc_runs gc_time)
@@ -53,8 +59,10 @@ module Rack
         ::RubyProf.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
-          @times.times { @app.call(env) }
+          runs.times { @app.call(env) }
         end
         GC.disable_stats if GC.respond_to?(:disable_stats)
 

data/lib/rack/contrib/sendfile.rb

@@ -94,8 +94,6 @@ module Rack
   #   XSendFile on
 
   class Sendfile
-    F = ::File
-
     def initialize(app, variation=nil)
       @app = app
       @variation = variation
@@ -106,7 +104,7 @@ module Rack
       if body.respond_to?(:to_path)
         case type = variation(env)
         when 'X-Accel-Redirect'
-          path = F.expand_path(body.to_path)
+          path = ::File.expand_path(body.to_path)
           if url = map_accel_path(env, path)
             headers[type] = url
             body = []
@@ -114,7 +112,7 @@ module Rack
             env['rack.errors'] << "X-Accel-Mapping header missing"
           end
         when 'X-Sendfile', 'X-Lighttpd-Send-File'
-          path = F.expand_path(body.to_path)
+          path = ::File.expand_path(body.to_path)
           headers[type] = path
           body = []
         when '', nil

data/lib/rack/contrib/static_cache.rb

@@ -24,6 +24,12 @@ module Rack
   #
   # You can use Rack::Deflater along with Rack::StaticCache for further improvements in page loading time.
   #
+  # If you'd like to use a non-standard version identifier in your URLs, you
+  # can set the regex to remove with the `:version_regex` option.  If you
+  # want to capture something after the regex (such as file extensions), you
+  # should capture that as `\1`.  All other captured subexpressions will be
+  # discarded.  You may find the `?:` capture modifier helpful.
+  #
   # Examples:
   #     use Rack::StaticCache, :urls => ["/images", "/css", "/js", "/documents*"], :root => "statics"
   #     will serve all requests beginning with /images, /css or /js from the
@@ -57,8 +63,10 @@ module Rack
       root = options[:root] || Dir.pwd
       @file_server = Rack::File.new(root)
       @cache_duration = options[:duration] || 1
-      @versioning_enabled = true
-      @versioning_enabled = options[:versioning] unless options[:versioning].nil?
+      @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
@@ -66,16 +74,18 @@ module Rack
     def call(env)
       path = env["PATH_INFO"]
       url = @urls.detect{ |u| path.index(u) == 0 }
-      unless url.nil?
-        path.sub!(/-[\d.]+([.][a-zA-Z][\w]+)?$/, '\1') if @versioning_enabled
+      if url.nil?
+        @app.call(env)
+      else
+        if @versioning_enabled
+          path.sub!(@version_regex, '\1')
+        end
         status, headers, body = @file_server.call(env)
         if @no_cache[url].nil?
           headers['Cache-Control'] ="max-age=#{@duration_in_seconds}, public"
           headers['Expires'] = @duration_in_words
         end
         [status, headers, body]
-      else
-        @app.call(env)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-contrib
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - rack-devel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-28 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: minitest-hooks
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +226,7 @@ files:
 - lib/rack/contrib/garbagecollector.rb
 - lib/rack/contrib/host_meta.rb
 - lib/rack/contrib/jsonp.rb
+- lib/rack/contrib/lazy_conditional_get.rb
 - lib/rack/contrib/lighttpd_script_name_fix.rb
 - lib/rack/contrib/locale.rb
 - lib/rack/contrib/mailexceptions.rb