Yessiest
/
landline
1
1
Fork 0
Code Issues 2 Pull Requests Projects 1 Releases Wiki Activity

Rebranding & better cookie DSL

This commit is contained in:
Yessiest 2023-09-19 22:58:15 +04:00
parent fcaeba4178
commit a800faf6e8
145 changed files with 518 additions and 30161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1 +1,3 @@
/*.gem
/doc
/.yardoc

31
.yardoc/checksums
View File

@ -1,31 +0,0 @@
lib/hyde.rb 632d043ed6e7484bca963c37e1629e1d88c89b69
lib/hyde/node.rb 6f1292fd88ba86988aaae75fb3d94c473b667654
lib/hyde/path.rb 42c04e42ea879ad73f639f2086b3ab5ca40489dc
lib/hyde/probe.rb 673b55e9aa8c8286a770bd23ae00bff1ac2047fe
lib/hyde/server.rb b68b932a689a2f8dbebebc2dc7eef5972c13d974
lib/hyde/request.rb 792427908273455eb694e13d3517cdae43af3454
lib/hyde/response.rb a82971ec8f86201de804e61b4dd277b48d28e8b2
lib/hyde/template.rb 69e46f8095e5e06dd69129ed975a5ce1e6d3de1f
lib/hyde/util/html.rb 258126a18f9e73068f2becc09a29bd8461941400
lib/hyde/util/query.rb b1e7b6da88a5d29198fba7188660a13ad47ac499
lib/hyde/util/cookie.rb 9a2eb0fdf1f716380c5314cf8fd21df2a60c8237
lib/hyde/util/errors.rb c275348668ee17c6478e60f3ecfb0c3b9d614480
lib/hyde/util/lookup.rb 5b8e28a8471bb786f4e0a0d616885d238c806661
lib/hyde/template/erb.rb d8c808a1fafaa65b400780204063bae6046e2f54
lib/hyde/probe/handler.rb 9b3eb4ce702c40920c04ed0cb3b93984683de447
lib/hyde/template/erubi.rb 74793cda58f79d6be3ce4ca25dc231296485bd4c
lib/hyde/util/multipart.rb 4c29eea87eb2093bad9cea228032121021aa38b9
lib/hyde/util/parseutils.rb 14376e92c85209d4ba46f4659652bb87a28e3a82
lib/hyde/dsl/methods_path.rb a695d61027389799893e15db5ae29de2a7511992
lib/hyde/pattern_matching.rb fe86f6529a2d22c128d9d3a74217862e9fa59c15
lib/hyde/dsl/methods_probe.rb c9fa8a2f095f6c99d356851f65786d70a288f690
lib/hyde/probe/http_method.rb 26ba5c9dabff5508dbd6efcba1711d6417cf957b
lib/hyde/util/parsesorting.rb a5eb853e443944ff678d70652fce86998c6b02c6
lib/hyde/dsl/methods_common.rb ea06161f4324127fbbacd51918eadc4e059e4fcf
lib/hyde/probe/serve_handler.rb 6c1d2a7b949700468342ced4c23c7fe60df4d3f0
lib/hyde/dsl/methods_template.rb 5ea0be9ad7411ed0d5bd50435edf2b7be9bd0b6f
lib/hyde/dsl/constructors_path.rb 9609d3470a1b0f3c30b83a15ef7683ab8c751960
lib/hyde/pattern_matching/glob.rb 16595083bc8d6f7b98f4adda502a05bd411bc1ca
lib/hyde/pattern_matching/util.rb 188dc7d5d9a9a6538a01943a83eb132c385dc092
lib/hyde/dsl/constructors_probe.rb c447b87b77ddb476584a3d77c5bf58f8122492ee
lib/hyde/pattern_matching/rematch.rb 54a4f94791e68d85c38034d954e4c3174e01511b

0
.yardoc/complete
View File

BIN
.yardoc/object_types
View File

Binary file not shown.

BIN
.yardoc/objects/root.dat
View File

Binary file not shown.

BIN
.yardoc/proxy_types
View File

Binary file not shown.

8
HACKING.md
View File

@ -1,8 +1,8 @@
# Notes and things to consider on Hyde hacking
# Notes and things to consider on Landline hacking
The structure of the Hyde rewrite was specifically redesigned to allow for
The structure of the Landline rewrite was specifically redesigned to allow for
extensive modification and extension. So to keep things that way, you may
want to consider the methodology of writing Hyde code.
want to consider the methodology of writing Landline code.
## Recommendations
@ -22,7 +22,7 @@ To keep things beautiful, consider following recommendations:
already. If it can't be helped, then at the very least use Rubocop.
- Document classes as if the next maintainer after you has you at gunpoint.
Document thoroughly, use YARD tags and **never** skip on public method
docs and class docs. As an example, consider Hyde::PatternMatching::Glob.
docs and class docs. As an example, consider Landline::PatternMatching::Glob.
- Unit tests suck for many reasons. However, if you're writing a class that
does not have any dependents and which is frequently used, consider making
a unit test for it. People that might have to fix things further along

58
LAYOUT.md
View File

@ -1,56 +1,56 @@
# Internal structure of Hyde lib
# Internal structure of Landline lib
Note: If you want to start hacking on Hyde and extending it, follow this
Note: If you want to start hacking on Landline and extending it, follow this
layout as closely as possible.
## Core classes
These are core classes of Hyde and they are loaded as soon as the library is loaded.
These are core classes of Landline and they are loaded as soon as the library is loaded.
- Hyde::Path [path.rb]
- Hyde::PathBinding [path.rb]
- Hyde::Probe [probe.rb]
- Hyde::ProbeBinding [probe.rb]
- Hyde::Node (parent of Path and Probe) [node.rb]
- Hyde::Server (Rack application interface) [server.rb]
- Hyde::ServerBinding [server.rb]
- Hyde::Request (Rack request wrapper) [request.rb]
- Hyde::Response (Rack response wrapper) [response.rb]
- Hyde::Pattern [pattern\_matching.rb]
- Landline::Path [path.rb]
- Landline::PathBinding [path.rb]
- Landline::Probe [probe.rb]
- Landline::ProbeBinding [probe.rb]
- Landline::Node (parent of Path and Probe) [node.rb]
- Landline::Server (Rack application interface) [server.rb]
- Landline::ServerBinding [server.rb]
- Landline::Request (Rack request wrapper) [request.rb]
- Landline::Response (Rack response wrapper) [response.rb]
- Landline::Pattern [pattern\_matching.rb]
## Patterns
These are classes that Hyde::Pattern can interface with to create Patterns.
These are classes that Landline::Pattern can interface with to create Patterns.
- Hyde::PatternMatching::ReMatch [pattern\_matching/rematch.rb]
- Hyde::PatternMatching::Glob [pattern\_matching/glob.rb]
- Landline::PatternMatching::ReMatch [pattern\_matching/rematch.rb]
- Landline::PatternMatching::Glob [pattern\_matching/glob.rb]
## DSL Method mixins
These are module mixins that add common methods to DSL bindings.
- Hyde::DSL::PathConstructors [dsl/path\_constructors.rb]
- Landline::DSL::PathConstructors [dsl/path\_constructors.rb]
## Utilities
These are self-contained classes and methods that add extra functionality to Hyde.
These are self-contained classes and methods that add extra functionality to Landline.
- Hyde::Util::Lookup [util/lookup.rb]
- Landline::Util::Lookup [util/lookup.rb]
## Probe subclasses
These are reactive request handlers with their own semantics, if needed.
- Hyde::Handler [probe/handler.rb]
- Hyde::GETHandler [probe/http\_method.rb]
- Hyde::POSTHandler [probe/http\_method.rb]
- Hyde::HEADHandler [probe/http\_method.rb]
- Hyde::PUTHandler [probe/http\_method.rb]
- Hyde::DELETEHandler [probe/http\_method.rb]
- Hyde::CONNECTHandler [probe/http\_method.rb]
- Hyde::OPTIONSHandler [probe/http\_method.rb]
- Hyde::TRACEHandler [probe/http\_method.rb]
- Hyde::PATCHHandler [probe/http\_method.rb]
- Landline::Handler [probe/handler.rb]
- Landline::GETHandler [probe/http\_method.rb]
- Landline::POSTHandler [probe/http\_method.rb]
- Landline::HEADHandler [probe/http\_method.rb]
- Landline::PUTHandler [probe/http\_method.rb]
- Landline::DELETEHandler [probe/http\_method.rb]
- Landline::CONNECTHandler [probe/http\_method.rb]
- Landline::OPTIONSHandler [probe/http\_method.rb]
- Landline::TRACEHandler [probe/http\_method.rb]
- Landline::PATCHHandler [probe/http\_method.rb]
## Path subclasses

30
README.md
View File

@ -1,16 +1,16 @@
# The strange case of Dr. Rack and Mr. Hyde
# The strange case of Dr. Rack and Mr. Landline
Hyde is a library that provides a DSL for creating web applications. As of now it is using Rack as the webserver adapter, but ideally it shouldn't take much work to make it run on top of any webserver.
Landline is a library that provides a DSL for creating web applications. As of now it is using Rack as the webserver adapter, but ideally it shouldn't take much work to make it run on top of any webserver.
Hyde was made mostly for fun. Ideally it will become something more, but as of yet it's just an experiment revolving around Ruby Metaprogramming and its DSL capabilities.
Landline was made mostly for fun. Ideally it will become something more, but as of yet it's just an experiment revolving around Ruby Metaprogramming and its DSL capabilities.
# Examples
A simple "Hello, World!" app using Hyde
A simple "Hello, World!" app using Landline
```ruby
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
get "/hello" do
header "content-type", "text/plain"
"Hello world!"
@ -23,11 +23,11 @@ run app
A push/pull stack as an app
```ruby
require 'hyde'
require 'landline'
stack = []
app = Hyde::Server.new do
app = Landline::Server.new do
get "/pop" do
header 'content-type', 'text/plain'
stack.pop.to_s
@ -45,11 +45,11 @@ run app
Several push/pull buckets
```ruby
require 'hyde'
require 'landline'
stack = { "1" => [], "2" => [], "3" => [] }
app = Hyde::Server.new do
app = Landline::Server.new do
path "bucket_(1|2|3)" do
get "pop" do |bucket|
header "content-type", "text/plain"
@ -70,9 +70,9 @@ Static file serving
(Note: index applies *only* to /var/www (to the path its defined in))
```ruby
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
root "/var/www"
index ["index.html","index.htm"]
serve "**/*.(html|htm)"
@ -84,9 +84,9 @@ run app
Logging on a particular path
```ruby
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
path "unimportant" do
get "version" do
header "content-type", "text/plain"
@ -117,7 +117,7 @@ Someday it's gonna be there somewhere
# License
```
Hyde - an HTTP request pattern matching system
Landline - an HTTP request pattern matching system
Copyright (C) 2022 yessiest (yessiest@memeware.net)
This program is free software: you can redistribute it and/or modify

185
doc/Hyde.html
View File

@ -1,185 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (H)</a> &raquo;
<span class="title">Hyde</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde.rb<span class="defines">,<br />
lib/hyde/node.rb,<br /> lib/hyde/path.rb,<br /> lib/hyde/probe.rb,<br /> lib/hyde/server.rb,<br /> lib/hyde/request.rb,<br /> lib/hyde/response.rb,<br /> lib/hyde/template.rb,<br /> lib/hyde/util/html.rb,<br /> lib/hyde/util/query.rb,<br /> lib/hyde/util/cookie.rb,<br /> lib/hyde/util/errors.rb,<br /> lib/hyde/util/lookup.rb,<br /> lib/hyde/template/erb.rb,<br /> lib/hyde/probe/handler.rb,<br /> lib/hyde/template/erubi.rb,<br /> lib/hyde/util/multipart.rb,<br /> lib/hyde/util/parseutils.rb,<br /> lib/hyde/dsl/methods_path.rb,<br /> lib/hyde/pattern_matching.rb,<br /> lib/hyde/dsl/methods_probe.rb,<br /> lib/hyde/probe/http_method.rb,<br /> lib/hyde/util/parsesorting.rb,<br /> lib/hyde/dsl/methods_common.rb,<br /> lib/hyde/probe/serve_handler.rb,<br /> lib/hyde/dsl/methods_template.rb,<br /> lib/hyde/dsl/constructors_path.rb,<br /> lib/hyde/pattern_matching/glob.rb,<br /> lib/hyde/pattern_matching/util.rb,<br /> lib/hyde/dsl/constructors_probe.rb,<br /> lib/hyde/pattern_matching/rematch.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Hyde is a hideously simple ruby web framework</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Hyde/DSL.html" title="Hyde::DSL (module)">DSL</a></span>, <span class='object_link'><a href="Hyde/Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span>, <span class='object_link'><a href="Hyde/PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span>, <span class='object_link'><a href="Hyde/Templates.html" title="Hyde::Templates (module)">Templates</a></span>, <span class='object_link'><a href="Hyde/Util.html" title="Hyde::Util (module)">Util</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Hyde/Cookie.html" title="Hyde::Cookie (class)">Cookie</a></span>, <span class='object_link'><a href="Hyde/Error.html" title="Hyde::Error (class)">Error</a></span>, <span class='object_link'><a href="Hyde/Node.html" title="Hyde::Node (class)">Node</a></span>, <span class='object_link'><a href="Hyde/ParsingError.html" title="Hyde::ParsingError (class)">ParsingError</a></span>, <span class='object_link'><a href="Hyde/Path.html" title="Hyde::Path (class)">Path</a></span>, <span class='object_link'><a href="Hyde/PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span>, <span class='object_link'><a href="Hyde/Pattern.html" title="Hyde::Pattern (class)">Pattern</a></span>, <span class='object_link'><a href="Hyde/Probe.html" title="Hyde::Probe (class)">Probe</a></span>, <span class='object_link'><a href="Hyde/ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span>, <span class='object_link'><a href="Hyde/ProcessorContext.html" title="Hyde::ProcessorContext (class)">ProcessorContext</a></span>, <span class='object_link'><a href="Hyde/Request.html" title="Hyde::Request (class)">Request</a></span>, <span class='object_link'><a href="Hyde/Response.html" title="Hyde::Response (class)">Response</a></span>, <span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span>, <span class='object_link'><a href="Hyde/ServerContext.html" title="Hyde::ServerContext (class)">ServerContext</a></span>, <span class='object_link'><a href="Hyde/Template.html" title="Hyde::Template (class)">Template</a></span>, <span class='object_link'><a href="Hyde/TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
<div class="docstring">
<div class="discussion">
<p>Hyde version</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.8 (beta/rewrite)</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="VLINE-constant" class="">VLINE =
<div class="docstring">
<div class="discussion">
<p>Hyde branding and version</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Hyde/</span><span class='embexpr_beg'>#{</span><span class='const'>Hyde</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="#VERSION-constant" title="Hyde::VERSION (constant)">VERSION</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'> (Ruby/</span><span class='embexpr_beg'>#{</span><span class='const'>RUBY_VERSION</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='const'>RUBY_RELEASE_DATE</span><span class='embexpr_end'>}</span><span class='tstring_content'>)\n</span><span class='tstring_end'>&quot;</span></span></pre></dd>
<dt id="COPYRIGHT-constant" class="">COPYRIGHT =
<div class="docstring">
<div class="discussion">
<p>Hyde copyright</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Copyright 2023 Yessiest</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/CONNECTHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::CONNECTHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::CONNECTHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">CONNECTHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::CONNECTHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::CONNECTHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a CONNECT</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CONNECT</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

830
doc/Hyde/Cookie.html
View File

