io.aviso/rook 0.2.2

AvisoNovate · Dec 2, 2016 · d311016 · d311016
1 parent 6b4c8f0
commit d311016
Show file tree

Hide file tree

Showing 7 changed files with 169 additions and 50 deletions.
diff --git a/rook/css/default.css b/rook/css/default.css
@@ -21,6 +21,14 @@ h2 {
     font-size: 25px;
 }
 
+h5.license {
+    margin: 9px 0 22px 0;
+    color: #555;
+    font-weight: normal;
+    font-size: 12px;
+    font-style: italic;
+}
+
 .document h1, .namespace-index h1 {
     font-size: 32px;
     margin-top: 12px;
@@ -433,49 +441,56 @@ p {
 }
 
 .markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td {
-    line-height: 18px;
+    line-height: 22px;
+}
+
+.markdown li {
+    padding: 2px 0;
 }
 
 .markdown h2 {
     font-weight: normal;
     font-size: 25px;
+    margin: 30px 0 10px 0;
 }
 
-#content .markdown h3 {
+.markdown h3 {
+    font-weight: normal;
     font-size: 20px;
+    margin: 30px 0 0 0;
 }
 
 .markdown h4 {
     font-size: 15px;
+    margin: 22px 0 -4px 0;
 }
 
 .doc, .public, .namespace .index {
     max-width: 680px;
     overflow-x: visible;
 }
 
-.markdown code, .src-link a {
-    background: #f6f6f6;
+.markdown pre > code {
+    display: block;
+    padding: 10px;
+}
+
+.markdown pre > code, .src-link a {
     border: 1px solid #e4e4e4;
     border-radius: 2px;
 }
 
-.markdown pre, pre.deps {
-    background: #f4f4f4;
-    border: 1px solid #e0e0e0;
-    border-radius: 2px;
-    padding: 5px 10px;
-    margin: 15px 10px;
+.markdown code:not(.hljs), .src-link a {
+    background: #f6f6f6;
 }
 
 pre.deps {
     display: inline-block;
     margin: 0 10px;
-}
-
-.markdown pre code {
-    background: transparent;
-    border: none;
+    border: 1px solid #e4e4e4;
+    border-radius: 2px;
+    padding: 10px;
+    background-color: #f6f6f6;
 }
 
 .markdown hr {

diff --git a/rook/css/highlight.css b/rook/css/highlight.css
@@ -0,0 +1,97 @@
+/*
+github.com style (c) Vasily Polovnyov <[email protected]>
+*/
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  color: #333;
+  background: #f8f8f8;
+}
+
+.hljs-comment,
+.hljs-quote {
+  color: #998;
+  font-style: italic;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-subst {
+  color: #333;
+  font-weight: bold;
+}
+
+.hljs-number,
+.hljs-literal,
+.hljs-variable,
+.hljs-template-variable,
+.hljs-tag .hljs-attr {
+  color: #008080;
+}
+
+.hljs-string,
+.hljs-doctag {
+  color: #d14;
+}
+
+.hljs-title,
+.hljs-section,
+.hljs-selector-id {
+  color: #900;
+  font-weight: bold;
+}
+
+.hljs-subst {
+  font-weight: normal;
+}
+
+.hljs-type,
+.hljs-class .hljs-title {
+  color: #458;
+  font-weight: bold;
+}
+
+.hljs-tag,
+.hljs-name,
+.hljs-attribute {
+  color: #000080;
+  font-weight: normal;
+}
+
+.hljs-regexp,
+.hljs-link {
+  color: #009926;
+}
+
+.hljs-symbol,
+.hljs-bullet {
+  color: #990073;
+}
+
+.hljs-built_in,
+.hljs-builtin-name {
+  color: #0086b3;
+}
+
+.hljs-meta {
+  color: #999;
+  font-weight: bold;
+}
+
+.hljs-deletion {
+  background: #fdd;
+}
+
+.hljs-addition {
+  background: #dfd;
+}
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}
diff --git a/rook/index.html b/rook/index.html
@@ -1,3 +1,3 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<html><head><meta charset="UTF-8" /><link href="css/default.css" rel="stylesheet" type="text/css" /><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>Rook 0.2.1</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Rook</span> <span class="project-version">0.2.1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></li><li class="depth-3"><a href="io.aviso.rook.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rook</span></div></a></li><li class="depth-4"><a href="io.aviso.rook.interceptors.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>interceptors</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Rook</span> <span class="project-version">0.2.1</span></span></h1><div class="doc"><p>Smart namespace-driven routing for Pedestal.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[io.aviso/rook "0.2.1"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="io.aviso.rook.html">io.aviso.rook</a></h3><div class="doc"><div class="markdown"><p>Rook is used to map the functions of a namespace as web request endpoints, based largely on metadata on the functions.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.rook.html#var-default-arg-resolvers">default-arg-resolvers</a> </li><li> <a href="io.aviso.rook.html#var-default-options">default-options</a> </li><li> <a href="io.aviso.rook.html#var-gen-table-routes">gen-table-routes</a> </li><li> <a href="io.aviso.rook.html#var-meta-value-for-parameter">meta-value-for-parameter</a> </li><li> <a href="io.aviso.rook.html#var-non-nil-arg-resolver">non-nil-arg-resolver</a> </li><li> <a href="io.aviso.rook.html#var-standard-arg-resolver">standard-arg-resolver</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.rook.interceptors.html">io.aviso.rook.interceptors</a></h3><div class="doc"><div class="markdown"><p>Common interceptors used with Rook.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.rook.interceptors.html#var-keywordized-form">keywordized-form</a> </li></ul></div></div></div></body></html>
+<html><head><meta charset="UTF-8" /><title>Rook 0.2.2</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Rook</span> <span class="project-version">0.2.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></li><li class="depth-3"><a href="io.aviso.rook.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rook</span></div></a></li><li class="depth-4 branch"><a href="io.aviso.rook.arg-resolvers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>arg-resolvers</span></div></a></li><li class="depth-4"><a href="io.aviso.rook.interceptors.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>interceptors</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Rook</span> <span class="project-version">0.2.2</span></span></h1><h5 class="license">Released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Sofware License 2.0</a></h5><div class="doc"><p>Smart namespace-driven routing for Pedestal.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[io.aviso/rook "0.2.2"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="io.aviso.rook.html">io.aviso.rook</a></h3><div class="doc"><div class="markdown"><p>Rook is used to map the functions of a namespace as web request endpoints, based largely on metadata on the functions.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.rook.html#var-default-options">default-options</a> </li><li> <a href="io.aviso.rook.html#var-gen-table-routes">gen-table-routes</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.rook.arg-resolvers.html">io.aviso.rook.arg-resolvers</a></h3><div class="doc"><div class="markdown"><p>Built-in implementations and support functions for argument resolver generators.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.rook.arg-resolvers.html#var-default-arg-resolvers">default-arg-resolvers</a> </li><li> <a href="io.aviso.rook.arg-resolvers.html#var-inject-resolver">inject-resolver</a> </li><li> <a href="io.aviso.rook.arg-resolvers.html#var-meta-value-for-parameter">meta-value-for-parameter</a> </li><li> <a href="io.aviso.rook.arg-resolvers.html#var-non-nil-arg-resolver">non-nil-arg-resolver</a> </li><li> <a href="io.aviso.rook.arg-resolvers.html#var-standard-arg-resolver">standard-arg-resolver</a> </li></ul></div></div><div class="namespace"><h3><a href="io.aviso.rook.interceptors.html">io.aviso.rook.interceptors</a></h3><div class="doc"><div class="markdown"><p>Common interceptors used with Rook.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="io.aviso.rook.interceptors.html#var-keywordized-form">keywordized-form</a> </li></ul></div></div></div></body></html>
diff --git a/rook/io.aviso.rook.arg-resolvers.html b/rook/io.aviso.rook.arg-resolvers.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html PUBLIC ""
+    "">
+<html><head><meta charset="UTF-8" /><title>io.aviso.rook.arg-resolvers documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Rook</span> <span class="project-version">0.2.2</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aviso</span></div></div></li><li class="depth-3"><a href="io.aviso.rook.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rook</span></div></a></li><li class="depth-4 branch current"><a href="io.aviso.rook.arg-resolvers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>arg-resolvers</span></div></a></li><li class="depth-4"><a href="io.aviso.rook.interceptors.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>interceptors</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="io.aviso.rook.arg-resolvers.html#var-default-arg-resolvers"><div class="inner"><span>default-arg-resolvers</span></div></a></li><li class="depth-1"><a href="io.aviso.rook.arg-resolvers.html#var-inject-resolver"><div class="inner"><span>inject-resolver</span></div></a></li><li class="depth-1"><a href="io.aviso.rook.arg-resolvers.html#var-meta-value-for-parameter"><div class="inner"><span>meta-value-for-parameter</span></div></a></li><li class="depth-1"><a href="io.aviso.rook.arg-resolvers.html#var-non-nil-arg-resolver"><div class="inner"><span>non-nil-arg-resolver</span></div></a></li><li class="depth-1"><a href="io.aviso.rook.arg-resolvers.html#var-standard-arg-resolver"><div class="inner"><span>standard-arg-resolver</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">io.aviso.rook.arg-resolvers</h1><h4 class="added">added in 0.2.2</h4><div class="doc"><div class="markdown"><p>Built-in implementations and support functions for argument resolver generators.</p></div></div><div class="public anchor" id="var-default-arg-resolvers"><h3>default-arg-resolvers</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>Defines the following argument resolvers:</p>
+<dl>
+  <dt>:request
+  </dt>
+  <dd>The argument resolves to a key in the :request map.</dd>
+  <dd>An exception is thrown if the resolved value is nil.</dd>
+  <dt>:path-param
+  </dt>
+  <dd>The argument resolves to a path parameter.</dd>
+  <dd>An exception is thrown if the resolved value is nil.</dd>
+  <dt>:query-param
+  </dt>
+  <dd>The argument resolves to a query parameter, as applied by the  default io.pedestal.http.route/query-params interceptor.</dd>
+  <dt>:form-param
+  </dt>
+  <dd>As :query-param, but for the encoded form parameters.  Assumes the necessary middleware to process the body into form parameters  and keywordize the keys is present.</dd>
+</dl>
+<p>For these resolvers if the meta data value is exactly the value true (e.g., just using ^:request), then the effective value is a keyword generated from the parameter symbol.</p></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/rook/blob/master/src/io/aviso/rook/arg_resolvers.clj#L68">view source</a></div></div><div class="public anchor" id="var-inject-resolver"><h3>inject-resolver</h3><div class="usage"><code>(inject-resolver meta-key injections)</code></div><div class="doc"><div class="markdown"><p>For a given meta-data key and map of injections, returns an arg-resolver generator, wrapped in a map that can be merged with <a href="io.aviso.rook.arg-resolvers.html#var-default-arg-resolvers">default-arg-resolvers</a>.</p>
+<p>Parameters are converted to keys into the injections map. The injections map should use keyword keys.</p>
+<p>Will throw an exception if a parameter symbol fails to match a non-nil value in the injections map.</p></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/rook/blob/master/src/io/aviso/rook/arg_resolvers.clj#L96">view source</a></div></div><div class="public anchor" id="var-meta-value-for-parameter"><h3>meta-value-for-parameter</h3><div class="usage"><code>(meta-value-for-parameter sym meta-key)</code></div><div class="doc"><div class="markdown"><p>Given a parameter symbol and a metadata key, returns the value for that metadata key.</p>
+<p>It is presumed that the value is a keyword, though no check is made.</p>
+<p>When the metadata value is explicitly true, the symbol is converted into a simple (not namespaced) keyword.</p></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/rook/blob/master/src/io/aviso/rook/arg_resolvers.clj#L35">view source</a></div></div><div class="public anchor" id="var-non-nil-arg-resolver"><h3>non-nil-arg-resolver</h3><div class="usage"><code>(non-nil-arg-resolver sym ks)</code></div><div class="doc"><div class="markdown"><p>Returns an arg resolver that extracts a value nested in the context.</p>
+<p>The value must be non-nil, or an exception is thrown.</p>
+<dl>
+  <dt>sym</dt>
+  <dd>The symbol for which the argument resolver was created; identified in the exception.</dd>
+  <dt>ks</dt>
+  <dd>a sequence of keys.</dd>
+</dl></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/rook/blob/master/src/io/aviso/rook/arg_resolvers.clj#L5">view source</a></div></div><div class="public anchor" id="var-standard-arg-resolver"><h3>standard-arg-resolver</h3><div class="usage"><code>(standard-arg-resolver ks)</code></div><div class="doc"><div class="markdown"><p>Returns an arg resolver that extracts a value nested in the context.</p>
+<dl>
+  <dt>ks</dt>
+  <dd>A sequence of keys.</dd>
+</dl></div></div><div class="src-link"><a href="https://github.com/AvisoNovate/rook/blob/master/src/io/aviso/rook/arg_resolvers.clj#L25">view source</a></div></div></div></body></html>