reitit/coercion/clojure_spec_coercion.html
2018-08-27 12:55:55 +00:00

872 lines
24 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Clojure.spec · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../gitbook/style.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="data_spec_coercion.html" />
<link rel="prev" href="schema_coercion.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="../">
<a href="../">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="../basics/">
<a href="../basics/">
Basics
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="../basics/route_syntax.html">
<a href="../basics/route_syntax.html">
Route Syntax
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="../basics/router.html">
<a href="../basics/router.html">
Router
</a>
</li>
<li class="chapter " data-level="1.2.3" data-path="../basics/path_based_routing.html">
<a href="../basics/path_based_routing.html">
Path-based Routing
</a>
</li>
<li class="chapter " data-level="1.2.4" data-path="../basics/name_based_routing.html">
<a href="../basics/name_based_routing.html">
Name-based Routing
</a>
</li>
<li class="chapter " data-level="1.2.5" data-path="../basics/route_data.html">
<a href="../basics/route_data.html">
Route Data
</a>
</li>
<li class="chapter " data-level="1.2.6" data-path="../basics/route_data_validation.html">
<a href="../basics/route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="1.2.7" data-path="../basics/route_conflicts.html">
<a href="../basics/route_conflicts.html">
Route Conflicts
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="./">
<a href="./">
Coercion
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="coercion.html">
<a href="coercion.html">
Coercion Explained
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="schema_coercion.html">
<a href="schema_coercion.html">
Plumatic Schema
</a>
</li>
<li class="chapter active" data-level="1.3.3" data-path="clojure_spec_coercion.html">
<a href="clojure_spec_coercion.html">
Clojure.spec
</a>
</li>
<li class="chapter " data-level="1.3.4" data-path="data_spec_coercion.html">
<a href="data_spec_coercion.html">
Data-specs
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../ring/">
<a href="../ring/">
Ring
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="../ring/ring.html">
<a href="../ring/ring.html">
Ring-router
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="../ring/reverse_routing.html">
<a href="../ring/reverse_routing.html">
Reverse-routing
</a>
</li>
<li class="chapter " data-level="1.4.3" data-path="../ring/default_handler.html">
<a href="../ring/default_handler.html">
Default handler
</a>
</li>
<li class="chapter " data-level="1.4.4" data-path="../ring/static.html">
<a href="../ring/static.html">
Static Resources
</a>
</li>
<li class="chapter " data-level="1.4.5" data-path="../ring/dynamic_extensions.html">
<a href="../ring/dynamic_extensions.html">
Dynamic Extensions
</a>
</li>
<li class="chapter " data-level="1.4.6" data-path="../ring/data_driven_middleware.html">
<a href="../ring/data_driven_middleware.html">
Data-driven Middleware
</a>
</li>
<li class="chapter " data-level="1.4.7" data-path="../ring/transforming_middleware_chain.html">
<a href="../ring/transforming_middleware_chain.html">
Transforming Middleware Chain
</a>
</li>
<li class="chapter " data-level="1.4.8" data-path="../ring/middleware_registry.html">
<a href="../ring/middleware_registry.html">
Middleware Registry
</a>
</li>
<li class="chapter " data-level="1.4.9" data-path="../ring/default_middleware.html">
<a href="../ring/default_middleware.html">
Default Middleware
</a>
</li>
<li class="chapter " data-level="1.4.10" data-path="../ring/coercion.html">
<a href="../ring/coercion.html">
Pluggable Coercion
</a>
</li>
<li class="chapter " data-level="1.4.11" data-path="../ring/route_data_validation.html">
<a href="../ring/route_data_validation.html">
Route Data Validation
</a>
</li>
<li class="chapter " data-level="1.4.12" data-path="../ring/compiling_middleware.html">
<a href="../ring/compiling_middleware.html">
Compiling Middleware
</a>
</li>
<li class="chapter " data-level="1.4.13" data-path="../ring/swagger.html">
<a href="../ring/swagger.html">
Swagger Support
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="../advanced/">
<a href="../advanced/">
Advanced
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="../advanced/configuring_routers.html">
<a href="../advanced/configuring_routers.html">
Configuring Routers
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="../advanced/composing_routers.html">
<a href="../advanced/composing_routers.html">
Composing Routers
</a>
</li>
<li class="chapter " data-level="1.5.3" data-path="../advanced/different_routers.html">
<a href="../advanced/different_routers.html">
Different Routers
</a>
</li>
<li class="chapter " data-level="1.5.4" data-path="../advanced/route_validation.html">
<a href="../advanced/route_validation.html">
Route Validation
</a>
</li>
<li class="chapter " data-level="1.5.5" data-path="../advanced/dev_workflow.html">
<a href="../advanced/dev_workflow.html">
Dev Workflow
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.6" data-path="../patterns/">
<a href="../patterns/">
Patterns
</a>
<ul class="articles">
<li class="chapter " data-level="1.6.1" data-path="../patterns/shared_routes.html">
<a href="../patterns/shared_routes.html">
Shared Routes
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.7" data-path="../frontend/">
<a href="../frontend/">
Frontend
</a>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="../frontend/basics.html">
<a href="../frontend/basics.html">
Basics
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="../frontend/browser.html">
<a href="../frontend/browser.html">
Browser integration
</a>
</li>
<li class="chapter " data-level="1.7.3" data-path="../frontend/controllers.html">
<a href="../frontend/controllers.html">
Controllers (WIP)
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="../performance.html">
<a href="../performance.html">
Performance
</a>
</li>
<li class="chapter " data-level="1.9" data-path="../interceptors.html">
<a href="../interceptors.html">
Interceptors (WIP)
</a>
</li>
<li class="chapter " data-level="1.10" data-path="../development.html">
<a href="../development.html">
Development Instructions
</a>
</li>
<li class="chapter " data-level="1.11" data-path="../faq.html">
<a href="../faq.html">
FAQ
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href=".." >Clojure.spec</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="clojurespec-coercion">Clojure.spec Coercion</h1>
<p>The <a href="https://clojure.org/guides/spec" target="_blank">clojure.spec</a> library specifies the structure of data, validates or destructures it, and can generate data based on the spec.</p>
<p><strong>NOTE</strong>: Currently, <code>clojure.spec</code> <a href="https://dev.clojure.org/jira/browse/CLJ-2116" target="_blank">doesn&apos;t support runtime transformations via conforming</a>, so one needs to wrap all specs into <a href="https://github.com/metosin/spec-tools/blob/master/README.md#spec-records" target="_blank">Spec Records</a> to get the coercion working.</p>
<pre><code class="lang-clj">(<span class="hljs-name">require</span> &apos;[reitit.coercion.spec])
(<span class="hljs-name">require</span> &apos;[reitit.coercion <span class="hljs-symbol">:as</span> coercion])
(<span class="hljs-name">require</span> &apos;[spec-tools.spec <span class="hljs-symbol">:as</span> spec])
(<span class="hljs-name">require</span> &apos;[clojure.spec.alpha <span class="hljs-symbol">:as</span> s])
(<span class="hljs-name">require</span> &apos;[reitit.core <span class="hljs-symbol">:as</span> r])
<span class="hljs-comment">;; need to wrap the primitives!</span>
(<span class="hljs-name">s/def</span> <span class="hljs-symbol">::company</span> spec/string?)
(<span class="hljs-name">s/def</span> <span class="hljs-symbol">::user-id</span> spec/int?)
(<span class="hljs-name">s/def</span> <span class="hljs-symbol">::path-params</span> (<span class="hljs-name">s/keys</span> <span class="hljs-symbol">:req-un</span> [<span class="hljs-symbol">::company</span> <span class="hljs-symbol">::user-id</span>]))
(<span class="hljs-name"><span class="hljs-builtin-name">def</span></span> router
(<span class="hljs-name">r/router</span>
[<span class="hljs-string">&quot;/:company/users/:user-id&quot;</span> {<span class="hljs-symbol">:name</span> <span class="hljs-symbol">::user-view</span>
<span class="hljs-symbol">:coercion</span> reitit.coercion.spec/coercion
<span class="hljs-symbol">:parameters</span> {<span class="hljs-symbol">:path</span> <span class="hljs-symbol">::path-params</span>}}]
{<span class="hljs-symbol">:compile</span> coercion/compile-request-coercers}))
(<span class="hljs-name"><span class="hljs-builtin-name">defn</span></span> match-by-path-and-coerce! [path]
(<span class="hljs-name"><span class="hljs-builtin-name">if-let</span></span> [match (<span class="hljs-name">r/match-by-path</span> router path)]
(<span class="hljs-name"><span class="hljs-builtin-name">assoc</span></span> match <span class="hljs-symbol">:parameters</span> (<span class="hljs-name">coercion/coerce!</span> match))))
</code></pre>
<p>Successful coercion:</p>
<pre><code class="lang-clj">(<span class="hljs-name">match-by-path-and-coerce!</span> <span class="hljs-string">&quot;/metosin/users/123&quot;</span>)
<span class="hljs-comment">; #Match{:template &quot;/:company/users/:user-id&quot;,</span>
<span class="hljs-comment">; :data {:name :user/user-view,</span>
<span class="hljs-comment">; :coercion &lt;&lt;:spec&gt;&gt;</span>
<span class="hljs-comment">; :parameters {:path ::path-params}},</span>
<span class="hljs-comment">; :result {:path #object[reitit.coercion$request_coercer$]},</span>
<span class="hljs-comment">; :path-params {:company &quot;metosin&quot;, :user-id &quot;123&quot;},</span>
<span class="hljs-comment">; :parameters {:path {:company &quot;metosin&quot;, :user-id 123}}</span>
<span class="hljs-comment">; :path &quot;/metosin/users/123&quot;}</span>
</code></pre>
<p>Failing coercion:</p>
<pre><code class="lang-clj">(<span class="hljs-name">match-by-path-and-coerce!</span> <span class="hljs-string">&quot;/metosin/users/ikitommi&quot;</span>)
<span class="hljs-comment">; =&gt; ExceptionInfo Request coercion failed...</span>
</code></pre>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="schema_coercion.html" class="navigation navigation-prev " aria-label="Previous page: Plumatic Schema">
<i class="fa fa-angle-left"></i>
</a>
<a href="data_spec_coercion.html" class="navigation navigation-next " aria-label="Next page: Data-specs">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Clojure.spec","level":"1.3.3","depth":2,"next":{"title":"Data-specs","level":"1.3.4","depth":2,"path":"coercion/data_spec_coercion.md","ref":"coercion/data_spec_coercion.md","articles":[]},"previous":{"title":"Plumatic Schema","level":"1.3.2","depth":2,"path":"coercion/schema_coercion.md","ref":"coercion/schema_coercion.md","articles":[]},"dir":"ltr"},"config":{"plugins":["editlink","github","highlight"],"root":"doc","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"editlink":{"label":"Edit This Page","multilingual":false,"base":"https://github.com/metosin/reitit/tree/master/doc"},"github":{"url":"https://github.com/metosin/reitit"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"gitbook":"*"},"file":{"path":"coercion/clojure_spec_coercion.md","mtime":"2018-08-27T12:54:55.959Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-08-27T12:55:46.715Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
<script src="../gitbook/gitbook.js"></script>
<script src="../gitbook/theme.js"></script>
<script src="../gitbook/gitbook-plugin-editlink/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>