@ -1,830 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Cookie
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Cookie";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Cookie</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Cookie
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Cookie</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/cookie.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Utility class for handling cookies</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#key-instance_method" title="#key (instance method)">#<strong>key</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#params-instance_method" title="#params (instance method)">#<strong>params</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute params.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#value-instance_method" title="#value (instance method)">#<strong>value</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute value.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#from_cookie_string-class_method" title="from_cookie_string (class method)">.<strong>from_cookie_string</strong>(data) &#x21d2; Array(Cookie) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create cookie(s) from a &quot;Cookie: &quot; format.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#from_setcookie_string-class_method" title="from_setcookie_string (class method)">.<strong>from_setcookie_string</strong>(data) &#x21d2; Cookie </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create cookie from a &quot;Set-Cookie: &quot; format.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(key, value, params = {}) &#x21d2; Cookie </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Cookie.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert cookie to &quot;Set-Cookie: &quot; string representation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_short-instance_method" title="#to_short (instance method)">#<strong>to_short</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert cookie to &quot;Cookie: &quot; string representation (no params).</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(key, value, params = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Cookie.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>data</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>raw cookie data</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14
15
16
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'>COOKIE_KEY</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ParsingError.html" title="Hyde::ParsingError (class)">ParsingError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid cookie key: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/HeaderRegexp.html#COOKIE_VALUE-constant" title="Hyde::Util::HeaderRegexp::COOKIE_VALUE (constant)">COOKIE_VALUE</a></span></span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ParsingError.html" title="Hyde::ParsingError (class)">ParsingError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid cookie value: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='ivar'>@key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span>
<span class='ivar'>@value</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="key=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="key-instance_method">
#<strong>key</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute key.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_key'>key</span>
<span class='ivar'>@key</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="params-instance_method">
#<strong>params</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute params.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
<span class='ivar'>@params</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="value=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="value-instance_method">
#<strong>value</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute value.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='ivar'>@value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="from_cookie_string-class_method">
.<strong>from_cookie_string</strong>(data) &#x21d2; <tt>Array(<span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span>)</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create cookie(s) from a &quot;Cookie: &quot; format</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>data</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>value part of &quot;Cookie: &quot; header</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(<span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span>)</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 53</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_cookie_string'>from_cookie_string</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cookiestr'>cookiestr</span><span class='op'>|</span>
<span class='const'><span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Hyde::Cookie#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_cookiestr'>cookiestr</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:strip</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="from_setcookie_string-class_method">
.<strong>from_setcookie_string</strong>(data) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create cookie from a &quot;Set-Cookie: &quot; format</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>data</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>value part of &quot;Set-Cookie: &quot; header</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43
44
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 41</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_setcookie_string'>from_setcookie_string</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='id identifier rubyid_kvpair'>kvpair</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/ParserCommon.html" title="Hyde::Util::ParserCommon (module)">ParserCommon</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_value'><span class='object_link'><a href="Util/ParserCommon.html#parse_value-class_method" title="Hyde::Util::ParserCommon.parse_value (method)">parse_value</a></span></span><span class='lparen'>(</span>
<span class='id identifier rubyid_data'>data</span><span class='comma'>,</span>
<span class='label'>regexp:</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/HeaderRegexp.html#COOKIE_PARAM-constant" title="Hyde::Util::HeaderRegexp::COOKIE_PARAM (constant)">COOKIE_PARAM</a></span></span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_kvpair'>kvpair</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>=</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:strip</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="Hyde::Cookie (class)">Cookie</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Hyde::Cookie#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="to_s-instance_method">
#<strong>to_s</strong> &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert cookie to &quot;Set-Cookie: &quot; string representation.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
<span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_value'>make_value</span><span class='lparen'>(</span><span class='id identifier rubyid_to_short'>to_short</span><span class='comma'>,</span> <span class='ivar'>@params</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_short-instance_method">
#<strong>to_short</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert cookie to &quot;Cookie: &quot; string representation (no params)</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/cookie.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_short'>to_short</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/DELETEHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::DELETEHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DELETEHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">DELETEHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::DELETEHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::DELETEHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a DELETE</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

127
doc/Hyde/DSL.html
View File

@ -1,127 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">DSL</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/methods_path.rb<span class="defines">,<br />
lib/hyde/dsl/methods_probe.rb,<br /> lib/hyde/dsl/methods_common.rb,<br /> lib/hyde/dsl/methods_template.rb,<br /> lib/hyde/dsl/constructors_path.rb,<br /> lib/hyde/dsl/constructors_probe.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Shared DSL methods</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">CommonMethods</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">PathConstructors</a></span>, <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">PathMethods</a></span>, <span class='object_link'><a href="DSL/ProbeConstructors.html" title="Hyde::DSL::ProbeConstructors (module)">ProbeConstructors</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">ProbeMethods</a></span>, <span class='object_link'><a href="DSL/TemplateMethods.html" title="Hyde::DSL::TemplateMethods (module)">TemplateMethods</a></span>
</p>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

337
doc/Hyde/DSL/CommonMethods.html
View File

@ -1,337 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL::CommonMethods
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL::CommonMethods";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span>
&raquo;
<span class="title">CommonMethods</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL::CommonMethods
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span>, <span class='object_link'><a href="../ProcessorContext.html" title="Hyde::ProcessorContext (class)">ProcessorContext</a></span>, <span class='object_link'><a href="../TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/methods_common.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Methods shared by probes, preprocessors and filters.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#bounce-instance_method" title="#bounce (instance method)">#<strong>bounce</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Bounce request to the next handler.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#die-instance_method" title="#die (instance method)">#<strong>die</strong>(errorcode, backtrace: nil) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Stop execution and generate a boilerplate response with the given code.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="bounce-instance_method">
#<strong>bounce</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Bounce request to the next handler</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'><p>throws :break to get out of the callback</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_common.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_bounce'>bounce</span>
<span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:break</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="die-instance_method">
#<strong>die</strong>(errorcode, backtrace: nil) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Stop execution and generate a boilerplate response with the given code</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>errorcode</span>
<span class='type'>(<tt>Integer</tt>)</span>
</li>
<li>
<span class='name'>backtrace</span>
<span class='type'>(<tt>Array(String)</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'><p>throws :finish to return back to Server</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_common.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_die'>die</span><span class='lparen'>(</span><span class='id identifier rubyid_errorcode'>errorcode</span><span class='comma'>,</span> <span class='label'>backtrace:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:finish</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_errorcode'>errorcode</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span>
<span class='op'>*</span><span class='lparen'>(</span><span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_properties'>properties</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>handle.</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_errorcode'>errorcode</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='kw'>or</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_properties'>properties</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>handle.default</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span>
<span class='id identifier rubyid_errorcode'>errorcode</span><span class='comma'>,</span>
<span class='label'>backtrace:</span> <span class='id identifier rubyid_backtrace'>backtrace</span>
<span class='rparen'>)</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

964
doc/Hyde/DSL/PathConstructors.html
View File

@ -1,964 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL::PathConstructors
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL::PathConstructors";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span>
&raquo;
<span class="title">PathConstructors</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL::PathConstructors
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/constructors_path.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Path (and subclasses) DSL constructors</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#connect-instance_method" title="#connect (instance method)">#<strong>connect</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::CONNECTHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::DELETEHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::GETHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#head-instance_method" title="#head (instance method)">#<strong>head</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::HEADHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::OPTIONSHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#patch-instance_method" title="#patch (instance method)">#<strong>patch</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::PATCHHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new <span class='object_link'><a href="../Path.html" title="Hyde::Path (class)">Path</a></span> object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#post-instance_method" title="#post (instance method)">#<strong>post</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>create a new Handlers::POSTHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#probe-instance_method" title="#probe (instance method)">#<strong>probe</strong>(path, &amp;_setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::Probe object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::PUTHandler object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#register-instance_method" title="#register (instance method)">#<strong>register</strong>(obj) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Append a Node child object to the list of children.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#serve-instance_method" title="#serve (instance method)">#<strong>serve</strong>(path) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::GETHandler that serves static files.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#trace-instance_method" title="#trace (instance method)">#<strong>trace</strong>(path, &amp;setup) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new Handlers::TRACEHandler object.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="connect-instance_method">
#<strong>connect</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::CONNECTHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/CONNECT.html" title="Hyde::Handlers::CONNECT (class)">CONNECT</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="delete-instance_method">
#<strong>delete</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::DELETEHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/DELETE.html" title="Hyde::Handlers::DELETE (class)">DELETE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get-instance_method">
#<strong>get</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::GETHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="head-instance_method">
#<strong>head</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::HEADHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_head'>head</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/HEAD.html" title="Hyde::Handlers::HEAD (class)">HEAD</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="options-instance_method">
#<strong>options</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::OPTIONSHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/OPTIONS.html" title="Hyde::Handlers::OPTIONS (class)">OPTIONS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="patch-instance_method">
#<strong>patch</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::PATCHHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/PATCH.html" title="Hyde::Handlers::PATCH (class)">PATCH</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="path-instance_method">
#<strong>path</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new <span class='object_link'><a href="../Path.html" title="Hyde::Path (class)">Path</a></span> object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Path.html" title="Hyde::Path (class)">Path</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Path.html#initialize-instance_method" title="Hyde::Path#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="post-instance_method">
#<strong>post</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>create a new Handlers::POSTHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/POST.html" title="Hyde::Handlers::POST (class)">POST</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="probe-instance_method">
#<strong>probe</strong>(path, &amp;_setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::Probe object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_probe'>probe</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid__setup'>_setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'>Probe</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="put-instance_method">
#<strong>put</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::PUTHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/PUT.html" title="Hyde::Handlers::PUT (class)">PUT</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="register-instance_method">
#<strong>register</strong>(obj) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Append a Node child object to the list of children</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11
12
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>register accepts node children only</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_children'>children</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="serve-instance_method">
#<strong>serve</strong>(path) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::GETHandler that serves static files</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 73</span>
<span class='kw'>def</span> <span class='id identifier rubyid_serve'>serve</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/Serve.html" title="Hyde::Handlers::Serve (class)">Serve</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Serve.html#initialize-instance_method" title="Hyde::Handlers::Serve#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="trace-instance_method">
#<strong>trace</strong>(path, &amp;setup) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new Handlers::TRACEHandler object</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_path.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_trace'>trace</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Handlers/TRACE.html" title="Hyde::Handlers::TRACE (class)">TRACE</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Handlers/Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

777
doc/Hyde/DSL/PathMethods.html
View File

@ -1,777 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL::PathMethods
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL::PathMethods";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span>
&raquo;
<span class="title">PathMethods</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL::PathMethods
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/methods_path.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Common path methods</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#filter-instance_method" title="#filter (instance method)">#<strong>filter</strong>(&amp;block) {|request| ... } &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add a filter to the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#index-instance_method" title="#index (instance method)">#<strong>index</strong>(index) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set path index.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#plugin-instance_method" title="#plugin (instance method)">#<strong>plugin</strong>(filename) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Include an application as a child of path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#postprocess-instance_method" title="#postprocess (instance method)">#<strong>postprocess</strong>(&amp;block) {|request, response| ... } &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add a postprocessor to the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#preprocess-instance_method" title="#preprocess (instance method)">#<strong>preprocess</strong>(&amp;block) {|request| ... } &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add a preprocessor to the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remap-instance_method" title="#remap (instance method)">#<strong>remap</strong>(path) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set root path (without appending matched part).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#root-instance_method" title="#root (instance method)">#<strong>root</strong>(path) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set root path (appends matched part of the path).</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="filter-instance_method">
#<strong>filter</strong>(&amp;block) {|request| ... } &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add a filter to the path.
Blocks path access if a filter returns false.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_block'>block</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="index-instance_method">
#<strong>index</strong>(index) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set path index</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>index</span>
<span class='type'>(<tt>Array</tt>, <tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12
13
14
15
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_index'>index</span>
<span class='kw'>when</span> <span class='const'>Array</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_properties'>properties</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>index</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span>
<span class='kw'>when</span> <span class='const'>String</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_properties'>properties</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>index</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>index should be an Array or a String</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="plugin-instance_method">
#<strong>plugin</strong>(filename) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Include an application as a child of path.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>filename</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64
65
66
67
68
69
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_plugin'>plugin</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_define_singleton_method'>define_singleton_method</span><span class='lparen'>(</span><span class='symbol'>:run</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_object'>object</span><span class='op'>|</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>not a node instance or subclass instance</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_object'>object</span>
<span class='kw'>end</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_children'>children</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_singleton_class'>singleton_class</span><span class='period'>.</span><span class='id identifier rubyid_undef_method'>undef_method</span> <span class='symbol'>:run</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="postprocess-instance_method">
#<strong>postprocess</strong>(&amp;block) {|request, response| ... } &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add a postprocessor to the path.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
<li>
<span class='name'>response</span>
<span class='type'>(<tt><span class='object_link'><a href="../Response.html" title="Hyde::Response (class)">Hyde::Response</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_postprocess'>postprocess</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_postprocess'>postprocess</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_block'>block</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="preprocess-instance_method">
#<strong>preprocess</strong>(&amp;block) {|request| ... } &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add a preprocessor to the path.
Does not modify path execution.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_block'>block</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="remap-instance_method">
#<strong>remap</strong>(path) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set root path (without appending matched part).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remap'>remap</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_remap'>remap</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="root-instance_method">
#<strong>root</strong>(path) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set root path (appends matched part of the path).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_path.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_root'><span class='object_link'><a href="../../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_root'><span class='object_link'><a href="../../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

327
doc/Hyde/DSL/ProbeConstructors.html
View File

@ -1,327 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL::ProbeConstructors
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL::ProbeConstructors";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span>
&raquo;
<span class="title">ProbeConstructors</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL::ProbeConstructors
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span>, <span class='object_link'><a href="../TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/constructors_probe.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe (and subclasses) DSL construct</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#erb-instance_method" title="#erb (instance method)">#<strong>erb</strong>(input, vars = {}) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new erb template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#erubi-instance_method" title="#erubi (instance method)">#<strong>erubi</strong>(input, vars = {}, freeze: true, capture: false) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new erb template using Erubi engine.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="erb-instance_method">
#<strong>erb</strong>(input, vars = {}) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new erb template</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Hyde::DSL::ProbeConstructors.{Hyde{Hyde::Template{Hyde::Template#new}</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_probe.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_erb'>erb</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates.html" title="Hyde::Templates (module)">Templates</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates/ERB.html" title="Hyde::Templates::ERB (class)">ERB</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Templates/ERB.html#initialize-instance_method" title="Hyde::Templates::ERB#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span>
<span class='id identifier rubyid_vars'>vars</span><span class='comma'>,</span>
<span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="erubi-instance_method">
#<strong>erubi</strong>(input, vars = {}, freeze: true, capture: false) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new erb template using Erubi engine</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>freeze</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'><p>whether to use frozen string literal</p>
</div>
</li>
<li>
<span class='name'>capture</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'><p>whether to enable output capturing</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Hyde::DSL::ProbeConstructors.{Hyde{Hyde::Template{Hyde::Template#new}</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/constructors_probe.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_erubi'>erubi</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>freeze:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>capture:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates.html" title="Hyde::Templates (module)">Templates</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Templates/Erubi.html" title="Hyde::Templates::Erubi (class)">Erubi</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Templates/Erubi.html#initialize-instance_method" title="Hyde::Templates::Erubi#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span>
<span class='id identifier rubyid_vars'>vars</span><span class='comma'>,</span>
<span class='label'>parent:</span> <span class='ivar'>@origin</span><span class='comma'>,</span>
<span class='label'>freeze:</span> <span class='id identifier rubyid_freeze'>freeze</span><span class='comma'>,</span>
<span class='label'>capture:</span> <span class='id identifier rubyid_capture'>capture</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

936
doc/Hyde/DSL/ProbeMethods.html
View File

@ -1,936 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL::ProbeMethods
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL::ProbeMethods";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span>
&raquo;
<span class="title">ProbeMethods</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL::ProbeMethods
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span>, <span class='object_link'><a href="../TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/methods_probe.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Common methods for Probe objects</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#escape_html-instance_method" title="#escape_html (instance method)">#<strong>escape_html</strong>(text) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Escape HTML entities.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#file-instance_method" title="#file (instance method)">#<strong>file</strong>(path, mode = &quot;r&quot;, *all, &amp;block) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Open a file relative to current filepath.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#form-instance_method" title="#form (instance method)">#<strong>form</strong> &#x21d2; Hash{String=&gt;(String,Hyde::Util::FormPart)} </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns formdata.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#form%3F-instance_method" title="#form? (instance method)">#<strong>form?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks if current request has multipart/form-data associated with it.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#header-instance_method" title="#header (instance method)">#<strong>header</strong>(key, value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set response header (generate response if one doesn&#39;t exist yet).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_header-instance_method" title="#remove_header (instance method)">#<strong>remove_header</strong>(key, value = nil) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Delete a header value from the headers hash If no value is provided, deletes all key entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#request-instance_method" title="#request (instance method)">#<strong>request</strong> &#x21d2; Hyde::Request </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get the current request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong>(status) &#x21d2; Object </a>
(also: #code)
</span>
<span class="summary_desc"><div class='inline'><p>Set response status (generate response if one doesn&#39;t exist yet).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unescape_html-instance_method" title="#unescape_html (instance method)">#<strong>unescape_html</strong>(text) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Unescape HTML entities.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="escape_html-instance_method">
#<strong>escape_html</strong>(text) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Escape HTML entities</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Util.html#escape_html-class_method" title="Hyde::Util.escape_html (method)">Util.escape_html</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_escape_html'>escape_html</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_escape_html'><span class='object_link'><a href="../Util.html#escape_html-class_method" title="Hyde::Util.escape_html (method)">escape_html</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="file-instance_method">
#<strong>file</strong>(path, mode = &quot;r&quot;, *all, &amp;block) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Open a file relative to current filepath</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>File.open</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
93
94
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 93</span>
<span class='kw'>def</span> <span class='id identifier rubyid_file'>file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_mode'>mode</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>r</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_all'>all</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_filepath'>filepath</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_mode'>mode</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_all'>all</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="form-instance_method">
#<strong>form</strong> &#x21d2; <tt>Hash{String=&gt;(String,<span class='object_link'><a href="../Util/FormPart.html" title="Hyde::Util::FormPart (class)">Hyde::Util::FormPart</a></span>)}</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns formdata</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash{String=&gt;(String,<span class='object_link'><a href="../Util/FormPart.html" title="Hyde::Util::FormPart (class)">Hyde::Util::FormPart</a></span>)}</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82
83
84
85
86
87
88
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 82</span>
<span class='kw'>def</span> <span class='id identifier rubyid_form'>form</span>
<span class='id identifier rubyid__'>_</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/ParserCommon.html" title="Hyde::Util::ParserCommon (module)">ParserCommon</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_value'><span class='object_link'><a href="../Util/ParserCommon.html#parse_value-class_method" title="Hyde::Util::ParserCommon.parse_value (method)">parse_value</a></span></span><span class='lparen'>(</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/MultipartParser.html" title="Hyde::Util::MultipartParser (class)">MultipartParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Util/MultipartParser.html#initialize-instance_method" title="Hyde::Util::MultipartParser#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>boundary</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_h'><span class='object_link'><a href="../Util/MultipartParser.html#to_h-instance_method" title="Hyde::Util::MultipartParser#to_h (method)">to_h</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="form?-instance_method">
#<strong>form?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks if current request has multipart/form-data associated with it</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_form?'>form?</span>
<span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/ParserCommon.html" title="Hyde::Util::ParserCommon (module)">ParserCommon</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_value'><span class='object_link'><a href="../Util/ParserCommon.html#parse_value-class_method" title="Hyde::Util::ParserCommon.parse_value (method)">parse_value</a></span></span><span class='lparen'>(</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>multipart/form-data</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>and</span>
<span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>boundary</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='kw'>true</span>
<span class='kw'>else</span>
<span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="header-instance_method">
#<strong>header</strong>(key, value) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set response header (generate response if one doesn&#39;t exist yet)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>header name</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>header value</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_header'>header</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_status'>status</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>status</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>header key has invalid characters</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='op'>&amp;.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html#PRINTABLE-constant" title="Hyde::Util::HeaderRegexp::PRINTABLE (constant)">PRINTABLE</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>value key has invalid characters</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='kw'>or</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Response.html" title="Hyde::Response (class)">Response</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Response.html#initialize-instance_method" title="Hyde::Response#initialize (method)">new</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_key'>key</span> <span class='op'>=</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_add_header'>add_header</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="remove_header-instance_method">
#<strong>remove_header</strong>(key, value = nil) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Delete a header value from the headers hash
If no value is provided, deletes all key entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>header name</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'><p>header value</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove_header'>remove_header</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>status</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>header key has invalid characters</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='op'>&amp;.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util/HeaderRegexp.html#PRINTABLE-constant" title="Hyde::Util::HeaderRegexp::PRINTABLE (constant)">PRINTABLE</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>value key has invalid characters</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_delete_header'>delete_header</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="request-instance_method">
#<strong>request</strong> &#x21d2; <tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the current request</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="status-instance_method">
#<strong>status</strong>(status) &#x21d2; <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='code-instance_method'>code</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Set response status (generate response if one doesn&#39;t exist yet)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>status</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'><p>http status code</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='kw'>or</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Response.html" title="Hyde::Response (class)">Response</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Response.html#initialize-instance_method" title="Hyde::Response#initialize (method)">new</a></span></span><span class='rparen'>)</span>
<span class='ivar'>@origin</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unescape_html-instance_method">
#<strong>unescape_html</strong>(text) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Unescape HTML entities</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../Util.html#escape_html-class_method" title="Hyde::Util.escape_html (method)">Util.escape_html</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_probe.rb', line 105</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unescape_html'>unescape_html</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_unescape_html'><span class='object_link'><a href="../Util.html#unescape_html-class_method" title="Hyde::Util.unescape_html (method)">unescape_html</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

200
doc/Hyde/DSL/TemplateMethods.html
View File

@ -1,200 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::DSL::TemplateMethods
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::DSL::TemplateMethods";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../DSL.html" title="Hyde::DSL (module)">DSL</a></span></span>
&raquo;
<span class="title">TemplateMethods</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::DSL::TemplateMethods
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/dsl/methods_template.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Common methods for template contexts</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#import-instance_method" title="#import (instance method)">#<strong>import</strong>(filepath) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Import a template part.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="import-instance_method">
#<strong>import</strong>(filepath) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Import a template part</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/dsl/methods_template.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
<span class='ivar'>@parent_template</span><span class='period'>.</span><span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

138
doc/Hyde/Error.html
View File

@ -1,138 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: Hyde::Error
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Error";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Error</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Exception: Hyde::Error
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">StandardError</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">StandardError</li>
<li class="next">Hyde::Error</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/errors.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Generic error class, as recommended by Ruby documentation.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="ParsingError.html" title="Hyde::ParsingError (class)">ParsingError</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

366
doc/Hyde/GETHandler.html
View File

@ -1,366 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::GETHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::GETHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (G)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">GETHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::GETHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next">Hyde::GETHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a GET</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="CONNECTHandler.html" title="Hyde::CONNECTHandler (class)">CONNECTHandler</a></span>, <span class='object_link'><a href="DELETEHandler.html" title="Hyde::DELETEHandler (class)">DELETEHandler</a></span>, <span class='object_link'><a href="HEADHandler.html" title="Hyde::HEADHandler (class)">HEADHandler</a></span>, <span class='object_link'><a href="OPTIONSHandler.html" title="Hyde::OPTIONSHandler (class)">OPTIONSHandler</a></span>, <span class='object_link'><a href="PATCHHandler.html" title="Hyde::PATCHHandler (class)">PATCHHandler</a></span>, <span class='object_link'><a href="POSTHandler.html" title="Hyde::POSTHandler (class)">POSTHandler</a></span>, <span class='object_link'><a href="PUTHandler.html" title="Hyde::PUTHandler (class)">PUTHandler</a></span>, <span class='object_link'><a href="TRACEHandler.html" title="Hyde::TRACEHandler (class)">TRACEHandler</a></span></p>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation. Runs block supplied with object initialization. Request’s #splat and #param are passed to block.</p>
<p>Callback’s returned should be one of viable responses:</p>
<ul><li>
<p><span class='object_link'><a href="Response.html" title="Hyde::Response (class)">Response</a></span> object</p>
</li><li>
<p>An array that matches Rack return form</p>
</li><li>
<p>An array that matches old (Rack 2.x) return form</p>
</li><li>
<p>A string (returned as HTML with code 200)</p>
</li><li>
<p>false (bounces the request to next handler)</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if further navigation is possible</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'>
<p>may raise if die() is called.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
24
25
26
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/http_method.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_request_method'>request_method</span><span class='period'>.</span><span class='id identifier rubyid_casecmp'>casecmp</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='op'>::</span><span class='const'>METHOD</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>
<span class='kw'>return</span> <span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:17 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/HEADHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::HEADHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::HEADHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">HEADHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::HEADHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::HEADHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a HEAD</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HEAD</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

609
doc/Hyde/Handler.html
View File

@ -1,609 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Handler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next">Hyde::Handler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/handler.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes a callback on request</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#request-instance_method" title="#request (instance method)">#<strong>request</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#response-instance_method" title="#response (instance method)">#<strong>response</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute response.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:, &amp;exec) &#x21d2; Handler </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Handler.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:, &amp;exec) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Handler (class)">Handler</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Handler.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
</li>
<li>
<span class='name'>exec</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_exec'>exec</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='ivar'>@callback</span> <span class='op'>=</span> <span class='id identifier rubyid_exec'>exec</span>
<span class='ivar'>@context</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ProbeContext.html#initialize-instance_method" title="Hyde::ProbeContext#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="request-instance_method">
#<strong>request</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute request.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
<span class='ivar'>@request</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="response=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="response-instance_method">
#<strong>response</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute response.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
<span class='ivar'>@response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation. Runs block supplied with object initialization. Request’s #splat and #param are passed to block.</p>
<p>Callback’s returned should be one of viable responses:</p>
<ul><li>
<p><span class='object_link'><a href="Response.html" title="Hyde::Response (class)">Response</a></span> object</p>
</li><li>
<p>An array that matches Rack return form</p>
</li><li>
<p>An array that matches old (Rack 2.x) return form</p>
</li><li>
<p>A string (returned as HTML with code 200)</p>
</li><li>
<p>false (bounces the request to next handler)</p>
</li></ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if further navigation is possible</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'>
<p>may raise if die() is called.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>return</span> <span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/?$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
<span class='ivar'>@request</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_catch'>catch</span><span class='lparen'>(</span><span class='symbol'>:break</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_splat'>splat</span><span class='comma'>,</span>
<span class='op'>**</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_param'>param</span><span class='comma'>,</span>
<span class='op'>&amp;</span><span class='ivar'>@callback</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>if</span> <span class='ivar'>@response</span> <span class='kw'>and</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>File</span><span class='comma'>,</span> <span class='const'>IO</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
<span class='ivar'>@response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
<span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:finish</span><span class='comma'>,</span> <span class='ivar'>@response</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:finish</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:17 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

127
doc/Hyde/Handlers.html
View File

@ -1,127 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Handlers
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Handlers</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Handlers
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe.rb<span class="defines">,<br />
lib/hyde/probe/handler.rb,<br /> lib/hyde/probe/http_method.rb,<br /> lib/hyde/probe/serve_handler.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>All subclasses of Hyde::Probe that respond to requests</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Handlers/CONNECT.html" title="Hyde::Handlers::CONNECT (class)">CONNECT</a></span>, <span class='object_link'><a href="Handlers/DELETE.html" title="Hyde::Handlers::DELETE (class)">DELETE</a></span>, <span class='object_link'><a href="Handlers/GET.html" title="Hyde::Handlers::GET (class)">GET</a></span>, <span class='object_link'><a href="Handlers/HEAD.html" title="Hyde::Handlers::HEAD (class)">HEAD</a></span>, <span class='object_link'><a href="Handlers/Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span>, <span class='object_link'><a href="Handlers/OPTIONS.html" title="Hyde::Handlers::OPTIONS (class)">OPTIONS</a></span>, <span class='object_link'><a href="Handlers/PATCH.html" title="Hyde::Handlers::PATCH (class)">PATCH</a></span>, <span class='object_link'><a href="Handlers/POST.html" title="Hyde::Handlers::POST (class)">POST</a></span>, <span class='object_link'><a href="Handlers/PUT.html" title="Hyde::Handlers::PUT (class)">PUT</a></span>, <span class='object_link'><a href="Handlers/Serve.html" title="Hyde::Handlers::Serve (class)">Serve</a></span>, <span class='object_link'><a href="Handlers/TRACE.html" title="Hyde::Handlers::TRACE (class)">TRACE</a></span>
</p>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/CONNECT.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::CONNECT
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::CONNECT";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">CONNECT</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::CONNECT
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::CONNECT</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a CONNECT</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CONNECT</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/DELETE.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::DELETE
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::DELETE";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">DELETE</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::DELETE
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::DELETE</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a DELETE</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DELETE</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

360
doc/Hyde/Handlers/GET.html
View File

@ -1,360 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::GET
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::GET";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (G)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">GET</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::GET
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next">Hyde::Handlers::GET</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a GET</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="CONNECT.html" title="Hyde::Handlers::CONNECT (class)">CONNECT</a></span>, <span class='object_link'><a href="DELETE.html" title="Hyde::Handlers::DELETE (class)">DELETE</a></span>, <span class='object_link'><a href="HEAD.html" title="Hyde::Handlers::HEAD (class)">HEAD</a></span>, <span class='object_link'><a href="OPTIONS.html" title="Hyde::Handlers::OPTIONS (class)">OPTIONS</a></span>, <span class='object_link'><a href="PATCH.html" title="Hyde::Handlers::PATCH (class)">PATCH</a></span>, <span class='object_link'><a href="POST.html" title="Hyde::Handlers::POST (class)">POST</a></span>, <span class='object_link'><a href="PUT.html" title="Hyde::Handlers::PUT (class)">PUT</a></span>, <span class='object_link'><a href="TRACE.html" title="Hyde::Handlers::TRACE (class)">TRACE</a></span></p>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation.
Runs block supplied with object initialization.
Request&#39;s #splat and #param are passed to block.</p>
<p>Callback&#39;s returned should be one of viable responses:</p>
<ul>
<li><span class='object_link'><a href="../Response.html" title="Hyde::Response (class)">Response</a></span> object</li>
<li>An array that matches Rack return form</li>
<li>An array that matches old (Rack 2.x) return form</li>
<li>A string (returned as HTML with code 200)</li>
<li>false (bounces the request to next handler)</li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>true if further navigation is possible</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'><p>may raise if die() is called.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/http_method.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_request_method'>request_method</span><span class='period'>.</span><span class='id identifier rubyid_casecmp'>casecmp</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='op'>::</span><span class='const'>METHOD</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>
<span class='kw'>return</span> <span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/HEAD.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::HEAD
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::HEAD";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">HEAD</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::HEAD
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::HEAD</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a HEAD</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HEAD</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

597
doc/Hyde/Handlers/Handler.html
View File

@ -1,597 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::Handler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::Handler";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">Handler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::Handler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next">Hyde::Handlers::Handler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/handler.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes a callback on request</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#request-instance_method" title="#request (instance method)">#<strong>request</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute request.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#response-instance_method" title="#response (instance method)">#<strong>response</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute response.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:, &amp;exec) &#x21d2; Handler </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Handler.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:, &amp;exec) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Handlers::Handler (class)">Handler</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Handler.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
</li>
<li>
<span class='name'>exec</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_exec'>exec</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='ivar'>@callback</span> <span class='op'>=</span> <span class='id identifier rubyid_exec'>exec</span>
<span class='ivar'>@context</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../ProbeContext.html#initialize-instance_method" title="Hyde::ProbeContext#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="request-instance_method">
#<strong>request</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute request.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
<span class='ivar'>@request</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="response=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="response-instance_method">
#<strong>response</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute response.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
<span class='ivar'>@response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation.
Runs block supplied with object initialization.
Request&#39;s #splat and #param are passed to block.</p>
<p>Callback&#39;s returned should be one of viable responses:</p>
<ul>
<li><span class='object_link'><a href="../Response.html" title="Hyde::Response (class)">Response</a></span> object</li>
<li>An array that matches Rack return form</li>
<li>An array that matches old (Rack 2.x) return form</li>
<li>A string (returned as HTML with code 200)</li>
<li>false (bounces the request to next handler)</li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>true if further navigation is possible</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'><p>may raise if die() is called.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/handler.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='ivar'>@response</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>return</span> <span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/?$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
<span class='ivar'>@request</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_catch'>catch</span><span class='lparen'>(</span><span class='symbol'>:break</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_splat'>splat</span><span class='comma'>,</span>
<span class='op'>**</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_param'>param</span><span class='comma'>,</span>
<span class='op'>&amp;</span><span class='ivar'>@callback</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>if</span> <span class='ivar'>@response</span> <span class='kw'>and</span> <span class='lbracket'>[</span><span class='const'>String</span><span class='comma'>,</span> <span class='const'>File</span><span class='comma'>,</span> <span class='const'>IO</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
<span class='ivar'>@response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
<span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:finish</span><span class='comma'>,</span> <span class='ivar'>@response</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:finish</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/OPTIONS.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::OPTIONS
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::OPTIONS";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">OPTIONS</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::OPTIONS
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::OPTIONS</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a OPTIONS</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>OPTIONS</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/PATCH.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::PATCH
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::PATCH";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">PATCH</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::PATCH
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::PATCH</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a PATCH</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATCH</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/POST.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::POST
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::POST";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">POST</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::POST
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::POST</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a POST</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>POST</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/PUT.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::PUT
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::PUT";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">PUT</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::PUT
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::PUT</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a PUT</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PUT</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

469
doc/Hyde/Handlers/Serve.html
View File

@ -1,469 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::Serve
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::Serve";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">Serve</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::Serve
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next">Hyde::Handlers::Serve</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/serve_handler.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that sends files from a location</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#response-instance_method" title="#response (instance method)">#<strong>response</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute response.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:) &#x21d2; Serve </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Serve.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Handlers::Serve (class)">Serve</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Serve.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
</li>
<li>
<span class='name'>exec</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/serve_handler.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="response=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="response-instance_method">
#<strong>response</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute response.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/serve_handler.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
<span class='ivar'>@response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation.
Tries to serve files matched by handler</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="../Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>true if file was found</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24
25
26
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/serve_handler.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span> <span class='ivar'>@properties</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_delete_suffix'>delete_suffix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>StandardError</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

220
doc/Hyde/Handlers/TRACE.html
View File

@ -1,220 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Handlers::TRACE
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Handlers::TRACE";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span></span>
&raquo;
<span class="title">TRACE</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Handlers::TRACE
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></li>
<li class="next">Hyde::Handlers::TRACE</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a TRACE</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TRACE</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handlers::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handlers::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="../Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GET.html" title="Hyde::Handlers::GET (class)">GET</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GET.html#process-instance_method" title="Hyde::Handlers::GET#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handlers::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="../Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="../Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handlers::Handler#initialize (method)">Hyde::Handlers::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

702
doc/Hyde/Node.html
View File

@ -1,702 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Node
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Node";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (N)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Node</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Node
<span class="abstract note title">Abstract</span>
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Node</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/node.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This class is abstract.</strong>
<div class='inline'></div>
</div>
<p>Abstract class that reacts to request navigation.
Does nothing by default, behaviour should be overriden through</p>
<h1 id="reject-and-process">reject and #process</h1>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Path.html" title="Hyde::Path (class)">Path</a></span>, <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#remap-instance_method" title="#remap (instance method)">#<strong>remap</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute remap.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#root-instance_method" title="#root (instance method)">#<strong>root</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute root.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#go-instance_method" title="#go (instance method)">#<strong>go</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Try to navigate the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:) &#x21d2; Node </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Node.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(_request) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on successful request navigation.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reject-instance_method" title="#reject (instance method)">#<strong>reject</strong>(_request) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on failed request navigation.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Node (class)">Node</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Node.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/node.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='rparen'>)</span>
<span class='ivar'>@pattern</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Pattern.html" title="Hyde::Pattern (class)">Pattern</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Pattern.html#initialize-instance_method" title="Hyde::Pattern#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='ivar'>@properties</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util/Lookup.html" title="Hyde::Util::Lookup (class)">Lookup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Util/Lookup.html#initialize-instance_method" title="Hyde::Util::Lookup#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='op'>&amp;.</span><span class='id identifier rubyid_properties'>properties</span><span class='rparen'>)</span>
<span class='ivar'>@root</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@remap</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="remap=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="remap-instance_method">
#<strong>remap</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute remap.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/node.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remap'>remap</span>
<span class='ivar'>@remap</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="root=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="root-instance_method">
#<strong>root</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute root.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/node.rb', line 69</span>
<span class='kw'>def</span> <span class='id identifier rubyid_root'><span class='object_link'><a href="../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span>
<span class='ivar'>@root</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="go-instance_method">
#<strong>go</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Try to navigate the path. Run method callback in response.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'></span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/node.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_go'>go</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='comment'># rejected at pattern
</span> <span class='kw'>return</span> <span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_push_state'>push_state</span>
<span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_splat'>splat</span><span class='comma'>,</span> <span class='id identifier rubyid_param'>param</span> <span class='op'>=</span> <span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='id identifier rubyid_do_filepath'>do_filepath</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_delete_suffix'>delete_suffix</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_splat'>splat</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_splat'>splat</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_param'>param</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_param'>param</span><span class='rparen'>)</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='comment'># rejected at callback - restore state
</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_pop_state'>pop_state</span> <span class='kw'>unless</span> <span class='id identifier rubyid_value'>value</span>
<span class='comment'># finally, return process value
</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="process-instance_method">
#<strong>process</strong>(_request) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>_request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>true</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/node.rb', line 65</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid__request'>_request</span><span class='rparen'>)</span>
<span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reject-instance_method">
#<strong>reject</strong>(_request) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on failed request navigation</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>_request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>false</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/node.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='id identifier rubyid__request'>_request</span><span class='rparen'>)</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/OPTIONSHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::OPTIONSHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::OPTIONSHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">OPTIONSHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::OPTIONSHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::OPTIONSHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a OPTIONS</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>OPTIONS</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/PATCHHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::PATCHHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PATCHHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">PATCHHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::PATCHHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::PATCHHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a PATCH</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATCH</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/POSTHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::POSTHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::POSTHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">POSTHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::POSTHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::POSTHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a POST</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>POST</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/PUTHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::PUTHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PUTHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">PUTHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::PUTHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::PUTHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a PUT</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PUT</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

142
doc/Hyde/ParsingError.html
View File

@ -1,142 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Exception: Hyde::ParsingError
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ParsingError";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ParsingError</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Exception: Hyde::ParsingError
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Error.html" title="Hyde::Error (class)">Error</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next">StandardError</li>
<li class="next"><span class='object_link'><a href="Error.html" title="Hyde::Error (class)">Error</a></span></li>
<li class="next">Hyde::ParsingError</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/errors.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Error class raised by hyde/util/parseutils module.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

897
doc/Hyde/Path.html
View File

@ -1,897 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Path
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Path";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Path</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Path
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next">Hyde::Path</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/path.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Primary building block of request navigation.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Server.html" title="Hyde::Server (class)">Server</a></span></p>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="ProcContext-constant" class="">ProcContext =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ProcessorContext.html" title="Hyde::ProcessorContext (class)">ProcessorContext</a></span></span></pre></dd>
<dt id="Context-constant" class="">Context =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#children-instance_method" title="#children (instance method)">#<strong>children</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute children.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#properties-instance_method" title="#properties (instance method)">#<strong>properties</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute properties.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#filter-instance_method" title="#filter (instance method)">#<strong>filter</strong>(&amp;block) {|request| ... } &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add a filter to the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:, &amp;setup) &#x21d2; Path </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#postprocess-instance_method" title="#postprocess (instance method)">#<strong>postprocess</strong>(&amp;block) {|request, response| ... } &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add a postprocessor to the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#preprocess-instance_method" title="#preprocess (instance method)">#<strong>preprocess</strong>(&amp;block) {|request| ... } &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Add a preprocessor to the path.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:, &amp;setup) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Path (class)">Path</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Path.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'><p>Object to generate <span class='object_link'><a href="Pattern.html" title="Hyde::Pattern (class)">Hyde::Pattern</a></span> from</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
&mdash;
<div class='inline'><p>Parent object to inherit properties to</p>
</div>
</li>
<li>
<span class='name'>setup</span>
<span class='type'>(<tt>#call</tt>)</span>
&mdash;
<div class='inline'><p>Setup block</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40
41
42
43
44
45
46
47
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='comment'># Child nodes array
</span> <span class='ivar'>@children</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='comment'># Arrays of preprocessors, postprocessors and filters
</span> <span class='ivar'>@preprocessors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@postprocessors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='ivar'>@filters</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='comment'># Contexts setup
</span> <span class='id identifier rubyid_context'>context</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='op'>::</span><span class='const'>Context</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='ivar'>@proccontext</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='op'>::</span><span class='const'>ProcContext</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="children-instance_method">
#<strong>children</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute children.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_children'>children</span>
<span class='ivar'>@children</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="properties-instance_method">
#<strong>properties</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute properties.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span>
<span class='ivar'>@properties</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="filter-instance_method">
#<strong>filter</strong>(&amp;block) {|request| ... } &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add a filter to the path.
Blocks path access if a filter returns false.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_filter'>filter</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@filters</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="postprocess-instance_method">
#<strong>postprocess</strong>(&amp;block) {|request, response| ... } &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add a postprocessor to the path.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
<li>
<span class='name'>response</span>
<span class='type'>(<tt><span class='object_link'><a href="Response.html" title="Hyde::Response (class)">Hyde::Response</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_postprocess'>postprocess</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@postprocessors</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="preprocess-instance_method">
#<strong>preprocess</strong>(&amp;block) {|request| ... } &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Add a preprocessor to the path.
Does not modify path execution.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>block</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
<p class="tag_title">Yield Parameters:</p>
<ul class="yieldparam">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 78</span>
<span class='kw'>def</span> <span class='id identifier rubyid_preprocess'>preprocess</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='ivar'>@preprocessors</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation.
Finds the next appropriate path to go to.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>true if further navigation will be done</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>UncaughtThrowError</tt>)</span>
&mdash;
<div class='inline'><p>by default throws :response if no matches found.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_run_filters'>run_filters</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='id identifier rubyid_run_preprocessors'>run_preprocessors</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='id identifier rubyid_enqueue_postprocessors'>enqueue_postprocessors</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='ivar'>@children</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_go'>go</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span>
<span class='id identifier rubyid__die'>_die</span><span class='lparen'>(</span><span class='int'>404</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>StandardError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
<span class='id identifier rubyid__die'>_die</span><span class='lparen'>(</span><span class='int'>500</span><span class='comma'>,</span> <span class='label'>backtrace:</span> <span class='lbracket'>[</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_backtrace'>backtrace</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

245
doc/Hyde/PathBinding.html
View File

@ -1,245 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::PathBinding
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PathBinding";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">PathBinding</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::PathBinding
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::PathBinding</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">DSL::PathConstructors</a></span>, <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">DSL::PathMethods</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/path.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Protected interface that provides DSL context for setup block.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="ServerBinding.html" title="Hyde::ServerBinding (class)">ServerBinding</a></span></p>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path) &#x21d2; PathBinding </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of PathBinding.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">DSL::PathMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathMethods.html#filter-instance_method" title="Hyde::DSL::PathMethods#filter (method)">#filter</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#index-instance_method" title="Hyde::DSL::PathMethods#index (method)">#index</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#postprocess-instance_method" title="Hyde::DSL::PathMethods#postprocess (method)">#postprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#preprocess-instance_method" title="Hyde::DSL::PathMethods#preprocess (method)">#preprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#remap-instance_method" title="Hyde::DSL::PathMethods#remap (method)">#remap</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#root-instance_method" title="Hyde::DSL::PathMethods#root (method)">#root</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">DSL::PathConstructors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathConstructors.html#connect-instance_method" title="Hyde::DSL::PathConstructors#connect (method)">#connect</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#delete-instance_method" title="Hyde::DSL::PathConstructors#delete (method)">#delete</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#get-instance_method" title="Hyde::DSL::PathConstructors#get (method)">#get</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#head-instance_method" title="Hyde::DSL::PathConstructors#head (method)">#head</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#options-instance_method" title="Hyde::DSL::PathConstructors#options (method)">#options</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#patch-instance_method" title="Hyde::DSL::PathConstructors#patch (method)">#patch</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#path-instance_method" title="Hyde::DSL::PathConstructors#path (method)">#path</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#post-instance_method" title="Hyde::DSL::PathConstructors#post (method)">#post</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#probe-instance_method" title="Hyde::DSL::PathConstructors#probe (method)">#probe</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#put-instance_method" title="Hyde::DSL::PathConstructors#put (method)">#put</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#register-instance_method" title="Hyde::DSL::PathConstructors#register (method)">#register</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#serve-instance_method" title="Hyde::DSL::PathConstructors#serve (method)">#serve</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#trace-instance_method" title="Hyde::DSL::PathConstructors#trace (method)">#trace</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::PathBinding (class)">PathBinding</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of PathBinding.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Sep 9 19:10:58 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

242
doc/Hyde/PathContext.html
View File

@ -1,242 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::PathContext
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PathContext";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">PathContext</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::PathContext
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::PathContext</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">DSL::PathConstructors</a></span>, <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">DSL::PathMethods</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/path.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Execution context for path setup block.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="ServerContext.html" title="Hyde::ServerContext (class)">ServerContext</a></span></p>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path) &#x21d2; PathContext </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of PathContext.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">DSL::PathMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathMethods.html#filter-instance_method" title="Hyde::DSL::PathMethods#filter (method)">#filter</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#index-instance_method" title="Hyde::DSL::PathMethods#index (method)">#index</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#plugin-instance_method" title="Hyde::DSL::PathMethods#plugin (method)">#plugin</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#postprocess-instance_method" title="Hyde::DSL::PathMethods#postprocess (method)">#postprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#preprocess-instance_method" title="Hyde::DSL::PathMethods#preprocess (method)">#preprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#remap-instance_method" title="Hyde::DSL::PathMethods#remap (method)">#remap</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#root-instance_method" title="Hyde::DSL::PathMethods#root (method)">#root</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">DSL::PathConstructors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathConstructors.html#connect-instance_method" title="Hyde::DSL::PathConstructors#connect (method)">#connect</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#delete-instance_method" title="Hyde::DSL::PathConstructors#delete (method)">#delete</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#get-instance_method" title="Hyde::DSL::PathConstructors#get (method)">#get</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#head-instance_method" title="Hyde::DSL::PathConstructors#head (method)">#head</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#options-instance_method" title="Hyde::DSL::PathConstructors#options (method)">#options</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#patch-instance_method" title="Hyde::DSL::PathConstructors#patch (method)">#patch</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#path-instance_method" title="Hyde::DSL::PathConstructors#path (method)">#path</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#post-instance_method" title="Hyde::DSL::PathConstructors#post (method)">#post</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#probe-instance_method" title="Hyde::DSL::PathConstructors#probe (method)">#probe</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#put-instance_method" title="Hyde::DSL::PathConstructors#put (method)">#put</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#register-instance_method" title="Hyde::DSL::PathConstructors#register (method)">#register</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#serve-instance_method" title="Hyde::DSL::PathConstructors#serve (method)">#serve</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#trace-instance_method" title="Hyde::DSL::PathConstructors#trace (method)">#trace</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::PathContext (class)">PathContext</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of PathContext.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

552
doc/Hyde/Pattern.html
View File

@ -1,552 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Pattern
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Pattern";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Pattern</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Pattern
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Pattern</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/pattern_matching.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Delegate class for all available patterns.
Picks appropriate pattern based on contents.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(pattern) &#x21d2; Pattern </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Pattern.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match-instance_method" title="#match (instance method)">#<strong>match</strong>(input) &#x21d2; Array(String,Array,Hash), FalseClass </a>
</span>
<span class="summary_desc"><div class='inline'><p>Match the string and assign matches to parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match%3F-instance_method" title="#match? (instance method)">#<strong>match?</strong>(input) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if a string can be matched.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#static%3F-instance_method" title="#static? (instance method)">#<strong>static?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks if pattern object is static (is a simple String pattern).</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(pattern) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Pattern (class)">Pattern</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Pattern.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>pattern</span>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'><p>object to generate pattern from</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='rparen'>)</span>
<span class='ivar'>@pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_patternify'>patternify</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='rparen'>)</span>
<span class='ivar'>@static</span> <span class='op'>=</span> <span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="match-instance_method">
#<strong>match</strong>(input) &#x21d2; <tt>Array(String,Array,Hash)</tt>, <tt>FalseClass</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Match the string and assign matches to parameters.
Returns:</p>
<ul>
<li>Unmatched part of a string</li>
<li>Unnamed parameters</li>
<li>Named parameters</li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>String to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(String,Array,Hash)</tt>)</span>
</li>
<li>
<span class='type'>(<tt>FalseClass</tt>)</span>
&mdash;
<div class='inline'><p>if input doesn&#39;t match pattern</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37
38
39
40
41
42
43
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
<span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='ivar'>@pattern</span><span class='rparen'>)</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_delete_prefix'>delete_prefix</span><span class='lparen'>(</span><span class='ivar'>@pattern</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rbracket'>]</span>
<span class='kw'>else</span>
<span class='kw'>false</span>
<span class='kw'>end</span>
<span class='kw'>else</span>
<span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="match?-instance_method">
#<strong>match?</strong>(input) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if a string can be matched.
Lighter version of match that doesn&#39;t assign any variables.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>String to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
52
53
54
55
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching.rb', line 52</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
<span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span> <span class='ivar'>@pattern</span>
<span class='kw'>else</span>
<span class='ivar'>@pattern</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="static?-instance_method">
#<strong>static?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Checks if pattern object is static (is a simple String pattern).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_static?'>static?</span>
<span class='ivar'>@static</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

241
doc/Hyde/PatternMatching.html
View File

@ -1,241 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::PatternMatching
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PatternMatching";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">PatternMatching</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::PatternMatching
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/pattern_matching.rb<span class="defines">,<br />
lib/hyde/pattern_matching/glob.rb,<br /> lib/hyde/pattern_matching/util.rb,<br /> lib/hyde/pattern_matching/rematch.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Utility functions and pattern-generator classes.
Used primarily to create patterns for path definitions.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="PatternMatching/Glob.html" title="Hyde::PatternMatching::Glob (class)">Glob</a></span>, <span class='object_link'><a href="PatternMatching/ReMatch.html" title="Hyde::PatternMatching::ReMatch (class)">ReMatch</a></span>
</p>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#canonicalize-class_method" title="canonicalize (class method)">.<strong>canonicalize</strong>(string) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Strips extra slashes from a string.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="canonicalize-class_method">
.<strong>canonicalize</strong>(string) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Strips extra slashes from a string.
(including slashes at the start and end of the string)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>string</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/util.rb', line 9</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'>canonicalize</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
<span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\/+</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_delete_prefix'>delete_prefix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_delete_suffix'>delete_suffix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

648
doc/Hyde/PatternMatching/Glob.html
View File

@ -1,648 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::PatternMatching::Glob
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PatternMatching::Glob";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (G)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span>
&raquo;
<span class="title">Glob</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::PatternMatching::Glob
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::PatternMatching::Glob</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/pattern_matching/glob.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Implements glob-like pattern matching.
Exact specifications for globbing rules:</p>
<p>&quot;/&quot;</p>
<ul>
<li>act as directory separators</li>
<li>multiple slashes (i.e. &quot;///&quot;) are the same as one slash (&quot;/&quot;)</li>
<li>slashes are stripped at start and end of an expression or path</li>
<li>slashes are not matched by anything but the globstar (&quot;**&quot;)</li>
</ul>
<p>&quot;<em>&quot; ( regexp: /([^/]</em>)/ )</p>
<ul>
<li>matches from 0 to any number of characters</li>
<li>does not match nothing if placed between two slashes (i.e &quot;/*/&quot;)</li>
<li>result is captured in an array</li>
<li>stops at slashes</li>
<li>greedy (matches as much as possible)</li>
</ul>
<p>&quot;*<em>&quot; ( regexp: /(.</em>)/ )</p>
<ul>
<li>matches any number of characters</li>
<li>matches slashes (&quot;/&quot;)</li>
<li>result is captured in an array</li>
<li>does not stop at slashes</li>
<li>greedy (matches as much as possible)</li>
</ul>
<p>&quot;[...]+&quot; ( regexp: itself, ! and ^ at the start are interchangeable )</p>
<ul>
<li>acts like a regexp range</li>
<li>matches any characters, including slashes if specified</li>
<li>matches any number of characters</li>
<li>valid ways to specify a range: [A-z], [a-z], <a href="ascii%20order">9-z</a></li>
<li>! or ^ at the start invert meaning (any character not in range)</li>
<li>result is captured in an array</li>
</ul>
<p>&quot;:name&quot; ( regexp: acts like a named group for /[^/]*/ )</p>
<ul>
<li>acts like * as defined above</li>
<li>result is captured in a hash with &quot;name&quot; as key</li>
<li>name allows alphanumeric characters and underscores</li>
<li>ignored unless placed between two slashes</li>
</ul>
<p>&quot;(name|name2|...)&quot; ( regexp: itself )</p>
<ul>
<li>matches any of (full keywords) name, name2, ...</li>
<li>result is captured in an array</li>
<li>each name may include only these groups of characters:
<ul>
<li>alphanumeric</li>
<li>slashes</li>
<li>underscores</li>
<li>dashes</li>
</ul></li>
</ul>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#can_convert%3F-class_method" title="can_convert? (class method)">.<strong>can_convert?</strong>(input) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if input is convertible to a Glob and if it should be converted.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(pattern) &#x21d2; Glob </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Glob.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match-instance_method" title="#match (instance method)">#<strong>match</strong>(input) &#x21d2; Array(String,Array,Hash), FalseClass </a>
</span>
<span class="summary_desc"><div class='inline'><p>Match the string and assign matches to parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match%3F-instance_method" title="#match? (instance method)">#<strong>match?</strong>(input) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if a string can be matched.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(pattern) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::PatternMatching::Glob (class)">Glob</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Glob.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>Glob pattern</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58
59
60
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/glob.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='rparen'>)</span>
<span class='id identifier rubyid_pattern'>pattern</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="../PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='rparen'>)</span>
<span class='id identifier rubyid_pieces'>pieces</span> <span class='op'>=</span> <span class='id identifier rubyid_pattern'>pattern</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='const'>TOKENS</span><span class='rparen'>)</span>
<span class='comment'># @type [Array&lt;String,Integer&gt;]
</span> <span class='ivar'>@index</span> <span class='op'>=</span> <span class='id identifier rubyid_build_index'>build_index</span><span class='lparen'>(</span><span class='id identifier rubyid_pieces'>pieces</span><span class='rparen'>)</span>
<span class='comment'># @type [Regexp]
</span> <span class='ivar'>@glob</span> <span class='op'>=</span> <span class='id identifier rubyid_build_regexp'>build_regexp</span><span class='lparen'>(</span><span class='id identifier rubyid_pieces'>pieces</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="can_convert?-class_method">
.<strong>can_convert?</strong>(input) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if input is convertible to a Glob and if it should be converted</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'></span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>Input can be safely converted to Glob</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
96
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/glob.rb', line 96</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_can_convert?'>can_convert?</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span> <span class='kw'>and</span>
<span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='const'>TOKENS</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="match-instance_method">
#<strong>match</strong>(input) &#x21d2; <tt>Array(String,Array,Hash)</tt>, <tt>FalseClass</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Match the string and assign matches to parameters.
Returns:</p>
<ul>
<li>Unmatched part of a string</li>
<li>Unnamed parameters</li>
<li>Named parameters</li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>String to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(String,Array,Hash)</tt>)</span>
</li>
<li>
<span class='type'>(<tt>FalseClass</tt>)</span>
&mdash;
<div class='inline'><p>if input doesn&#39;t match glob</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
74
75
76
77
78
79
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/glob.rb', line 74</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="../PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='ivar'>@glob</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_result'>result</span>
<span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_post_match'>post_match</span>
<span class='id identifier rubyid_named_params'>named_params</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_assign_by_index'>assign_by_index</span><span class='lparen'>(</span><span class='ivar'>@index</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_captures'>captures</span><span class='rparen'>)</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_named_params'>named_params</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="match?-instance_method">
#<strong>match?</strong>(input) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if a string can be matched.
Lighter version of match that doesn&#39;t assign any variables.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>String to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
88
89
90
91</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/glob.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="../PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span> <span class='ivar'>@glob</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

557
doc/Hyde/PatternMatching/ReMatch.html
View File

@ -1,557 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::PatternMatching::ReMatch
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::PatternMatching::ReMatch";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (R)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span>
&raquo;
<span class="title">ReMatch</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::PatternMatching::ReMatch
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::PatternMatching::ReMatch</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/pattern_matching/rematch.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>If you are planning to write your own pattern, this is the easiest one to read.</p>
</div>
</div>
<p>Regexp pattern matching wrapper.
Following principles apply to the wrapper:</p>
<ul>
<li>Regexp input is canonicalized using Hyde::PatternMatching.canonicalize</li>
<li>Matched content and anything before it is consumed in #match output</li>
</ul>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#can_convert%3F-class_method" title="can_convert? (class method)">.<strong>can_convert?</strong>(string) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if input is convertible and if it should be converted.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(pattern) &#x21d2; ReMatch </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of ReMatch.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match-instance_method" title="#match (instance method)">#<strong>match</strong>(input) &#x21d2; Array(String,Array,Hash), FalseClass </a>
</span>
<span class="summary_desc"><div class='inline'><p>Match the string and assign matches to parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match%3F-instance_method" title="#match? (instance method)">#<strong>match?</strong>(input) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if a string can be matched.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(pattern) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::PatternMatching::ReMatch (class)">ReMatch</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ReMatch.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/rematch.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='rparen'>)</span>
<span class='ivar'>@glob</span> <span class='op'>=</span> <span class='id identifier rubyid_pattern'>pattern</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="can_convert?-class_method">
.<strong>can_convert?</strong>(string) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if input is convertible and if it should be converted.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'></span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>Input can be safely converted to Glob</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/rematch.rb', line 44</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_can_convert?'>can_convert?</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
<span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Regexp</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="match-instance_method">
#<strong>match</strong>(input) &#x21d2; <tt>Array(String,Array,Hash)</tt>, <tt>FalseClass</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Match the string and assign matches to parameters.
Returns:</p>
<ul>
<li>Unmatched part of a string</li>
<li>Unnamed parameters</li>
<li>Named parameters</li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>String to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(String,Array,Hash)</tt>)</span>
</li>
<li>
<span class='type'>(<tt>FalseClass</tt>)</span>
&mdash;
<div class='inline'><p>if input doesn&#39;t match regexp</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/rematch.rb', line 26</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="../PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='ivar'>@glob</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='id identifier rubyid_result'>result</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_post_match'>post_match</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_captures'>captures</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_named_captures'>named_captures</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="match?-instance_method">
#<strong>match?</strong>(input) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if a string can be matched.
Lighter version of match that doesn&#39;t assign any variables.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'><p>String to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/pattern_matching/rematch.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span></span><span class='period'>.</span><span class='id identifier rubyid_canonicalize'><span class='object_link'><a href="../PatternMatching.html#canonicalize-class_method" title="Hyde::PatternMatching.canonicalize (method)">canonicalize</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span> <span class='ivar'>@glob</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

465
doc/Hyde/Probe.html
View File

@ -1,465 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Probe
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Probe";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Probe</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Probe
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next">Hyde::Probe</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Test probe. Also base for all &quot;reactive&quot; nodes.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Handlers/Handler.html" title="Hyde::Handlers::Handler (class)">Handlers::Handler</a></span>, <span class='object_link'><a href="Handlers/Serve.html" title="Hyde::Handlers::Serve (class)">Handlers::Serve</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#properties-instance_method" title="#properties (instance method)">#<strong>properties</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute properties.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:) &#x21d2; Probe </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Probe.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Probe (class)">Probe</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Probe.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="properties-instance_method">
#<strong>properties</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute properties.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span>
<span class='ivar'>@properties</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation.
Throws an error upon reaching the path.
This behaviour should only be used internally.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'><p>true if further navigation is possible</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>StandardError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56
57
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='id identifier rubyid_reject'>reject</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/?$</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>StandardError</span><span class='comma'>,</span> <span class='heredoc_beg'>&lt;&lt;~STREND</span>
<span class='tstring_content'> probe reached </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_splat'>splat</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>, </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_param'>param</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>
</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_pretty_inspect'>pretty_inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>
</span><span class='heredoc_end'> STREND
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

219
doc/Hyde/ProbeBinding.html
View File

@ -1,219 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::ProbeBinding
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ProbeBinding";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ProbeBinding</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::ProbeBinding
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::ProbeBinding</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">DSL::ProbeMethods</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/binding.rb</dd>
</dl>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(origin) &#x21d2; ProbeBinding </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of ProbeBinding.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">DSL::ProbeMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/ProbeMethods.html#bounce-instance_method" title="Hyde::DSL::ProbeMethods#bounce (method)">#bounce</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#die-instance_method" title="Hyde::DSL::ProbeMethods#die (method)">#die</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#header-instance_method" title="Hyde::DSL::ProbeMethods#header (method)">#header</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#remove_header-instance_method" title="Hyde::DSL::ProbeMethods#remove_header (method)">#remove_header</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#request-instance_method" title="Hyde::DSL::ProbeMethods#request (method)">#request</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#status-instance_method" title="Hyde::DSL::ProbeMethods#status (method)">#status</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(origin) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::ProbeBinding (class)">ProbeBinding</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ProbeBinding.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
7
8
9</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/binding.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span> <span class='op'>=</span> <span class='id identifier rubyid_origin'>origin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Sep 9 19:10:58 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

249
doc/Hyde/ProbeContext.html
View File

@ -1,249 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::ProbeContext
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ProbeContext";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ProbeContext</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::ProbeContext
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::ProbeContext</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">DSL::CommonMethods</a></span>, <span class='object_link'><a href="DSL/ProbeConstructors.html" title="Hyde::DSL::ProbeConstructors (module)">DSL::ProbeConstructors</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">DSL::ProbeMethods</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Context that provides execution context for Probes.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(origin) &#x21d2; ProbeContext </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of ProbeContext.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">DSL::CommonMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/CommonMethods.html#bounce-instance_method" title="Hyde::DSL::CommonMethods#bounce (method)">#bounce</a></span>, <span class='object_link'><a href="DSL/CommonMethods.html#die-instance_method" title="Hyde::DSL::CommonMethods#die (method)">#die</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">DSL::ProbeMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/ProbeMethods.html#escape_html-instance_method" title="Hyde::DSL::ProbeMethods#escape_html (method)">#escape_html</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#file-instance_method" title="Hyde::DSL::ProbeMethods#file (method)">#file</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#form-instance_method" title="Hyde::DSL::ProbeMethods#form (method)">#form</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#form%3F-instance_method" title="Hyde::DSL::ProbeMethods#form? (method)">#form?</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#header-instance_method" title="Hyde::DSL::ProbeMethods#header (method)">#header</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#remove_header-instance_method" title="Hyde::DSL::ProbeMethods#remove_header (method)">#remove_header</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#request-instance_method" title="Hyde::DSL::ProbeMethods#request (method)">#request</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#status-instance_method" title="Hyde::DSL::ProbeMethods#status (method)">#status</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#unescape_html-instance_method" title="Hyde::DSL::ProbeMethods#unescape_html (method)">#unescape_html</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/ProbeConstructors.html" title="Hyde::DSL::ProbeConstructors (module)">DSL::ProbeConstructors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/ProbeConstructors.html#erb-instance_method" title="Hyde::DSL::ProbeConstructors#erb (method)">#erb</a></span>, <span class='object_link'><a href="DSL/ProbeConstructors.html#erubi-instance_method" title="Hyde::DSL::ProbeConstructors#erubi (method)">#erubi</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(origin) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::ProbeContext (class)">ProbeContext</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ProbeContext.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span> <span class='op'>=</span> <span class='id identifier rubyid_origin'>origin</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

227
doc/Hyde/ProcessorContext.html
View File

@ -1,227 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::ProcessorContext
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ProcessorContext";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ProcessorContext</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::ProcessorContext
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::ProcessorContext</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">DSL::CommonMethods</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/path.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Execution context for filters and preprocessors.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path) &#x21d2; ProcessorContext </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of ProcessorContext.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">DSL::CommonMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/CommonMethods.html#bounce-instance_method" title="Hyde::DSL::CommonMethods#bounce (method)">#bounce</a></span>, <span class='object_link'><a href="DSL/CommonMethods.html#die-instance_method" title="Hyde::DSL::CommonMethods#die (method)">#die</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::ProcessorContext (class)">ProcessorContext</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ProcessorContext.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/path.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

1548
doc/Hyde/Request.html
View File

File diff suppressed because it is too large Load Diff

1150
doc/Hyde/Response.html
View File

File diff suppressed because it is too large Load Diff

476
doc/Hyde/ServeHandler.html
View File

@ -1,476 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::ServeHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ServeHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ServeHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::ServeHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next">Hyde::ServeHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/serve_handler.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that sends files from a location</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#response-instance_method" title="#response (instance method)">#<strong>response</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute response.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(path, parent:) &#x21d2; ServeHandler </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of ServeHandler.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#process-instance_method" title="#process (instance method)">#<strong>process</strong>(request) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Method callback on successful request navigation.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(path, parent:) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::ServeHandler (class)">ServeHandler</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ServeHandler.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>path</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
</li>
<li>
<span class='name'>exec</span>
<span class='type'>(<tt>#call</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/serve_handler.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="response=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="response-instance_method">
#<strong>response</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute response.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/serve_handler.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
<span class='ivar'>@response</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="process-instance_method">
#<strong>process</strong>(request) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Method callback on successful request navigation. Tries to serve files matched by handler</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Hyde::Request</a></span></tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if file was found</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23
24
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/probe/serve_handler.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span> <span class='ivar'>@properties</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_delete_suffix'>delete_suffix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>StandardError</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

442
doc/Hyde/Server.html
View File

@ -1,442 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Server
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Server";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Server</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Server
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Path.html" title="Hyde::Path (class)">Path</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Path.html" title="Hyde::Path (class)">Path</a></span></li>
<li class="next">Hyde::Server</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/server.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A specialized path that can be used directly as a Rack application.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="Context-constant" class="">Context =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="ServerContext.html" title="Hyde::ServerContext (class)">ServerContext</a></span></span></pre></dd>
</dl>
<h3 class="inherited">Constants inherited
from <span class='object_link'><a href="Path.html" title="Hyde::Path (class)">Path</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Path.html#ProcContext-constant" title="Hyde::Path::ProcContext (constant)">Path::ProcContext</a></span></p>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Path.html" title="Hyde::Path (class)">Path</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Path.html#children-instance_method" title="Hyde::Path#children (method)">#children</a></span>, <span class='object_link'><a href="Path.html#properties-instance_method" title="Hyde::Path#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(env) &#x21d2; Array(Integer,Hash,Array) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Rack ingress point.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent: nil, &amp;setup) &#x21d2; Server </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Server.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Path.html" title="Hyde::Path (class)">Path</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Path.html#filter-instance_method" title="Hyde::Path#filter (method)">#filter</a></span>, <span class='object_link'><a href="Path.html#postprocess-instance_method" title="Hyde::Path#postprocess (method)">#postprocess</a></span>, <span class='object_link'><a href="Path.html#preprocess-instance_method" title="Hyde::Path#preprocess (method)">#preprocess</a></span>, <span class='object_link'><a href="Path.html#process-instance_method" title="Hyde::Path#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(parent: nil, &amp;setup) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Server (class)">Server</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Server.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'><p>Parent object to inherit properties to</p>
</div>
</li>
<li>
<span class='name'>setup</span>
<span class='type'>(<tt>#<span class='object_link'><a href="#call-instance_method" title="Hyde::Server#call (method)">call</a></span></tt>)</span>
&mdash;
<div class='inline'><p>Setup block</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/server.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>parent:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_setup'>setup</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>index</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>handle.default</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_proc'>proc</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='label'>backtrace:</span> <span class='kw'>nil</span><span class='op'>|</span>
<span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Util.html" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_default_error_page'><span class='object_link'><a href="Util.html#default_error_page-class_method" title="Hyde::Util.default_error_page (method)">default_error_page</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_backtrace'>backtrace</span><span class='rparen'>)</span>
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-length</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/html</span><span class='tstring_end'>&quot;</span></span>
<span class='rbrace'>}</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_page'>page</span><span class='rbracket'>]</span>
<span class='kw'>end</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='ivar'>@properties</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_v'>v</span> <span class='kw'>unless</span> <span class='ivar'>@properties</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="call-instance_method">
#<strong>call</strong>(env) &#x21d2; <tt>Array(Integer,Hash,Array)</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Rack ingress point.
This should not be called under any circumstances twice in the same application,
although server nesting for the purpose of creating virtual hosts is allowed.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>env</span>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(Integer,Hash,Array)</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/server.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Request.html" title="Hyde::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Request.html#initialize-instance_method" title="Hyde::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_catch'>catch</span><span class='lparen'>(</span><span class='symbol'>:finish</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_go'>go</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_run_postprocessors'>run_postprocessors</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Response.html" title="Hyde::Response (class)">Response</a></span></span><span class='period'>.</span><span class='id identifier rubyid_convert'><span class='object_link'><a href="Response.html#convert-class_method" title="Hyde::Response.convert (method)">convert</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_finalize'>finalize</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

162
doc/Hyde/ServerBinding.html
View File

@ -1,162 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::ServerBinding
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ServerBinding";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ServerBinding</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::ServerBinding
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="PathBinding.html" title="Hyde::PathBinding (class)">PathBinding</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="PathBinding.html" title="Hyde::PathBinding (class)">PathBinding</a></span></li>
<li class="next">Hyde::ServerBinding</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/server.rb</dd>
</dl>
</div>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="PathBinding.html" title="Hyde::PathBinding (class)">PathBinding</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PathBinding.html#initialize-instance_method" title="Hyde::PathBinding#initialize (method)">#initialize</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">DSL::PathMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathMethods.html#filter-instance_method" title="Hyde::DSL::PathMethods#filter (method)">#filter</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#index-instance_method" title="Hyde::DSL::PathMethods#index (method)">#index</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#postprocess-instance_method" title="Hyde::DSL::PathMethods#postprocess (method)">#postprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#preprocess-instance_method" title="Hyde::DSL::PathMethods#preprocess (method)">#preprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#remap-instance_method" title="Hyde::DSL::PathMethods#remap (method)">#remap</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#root-instance_method" title="Hyde::DSL::PathMethods#root (method)">#root</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">DSL::PathConstructors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathConstructors.html#connect-instance_method" title="Hyde::DSL::PathConstructors#connect (method)">#connect</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#delete-instance_method" title="Hyde::DSL::PathConstructors#delete (method)">#delete</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#get-instance_method" title="Hyde::DSL::PathConstructors#get (method)">#get</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#head-instance_method" title="Hyde::DSL::PathConstructors#head (method)">#head</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#options-instance_method" title="Hyde::DSL::PathConstructors#options (method)">#options</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#patch-instance_method" title="Hyde::DSL::PathConstructors#patch (method)">#patch</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#path-instance_method" title="Hyde::DSL::PathConstructors#path (method)">#path</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#post-instance_method" title="Hyde::DSL::PathConstructors#post (method)">#post</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#probe-instance_method" title="Hyde::DSL::PathConstructors#probe (method)">#probe</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#put-instance_method" title="Hyde::DSL::PathConstructors#put (method)">#put</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#register-instance_method" title="Hyde::DSL::PathConstructors#register (method)">#register</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#serve-instance_method" title="Hyde::DSL::PathConstructors#serve (method)">#serve</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#trace-instance_method" title="Hyde::DSL::PathConstructors#trace (method)">#trace</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="PathBinding.html#initialize-instance_method" title="Hyde::PathBinding#initialize (method)">Hyde::PathBinding</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sat Sep 9 19:10:58 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

162
doc/Hyde/ServerContext.html
View File

@ -1,162 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::ServerContext
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::ServerContext";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">ServerContext</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::ServerContext
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span></li>
<li class="next">Hyde::ServerContext</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/server.rb</dd>
</dl>
</div>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PathContext.html#initialize-instance_method" title="Hyde::PathContext#initialize (method)">#initialize</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">DSL::PathMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathMethods.html#filter-instance_method" title="Hyde::DSL::PathMethods#filter (method)">#filter</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#index-instance_method" title="Hyde::DSL::PathMethods#index (method)">#index</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#plugin-instance_method" title="Hyde::DSL::PathMethods#plugin (method)">#plugin</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#postprocess-instance_method" title="Hyde::DSL::PathMethods#postprocess (method)">#postprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#preprocess-instance_method" title="Hyde::DSL::PathMethods#preprocess (method)">#preprocess</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#remap-instance_method" title="Hyde::DSL::PathMethods#remap (method)">#remap</a></span>, <span class='object_link'><a href="DSL/PathMethods.html#root-instance_method" title="Hyde::DSL::PathMethods#root (method)">#root</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">DSL::PathConstructors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/PathConstructors.html#connect-instance_method" title="Hyde::DSL::PathConstructors#connect (method)">#connect</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#delete-instance_method" title="Hyde::DSL::PathConstructors#delete (method)">#delete</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#get-instance_method" title="Hyde::DSL::PathConstructors#get (method)">#get</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#head-instance_method" title="Hyde::DSL::PathConstructors#head (method)">#head</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#options-instance_method" title="Hyde::DSL::PathConstructors#options (method)">#options</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#patch-instance_method" title="Hyde::DSL::PathConstructors#patch (method)">#patch</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#path-instance_method" title="Hyde::DSL::PathConstructors#path (method)">#path</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#post-instance_method" title="Hyde::DSL::PathConstructors#post (method)">#post</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#probe-instance_method" title="Hyde::DSL::PathConstructors#probe (method)">#probe</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#put-instance_method" title="Hyde::DSL::PathConstructors#put (method)">#put</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#register-instance_method" title="Hyde::DSL::PathConstructors#register (method)">#register</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#serve-instance_method" title="Hyde::DSL::PathConstructors#serve (method)">#serve</a></span>, <span class='object_link'><a href="DSL/PathConstructors.html#trace-instance_method" title="Hyde::DSL::PathConstructors#trace (method)">#trace</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="PathContext.html#initialize-instance_method" title="Hyde::PathContext#initialize (method)">Hyde::PathContext</a></span></p>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

221
doc/Hyde/TRACEHandler.html
View File

@ -1,221 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::TRACEHandler
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::TRACEHandler";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">TRACEHandler</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::TRACEHandler
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></li>
<li class="next"><span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></li>
<li class="next"><span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></li>
<li class="next"><span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></li>
<li class="next">Hyde::TRACEHandler</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/probe/http_method.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Probe that executes callback on a TRACE</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="METHOD-constant" class="">METHOD =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TRACE</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#request-instance_method" title="Hyde::Handler#request (method)">#request</a></span>, <span class='object_link'><a href="Handler.html#response-instance_method" title="Hyde::Handler#response (method)">#response</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#properties-instance_method" title="Hyde::Probe#properties (method)">#properties</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#remap-instance_method" title="Hyde::Node#remap (method)">#remap</a></span>, <span class='object_link'><a href="Node.html#root-instance_method" title="Hyde::Node#root (method)">#root</a></span></p>
<h2>Method Summary</h2>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="GETHandler.html" title="Hyde::GETHandler (class)">GETHandler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="GETHandler.html#process-instance_method" title="Hyde::GETHandler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Handler.html" title="Hyde::Handler (class)">Handler</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Handler.html#process-instance_method" title="Hyde::Handler#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Probe.html" title="Hyde::Probe (class)">Probe</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Probe.html#initialize-instance_method" title="Hyde::Probe#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Probe.html#process-instance_method" title="Hyde::Probe#process (method)">#process</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Node</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Node.html#go-instance_method" title="Hyde::Node#go (method)">#go</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Hyde::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#process-instance_method" title="Hyde::Node#process (method)">#process</a></span>, <span class='object_link'><a href="Node.html#reject-instance_method" title="Hyde::Node#reject (method)">#reject</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Handler.html#initialize-instance_method" title="Hyde::Handler#initialize (method)">Hyde::Handler</a></span></p>
</div>
</div>
<div id="footer">
Generated on Wed Sep 13 01:10:18 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

766
doc/Hyde/Template.html
View File

@ -1,766 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Template
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Template";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Template</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Template
<span class="abstract note title">Abstract</span>
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Template</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/template.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<div class="note abstract">
<strong>This class is abstract.</strong>
<div class='inline'><p>does not represent any actual template engine.</p>
</div>
</div>
<p>Interface for Template engines</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Templates/ERB.html" title="Hyde::Templates::ERB (class)">Hyde::Templates::ERB</a></span>, <span class='object_link'><a href="Templates/Erubi.html" title="Hyde::Templates::Erubi (class)">Hyde::Templates::Erubi</a></span></p>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#import-instance_method" title="#import (instance method)">#<strong>import</strong>(filepath) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Import a template from within current template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(input, vars = {}, parent:) &#x21d2; Template </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#local_variable_get-instance_method" title="#local_variable_get (instance method)">#<strong>local_variable_get</strong>(key) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get local variable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#local_variable_set-instance_method" title="#local_variable_set (instance method)">#<strong>local_variable_set</strong>(key, value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set local variable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#local_variables-instance_method" title="#local_variables (instance method)">#<strong>local_variables</strong> &#x21d2; Array(Symbol) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get an array of defined local variables.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#override_locals-instance_method" title="#override_locals (instance method)">#<strong>override_locals</strong>(vars) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Override binding variables.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Run the template.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(input, vars = {}, parent:) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Template (class)">Template</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Template.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>, <tt>File</tt>)</span>
&mdash;
<div class='inline'><p>template text</p>
</div>
</li>
<li>
<span class='name'>vars</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
&mdash;
<div class='inline'><p>local variables for tempalte</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="Node.html" title="Hyde::Node (class)">Hyde::Node</a></span></tt>)</span>
&mdash;
<div class='inline'><p>parent node</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41
42
43
44
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='rparen'>)</span>
<span class='ivar'>@template</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>File</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='op'>:</span> <span class='id identifier rubyid_input'>input</span>
<span class='ivar'>@context</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="TemplateContext.html#initialize-instance_method" title="Hyde::TemplateContext#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
<span class='ivar'>@parent</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span> <span class='kw'>if</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>File</span>
<span class='ivar'>@binding</span> <span class='op'>=</span> <span class='ivar'>@context</span><span class='period'>.</span><span class='id identifier rubyid_binding'>binding</span>
<span class='id identifier rubyid_vars'>vars</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
<span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variable_set'>local_variable_set</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="import-instance_method">
#<strong>import</strong>(filepath) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Import a template from within current template</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
85
86
87
88
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 85</span>
<span class='kw'>def</span> <span class='id identifier rubyid_import'>import</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='rparen'>)</span>
<span class='id identifier rubyid_newtemp'>newtemp</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_filepath'>filepath</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='ivar'>@parent</span><span class='rparen'>)</span>
<span class='id identifier rubyid_newtemp'>newtemp</span><span class='period'>.</span><span class='id identifier rubyid_binding'>binding</span> <span class='op'>=</span> <span class='ivar'>@binding</span>
<span class='id identifier rubyid_newtemp'>newtemp</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="local_variable_get-instance_method">
#<strong>local_variable_get</strong>(key) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get local variable</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>Symbol</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 60</span>
<span class='kw'>def</span> <span class='id identifier rubyid_local_variable_get'>local_variable_get</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variable_get'>local_variable_get</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="local_variable_set-instance_method">
#<strong>local_variable_set</strong>(key, value) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set local variable</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>Symbol</tt>)</span>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_local_variable_set'>local_variable_set</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variable_set'>local_variable_set</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="local_variables-instance_method">
#<strong>local_variables</strong> &#x21d2; <tt>Array(Symbol)</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get an array of defined local variables</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(Symbol)</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_local_variables'>local_variables</span>
<span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variables'>local_variables</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="override_locals-instance_method">
#<strong>override_locals</strong>(vars) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Override binding variables.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>vars</span>
<span class='type'>(<tt>Hash{Symbol =&gt; Object}</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 72</span>
<span class='kw'>def</span> <span class='id identifier rubyid_override_locals'>override_locals</span><span class='lparen'>(</span><span class='id identifier rubyid_vars'>vars</span><span class='rparen'>)</span>
<span class='id identifier rubyid_vars'>vars</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
<span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variable_set'>local_variable_set</span><span class='lparen'>(</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="run-instance_method">
#<strong>run</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method is a stub.</p>
</div>
</div>
<p>Run the template</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span>
<span class='comment'># ... (stub)
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

342
doc/Hyde/TemplateContext.html
View File

@ -1,342 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::TemplateContext
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::TemplateContext";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">TemplateContext</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::TemplateContext
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::TemplateContext</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">DSL::CommonMethods</a></span>, <span class='object_link'><a href="DSL/ProbeConstructors.html" title="Hyde::DSL::ProbeConstructors (module)">DSL::ProbeConstructors</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">DSL::ProbeMethods</a></span>, <span class='object_link'><a href="DSL/TemplateMethods.html" title="Hyde::DSL::TemplateMethods (module)">DSL::TemplateMethods</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/template.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Context for template engines</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#binding-instance_method" title="#binding (instance method)">#<strong>binding</strong> &#x21d2; Binding </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent, parent_template) &#x21d2; TemplateContext </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of TemplateContext.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/TemplateMethods.html" title="Hyde::DSL::TemplateMethods (module)">DSL::TemplateMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/TemplateMethods.html#import-instance_method" title="Hyde::DSL::TemplateMethods#import (method)">#import</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">DSL::CommonMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/CommonMethods.html#bounce-instance_method" title="Hyde::DSL::CommonMethods#bounce (method)">#bounce</a></span>, <span class='object_link'><a href="DSL/CommonMethods.html#die-instance_method" title="Hyde::DSL::CommonMethods#die (method)">#die</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">DSL::ProbeMethods</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/ProbeMethods.html#escape_html-instance_method" title="Hyde::DSL::ProbeMethods#escape_html (method)">#escape_html</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#file-instance_method" title="Hyde::DSL::ProbeMethods#file (method)">#file</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#form-instance_method" title="Hyde::DSL::ProbeMethods#form (method)">#form</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#form%3F-instance_method" title="Hyde::DSL::ProbeMethods#form? (method)">#form?</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#header-instance_method" title="Hyde::DSL::ProbeMethods#header (method)">#header</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#remove_header-instance_method" title="Hyde::DSL::ProbeMethods#remove_header (method)">#remove_header</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#request-instance_method" title="Hyde::DSL::ProbeMethods#request (method)">#request</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#status-instance_method" title="Hyde::DSL::ProbeMethods#status (method)">#status</a></span>, <span class='object_link'><a href="DSL/ProbeMethods.html#unescape_html-instance_method" title="Hyde::DSL::ProbeMethods#unescape_html (method)">#unescape_html</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="DSL/ProbeConstructors.html" title="Hyde::DSL::ProbeConstructors (module)">DSL::ProbeConstructors</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DSL/ProbeConstructors.html#erb-instance_method" title="Hyde::DSL::ProbeConstructors#erb (method)">#erb</a></span>, <span class='object_link'><a href="DSL/ProbeConstructors.html#erubi-instance_method" title="Hyde::DSL::ProbeConstructors#erubi (method)">#erubi</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(parent, parent_template) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::TemplateContext (class)">TemplateContext</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of TemplateContext.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 27</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span><span class='comma'>,</span> <span class='id identifier rubyid_parent_template'>parent_template</span><span class='rparen'>)</span>
<span class='ivar'>@origin</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='ivar'>@parent_template</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_template'>parent_template</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="binding-instance_method">
#<strong>binding</strong> &#x21d2; <tt>Binding</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Binding</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_binding'>binding</span>
<span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_binding'>binding</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

127
doc/Hyde/Templates.html
View File

@ -1,127 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Templates
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Templates";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Templates</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Templates
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/template.rb<span class="defines">,<br />
lib/hyde/template/erb.rb,<br /> lib/hyde/template/erubi.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>All template engine adapters subclassed from Template</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Templates/ERB.html" title="Hyde::Templates::ERB (class)">ERB</a></span>, <span class='object_link'><a href="Templates/Erubi.html" title="Hyde::Templates::Erubi (class)">Erubi</a></span>
</p>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

312
doc/Hyde/Templates/ERB.html
View File

@ -1,312 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Templates::ERB
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Templates::ERB";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Templates.html" title="Hyde::Templates (module)">Templates</a></span></span>
&raquo;
<span class="title">ERB</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Templates::ERB
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Template.html" title="Hyde::Template (class)">Hyde::Template</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Template.html" title="Hyde::Template (class)">Hyde::Template</a></span></li>
<li class="next">Hyde::Templates::ERB</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/template/erb.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>ERB Template language adapter</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(input, vars = nil, parent:) &#x21d2; ERB </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of ERB.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Run the template.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Template.html" title="Hyde::Template (class)">Hyde::Template</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Template.html#import-instance_method" title="Hyde::Template#import (method)">#import</a></span>, <span class='object_link'><a href="../Template.html#local_variable_get-instance_method" title="Hyde::Template#local_variable_get (method)">#local_variable_get</a></span>, <span class='object_link'><a href="../Template.html#local_variable_set-instance_method" title="Hyde::Template#local_variable_set (method)">#local_variable_set</a></span>, <span class='object_link'><a href="../Template.html#local_variables-instance_method" title="Hyde::Template#local_variables (method)">#local_variables</a></span>, <span class='object_link'><a href="../Template.html#override_locals-instance_method" title="Hyde::Template#override_locals (method)">#override_locals</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(input, vars = nil, parent:) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Templates::ERB (class)">ERB</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ERB.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Hyde::Templates::ERB.{Hyde{Hyde::Template{Hyde::Template#new}</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template/erb.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span><span class='rparen'>)</span>
<span class='kw'>super</span>
<span class='id identifier rubyid_varname'>varname</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_part_</span><span class='embexpr_beg'>#{</span><span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='lparen'>(</span><span class='int'>10</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>while</span> <span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variable_defined?'>local_variable_defined?</span> <span class='id identifier rubyid_varname'>varname</span>
<span class='id identifier rubyid_varname'>varname</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_part_</span><span class='embexpr_beg'>#{</span><span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='lparen'>(</span><span class='int'>10</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='kw'>end</span>
<span class='ivar'>@template</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>ERB</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@template</span><span class='comma'>,</span> <span class='label'>eoutvar:</span> <span class='id identifier rubyid_varname'>varname</span><span class='rparen'>)</span>
<span class='ivar'>@template</span><span class='period'>.</span><span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>File</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>(Inline)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="run-instance_method">
#<strong>run</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Run the template.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template/erb.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span>
<span class='ivar'>@template</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='ivar'>@binding</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

330
doc/Hyde/Templates/Erubi.html
View File

@ -1,330 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Templates::Erubi
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Templates::Erubi";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Templates.html" title="Hyde::Templates (module)">Templates</a></span></span>
&raquo;
<span class="title">Erubi</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Templates::Erubi
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../Template.html" title="Hyde::Template (class)">Hyde::Template</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../Template.html" title="Hyde::Template (class)">Hyde::Template</a></span></li>
<li class="next">Hyde::Templates::Erubi</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/template/erubi.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Erubi (ERB) template language adapter</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(input, vars = nil, parent:, freeze: true, capture: false) &#x21d2; Erubi </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Erubi.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Run the template.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Template.html" title="Hyde::Template (class)">Hyde::Template</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Template.html#import-instance_method" title="Hyde::Template#import (method)">#import</a></span>, <span class='object_link'><a href="../Template.html#local_variable_get-instance_method" title="Hyde::Template#local_variable_get (method)">#local_variable_get</a></span>, <span class='object_link'><a href="../Template.html#local_variable_set-instance_method" title="Hyde::Template#local_variable_set (method)">#local_variable_set</a></span>, <span class='object_link'><a href="../Template.html#local_variables-instance_method" title="Hyde::Template#local_variables (method)">#local_variables</a></span>, <span class='object_link'><a href="../Template.html#override_locals-instance_method" title="Hyde::Template#override_locals (method)">#override_locals</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(input, vars = nil, parent:, freeze: true, capture: false) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Templates::Erubi (class)">Erubi</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Erubi.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li>Hyde::Templates::Erubi.{Hyde{Hyde::Template{Hyde::Template#new}</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template/erubi.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span>
<span class='id identifier rubyid_vars'>vars</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>parent:</span><span class='comma'>,</span>
<span class='label'>freeze:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>capture:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_vars'>vars</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='id identifier rubyid_parent'>parent</span><span class='rparen'>)</span>
<span class='id identifier rubyid_varname'>varname</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_part_</span><span class='embexpr_beg'>#{</span><span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='lparen'>(</span><span class='int'>10</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>while</span> <span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_local_variable_defined?'>local_variable_defined?</span> <span class='id identifier rubyid_varname'>varname</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
<span class='id identifier rubyid_varname'>varname</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_part_</span><span class='embexpr_beg'>#{</span><span class='const'>SecureRandom</span><span class='period'>.</span><span class='id identifier rubyid_hex'>hex</span><span class='lparen'>(</span><span class='int'>10</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_properties'>properties</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>filename:</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>File</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>(Inline)</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='label'>bufvar:</span> <span class='id identifier rubyid_varname'>varname</span><span class='comma'>,</span>
<span class='label'>freeze:</span> <span class='id identifier rubyid_freeze'>freeze</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_engine'>engine</span> <span class='op'>=</span> <span class='id identifier rubyid_capture'>capture</span> <span class='op'>?</span> <span class='op'>::</span><span class='const'>Erubi</span><span class='op'>::</span><span class='const'>CaptureEndEngine</span> <span class='op'>:</span> <span class='op'>::</span><span class='const'>Erubi</span><span class='op'>::</span><span class='const'>Engine</span>
<span class='ivar'>@template</span> <span class='op'>=</span> <span class='id identifier rubyid_engine'>engine</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@template</span><span class='comma'>,</span> <span class='id identifier rubyid_properties'>properties</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="run-instance_method">
#<strong>run</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Run the template.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/template/erubi.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span>
<span class='ivar'>@binding</span><span class='period'>.</span><span class='id identifier rubyid_eval'>eval</span><span class='lparen'>(</span><span class='ivar'>@template</span><span class='period'>.</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

582
doc/Hyde/Util.html
View File

@ -1,582 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Util
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (U)</a> &raquo;
<span class='title'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span>
&raquo;
<span class="title">Util</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Util
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/lookup.rb<span class="defines">,<br />
lib/hyde/util/html.rb,<br /> lib/hyde/util/query.rb,<br /> lib/hyde/util/multipart.rb,<br /> lib/hyde/util/parseutils.rb,<br /> lib/hyde/util/parsesorting.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Various things that exists for purely logical reasons</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span>, <span class='object_link'><a href="Util/ParserCommon.html" title="Hyde::Util::ParserCommon (module)">ParserCommon</a></span>, <span class='object_link'><a href="Util/ParserSorting.html" title="Hyde::Util::ParserSorting (module)">ParserSorting</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Util/FormPart.html" title="Hyde::Util::FormPart (class)">FormPart</a></span>, <span class='object_link'><a href="Util/Lookup.html" title="Hyde::Util::Lookup (class)">Lookup</a></span>, <span class='object_link'><a href="Util/MultipartParser.html" title="Hyde::Util::MultipartParser (class)">MultipartParser</a></span>, <span class='object_link'><a href="Util/Query.html" title="Hyde::Util::Query (class)">Query</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="HTTP_STATUS-constant" class="">HTTP_STATUS =
<div class="docstring">
<div class="discussion">
<p>HTTP status codes and descriptions
Taken from WEBrick <a href="https://github.com/ruby/webrick/blob/master/lib/webrick/httpstatus.rb" target="_parent" title="https://github.com/ruby/webrick/blob/master/lib/webrick/httpstatus.rb">https://github.com/ruby/webrick/blob/master/lib/webrick/httpstatus.rb</a></p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span>
<span class='int'>100</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Continue</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>101</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Switching Protocols</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>200</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>OK</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>201</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Created</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>202</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Accepted</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>203</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Non-Authoritative Information</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>204</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>No Content</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>205</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Reset Content</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>206</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Partial Content</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>207</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Multi-Status</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>300</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Multiple Choices</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>301</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Moved Permanently</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>302</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Found</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>303</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>See Other</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>304</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Not Modified</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>305</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Use Proxy</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>307</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Temporary Redirect</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>400</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Bad Request</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>401</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unauthorized</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>402</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Payment Required</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>403</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Forbidden</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>404</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Not Found</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>405</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Method Not Allowed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>406</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Not Acceptable</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>407</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Proxy Authentication Required</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>408</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Request Timeout</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>409</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Conflict</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>410</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Gone</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>411</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Length Required</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>412</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Precondition Failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>413</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Request Entity Too Large</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>414</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Request-URI Too Large</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>415</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unsupported Media Type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>416</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Request Range Not Satisfiable</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>417</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Expectation Failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>418</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>I&#39;m a teapot</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
<span class='int'>422</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unprocessable Entity</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>423</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Locked</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>424</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Failed Dependency</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>426</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Upgrade Required</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>428</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Precondition Required</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>429</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Too Many Requests</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>431</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Request Header Fields Too Large</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>451</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unavailable For Legal Reasons</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>500</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Internal Server Error</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>501</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Not Implemented</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>502</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Bad Gateway</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>503</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Service Unavailable</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>504</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Gateway Timeout</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>505</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>HTTP Version Not Supported</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>507</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Insufficient Storage</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='int'>511</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Network Authentication Required</span><span class='tstring_end'>&#39;</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#default_error_page-class_method" title="default_error_page (class method)">.<strong>default_error_page</strong>(code, backtrace) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Default error page for Hyde.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#escape_html-class_method" title="escape_html (class method)">.<strong>escape_html</strong>(str) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return string with escaped HTML entities.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unescape_html-class_method" title="unescape_html (class method)">.<strong>unescape_html</strong>(str) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return string with unescaped HTML entities.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="default_error_page-class_method">
.<strong>default_error_page</strong>(code, backtrace) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Default error page for Hyde</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>code</span>
<span class='type'>(<tt>Integer</tt>)</span>
&mdash;
<div class='inline'><p>HTTP Status code</p>
</div>
</li>
<li>
<span class='name'>backtrace</span>
<span class='type'>(<tt>Array(String)</tt>, <tt>nil</tt>)</span>
&mdash;
<div class='inline'><p>Message to show in backtrace window</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/html.rb', line 89</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_error_page'>default_error_page</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_backtrace'>backtrace</span><span class='rparen'>)</span>
<span class='id identifier rubyid_backtrace'>backtrace</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_errortext'>errortext</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#HTTP_STATUS-constant" title="Hyde::Util::HTTP_STATUS (constant)">HTTP_STATUS</a></span></span><span class='lbracket'>[</span><span class='id identifier rubyid_code'>code</span><span class='rbracket'>]</span>
<span class='heredoc_beg'>&lt;&lt;~HTMLEOF</span>
<span class='tstring_content'> &lt;!DOCTYPE HTML&gt;
</span><span class='tstring_content'> &lt;html&gt;
</span><span class='tstring_content'> &lt;head&gt;
</span><span class='tstring_content'> &lt;title&gt;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_escape_html'><span class='object_link'><a href="#escape_html-class_method" title="Hyde::Util.escape_html (method)">escape_html</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_errortext'>errortext</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/title&gt;
</span><span class='tstring_content'> &lt;style&gt; .header {padding: 0.5rem; overflow: auto;} .title { font-weight: bolder; font-size: 48px; margin: 10px 10px; text-shadow: 1px 1px 1px #202222, 2px 2px 2px #404444; float: left } body { margin: 0; } .text { font-size 1rem; } .small { color: #7D7D7D; font-size: 12px;} .code { font-family: monospace; font-size: 0.7rem; } &lt;/style&gt;
</span><span class='tstring_content'> &lt;meta charset=&quot;utf-8&quot;&gt;
</span><span class='tstring_content'> &lt;/head&gt;
</span><span class='tstring_content'> &lt;body&gt;
</span><span class='tstring_content'> &lt;div class=&quot;header&quot;&gt;
</span><span class='tstring_content'> &lt;p class=&quot;title&quot;&gt;HYDE&lt;/p&gt;
</span><span class='tstring_content'> &lt;p style=&quot;float: right&quot;&gt;&lt;a href=&quot;https://adastra7.net/git/yessiest/hyde&quot;&gt;Source code&lt;/a&gt;&lt;/p&gt;
</span><span class='tstring_content'> &lt;/div&gt;
</span><span class='tstring_content'> &lt;div style=&quot;padding: 0.5rem&quot;&gt;
</span><span class='tstring_content'> &lt;p class=&quot;text&quot;&gt;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_escape_html'><span class='object_link'><a href="#escape_html-class_method" title="Hyde::Util.escape_html (method)">escape_html</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_errortext'>errortext</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/p&gt;
</span><span class='tstring_content'> &lt;pre&gt;&lt;code class=&quot;text code&quot;&gt;
</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_backtrace'>backtrace</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='const'><span class='object_link'><a href="" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbeg'>:</span><span class='id identifier rubyid_escape_html'>escape_html</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;br/&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>
</span><span class='tstring_content'> &lt;/code&gt;&lt;/pre&gt;
</span><span class='tstring_content'> &lt;hr/&gt;
</span><span class='tstring_content'> &lt;p class=&quot;small&quot;&gt;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="" title="Hyde::Util (module)">Util</a></span></span><span class='period'>.</span><span class='id identifier rubyid_escape_html'><span class='object_link'><a href="#escape_html-class_method" title="Hyde::Util.escape_html (method)">escape_html</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Hyde.html#VLINE-constant" title="Hyde::VLINE (constant)">VLINE</a></span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/p&gt;
</span><span class='tstring_content'> &lt;/div&gt;
</span><span class='tstring_content'> &lt;/body&gt;
</span><span class='tstring_content'> &lt;/html&gt;
</span><span class='heredoc_end'> HTMLEOF
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="escape_html-class_method">
.<strong>escape_html</strong>(str) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>Do <strong>not</strong> use this to inject untrusted input into JavaScript code or CSS style of the page.</p>
</div>
</div>
<p>Return string with escaped HTML entities.
This function is not adequate to prevent string interpolation.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>str</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
69
70
71
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/html.rb', line 69</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_escape_html'>escape_html</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escapeHTML'>escapeHTML</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[^\x1-\x7E]</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&amp;#</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_match'>match</span><span class='period'>.</span><span class='id identifier rubyid_ord'>ord</span><span class='embexpr_end'>}</span><span class='tstring_content'>;</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unescape_html-class_method">
.<strong>unescape_html</strong>(str) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return string with unescaped HTML entities.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>str</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79
80
81</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/html.rb', line 79</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_unescape_html'>unescape_html</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_unescapeHTML'>unescapeHTML</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

1022
doc/Hyde/Util/FormPart.html
View File

File diff suppressed because it is too large Load Diff

274
doc/Hyde/Util/HeaderRegexp.html
View File

@ -1,274 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Util::HeaderRegexp
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::HeaderRegexp";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (H)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">HeaderRegexp</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Util::HeaderRegexp
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/parseutils.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>(not exactly precise) Regular expressions for some RFC definitions</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="TOKEN-constant" class="">TOKEN =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC2616 definiton of token</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[!-~&amp;&amp;[^()&lt;&gt;@,;:\\&quot;\/\[\]?={}\t]]+</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="QUOTED-constant" class="">QUOTED =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC2616 definition of quoted-string</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>&quot;[\x0-\x7E&amp;&amp;[^\x1-\x8\xb-\x1f]]*(?&lt;!\\)&quot;</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PRINTCHAR-constant" class="">PRINTCHAR =
<div class="docstring">
<div class="discussion">
<p>Matches any CHAR except CTLs</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[\x2-\x7E]</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PRINTABLE-constant" class="">PRINTABLE =
<div class="docstring">
<div class="discussion">
<p>Matches 1 or more CHARs excluding CTLs</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PRINTCHAR-constant" title="Hyde::Util::HeaderRegexp::PRINTCHAR (constant)">PRINTCHAR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>+</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_OCTET-constant" class="">COOKIE_OCTET =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC6265 definition of a cookie-octet</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[\x21-\x7E&amp;&amp;[^&quot;,;\\]]*</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_VALUE-constant" class="">COOKIE_VALUE =
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(?:</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#QUOTED-constant" title="Hyde::Util::HeaderRegexp::QUOTED (constant)">QUOTED</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_OCTET-constant" title="Hyde::Util::HeaderRegexp::COOKIE_OCTET (constant)">COOKIE_OCTET</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_NAME-constant" class="">COOKIE_NAME =
</dt>
<dd><pre class="code"><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span></pre></dd>
<dt id="COOKIE_PAIR-constant" class="">COOKIE_PAIR =
<div class="docstring">
<div class="discussion">
<p>Matches the RFC6265 definition of cookie-pair.
Captures name (1) and value (2).</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_NAME-constant" title="Hyde::Util::HeaderRegexp::COOKIE_NAME (constant)">COOKIE_NAME</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_VALUE-constant" title="Hyde::Util::HeaderRegexp::COOKIE_VALUE (constant)">COOKIE_VALUE</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PARAM_QUOTED-constant" class="">PARAM_QUOTED =
<div class="docstring">
<div class="discussion">
<p>Matches a very abstract definition of a quoted header paramter.
Captures name (1) and value (2).</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=?(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#QUOTED-constant" title="Hyde::Util::HeaderRegexp::QUOTED (constant)">QUOTED</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PRINTCHAR-constant" title="Hyde::Util::HeaderRegexp::PRINTCHAR (constant)">PRINTCHAR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>*)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="PARAM-constant" class="">PARAM =
<div class="docstring">
<div class="discussion">
<p>Matches a very abstract definition of a header parameter.
Captures name (1) and value (2).</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=?(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PRINTCHAR-constant" title="Hyde::Util::HeaderRegexp::PRINTCHAR (constant)">PRINTCHAR</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>*)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="COOKIE_PARAM-constant" class="">COOKIE_PARAM =
<div class="docstring">
<div class="discussion">
<p>Specifically matches cookie parameters</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#TOKEN-constant" title="Hyde::Util::HeaderRegexp::TOKEN (constant)">TOKEN</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)=?(</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#QUOTED-constant" title="Hyde::Util::HeaderRegexp::QUOTED (constant)">QUOTED</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>|</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#COOKIE_OCTET-constant" title="Hyde::Util::HeaderRegexp::COOKIE_OCTET (constant)">COOKIE_OCTET</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>)\Z</span><span class='regexp_end'>/o</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

599
doc/Hyde/Util/Lookup.html
View File

@ -1,599 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Util::Lookup
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::Lookup";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (L)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">Lookup</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Util::Lookup
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Util::Lookup</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/lookup.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Value container with recursive lookup</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#parent-instance_method" title="#parent (instance method)">#<strong>parent</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute parent.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#[]-class_method" title="[] (class method)">.<strong>[]</strong>(hash) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Initialize a Lookup from Hash.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) &#x21d2; Object<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get a value by key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(key, value) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Set a value by key.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(parent = nil, hash = {}) &#x21d2; Lookup </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Lookup.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(parent = nil, hash = {}) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Util::Lookup (class)">Lookup</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Lookup.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Hyde::Util::Lookup (class)">Lookup</a></span></tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/lookup.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='ivar'>@parent</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_parent'>parent</span> <span class='kw'>or</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='ivar'>@storage</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="parent=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="parent-instance_method">
#<strong>parent</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute parent.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/lookup.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='ivar'>@parent</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-class_method">
.<strong>[]</strong>(hash) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initialize a Lookup from Hash</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>hash</span>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/lookup.rb', line 16</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="Hyde::Util::Lookup (class)">Lookup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Hyde::Util::Lookup#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_hash'>hash</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-instance_method">
#<strong>[]</strong>(key) &#x21d2; <tt>Object</tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Get a value by key</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>#hash</tt>)</span>
&mdash;
<div class='inline'><p>key for value</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>, <tt>nil</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/lookup.rb', line 23</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='ivar'>@storage</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='kw'>or</span> <span class='ivar'>@parent</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="[]=-instance_method">
#<strong>[]=</strong>(key, value) &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set a value by key</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>#hash</tt>)</span>
&mdash;
<div class='inline'><p>key for value</p>
</div>
</li>
<li>
<span class='name'>value</span>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'><p>value value</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/lookup.rb', line 30</span>
<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@storage</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

487
doc/Hyde/Util/MultipartParser.html
View File

@ -1,487 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Util::MultipartParser
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::MultipartParser";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (M)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">MultipartParser</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Util::MultipartParser
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Util::MultipartParser</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="ParserSorting.html" title="Hyde::Util::ParserSorting (module)">ParserSorting</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/multipart.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A very naive implementation of a Multipart form parser.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(io, boundary) &#x21d2; MultipartParser </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of MultipartParser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse-instance_method" title="#parse (instance method)">#<strong>parse</strong> &#x21d2; Array&lt;FormPart, FormFile&gt; </a>
</span>
<span class="summary_desc"><div class='inline'><p>Parse multipart formdata.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return a hash of current form.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(io, boundary) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Util::MultipartParser (class)">MultipartParser</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of MultipartParser.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47
48
49
50</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/multipart.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='comma'>,</span> <span class='id identifier rubyid_boundary'>boundary</span><span class='rparen'>)</span>
<span class='ivar'>@input</span> <span class='op'>=</span> <span class='id identifier rubyid_io'>io</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_io'>io</span>
<span class='ivar'>@boundary</span> <span class='op'>=</span> <span class='id identifier rubyid_boundary'>boundary</span>
<span class='ivar'>@state</span> <span class='op'>=</span> <span class='symbol'>:idle</span>
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="parse-instance_method">
#<strong>parse</strong> &#x21d2; <tt>Array&lt;<span class='object_link'><a href="FormPart.html" title="Hyde::Util::FormPart (class)">FormPart</a></span>, FormFile&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Parse multipart formdata</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;<span class='object_link'><a href="FormPart.html" title="Hyde::Util::FormPart (class)">FormPart</a></span>, FormFile&gt;</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/multipart.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span>
<span class='kw'>return</span> <span class='ivar'>@data</span> <span class='kw'>unless</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='kw'>while</span> <span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span> <span class='op'>=</span> <span class='ivar'>@input</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='ivar'>@state</span>
<span class='kw'>when</span> <span class='symbol'>:idle</span> <span class='comment'># waiting for valid boundary
</span> <span class='kw'>if</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='embexpr_beg'>#{</span><span class='ivar'>@boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span>
<span class='comment'># transition to :headers on valid boundary
</span> <span class='ivar'>@state</span> <span class='op'>=</span> <span class='symbol'>:headers</span>
<span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="FormPart.html" title="Hyde::Util::FormPart (class)">FormPart</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='kw'>nil</span><span class='rbracket'>]</span> <span class='op'>*</span> <span class='int'>5</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>when</span> <span class='symbol'>:headers</span> <span class='comment'># after valid boundary - checking for headers
</span> <span class='kw'>if</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span>
<span class='comment'># prepare form field and transition to :data or :file
</span> <span class='ivar'>@state</span> <span class='op'>=</span> <span class='id identifier rubyid_file?'>file?</span><span class='lparen'>(</span><span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='symbol'>:file</span> <span class='op'>:</span> <span class='symbol'>:data</span>
<span class='kw'>if</span> <span class='ivar'>@state</span> <span class='op'>==</span> <span class='symbol'>:data</span>
<span class='id identifier rubyid_setup_data_meta'>setup_data_meta</span><span class='lparen'>(</span><span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_setup_file_meta'>setup_file_meta</span><span class='lparen'>(</span><span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>next</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_push_header'>push_header</span><span class='lparen'>(</span><span class='id identifier rubyid_line'>line</span><span class='comma'>,</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>when</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:file</span> <span class='comment'># after headers - processing form data
</span> <span class='kw'>if</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='comment'># transition to :idle on empty headers
</span> <span class='ivar'>@state</span> <span class='op'>=</span> <span class='symbol'>:idle</span>
<span class='kw'>next</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='embexpr_beg'>#{</span><span class='ivar'>@boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='embexpr_beg'>#{</span><span class='ivar'>@boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>--\r\n</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_line'>line</span>
<span class='comment'># finalize and transition to either :headers or :idle
</span> <span class='kw'>if</span> <span class='ivar'>@state</span> <span class='op'>==</span> <span class='symbol'>:file</span>
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_tempfile'>tempfile</span><span class='period'>.</span><span class='id identifier rubyid_truncate'>truncate</span><span class='lparen'>(</span><span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_tempfile'>tempfile</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>-</span> <span class='int'>2</span><span class='rparen'>)</span>
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_tempfile'>tempfile</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
<span class='kw'>else</span>
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_delete_suffix!'>delete_suffix!</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='ivar'>@state</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='embexpr_beg'>#{</span><span class='ivar'>@boundary</span><span class='embexpr_end'>}</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>?</span> <span class='symbol'>:headers</span> <span class='op'>:</span> <span class='symbol'>:idle</span>
<span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="FormPart.html" title="Hyde::Util::FormPart (class)">FormPart</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='kw'>nil</span><span class='rbracket'>]</span> <span class='op'>*</span> <span class='int'>5</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>next</span>
<span class='kw'>end</span>
<span class='kw'>if</span> <span class='ivar'>@state</span> <span class='op'>==</span> <span class='symbol'>:data</span>
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_line'>line</span>
<span class='kw'>else</span>
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_tempfile'>tempfile</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_line'>line</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='ivar'>@state</span> <span class='op'>=</span> <span class='symbol'>:idle</span>
<span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span>
<span class='ivar'>@data</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="to_h-instance_method">
#<strong>to_h</strong> &#x21d2; <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return a hash of current form.
(equivalent to Query.parse but for multipart/form-data)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
116
117
118</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/multipart.rb', line 116</span>
<span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
<span class='id identifier rubyid_flatten'>flatten</span><span class='lparen'>(</span><span class='id identifier rubyid_sort'>sort</span><span class='lparen'>(</span><span class='id identifier rubyid_gen_hash'>gen_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_parse'>parse</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:46 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

476
doc/Hyde/Util/ParserCommon.html
View File

@ -1,476 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Util::ParserCommon
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::ParserCommon";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">ParserCommon</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Util::ParserCommon
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/parseutils.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Module for all things related to parsing HTTP and related syntax.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="RFC1123_DATE-constant" class="">RFC1123_DATE =
<div class="docstring">
<div class="discussion">
<h1 id="strftime-parameter-to-return-a-correct-rfc-1123-date">strftime parameter to return a correct RFC 1123 date.</h1>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%a, %d %b %Y %H:%M:%S GMT</span><span class='tstring_end'>&quot;</span></span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#make_value-class_method" title="make_value (class method)">.<strong>make_value</strong>(input, opts, sep = &quot;;&quot;) &#x21d2; String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Construct a parametrized header value.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse_value-class_method" title="parse_value (class method)">.<strong>parse_value</strong>(input, sep: &quot;;&quot;, unquote: false, regexp: nil) &#x21d2; Array(String, Hash) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Parse parametrized header values.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="make_value-class_method">
.<strong>make_value</strong>(input, opts, sep = &quot;;&quot;) &#x21d2; <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct a parametrized header value.
Does some input sanitization during construction</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
<li>
<span class='name'>opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../ParsingError.html" title="Hyde::ParsingError (class)">Hyde::ParsingError</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/parseutils.rb', line 80</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_value'>make_value</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='comma'>,</span> <span class='id identifier rubyid_sep'>sep</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_output'>output</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span> <span class='const'><span class='object_link'><a href="HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderRegexp.html#PRINTABLE-constant" title="Hyde::Util::HeaderRegexp::PRINTABLE (constant)">PRINTABLE</a></span></span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../ParsingError.html" title="Hyde::ParsingError (class)">ParsingError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>input is not ascii printable</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_opts'>opts</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='id identifier rubyid_check_param'>check_param</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='id identifier rubyid_newparam'>newparam</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sep'>sep</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>else</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_sep'>sep</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_output'>output</span> <span class='op'>+=</span> <span class='id identifier rubyid_newparam'>newparam</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_output'>output</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse_value-class_method">
.<strong>parse_value</strong>(input, sep: &quot;;&quot;, unquote: false, regexp: nil) &#x21d2; <tt>Array(String, Hash)</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Parse parametrized header values.
This method will try the best attempt at decoding parameters.
However, it does no decoding on the first argument.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>input</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
<li>
<span class='name'>sep</span>
<span class='type'>(<tt>String</tt>, <tt>Regexp</tt>)</span>
<em class="default">(defaults to: <tt>&quot;;&quot;</tt>)</em>
</li>
<li>
<span class='name'>unquote</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'><p>interpret params as possibly quoted</p>
</div>
</li>
<li>
<span class='name'>regexp</span>
<span class='type'>(<tt>Regexp</tt>, <tt>nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'><p>override param matching regexp</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array(String, Hash)</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/parseutils.rb', line 51</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_value'>parse_value</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='comma'>,</span> <span class='label'>sep:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>unquote:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>regexp:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_parts'>parts</span> <span class='op'>=</span> <span class='id identifier rubyid_input'>input</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='id identifier rubyid_sep'>sep</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_decode_uri_component'>decode_uri_component</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_strip'>strip</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_base'>base</span> <span class='op'>=</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
<span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='id identifier rubyid_parts'>parts</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_raw'>raw</span><span class='op'>|</span>
<span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_raw'>raw</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='kw'>if</span> <span class='id identifier rubyid_regexp'>regexp</span>
<span class='id identifier rubyid_regexp'>regexp</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_unquote'>unquote</span>
<span class='const'><span class='object_link'><a href="HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderRegexp.html#PARAM_QUOTED-constant" title="Hyde::Util::HeaderRegexp::PARAM_QUOTED (constant)">PARAM_QUOTED</a></span></span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HeaderRegexp.html#PARAM-constant" title="Hyde::Util::HeaderRegexp::PARAM (constant)">PARAM</a></span></span>
<span class='kw'>end</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span> <span class='kw'>true</span>
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A&quot;.*&quot;\z</span><span class='regexp_end'>/</span></span> <span class='kw'>then</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_undump'>undump</span>
<span class='kw'>else</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rbracket'>]</span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span>
<span class='lbracket'>[</span><span class='id identifier rubyid_base'>base</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

120
doc/Hyde/Util/ParserSorting.html
View File

@ -1,120 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Hyde::Util::ParserSorting
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::ParserSorting";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (P)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">ParserSorting</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Hyde::Util::ParserSorting
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="MultipartParser.html" title="Hyde::Util::MultipartParser (class)">MultipartParser</a></span>, <span class='object_link'><a href="Query.html" title="Hyde::Util::Query (class)">Query</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/parsesorting.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Internal library for generating form hashes</p>
</div>
</div>
<div class="tags">
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

498
doc/Hyde/Util/Query.html
View File

@ -1,498 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Hyde::Util::Query
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Hyde::Util::Query";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (Q)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Hyde.html" title="Hyde (module)">Hyde</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Util.html" title="Hyde::Util (module)">Util</a></span></span>
&raquo;
<span class="title">Query</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Hyde::Util::Query
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Hyde::Util::Query</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="ParserSorting.html" title="Hyde::Util::ParserSorting (module)">ParserSorting</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/hyde/util/query.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Query string parser</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#[]-instance_method" title="#[] (instance method)">#<strong>[]</strong>(key) &#x21d2; String, Array </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get key from query.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(query) &#x21d2; Query </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Query.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse-instance_method" title="#parse (instance method)">#<strong>parse</strong> &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Better(tm) query parser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse_shallow-instance_method" title="#parse_shallow (instance method)">#<strong>parse_shallow</strong> &#x21d2; Hash </a>
</span>
<span class="summary_desc"><div class='inline'><p>Shallow query parser (does not do PHP-like array keys).</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(query) &#x21d2; <tt><span class='object_link'><a href="" title="Hyde::Util::Query (class)">Query</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Query.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>query</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/query.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
<span class='ivar'>@query</span> <span class='op'>=</span> <span class='id identifier rubyid_query'>query</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="[]-instance_method">
#<strong>[]</strong>(key) &#x21d2; <tt>String</tt>, <tt>Array</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get key from query.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>key</span>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/query.rb', line 39</span>
<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='lparen'>(</span><span class='ivar'>@cache</span> <span class='op'>||=</span> <span class='id identifier rubyid_parse'>parse</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse-instance_method">
#<strong>parse</strong> &#x21d2; <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Better(tm) query parser.
Returns a hash with arrays.
Key semantics:</p>
<ul>
<li><code>key=value</code> creates a key value pair</li>
<li><code>key[]=value</code> appends <code>value</code> to an array named <code>key</code></li>
<li><code>key[index]=value</code> sets <code>value</code> at <code>index</code> of array named <code>key</code></li>
</ul>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/query.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span>
<span class='id identifier rubyid_construct_deep_hash'>construct_deep_hash</span><span class='lparen'>(</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_decode_www_form'>decode_www_form</span><span class='lparen'>(</span><span class='ivar'>@query</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse_shallow-instance_method">
#<strong>parse_shallow</strong> &#x21d2; <tt>Hash</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Shallow query parser (does not do PHP-like array keys)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Hash</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/hyde/util/query.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse_shallow'>parse_shallow</span>
<span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_decode_www_form'>decode_www_form</span><span class='lparen'>(</span><span class='ivar'>@query</span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_array'>array</span><span class='op'>|</span> <span class='id identifier rubyid_array'>array</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
<span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

576
doc/_index.html
View File

@ -1,576 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = null;
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.34</h1>
<div id="listing">
<h1 class="alphaindex">Alphabetic Index</h1>
<h2>File Listing</h2>
<ul id="files" class="index_inline_list">
<li class="r1"><a href="index.html" title="README">README</a></li>
</ul>
<div class="clear"></div>
<h2>Namespace Listing A-Z</h2>
<table>
<tr>
<td valign='top' width="33%">
<ul id="alpha_C" class="alpha">
<li class="letter">C</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/CONNECT.html" title="Hyde::Handlers::CONNECT (class)">CONNECT</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL/CommonMethods.html" title="Hyde::DSL::CommonMethods (module)">CommonMethods</a></span>
<small>(Hyde::DSL)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Cookie.html" title="Hyde::Cookie (class)">Cookie</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
<ul id="alpha_D" class="alpha">
<li class="letter">D</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/DELETE.html" title="Hyde::Handlers::DELETE (class)">DELETE</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL.html" title="Hyde::DSL (module)">DSL</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
<ul id="alpha_E" class="alpha">
<li class="letter">E</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Templates/ERB.html" title="Hyde::Templates::ERB (class)">ERB</a></span>
<small>(Hyde::Templates)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Error.html" title="Hyde::Error (class)">Error</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Templates/Erubi.html" title="Hyde::Templates::Erubi (class)">Erubi</a></span>
<small>(Hyde::Templates)</small>
</li>
</ul>
</ul>
<ul id="alpha_F" class="alpha">
<li class="letter">F</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Util/FormPart.html" title="Hyde::Util::FormPart (class)">FormPart</a></span>
<small>(Hyde::Util)</small>
</li>
</ul>
</ul>
<ul id="alpha_G" class="alpha">
<li class="letter">G</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/GET.html" title="Hyde::Handlers::GET (class)">GET</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/PatternMatching/Glob.html" title="Hyde::PatternMatching::Glob (class)">Glob</a></span>
<small>(Hyde::PatternMatching)</small>
</li>
</ul>
</ul>
<ul id="alpha_H" class="alpha">
<li class="letter">H</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/HEAD.html" title="Hyde::Handlers::HEAD (class)">HEAD</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Handlers/Handler.html" title="Hyde::Handlers::Handler (class)">Handler</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Handlers.html" title="Hyde::Handlers (module)">Handlers</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Util/HeaderRegexp.html" title="Hyde::Util::HeaderRegexp (module)">HeaderRegexp</a></span>
<small>(Hyde::Util)</small>
</li>
<li>
<span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span>
</li>
</ul>
</ul>
<ul id="alpha_L" class="alpha">
<li class="letter">L</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Util/Lookup.html" title="Hyde::Util::Lookup (class)">Lookup</a></span>
<small>(Hyde::Util)</small>
</li>
</ul>
</ul>
</td><td valign='top' width="33%">
<ul id="alpha_M" class="alpha">
<li class="letter">M</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Util/MultipartParser.html" title="Hyde::Util::MultipartParser (class)">MultipartParser</a></span>
<small>(Hyde::Util)</small>
</li>
</ul>
</ul>
<ul id="alpha_N" class="alpha">
<li class="letter">N</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Node.html" title="Hyde::Node (class)">Node</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
<ul id="alpha_O" class="alpha">
<li class="letter">O</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/OPTIONS.html" title="Hyde::Handlers::OPTIONS (class)">OPTIONS</a></span>
<small>(Hyde::Handlers)</small>
</li>
</ul>
</ul>
<ul id="alpha_P" class="alpha">
<li class="letter">P</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/PATCH.html" title="Hyde::Handlers::PATCH (class)">PATCH</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Handlers/POST.html" title="Hyde::Handlers::POST (class)">POST</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Handlers/PUT.html" title="Hyde::Handlers::PUT (class)">PUT</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Util/ParserCommon.html" title="Hyde::Util::ParserCommon (module)">ParserCommon</a></span>
<small>(Hyde::Util)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Util/ParserSorting.html" title="Hyde::Util::ParserSorting (module)">ParserSorting</a></span>
<small>(Hyde::Util)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/ParsingError.html" title="Hyde::ParsingError (class)">ParsingError</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Path.html" title="Hyde::Path (class)">Path</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL/PathConstructors.html" title="Hyde::DSL::PathConstructors (module)">PathConstructors</a></span>
<small>(Hyde::DSL)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/PathContext.html" title="Hyde::PathContext (class)">PathContext</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL/PathMethods.html" title="Hyde::DSL::PathMethods (module)">PathMethods</a></span>
<small>(Hyde::DSL)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Pattern.html" title="Hyde::Pattern (class)">Pattern</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/PatternMatching.html" title="Hyde::PatternMatching (module)">PatternMatching</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Probe.html" title="Hyde::Probe (class)">Probe</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL/ProbeConstructors.html" title="Hyde::DSL::ProbeConstructors (module)">ProbeConstructors</a></span>
<small>(Hyde::DSL)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/ProbeContext.html" title="Hyde::ProbeContext (class)">ProbeContext</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL/ProbeMethods.html" title="Hyde::DSL::ProbeMethods (module)">ProbeMethods</a></span>
<small>(Hyde::DSL)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/ProcessorContext.html" title="Hyde::ProcessorContext (class)">ProcessorContext</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
<ul id="alpha_Q" class="alpha">
<li class="letter">Q</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Util/Query.html" title="Hyde::Util::Query (class)">Query</a></span>
<small>(Hyde::Util)</small>
</li>
</ul>
</ul>
<ul id="alpha_R" class="alpha">
<li class="letter">R</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/PatternMatching/ReMatch.html" title="Hyde::PatternMatching::ReMatch (class)">ReMatch</a></span>
<small>(Hyde::PatternMatching)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Request.html" title="Hyde::Request (class)">Request</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Response.html" title="Hyde::Response (class)">Response</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
<ul id="alpha_S" class="alpha">
<li class="letter">S</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/Serve.html" title="Hyde::Handlers::Serve (class)">Serve</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/ServerContext.html" title="Hyde::ServerContext (class)">ServerContext</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
<ul id="alpha_T" class="alpha">
<li class="letter">T</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Handlers/TRACE.html" title="Hyde::Handlers::TRACE (class)">TRACE</a></span>
<small>(Hyde::Handlers)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Template.html" title="Hyde::Template (class)">Template</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/TemplateContext.html" title="Hyde::TemplateContext (class)">TemplateContext</a></span>
<small>(Hyde)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/DSL/TemplateMethods.html" title="Hyde::DSL::TemplateMethods (module)">TemplateMethods</a></span>
<small>(Hyde::DSL)</small>
</li>
<li>
<span class='object_link'><a href="Hyde/Templates.html" title="Hyde::Templates (module)">Templates</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
</td><td valign='top' width="33%">
<ul id="alpha_U" class="alpha">
<li class="letter">U</li>
<ul>
<li>
<span class='object_link'><a href="Hyde/Util.html" title="Hyde::Util (module)">Util</a></span>
<small>(Hyde)</small>
</li>
</ul>
</ul>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

51
doc/class_list.html
View File

File diff suppressed because one or more lines are too long

1
doc/css/common.css
View File

@ -1 +0,0 @@
/* Override this file with custom rules */

58
doc/css/full_list.css
View File

@ -1,58 +0,0 @@
body {
margin: 0;
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-size: 13px;
height: 101%;
overflow-x: hidden;
background: #fafafa;
}
h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
.clear { clear: both; }
.fixed_header { position: fixed; background: #fff; width: 100%; padding-bottom: 10px; margin-top: 0; top: 0; z-index: 9999; height: 70px; }
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
#full_list { padding: 0; list-style: none; margin-left: 0; margin-top: 80px; font-size: 1.1em; }
#full_list ul { padding: 0; }
#full_list li { padding: 0; margin: 0; list-style: none; }
#full_list li .item { padding: 5px 5px 5px 12px; }
#noresults { padding: 7px 12px; background: #fff; }
#content.insearch #noresults { margin-left: 7px; }
li.collapsed ul { display: none; }
li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
li { color: #888; cursor: pointer; }
li.deprecated { text-decoration: line-through; font-style: italic; }
li.odd { background: #f0f0f0; }
li.even { background: #fafafa; }
.item:hover { background: #ddd; }
li small:before { content: "("; }
li small:after { content: ")"; }
li small.search_info { display: none; }
a, a:visited { text-decoration: none; color: #05a; }
li.clicked > .item { background: #05a; color: #ccc; }
li.clicked > .item a, li.clicked > .item a:visited { color: #eee; }
li.clicked > .item a.toggle { opacity: 0.5; background-position: bottom right; }
li.collapsed.clicked a.toggle { background-position: top right; }
#search input { border: 1px solid #bbb; border-radius: 3px; }
#full_list_nav { margin-left: 10px; font-size: 0.9em; display: block; color: #aaa; }
#full_list_nav a, #nav a:visited { color: #358; }
#full_list_nav a:hover { background: transparent; color: #5af; }
#full_list_nav span:after { content: ' | '; }
#full_list_nav span:last-child:after { content: ''; }
#content h1 { margin-top: 0; }
li { white-space: nowrap; cursor: normal; }
li small { display: block; font-size: 0.8em; }
li small:before { content: ""; }
li small:after { content: ""; }
li small.search_info { display: none; }
#search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
#content.insearch #search { background-position: center right; }
#search input { width: 110px; }
#full_list.insearch ul { display: block; }
#full_list.insearch .item { display: none; }
#full_list.insearch .found { display: block; padding-left: 11px !important; }
#full_list.insearch li a.toggle { display: none; }
#full_list.insearch li small.search_info { display: block; }

497
doc/css/style.css
View File

@ -1,497 +0,0 @@
html {
width: 100%;
height: 100%;
}
body {
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-size: 13px;
width: 100%;
margin: 0;
padding: 0;
display: flex;
display: -webkit-flex;
display: -ms-flexbox;
}
#nav {
position: relative;
width: 100%;
height: 100%;
border: 0;
border-right: 1px dotted #eee;
overflow: auto;
}
.nav_wrap {
margin: 0;
padding: 0;
width: 20%;
height: 100%;
position: relative;
display: flex;
display: -webkit-flex;
display: -ms-flexbox;
flex-shrink: 0;
-webkit-flex-shrink: 0;
-ms-flex: 1 0;
}
#resizer {
position: absolute;
right: -5px;
top: 0;
width: 10px;
height: 100%;
cursor: col-resize;
z-index: 9999;
}
#main {
flex: 5 1;
-webkit-flex: 5 1;
-ms-flex: 5 1;
outline: none;
position: relative;
background: #fff;
padding: 1.2em;
padding-top: 0.2em;
box-sizing: border-box;
}
@media (max-width: 920px) {
.nav_wrap { width: 100%; top: 0; right: 0; overflow: visible; position: absolute; }
#resizer { display: none; }
#nav {
z-index: 9999;
background: #fff;
display: none;
position: absolute;
top: 40px;
right: 12px;
width: 500px;
max-width: 80%;
height: 80%;
overflow-y: scroll;
border: 1px solid #999;
border-collapse: collapse;
box-shadow: -7px 5px 25px #aaa;
border-radius: 2px;
}
}
@media (min-width: 920px) {
body { height: 100%; overflow: hidden; }
#main { height: 100%; overflow: auto; }
#search { display: none; }
}
#main img { max-width: 100%; }
h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
h1.title { margin-bottom: 10px; }
h1.alphaindex { margin-top: 0; font-size: 22px; }
h2 {
padding: 0;
padding-bottom: 3px;
border-bottom: 1px #aaa solid;
font-size: 1.4em;
margin: 1.8em 0 0.5em;
position: relative;
}
h2 small { font-weight: normal; font-size: 0.7em; display: inline; position: absolute; right: 0; }
h2 small a {
display: block;
height: 20px;
border: 1px solid #aaa;
border-bottom: 0;
border-top-left-radius: 5px;
background: #f8f8f8;
position: relative;
padding: 2px 7px;
}
.clear { clear: both; }
.inline { display: inline; }
.inline p:first-child { display: inline; }
.docstring, .tags, #filecontents { font-size: 15px; line-height: 1.5145em; }
.docstring p > code, .docstring p > tt, .tags p > code, .tags p > tt {
color: #c7254e; background: #f9f2f4; padding: 2px 4px; font-size: 1em;
border-radius: 4px;
}
.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
.docstring h1 { font-size: 1.2em; }
.docstring h2 { font-size: 1.1em; }
.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
.summary_desc .object_link a, .docstring .object_link a {
font-family: monospace; font-size: 1.05em;
color: #05a; background: #EDF4FA; padding: 2px 4px; font-size: 1em;
border-radius: 4px;
}
.rdoc-term { padding-right: 25px; font-weight: bold; }
.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
.summary_desc pre.code .object_link a, .docstring pre.code .object_link a {
padding: 0px; background: inherit; color: inherit; border-radius: inherit;
}
/* style for <table> */
#filecontents table, .docstring table { border-collapse: collapse; }
#filecontents table th, #filecontents table td,
.docstring table th, .docstring table td { border: 1px solid #ccc; padding: 8px; padding-right: 17px; }
#filecontents table tr:nth-child(odd),
.docstring table tr:nth-child(odd) { background: #eee; }
#filecontents table tr:nth-child(even),
.docstring table tr:nth-child(even) { background: #fff; }
#filecontents table th, .docstring table th { background: #fff; }
/* style for <ul> */
#filecontents li > p, .docstring li > p { margin: 0px; }
#filecontents ul, .docstring ul { padding-left: 20px; }
/* style for <dl> */
#filecontents dl, .docstring dl { border: 1px solid #ccc; }
#filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
#filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
#filecontents dd > p, .docstring dd > p { margin: 0px; }
.note {
color: #222;
margin: 20px 0;
padding: 10px;
border: 1px solid #eee;
border-radius: 3px;
display: block;
}
.docstring .note {
border-left-color: #ccc;
border-left-width: 5px;
}
.note.todo { background: #ffffc5; border-color: #ececaa; }
.note.returns_void { background: #efefef; }
.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
.note.title.deprecated { background: #ffe5e5; border-color: #e9dada; }
.note.private { background: #ffffc5; border-color: #ececaa; }
.note.title { padding: 3px 6px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
.summary_signature + .note.title { margin-left: 7px; }
h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
.note.title { background: #efefef; }
.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
.note.title.not_defined_here { background: transparent; border: none; font-style: italic; }
.discussion .note { margin-top: 6px; }
.discussion .note:first-child { margin-top: 0; }
h3.inherited {
font-style: italic;
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-weight: normal;
padding: 0;
margin: 0;
margin-top: 12px;
margin-bottom: 3px;
font-size: 13px;
}
p.inherited {
padding: 0;
margin: 0;
margin-left: 25px;
}
.box_info dl {
margin: 0;
border: 0;
width: 100%;
font-size: 1em;
display: flex;
display: -webkit-flex;
display: -ms-flexbox;
}
.box_info dl dt {
flex-shrink: 0;
-webkit-flex-shrink: 1;
-ms-flex-shrink: 1;
width: 100px;
text-align: right;
font-weight: bold;
border: 1px solid #aaa;
border-width: 1px 0px 0px 1px;
padding: 6px 0;
padding-right: 10px;
}
.box_info dl dd {
flex-grow: 1;
-webkit-flex-grow: 1;
-ms-flex: 1;
max-width: 420px;
padding: 6px 0;
padding-right: 20px;
border: 1px solid #aaa;
border-width: 1px 1px 0 0;
overflow: hidden;
position: relative;
}
.box_info dl:last-child > * {
border-bottom: 1px solid #aaa;
}
.box_info dl:nth-child(odd) > * { background: #eee; }
.box_info dl:nth-child(even) > * { background: #fff; }
.box_info dl > * { margin: 0; }
ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
.index_inline_list { padding-left: 0; font-size: 1.1em; }
.index_inline_list li {
list-style: none;
display: inline-block;
padding: 0 12px;
line-height: 30px;
margin-bottom: 5px;
}
dl.constants { margin-left: 10px; }
dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
dl.constants.compact dt { display: inline-block; font-weight: normal }
dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
dl.constants .docstring .note:first-child { margin-top: 5px; }
.summary_desc {
margin-left: 32px;
display: block;
font-family: sans-serif;
font-size: 1.1em;
margin-top: 8px;
line-height: 1.5145em;
margin-bottom: 0.8em;
}
.summary_desc tt { font-size: 0.9em; }
dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
dl.constants .discussion *:first-child { margin-top: 0; }
dl.constants .discussion *:last-child { margin-bottom: 0; }
.method_details { border-top: 1px dotted #ccc; margin-top: 25px; padding-top: 0; }
.method_details.first { border: 0; margin-top: 5px; }
.method_details.first h3.signature { margin-top: 1em; }
p.signature, h3.signature {
font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
padding: 6px 10px; margin-top: 1em;
background: #E8F4FF; border: 1px solid #d8d8e5; border-radius: 5px;
}
p.signature tt,
h3.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
p.signature .overload,
h3.signature .overload { display: block; }
p.signature .extras,
h3.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
p.signature .not_defined_here,
h3.signature .not_defined_here,
p.signature .aliases,
h3.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
p.signature .aliases .names,
h3.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
.tags .tag_title { font-size: 1.05em; margin-bottom: 0; font-weight: bold; }
.tags .tag_title tt { color: initial; padding: initial; background: initial; }
.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
.tags ul li { margin-bottom: 3px; }
.tags ul .name { font-family: monospace; font-weight: bold; }
.tags ul .note { padding: 3px 6px; }
.tags { margin-bottom: 12px; }
.tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; }
.tags .examples .inline p { padding: 0; margin: 0; font-weight: bold; font-size: 1em; }
.tags .examples .inline p:before { content: "▸"; font-size: 1em; margin-right: 5px; }
.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
.tags .overload .overload_item .signature {
padding: 2px 8px;
background: #F1F8FF; border: 1px solid #d8d8e5; border-radius: 3px;
}
.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
.tags .overload .docstring { margin-top: 15px; }
.defines { display: none; }
#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
.showSource { font-size: 0.9em; }
.showSource a, .showSource a:visited { text-decoration: none; color: #666; }
#content a, #content a:visited { text-decoration: none; color: #05a; }
#content a:hover { background: #ffffa5; }
ul.summary {
list-style: none;
font-family: monospace;
font-size: 1em;
line-height: 1.5em;
padding-left: 0px;
}
ul.summary a, ul.summary a:visited {
text-decoration: none; font-size: 1.1em;
}
ul.summary li { margin-bottom: 5px; }
.summary_signature { padding: 4px 8px; background: #f8f8f8; border: 1px solid #f0f0f0; border-radius: 5px; }
.summary_signature:hover { background: #CFEBFF; border-color: #A4CCDA; cursor: pointer; }
.summary_signature.deprecated { background: #ffe5e5; border-color: #e9dada; }
ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
#content .summary_signature:hover a,
#content .summary_signature:hover a:visited {
background: transparent;
color: #049;
}
p.inherited a { font-family: monospace; font-size: 0.9em; }
p.inherited { word-spacing: 5px; font-size: 1.2em; }
p.children { font-size: 1.2em; }
p.children a { font-size: 0.9em; }
p.children strong { font-size: 0.8em; }
p.children strong.modules { padding-left: 5px; }
ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
ul.fullTree li:first-child { padding-top: 0; background: transparent; }
ul.fullTree li:last-child { padding-bottom: 0; }
.showAll ul.fullTree { display: block; }
.showAll .inheritName { display: none; }
#search { position: absolute; right: 12px; top: 0px; z-index: 9000; }
#search a {
display: block; float: left;
padding: 4px 8px; text-decoration: none; color: #05a; fill: #05a;
border: 1px solid #d8d8e5;
border-bottom-left-radius: 3px; border-bottom-right-radius: 3px;
background: #F1F8FF;
box-shadow: -1px 1px 3px #ddd;
}
#search a:hover { background: #f5faff; color: #06b; fill: #06b; }
#search a.active {
background: #568; padding-bottom: 20px; color: #fff; fill: #fff;
border: 1px solid #457;
border-top-left-radius: 5px; border-top-right-radius: 5px;
}
#search a.inactive { color: #999; fill: #999; }
.inheritanceTree, .toggleDefines {
float: right;
border-left: 1px solid #aaa;
position: absolute; top: 0; right: 0;
height: 100%;
background: #f6f6f6;
padding: 5px;
min-width: 55px;
text-align: center;
}
#menu { font-size: 1.3em; color: #bbb; }
#menu .title, #menu a { font-size: 0.7em; }
#menu .title a { font-size: 1em; }
#menu .title { color: #555; }
#menu a, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
#menu a:hover { color: #05a; }
#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
#footer a, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
#footer a:hover { color: #05a; }
#listing ul.alpha { font-size: 1.1em; }
#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
#listing ul.alpha ul { margin: 0; padding-left: 15px; }
#listing ul small { color: #666; font-size: 0.7em; }
li.r1 { background: #f0f0f0; }
li.r2 { background: #fafafa; }
#content ul.summary li.deprecated .summary_signature a,
#content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
#toc {
position: relative;
float: right;
overflow-x: auto;
right: -3px;
margin-left: 20px;
margin-bottom: 20px;
padding: 20px; padding-right: 30px;
max-width: 300px;
z-index: 5000;
background: #fefefe;
border: 1px solid #ddd;
box-shadow: -2px 2px 6px #bbb;
}
#toc .title { margin: 0; }
#toc ol { padding-left: 1.8em; }
#toc li { font-size: 1.1em; line-height: 1.7em; }
#toc > ol > li { font-size: 1.1em; font-weight: bold; }
#toc ol > li > ol { font-size: 0.9em; }
#toc ol ol > li > ol { padding-left: 2.3em; }
#toc ol + li { margin-top: 0.3em; }
#toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; }
#toc.hidden:hover { background: #fafafa; }
#filecontents h1 + #toc.nofloat { margin-top: 0; }
@media (max-width: 560px) {
#toc {
margin-left: 0;
margin-top: 16px;
float: none;
max-width: none;
}
}
/* syntax highlighting */
.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
#filecontents pre.code, .docstring pre.code { display: block; }
.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
#filecontents pre.code, .docstring pre.code,
.tags pre.example {
padding: 9px 14px;
margin-top: 4px;
border: 1px solid #e1e1e8;
background: #f7f7f9;
border-radius: 4px;
font-size: 1em;
overflow-x: auto;
line-height: 1.2em;
}
pre.code { color: #000; tab-size: 2; }
pre.code .info.file { color: #555; }
pre.code .val { color: #036A07; }
pre.code .tstring_content,
pre.code .heredoc_beg, pre.code .heredoc_end,
pre.code .qwords_beg, pre.code .qwords_end, pre.code .qwords_sep,
pre.code .words_beg, pre.code .words_end, pre.code .words_sep,
pre.code .qsymbols_beg, pre.code .qsymbols_end, pre.code .qsymbols_sep,
pre.code .symbols_beg, pre.code .symbols_end, pre.code .symbols_sep,
pre.code .tstring, pre.code .dstring { color: #036A07; }
pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
pre.code .dot + pre.code .id,
pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
pre.code .comment { color: #0066FF; }
pre.code .const, pre.code .constant { color: #585CF6; }
pre.code .label,
pre.code .symbol { color: #C5060B; }
pre.code .kw,
pre.code .rubyid_require,
pre.code .rubyid_extend,
pre.code .rubyid_include { color: #0000FF; }
pre.code .ivar { color: #318495; }
pre.code .gvar,
pre.code .rubyid_backref,
pre.code .rubyid_nth_ref { color: #6D79DE; }
pre.code .regexp, .dregexp { color: #036A07; }
pre.code a { border-bottom: 1px dotted #bbf; }
/* inline code */
*:not(pre) > code {
padding: 1px 3px 1px 3px;
border: 1px solid #E1E1E8;
background: #F7F7F9;
border-radius: 4px;
}
/* Color fix for links */
#content .summary_desc pre.code .id > .object_link a, /* identifier */
#content .docstring pre.code .id > .object_link a { color: #0085FF; }
#content .summary_desc pre.code .const > .object_link a, /* constant */
#content .docstring pre.code .const > .object_link a { color: #585CF6; }

200
doc/file.README.html
View File

@ -1,200 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> &raquo;
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="the-strange-case-of-dr-rack-and-mr-hyde">The strange case of Dr. Rack and Mr. Hyde</h1>
<p>Hyde is a library that provides a DSL for creating web applications. As of now it is using Rack as the webserver adapter, but ideally it shouldn&#39;t take much work to make it run on top of any webserver.</p>
<p>Hyde was made mostly for fun. Ideally it will become something more, but as of yet it&#39;s just an experiment revolving around Ruby Metaprogramming and its DSL capabilities.</p>
<h1 id="examples">Examples</h1>
<p>A simple &quot;Hello, World!&quot; app using Hyde</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/hello</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Hello world!</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>A push/pull stack as an app</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/pop</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/push</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>Several push/pull buckets</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>3</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_path'>path</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bucket_(1|2|3)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pop</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_bucket'>bucket</span><span class='op'>|</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='lbracket'>[</span><span class='id identifier rubyid_bucket'>bucket</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>push</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_bucket'>bucket</span><span class='op'>|</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='lbracket'>[</span><span class='id identifier rubyid_bucket'>bucket</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>Static file serving
(Note: index applies <em>only</em> to /var/www (to the path its defined in))</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_root'>root</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/var/www</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_index'>index</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>index.html</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>index.htm</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_serve'>serve</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>**/*.(html|htm)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>Logging on a particular path</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_path'>path</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>unimportant</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1337 (the best one)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_path'>path</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>important</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_preprocess'>preprocess</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
<span class='comment'># Implement logging logic here
</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Client at </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>remote-addr</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> wanted to access something /important!</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>answer</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&quot;</span></span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;answer&quot;:42, &quot;desc&quot;:&quot;something important!&quot;}</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>And a lot more to be found in /examples in this repo.</p>
<h1 id="documentation">Documentation</h1>
<p>Someday it&#39;s gonna be there somewhere</p>
<h1 id="license">License</h1>
<pre class="code ruby"><code class="ruby"> Hyde - an HTTP request pattern matching system
Copyright (C) 2022 yessiest (yessiest@memeware.net)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
</code></pre>
</div></div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

56
doc/file_list.html
View File

@ -1,56 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8" />
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
<title>File List</title>
<base id="base_target" target="_parent" />
</head>
<body>
<div id="content">
<div class="fixed_header">
<h1 id="full_list_header">File List</h1>
<div id="full_list_nav">
<span><a target="_self" href="class_list.html">
Classes
</a></span>
<span><a target="_self" href="method_list.html">
Methods
</a></span>
<span><a target="_self" href="file_list.html">
Files
</a></span>
</div>
<div id="search">Search: <input type="text" /></div>
</div>
<ul id="full_list" class="file">
<li id="object_README" class="odd">
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
</li>
</ul>
</div>
</body>
</html>

17
doc/frames.html
View File

@ -1,17 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Documentation by YARD 0.9.34</title>
</head>
<script type="text/javascript">
var match = unescape(window.location.hash).match(/^#!(.+)/);
var name = match ? match[1] : 'index.html';
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
window.top.location = name;
</script>
<noscript>
<h1>Oops!</h1>
<h2>YARD requires JavaScript!</h2>
</noscript>
</html>

200
doc/index.html
View File

@ -1,200 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> &raquo;
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="the-strange-case-of-dr-rack-and-mr-hyde">The strange case of Dr. Rack and Mr. Hyde</h1>
<p>Hyde is a library that provides a DSL for creating web applications. As of now it is using Rack as the webserver adapter, but ideally it shouldn&#39;t take much work to make it run on top of any webserver.</p>
<p>Hyde was made mostly for fun. Ideally it will become something more, but as of yet it&#39;s just an experiment revolving around Ruby Metaprogramming and its DSL capabilities.</p>
<h1 id="examples">Examples</h1>
<p>A simple &quot;Hello, World!&quot; app using Hyde</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/hello</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Hello world!</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>A push/pull stack as an app</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/pop</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/push</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>Several push/pull buckets</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_stack'>stack</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>3</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_path'>path</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bucket_(1|2|3)</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>pop</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_bucket'>bucket</span><span class='op'>|</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='lbracket'>[</span><span class='id identifier rubyid_bucket'>bucket</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>push</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_bucket'>bucket</span><span class='op'>|</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_stack'>stack</span><span class='lbracket'>[</span><span class='id identifier rubyid_bucket'>bucket</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>Static file serving
(Note: index applies <em>only</em> to /var/www (to the path its defined in))</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_root'>root</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/var/www</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_index'>index</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>index.html</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>index.htm</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_serve'>serve</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>**/*.(html|htm)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>Logging on a particular path</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hyde</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_app'>app</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Hyde/Server.html" title="Hyde::Server (class)">Server</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Hyde/Server.html#initialize-instance_method" title="Hyde::Server#initialize (method)">new</a></span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_path'>path</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>unimportant</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>&quot;</span></span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1337 (the best one)</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_path'>path</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>important</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_preprocess'>preprocess</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_req'>req</span><span class='op'>|</span>
<span class='comment'># Implement logging logic here
</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Client at </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_req'>req</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>remote-addr</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> wanted to access something /important!</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_get'>get</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>answer</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_header'>header</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&quot;</span></span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{&quot;answer&quot;:42, &quot;desc&quot;:&quot;something important!&quot;}</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_run'>run</span> <span class='id identifier rubyid_app'>app</span>
</code></pre>
<p>And a lot more to be found in /examples in this repo.</p>
<h1 id="documentation">Documentation</h1>
<p>Someday it&#39;s gonna be there somewhere</p>
<h1 id="license">License</h1>
<pre class="code ruby"><code class="ruby"> Hyde - an HTTP request pattern matching system
Copyright (C) 2022 yessiest (yessiest@memeware.net)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
</code></pre>
</div></div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

314
doc/js/app.js
View File

@ -1,314 +0,0 @@
(function() {
var localStorage = {}, sessionStorage = {};
try { localStorage = window.localStorage; } catch (e) { }
try { sessionStorage = window.sessionStorage; } catch (e) { }
function createSourceLinks() {
$('.method_details_list .source_code').
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
$('.toggleSource').toggle(function() {
$(this).parent().nextAll('.source_code').slideDown(100);
$(this).text("Hide source");
},
function() {
$(this).parent().nextAll('.source_code').slideUp(100);
$(this).text("View source");
});
}
function createDefineLinks() {
var tHeight = 0;
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
$('.toggleDefines').toggle(function() {
tHeight = $(this).parent().prev().height();
$(this).prev().css('display', 'inline');
$(this).parent().prev().height($(this).parent().height());
$(this).text("(less)");
},
function() {
$(this).prev().hide();
$(this).parent().prev().height(tHeight);
$(this).text("more...");
});
}
function createFullTreeLinks() {
var tHeight = 0;
$('.inheritanceTree').toggle(function() {
tHeight = $(this).parent().prev().height();
$(this).parent().toggleClass('showAll');
$(this).text("(hide)");
$(this).parent().prev().height($(this).parent().height());
},
function() {
$(this).parent().toggleClass('showAll');
$(this).parent().prev().height(tHeight);
$(this).text("show all");
});
}
function searchFrameButtons() {
$('.full_list_link').click(function() {
toggleSearchFrame(this, $(this).attr('href'));
return false;
});
window.addEventListener('message', function(e) {
if (e.data === 'navEscape') {
$('#nav').slideUp(100);
$('#search a').removeClass('active inactive');
$(window).focus();
}
});
$(window).resize(function() {
if ($('#search:visible').length === 0) {
$('#nav').removeAttr('style');
$('#search a').removeClass('active inactive');
$(window).focus();
}
});
}
function toggleSearchFrame(id, link) {
var frame = $('#nav');
$('#search a').removeClass('active').addClass('inactive');
if (frame.attr('src') === link && frame.css('display') !== "none") {
frame.slideUp(100);
$('#search a').removeClass('active inactive');
}
else {
$(id).addClass('active').removeClass('inactive');
if (frame.attr('src') !== link) frame.attr('src', link);
frame.slideDown(100);
}
}
function linkSummaries() {
$('.summary_signature').click(function() {
document.location = $(this).find('a').attr('href');
});
}
function summaryToggle() {
$('.summary_toggle').click(function(e) {
e.preventDefault();
localStorage.summaryCollapsed = $(this).text();
$('.summary_toggle').each(function() {
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
var next = $(this).parent().parent().nextAll('ul.summary').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('ul.summary').first().toggle();
}
else if (next.hasClass('summary')) {
var list = $('<ul class="summary compact" />');
list.html(next.html());
list.find('.summary_desc, .note').remove();
list.find('a').each(function() {
$(this).html($(this).find('strong').html());
$(this).parent().html($(this)[0].outerHTML);
});
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage.summaryCollapsed == "collapse") {
$('.summary_toggle').first().click();
} else { localStorage.summaryCollapsed = "expand"; }
}
function constantSummaryToggle() {
$('.constants_summary_toggle').click(function(e) {
e.preventDefault();
localStorage.summaryCollapsed = $(this).text();
$('.constants_summary_toggle').each(function() {
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
var next = $(this).parent().parent().nextAll('dl.constants').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('dl.constants').first().toggle();
}
else if (next.hasClass('constants')) {
var list = $('<dl class="constants compact" />');
list.html(next.html());
list.find('dt').each(function() {
$(this).addClass('summary_signature');
$(this).text( $(this).text().split('=')[0]);
if ($(this).has(".deprecated").length) {
$(this).addClass('deprecated');
};
});
// Add the value of the constant as "Tooltip" to the summary object
list.find('pre.code').each(function() {
console.log($(this).parent());
var dt_element = $(this).parent().prev();
var tooltip = $(this).text();
if (dt_element.hasClass("deprecated")) {
tooltip = 'Deprecated. ' + tooltip;
};
dt_element.attr('title', tooltip);
});
list.find('.docstring, .tags, dd').remove();
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage.summaryCollapsed == "collapse") {
$('.constants_summary_toggle').first().click();
} else { localStorage.summaryCollapsed = "expand"; }
}
function generateTOC() {
if ($('#filecontents').length === 0) return;
var _toc = $('<ol class="top"></ol>');
var show = false;
var toc = _toc;
var counter = 0;
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
var i;
var curli;
if ($('#filecontents h1').length > 1) tags.unshift('h1');
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
var lastTag = parseInt(tags[0][1], 10);
$(tags.join(', ')).each(function() {
if ($(this).parents('.method_details .docstring').length != 0) return;
if (this.id == "filecontents") return;
show = true;
var thisTag = parseInt(this.tagName[1], 10);
if (this.id.length === 0) {
var proposedId = $(this).attr('toc-id');
if (typeof(proposedId) != "undefined") this.id = proposedId;
else {
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
this.id = proposedId;
}
}
if (thisTag > lastTag) {
for (i = 0; i < thisTag - lastTag; i++) {
if ( typeof(curli) == "undefined" ) {
curli = $('<li/>');
toc.append(curli);
}
toc = $('<ol/>');
curli.append(toc);
curli = undefined;
}
}
if (thisTag < lastTag) {
for (i = 0; i < lastTag - thisTag; i++) {
toc = toc.parent();
toc = toc.parent();
}
}
var title = $(this).attr('toc-title');
if (typeof(title) == "undefined") title = $(this).text();
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
toc.append(curli);
lastTag = thisTag;
});
if (!show) return;
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
$('#content').prepend(html);
$('#toc').append(_toc);
$('#toc .hide_toc').toggle(function() {
$('#toc .top').slideUp('fast');
$('#toc').toggleClass('hidden');
$('#toc .title small').toggle();
}, function() {
$('#toc .top').slideDown('fast');
$('#toc').toggleClass('hidden');
$('#toc .title small').toggle();
});
}
function navResizeFn(e) {
if (e.which !== 1) {
navResizeFnStop();
return;
}
sessionStorage.navWidth = e.pageX.toString();
$('.nav_wrap').css('width', e.pageX);
$('.nav_wrap').css('-ms-flex', 'inherit');
}
function navResizeFnStop() {
$(window).unbind('mousemove', navResizeFn);
window.removeEventListener('message', navMessageFn, false);
}
function navMessageFn(e) {
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
if (e.data.action === 'mouseup') navResizeFnStop();
}
function navResizer() {
$('#resizer').mousedown(function(e) {
e.preventDefault();
$(window).mousemove(navResizeFn);
window.addEventListener('message', navMessageFn, false);
});
$(window).mouseup(navResizeFnStop);
if (sessionStorage.navWidth) {
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
}
}
function navExpander() {
var done = false, timer = setTimeout(postMessage, 500);
function postMessage() {
if (done) return;
clearTimeout(timer);
var opts = { action: 'expand', path: pathId };
document.getElementById('nav').contentWindow.postMessage(opts, '*');
done = true;
}
window.addEventListener('message', function(event) {
if (event.data === 'navReady') postMessage();
return false;
}, false);
}
function mainFocus() {
var hash = window.location.hash;
if (hash !== '' && $(hash)[0]) {
$(hash)[0].scrollIntoView();
}
setTimeout(function() { $('#main').focus(); }, 10);
}
function navigationChange() {
// This works around the broken anchor navigation with the YARD template.
window.onpopstate = function() {
var hash = window.location.hash;
if (hash !== '' && $(hash)[0]) {
$(hash)[0].scrollIntoView();
}
};
}
$(document).ready(function() {
navResizer();
navExpander();
createSourceLinks();
createDefineLinks();
createFullTreeLinks();
searchFrameButtons();
linkSummaries();
summaryToggle();
constantSummaryToggle();
generateTOC();
mainFocus();
navigationChange();
});
})();

216
doc/js/full_list.js
View File

@ -1,216 +0,0 @@
(function() {
var $clicked = $(null);
var searchTimeout = null;
var searchCache = [];
var caseSensitiveMatch = false;
var ignoreKeyCodeMin = 8;
var ignoreKeyCodeMax = 46;
var commandKey = 91;
RegExp.escape = function(text) {
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
}
function escapeShortcut() {
$(document).keydown(function(evt) {
if (evt.which == 27) {
window.parent.postMessage('navEscape', '*');
}
});
}
function navResizer() {
$(window).mousemove(function(e) {
window.parent.postMessage({
action: 'mousemove', event: {pageX: e.pageX, which: e.which}
}, '*');
}).mouseup(function(e) {
window.parent.postMessage({action: 'mouseup'}, '*');
});
window.parent.postMessage("navReady", "*");
}
function clearSearchTimeout() {
clearTimeout(searchTimeout);
searchTimeout = null;
}
function enableLinks() {
// load the target page in the parent window
$('#full_list li').on('click', function(evt) {
$('#full_list li').removeClass('clicked');
$clicked = $(this);
$clicked.addClass('clicked');
evt.stopPropagation();
if (evt.target.tagName === 'A') return true;
var elem = $clicked.find('> .item .object_link a')[0];
var e = evt.originalEvent;
var newEvent = new MouseEvent(evt.originalEvent.type);
newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
elem.dispatchEvent(newEvent);
evt.preventDefault();
return false;
});
}
function enableToggles() {
// show/hide nested classes on toggle click
$('#full_list a.toggle').on('click', function(evt) {
evt.stopPropagation();
evt.preventDefault();
$(this).parent().parent().toggleClass('collapsed');
highlight();
});
}
function populateSearchCache() {
$('#full_list li .item').each(function() {
var $node = $(this);
var $link = $node.find('.object_link a');
if ($link.length > 0) {
searchCache.push({
node: $node,
link: $link,
name: $link.text(),
fullName: $link.attr('title').split(' ')[0]
});
}
});
}
function enableSearch() {
$('#search input').keyup(function(event) {
if (ignoredKeyPress(event)) return;
if (this.value === "") {
clearSearch();
} else {
performSearch(this.value);
}
});
$('#full_list').after("<div id='noresults' style='display:none'></div>");
}
function ignoredKeyPress(event) {
if (
(event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
(event.keyCode == commandKey)
) {
return true;
} else {
return false;
}
}
function clearSearch() {
clearSearchTimeout();
$('#full_list .found').removeClass('found').each(function() {
var $link = $(this).find('.object_link a');
$link.text($link.text());
});
$('#full_list, #content').removeClass('insearch');
$clicked.parents().removeClass('collapsed');
highlight();
}
function performSearch(searchString) {
clearSearchTimeout();
$('#full_list, #content').addClass('insearch');
$('#noresults').text('').hide();
partialSearch(searchString, 0);
}
function partialSearch(searchString, offset) {
var lastRowClass = '';
var i = null;
for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
var item = searchCache[i];
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
var matchString = buildMatchString(searchString);
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
if (searchName.match(matchRegexp) == null) {
item.node.removeClass('found');
item.link.text(item.link.text());
}
else {
item.node.addClass('found');
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
}
}
if(i == searchCache.length) {
searchDone();
} else {
searchTimeout = setTimeout(function() {
partialSearch(searchString, i);
}, 0);
}
}
function searchDone() {
searchTimeout = null;
highlight();
if ($('#full_list li:visible').size() === 0) {
$('#noresults').text('No results were found.').hide().fadeIn();
} else {
$('#noresults').text('').hide();
}
$('#content').removeClass('insearch');
}
function buildMatchString(searchString, event) {
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
var regexSearchString = RegExp.escape(searchString);
if (caseSensitiveMatch) {
regexSearchString += "|" +
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
join('.+?');
}
return regexSearchString;
}
function highlight() {
$('#full_list li:visible').each(function(n) {
$(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
});
}
/**
* Expands the tree to the target element and its immediate
* children.
*/
function expandTo(path) {
var $target = $(document.getElementById('object_' + path));
$target.addClass('clicked');
$target.removeClass('collapsed');
$target.parentsUntil('#full_list', 'li').removeClass('collapsed');
if($target[0]) {
window.scrollTo(window.scrollX, $target.offset().top - 250);
highlight();
}
}
function windowEvents(event) {
var msg = event.data;
if (msg.action === "expand") {
expandTo(msg.path);
}
return false;
}
window.addEventListener("message", windowEvents, false);
$(document).ready(function() {
escapeShortcut();
navResizer();
enableLinks();
enableToggles();
populateSearchCache();
enableSearch();
});
})();

4
doc/js/jquery.js vendored
View File

File diff suppressed because one or more lines are too long

1275
doc/method_list.html
View File

File diff suppressed because it is too large Load Diff

110
doc/top-level-namespace.html
View File

@ -1,110 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Top Level Namespace
&mdash; Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> &raquo;
<span class="title">Top Level Namespace</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Top Level Namespace
</h1>
<div class="box_info">
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Hyde.html" title="Hyde (module)">Hyde</a></span>
</p>
</div>
<div id="footer">
Generated on Sun Sep 17 00:23:45 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.0.6).
</div>
</div>
</body>
</html>

4
examples/buckets.ru
View File

@ -1,11 +1,11 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
stack = { "1" => [], "2" => [], "3" => [] }
app = Hyde::Server.new do
app = Landline::Server.new do
path "bucket_(1|2|3)" do
get "pop" do |bucket|
header "content-type", "text/plain"

10
examples/cookies/cookie.ru
View File

@ -1,18 +1,18 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'hyde/util/cookie'
require 'landline'
require 'landline/util/cookie'
app = Hyde::Server.new do
app = Landline::Server.new do
get "/set-cookie" do
header "set-cookie", Hyde::Cookie.new("test", (rand * 500).floor.to_s).to_s
cookie "test", (rand * 500).floor.to_s
header "content-type", "text/plain"
"Cookie set! Visit /get-cookie to view it"
end
get "/get-cookie" do
header "content-type", "text/plain"
request.headers["cookie"]&.pretty_inspect
request.cookies['test']&.pretty_inspect
end
end

4
examples/extension_testing/extension.ru
View File

@ -1,10 +1,10 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
require_relative 'external_methods'
app = Hyde::Server.new do
app = Landline::Server.new do
get "/hello" do
header "content-type", "text/plain"
do_hello()

2
examples/extension_testing/external_methods.rb
View File

@ -1,6 +1,6 @@
# frozen_string_literal: true
module Hyde
module Landline
module DSL
# Methods shared by probes, preprocessors and filters.
module CommonMethods

2
examples/extension_testing/readme.txt
View File

@ -1 +1 @@
Example of extending base Hyde functionality with additional DSL methods.
Example of extending base Landline functionality with additional DSL methods.

4
examples/form/form.ru
View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
root ENV["PWD"]
index ["index.html"]
post "/" do

2
examples/form/readme.txt
View File

@ -1 +1 @@
Example of handling forms in Hyde
Example of handling forms in Landline

4
examples/form2/form.ru
View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
root ENV["PWD"]
index ["index.html"]
post "/" do

2
examples/form2/readme.txt
View File

@ -1 +1 @@
Example of handling forms in Hyde
Example of handling forms in Landline

4
examples/helloworld.ru
View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
get "/hello" do
header "content-type", "text/plain"
"Hello World!"

4
examples/logging.ru
View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
path "unimportant" do
get "version" do
header "content-type", "text/plain"

6
examples/norxondor_gorgonax/config.ru
View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require_relative 'lib/hyde'
require_relative 'lib/landline'
app = Hyde::Server.new do
app = Landline::Server.new do
preprocess do |request|
puts "New request: #{request}"
end
@ -21,7 +21,7 @@ app = Hyde::Server.new do
You tried accessing #{suffix} at named param #{test}
Your request is a #{request} object
#{Hyde::VLINE}
#{Landline::VLINE}
RESPONSE
end
get "/bounce-random" do

4
examples/plugins/config.ru
View File

@ -1,9 +1,9 @@
# frozen_string_literal: true
$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
require 'hyde'
require 'landline'
app = Hyde::Server.new do
app = Landline::Server.new do
plugin "helloworld.ru"
end

Some files were not shown because too many files have changed in this diff Show More