RubyGems - utopia - Versions diffs - 2.2.0 → 2.3.0 - Mend

utopia 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (290) hide show

data/docs/wiki/middleware/controller/rewrite.html ADDED Viewed

@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Rewrite - Utopia</title>
+		<meta charset="UTF-8"/>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
+		<link rel="icon" type="image/png" href="../../../_static/icon.png"/>
+		<link rel="stylesheet" href="../../../_static/site.css" type="text/css" media="screen"/>
+		<script src="../../../_components/jquery/jquery.min.js"></script>
+		<script src="../../../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="">
+		<header>
+			<img src="../../../_static/utopia.svg"/>
+		</header>
+		<div id="page">
+	<nav>
+	 › <a href="../../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="../controller.html">Controller</a> › <a href="rewrite.html">Rewrite</a></nav>
+	<h1 id="controllerrewrite">Controller::Rewrite</h1>
+<p>The <code class="language-ruby">Controller::Rewrite</code> layer can match and rewrite requests before they processed. This allows you to handle URLs like <code>/post/15/view</code> or <code>/blog/123-pictures-of-my-cat</code> easily. The basic rewrite operation is to extract some part of the path and optionally executes a block. That means that the path is modified before being passed on to the next layer in the controller, and controller instance variables may be set.</p>
+<h2 id="regular-expressions">Regular Expressions</h2>
+<p>In your <code>controller.rb</code>:</p>
+<pre><code class="language-ruby">prepend Rewrite, Actions
+rewrite.extract_prefix permalink: /(?&lt;id&gt;\d+)-(?&lt;title&gt;.*)/ do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@permalink[:id])
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components &lt;&lt; &quot;post&quot;
+	end
+end
+on 'post' do
+	# You can do further processing here.
+	fail! unless @post.published?
+	@comments = @post.comments.first(5)
+end
+on 'edit' do
+	# You can do further processing here.
+	fail! unless @current_user&amp;.editor?
+end
+</code></pre>
+<p>In your <code>post.xnode</code>, as an example:</p>
+<pre><code class="language-trenni">&lt;content:page&gt;
+	&lt;content:heading&gt;Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}&lt;/content:heading&gt;
+	&lt;p&gt;#{attributes[:post].content}&lt;/p&gt;
+&lt;/content:page&gt;
+</code></pre>
+<p>Keep in mind, that URLs like <code>/123-pictures-of-my-cat/edit</code> will work as expected, and hit the <code>edit</code> action of the controller.</p>
+<h2 id="restful-resources">Restful Resources</h2>
+<p>Similar to the above, if we were solely interested in IDs, we could do the following:</p>
+<pre><code class="language-ruby">prepend Rewrite, Actions
+rewrite.extract_prefix post_id: Integer do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@post_id)
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components &lt;&lt; &quot;post&quot;
+	end
+end
+</code></pre>
+<p>This will only match complete integers. Assuming this code is in <code>/blog/controller.rb</code>, it would match something like <code>/blog/123/view</code> and assign <code class="language-ruby">Integer("123")</code> to <code class="language-ruby">@post_id</code>.</p>
+<h3 id="matching-other-things">Matching.. other things</h3>
+<p>It’s possible to match using <code class="language-ruby">Integer</code>, <code class="language-ruby">Float</code>, <code class="language-ruby">String</code>, and you can provide your own class which will be instantiated. If it doesn’t match, raise an exception and the rewrite rule will fail.</p>
+	<footer>
+		Last Modified: 2017-05-03 14:21:19 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/middleware/controller/rewrite/index.html ADDED Viewed

