Class: ActionDispatch::Static

Inherits:
Object
  • Object
show all
Defined in:
lib/action_dispatch/middleware/static.rb

Overview

This middleware will attempt to return the contents of a file's body from disk in the response. If a file is not found on disk, the request will be delegated to the application stack. This middleware is commonly initialized to serve assets from a server's public/ directory.

This middleware verifies the path to ensure that only files living in the root directory can be rendered. A request cannot produce a directory traversal using this middleware. Only 'GET' and 'HEAD' requests will result in a file being returned.

Instance Method Summary collapse

Constructor Details

#initialize(app, path, index: "index", headers: {}) ⇒ Static

Returns a new instance of Static.



111
112
113
114
# File 'lib/action_dispatch/middleware/static.rb', line 111

def initialize(app, path, index: "index", headers: {})
  @app = app
  @file_handler = FileHandler.new(path, index: index, headers: headers)
end

Instance Method Details

#call(env) ⇒ Object



116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/action_dispatch/middleware/static.rb', line 116

def call(env)
  req = Rack::Request.new env

  if req.get? || req.head?
    path = req.path_info.chomp("/".freeze)
    if match = @file_handler.match?(path)
      req.path_info = match
      return @file_handler.serve(req)
    end
  end

  @app.call(req.env)
end