205 lines
7.1 KiB
HTML
205 lines
7.1 KiB
HTML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
|
|
<head>
|
||
|
|
<title>Class: Rack::Static</title>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
||
|
|
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
||
|
|
<script type="text/javascript">
|
||
|
|
// <![CDATA[
|
||
|
|
|
||
|
|
function popupCode( url ) {
|
||
|
|
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
||
|
|
}
|
||
|
|
|
||
|
|
function toggleCode( id ) {
|
||
|
|
if ( document.getElementById )
|
||
|
|
elem = document.getElementById( id );
|
||
|
|
else if ( document.all )
|
||
|
|
elem = eval( "document.all." + id );
|
||
|
|
else
|
||
|
|
return false;
|
||
|
|
|
||
|
|
elemStyle = elem.style;
|
||
|
|
|
||
|
|
if ( elemStyle.display != "block" ) {
|
||
|
|
elemStyle.display = "block"
|
||
|
|
} else {
|
||
|
|
elemStyle.display = "none"
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Make codeblocks hidden by default
|
||
|
|
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
||
|
|
|
||
|
|
// ]]>
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div id="classHeader">
|
||
|
|
<table class="header-table">
|
||
|
|
<tr class="top-aligned-row">
|
||
|
|
<td><strong>Class</strong></td>
|
||
|
|
<td class="class-name-in-header">Rack::Static</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="top-aligned-row">
|
||
|
|
<td><strong>In:</strong></td>
|
||
|
|
<td>
|
||
|
|
<a href="../../files/lib/rack/static_rb.html">
|
||
|
|
lib/rack/static.rb
|
||
|
|
</a>
|
||
|
|
<br />
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr class="top-aligned-row">
|
||
|
|
<td><strong>Parent:</strong></td>
|
||
|
|
<td>
|
||
|
|
Object
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- banner header -->
|
||
|
|
|
||
|
|
<div id="bodyContent">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div id="contextContent">
|
||
|
|
|
||
|
|
<div id="description">
|
||
|
|
<p>
|
||
|
|
The <a href="Static.html">Rack::Static</a> middleware intercepts requests
|
||
|
|
for static files (javascript files, images, stylesheets, etc) based on the
|
||
|
|
url prefixes passed in the options, and serves them using a <a
|
||
|
|
href="File.html">Rack::File</a> object. This allows a <a
|
||
|
|
href="../Rack.html">Rack</a> stack to serve both static and dynamic
|
||
|
|
content.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Examples:
|
||
|
|
</p>
|
||
|
|
<pre>
|
||
|
|
use Rack::Static, :urls => ["/media"]
|
||
|
|
will serve all requests beginning with /media from the "media" folder
|
||
|
|
located in the current directory (ie media/*).
|
||
|
|
|
||
|
|
use Rack::Static, :urls => ["/css", "/images"], :root => "public"
|
||
|
|
will serve all requests beginning with /css or /images from the folder
|
||
|
|
"public" in the current directory (ie public/css/* and public/images/*)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="method-list">
|
||
|
|
<h3 class="section-bar">Methods</h3>
|
||
|
|
|
||
|
|
<div class="name-list">
|
||
|
|
<a href="#M000146">call</a>
|
||
|
|
<a href="#M000145">new</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- if includes -->
|
||
|
|
|
||
|
|
<div id="section">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- if method_list -->
|
||
|
|
<div id="methods">
|
||
|
|
<h3 class="section-bar">Public Class methods</h3>
|
||
|
|
|
||
|
|
<div id="method-M000145" class="method-detail">
|
||
|
|
<a name="M000145"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
<a href="#M000145" class="method-signature">
|
||
|
|
<span class="method-name">new</span><span class="method-args">(app, options={})</span>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
<p><a class="source-toggle" href="#"
|
||
|
|
onclick="toggleCode('M000145-source');return false;">[Source]</a></p>
|
||
|
|
<div class="method-source-code" id="M000145-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/rack/static.rb, line 19</span>
|
||
|
|
19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">options</span>={})
|
||
|
|
20: <span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</span>
|
||
|
|
21: <span class="ruby-ivar">@urls</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:urls</span>] <span class="ruby-operator">||</span> [<span class="ruby-value str">"/favicon.ico"</span>]
|
||
|
|
22: <span class="ruby-identifier">root</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:root</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">pwd</span>
|
||
|
|
23: <span class="ruby-ivar">@file_server</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">root</span>)
|
||
|
|
24: <span class="ruby-keyword kw">end</span>
|
||
|
|
</pre>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h3 class="section-bar">Public Instance methods</h3>
|
||
|
|
|
||
|
|
<div id="method-M000146" class="method-detail">
|
||
|
|
<a name="M000146"></a>
|
||
|
|
|
||
|
|
<div class="method-heading">
|
||
|
|
<a href="#M000146" class="method-signature">
|
||
|
|
<span class="method-name">call</span><span class="method-args">(env)</span>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="method-description">
|
||
|
|
<p><a class="source-toggle" href="#"
|
||
|
|
onclick="toggleCode('M000146-source');return false;">[Source]</a></p>
|
||
|
|
<div class="method-source-code" id="M000146-source">
|
||
|
|
<pre>
|
||
|
|
<span class="ruby-comment cmt"># File lib/rack/static.rb, line 26</span>
|
||
|
|
26: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
|
||
|
|
27: <span class="ruby-identifier">path</span> = <span class="ruby-identifier">env</span>[<span class="ruby-value str">"PATH_INFO"</span>]
|
||
|
|
28: <span class="ruby-identifier">can_serve</span> = <span class="ruby-ivar">@urls</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">url</span><span class="ruby-operator">|</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">url</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span> }
|
||
|
|
29:
|
||
|
|
30: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">can_serve</span>
|
||
|
|
31: <span class="ruby-ivar">@file_server</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
|
||
|
|
32: <span class="ruby-keyword kw">else</span>
|
||
|
|
33: <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
|
||
|
|
34: <span class="ruby-keyword kw">end</span>
|
||
|
|
35: <span class="ruby-keyword kw">end</span>
|
||
|
|
</pre>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div id="validator-badges">
|
||
|
|
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|