@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Rewrite - Utopia</title>
+		<meta charset="UTF-8"/>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
+		<link rel="icon" type="image/png" href="../../../../_static/icon.png"/>
+		<link rel="stylesheet" href="../../../../_static/site.css" type="text/css" media="screen"/>
+		<script src="../../../../_components/jquery/jquery.min.js"></script>
+		<script src="../../../../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="">
+		<header>
+			<img src="../../../../_static/utopia.svg"/>
+		</header>
+		<div id="page">
+	<nav>
+	 › <a href="../../../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="../../controller.html">Controller</a> › <a href="../rewrite.html">Rewrite</a></nav>
+	<h1 id="controllerrewrite">Controller::Rewrite</h1>
+<p>The <code class="language-ruby">Controller::Rewrite</code> layer can match and rewrite requests before they processed. This allows you to handle URLs like <code>/post/15/view</code> or <code>/blog/123-pictures-of-my-cat</code> easily. The basic rewrite operation is to extract some part of the path and optionally executes a block. That means that the path is modified before being passed on to the next layer in the controller, and controller instance variables may be set.</p>
+<h2 id="regular-expressions">Regular Expressions</h2>
+<p>In your <code>controller.rb</code>:</p>
+<pre><code class="language-ruby">prepend Rewrite, Actions
+rewrite.extract_prefix permalink: /(?&lt;id&gt;\d+)-(?&lt;title&gt;.*)/ do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@permalink[:id])
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components &lt;&lt; &quot;post&quot;
+	end
+end
+on 'post' do
+	# You can do further processing here.
+	fail! unless @post.published?
+	@comments = @post.comments.first(5)
+end
+on 'edit' do
+	# You can do further processing here.
+	fail! unless @current_user&amp;.editor?
+end
+</code></pre>
+<p>In your <code>post.xnode</code>, as an example:</p>
+<pre><code class="language-trenni">&lt;content:page&gt;
+	&lt;content:heading&gt;Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}&lt;/content:heading&gt;
+	&lt;p&gt;#{attributes[:post].content}&lt;/p&gt;
+&lt;/content:page&gt;
+</code></pre>
+<p>Keep in mind, that URLs like <code>/123-pictures-of-my-cat/edit</code> will work as expected, and hit the <code>edit</code> action of the controller.</p>
+<h2 id="restful-resources">Restful Resources</h2>
+<p>Similar to the above, if we were solely interested in IDs, we could do the following:</p>
+<pre><code class="language-ruby">prepend Rewrite, Actions
+rewrite.extract_prefix post_id: Integer do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@post_id)
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components &lt;&lt; &quot;post&quot;
+	end
+end
+</code></pre>
+<p>This will only match complete integers. Assuming this code is in <code>/blog/controller.rb</code>, it would match something like <code>/blog/123/view</code> and assign <code class="language-ruby">Integer("123")</code> to <code class="language-ruby">@post_id</code>.</p>
+<h3 id="matching-other-things">Matching.. other things</h3>
+<p>It’s possible to match using <code class="language-ruby">Integer</code>, <code class="language-ruby">Float</code>, <code class="language-ruby">String</code>, and you can provide your own class which will be instantiated. If it doesn’t match, raise an exception and the rewrite rule will fail.</p>
+	<footer>
+		Last Modified: 2017-05-03 14:21:19 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/middleware/localization.html ADDED Viewed

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Localization - Utopia</title>
+		<meta charset="UTF-8"/>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
+		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
+		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
+		<script src="../../_components/jquery/jquery.min.js"></script>
+		<script src="../../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="">
+		<header>
+			<img src="../../_static/utopia.svg"/>
+		</header>
+		<div id="page">
+	<nav>
+	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="localization.html">Localization</a></nav>
+	<h1 id="localization">Localization</h1>
+<p>The localization middleware uses the <code>Accept-Language</code> header to guess the preferred locale out of the given options. If a request path maps to a resource, that resource is returned. Otherwise, a localized request is made.</p>
+<pre><code class="language-ruby">use Utopia::Localization,
+	:default_locale =&gt; 'en',
+	:locales =&gt; ['en', 'de', 'ja', 'zh']
+</code></pre>
+<p>Somewhere further down the chain, you can localize a resource:</p>
+<pre><code class="language-ruby">localization = Utopia::Localization[request]
+show_welcome(localization.current_locale)
+</code></pre>
+	<footer>
+		Last Modified: 2017-05-03 14:21:19 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/middleware/localization/index.html ADDED Viewed

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Localization - Utopia</title>
+		<meta charset="UTF-8"/>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
+		<link rel="icon" type="image/png" href="../../../_static/icon.png"/>
+		<link rel="stylesheet" href="../../../_static/site.css" type="text/css" media="screen"/>
+		<script src="../../../_components/jquery/jquery.min.js"></script>
+		<script src="../../../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="">
+		<header>
+			<img src="../../../_static/utopia.svg"/>
+		</header>
+		<div id="page">
+	<nav>
+	 › <a href="../../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="../localization.html">Localization</a></nav>
+	<h1 id="localization">Localization</h1>
+<p>The localization middleware uses the <code>Accept-Language</code> header to guess the preferred locale out of the given options. If a request path maps to a resource, that resource is returned. Otherwise, a localized request is made.</p>
+<pre><code class="language-ruby">use Utopia::Localization,
+	:default_locale =&gt; 'en',
+	:locales =&gt; ['en', 'de', 'ja', 'zh']
+</code></pre>
+<p>Somewhere further down the chain, you can localize a resource:</p>
+<pre><code class="language-ruby">localization = Utopia::Localization[request]
+show_welcome(localization.current_locale)
+</code></pre>
+	<footer>
+		Last Modified: 2017-05-03 14:21:19 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/middleware/redirection.html ADDED Viewed

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Redirection - Utopia</title>
+		<meta charset="UTF-8"/>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
+		<link rel="icon" type="image/png" href="../../_static/icon.png"/>
+		<link rel="stylesheet" href="../../_static/site.css" type="text/css" media="screen"/>
+		<script src="../../_components/jquery/jquery.min.js"></script>
+		<script src="../../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="">
+		<header>
+			<img src="../../_static/utopia.svg"/>
+		</header>
+		<div id="page">
+	<nav>
+	 › <a href="../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="redirection.html">Redirection</a></nav>
+	<h1 id="redirection">Redirection</h1>
+<p>A set of flexible URI rewriting middleware which includes support for string mappings, regular expressions and status codes (e.g. 404 errors).</p>
+<pre><code class="language-ruby"># String (fast hash lookup) rewriting:
+use Utopia::Redirection::Rewrite,
+	'/' =&gt; '/welcome/index'
+# Redirect directories (e.g. /) to an index file (e.g. /index):
+use Utopia::Redirection::DirectoryIndex,
+	index: 'index.html'
+# Redirect (error) status codes to actual pages:
+use Utopia::Redirection::Errors,
+	404 =&gt; '/errors/file-not-found'
+</code></pre>
+	<footer>
+		Last Modified: 2016-12-13 12:37:11 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/middleware/redirection/index.html ADDED Viewed

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Redirection - Utopia</title>
+		<meta charset="UTF-8"/>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous"/>
+		<link rel="icon" type="image/png" href="../../../_static/icon.png"/>
+		<link rel="stylesheet" href="../../../_static/site.css" type="text/css" media="screen"/>
+		<script src="../../../_components/jquery/jquery.min.js"></script>
+		<script src="../../../_components/jquery-syntax/jquery.syntax.min.js"></script>
+		<script type="text/javascript">
+		//<![CDATA[
+			jQuery(function($) {
+				$.syntax();
+			});
+		//]]>
+		</script>
+	</head>
+	<body class="">
+		<header>
+			<img src="../../../_static/utopia.svg"/>
+		</header>
+		<div id="page">
+	<nav>
+	 › <a href="../../../wiki.html">Wiki</a> › <span>Middleware</span> › <a href="../redirection.html">Redirection</a></nav>
+	<h1 id="redirection">Redirection</h1>
+<p>A set of flexible URI rewriting middleware which includes support for string mappings, regular expressions and status codes (e.g. 404 errors).</p>
+<pre><code class="language-ruby"># String (fast hash lookup) rewriting:
+use Utopia::Redirection::Rewrite,
+	'/' =&gt; '/welcome/index'
+# Redirect directories (e.g. /) to an index file (e.g. /index):
+use Utopia::Redirection::DirectoryIndex,
+	index: 'index.html'
+# Redirect (error) status codes to actual pages:
+use Utopia::Redirection::Errors,
+	404 =&gt; '/errors/file-not-found'
+</code></pre>
+	<footer>
+		Last Modified: 2016-12-13 12:37:11 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>