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

utopia 2.2.0 → 2.3.0

Files changed (290) hide show

data/docs/code/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!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.12
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  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="Utopia.html" title="Utopia (module)">Utopia</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Sat Mar 24 21:17:19 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.12 (ruby-2.5.0).
+</div>
+    </div>
+  </body>
+</html>

data/docs/index.html ADDED Viewed

@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Wiki - 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></nav>
+	<h1 id="utopia-documentation-wiki">Utopia Documentation Wiki</h1>
+<p>This wiki includes documentation and examples showing how to use Utopia. You can also browse the <a href="code/index.html">code documentation</a> for more detail. Feel free to <a href="wiki/edit.html">edit</a> any part of this documentation and submit a PR.</p>
+<h2 id="introduction-guide">Introduction Guide</h2>
+<p>Reading these pages in order will give you an overview of the design of Utopia, how to set it up for local development and how to deploy it.</p>
+<ul>
+  <li><a href="wiki/development-environment-setup/index.html">Development Environment Setup</a></li>
+  <li><a href="wiki/server-setup/index.html">Server Setup</a></li>
+  <li><a href="wiki/your-first-page/index.html">Your First Page</a>
+    <ul>
+      <li><a href="wiki/faq/what-is-xnode/index.html">What is <code>.xnode</code>?</a></li>
+    </ul>
+  </li>
+  <li><a href="wiki/bower-integration/index.html">Installing JavaScript Libraries</a></li>
+  <li><a href="wiki/testing/index.html">Website Tests</a></li>
+  <li><a href="wiki/updating-utopia/index.html">Updating Your Site</a></li>
+</ul>
+<h2 id="middleware">Middleware</h2>
+<p>The following are Rack Middleware which provide the core of Utopia.</p>
+<ul>
+  <li><a href="wiki/middleware/static/index.html">Static</a> — Serve static files efficiently.</li>
+  <li><a href="wiki/middleware/redirection/index.html">Redirection</a> — Redirect URL patterns and status codes.</li>
+  <li><a href="wiki/middleware/localization/index.html">Localization</a> — Non-intrusive localization of resources.</li>
+  <li><a href="wiki/middleware/controller/index.html">Controller</a> — Flexible nested controllers with efficient behaviour.
+    <ul>
+      <li><a href="wiki/middleware/controller/actions/index.html">Controller Actions</a> — Invoke named actions.</li>
+      <li><a href="wiki/middleware/controller/rewrite/index.html">Controller Rewrite</a> — Pattern match requests.</li>
+    </ul>
+  </li>
+  <li><a href="wiki/middleware/content/index.html">Content</a> — XML-style template engine with dynamic markup.</li>
+  <li><a href="wiki/middleware/session/index.html">Session</a> — Session storage using encrypted client-side cookies.</li>
+</ul>
+<h2 id="examples">Examples</h2>
+<p>Here are some open-source sites built on Utopia.</p>
+<ul>
+  <li><a href="http://www.codeotaku.com">www.codeotaku.com</a> (<a href="https://github.com/ioquatix/www.codeotaku.com">source</a>) — Personal website, blog.</li>
+  <li>Financier (<a href="https://github.com/ioquatix/financier">source</a>) — Small business management platform, invoicing.</li>
+</ul>
+	<footer>
+		Last Modified: 2018-01-26 09:29:57 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki.html ADDED Viewed

@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Wiki - 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></nav>
+	<h1 id="utopia-documentation-wiki">Utopia Documentation Wiki</h1>
+<p>This wiki includes documentation and examples showing how to use Utopia. You can also browse the <a href="code/index.html">code documentation</a> for more detail. Feel free to <a href="wiki/edit.html">edit</a> any part of this documentation and submit a PR.</p>
+<h2 id="introduction-guide">Introduction Guide</h2>
+<p>Reading these pages in order will give you an overview of the design of Utopia, how to set it up for local development and how to deploy it.</p>
+<ul>
+  <li><a href="wiki/development-environment-setup/index.html">Development Environment Setup</a></li>
+  <li><a href="wiki/server-setup/index.html">Server Setup</a></li>
+  <li><a href="wiki/your-first-page/index.html">Your First Page</a>
+    <ul>
+      <li><a href="wiki/faq/what-is-xnode/index.html">What is <code>.xnode</code>?</a></li>
+    </ul>
+  </li>
+  <li><a href="wiki/bower-integration/index.html">Installing JavaScript Libraries</a></li>
+  <li><a href="wiki/testing/index.html">Website Tests</a></li>
+  <li><a href="wiki/updating-utopia/index.html">Updating Your Site</a></li>
+</ul>
+<h2 id="middleware">Middleware</h2>
+<p>The following are Rack Middleware which provide the core of Utopia.</p>
+<ul>
+  <li><a href="wiki/middleware/static/index.html">Static</a> — Serve static files efficiently.</li>
+  <li><a href="wiki/middleware/redirection/index.html">Redirection</a> — Redirect URL patterns and status codes.</li>
+  <li><a href="wiki/middleware/localization/index.html">Localization</a> — Non-intrusive localization of resources.</li>
+  <li><a href="wiki/middleware/controller/index.html">Controller</a> — Flexible nested controllers with efficient behaviour.
+    <ul>
+      <li><a href="wiki/middleware/controller/actions/index.html">Controller Actions</a> — Invoke named actions.</li>
+      <li><a href="wiki/middleware/controller/rewrite/index.html">Controller Rewrite</a> — Pattern match requests.</li>
+    </ul>
+  </li>
+  <li><a href="wiki/middleware/content/index.html">Content</a> — XML-style template engine with dynamic markup.</li>
+  <li><a href="wiki/middleware/session/index.html">Session</a> — Session storage using encrypted client-side cookies.</li>
+</ul>
+<h2 id="examples">Examples</h2>
+<p>Here are some open-source sites built on Utopia.</p>
+<ul>
+  <li><a href="http://www.codeotaku.com">www.codeotaku.com</a> (<a href="https://github.com/ioquatix/www.codeotaku.com">source</a>) — Personal website, blog.</li>
+  <li>Financier (<a href="https://github.com/ioquatix/financier">source</a>) — Small business management platform, invoicing.</li>
+</ul>
+	<footer>
+		Last Modified: 2018-01-26 09:29:57 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/bower-integration.html ADDED Viewed

@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Bower Integration - 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> › <a href="bower-integration.html">Bower Integration</a></nav>
+	<h1 id="bower-integration">Bower Integration</h1>
+<p>Utopia integrates with Bower and provides a rake task to improve deployment of <code>dist</code> code.</p>
+<p>By default, utopia includes a <code>.bowerrc</code> file which installs modules into <code>lib/components</code>. This code can then be copied into <code>public/_components</code> using <code>rake bower:update</code>.</p>
+<h2 id="installing-jquery">Installing jQuery</h2>
+<p>Firstly install jquery using bower:</p>
+<pre><code>$ bower install jquery
+</code></pre>
+<p>Copy the distribution scripts to <code>public/_components</code>:</p>
+<pre><code>$ rake bower:update
+</code></pre>
+<p>Then add the appropriate <code>&lt;script&gt;</code> tags to <code>pages/_page.xnode</code>:</p>
+<pre><code>&lt;script src=&quot;/_components/jquery/jquery.min.js&quot; type=&quot;text/javascript&quot;&gt;&lt;/script&gt;
+</code></pre>
+<h2 id="what-does-rake-bowerupdate-do">What does <code>rake bower:update</code> do?</h2>
+<p>This task copies only the contents of the dist directory. This ensures that you only get files intended for distribution. If the bower package doesn’t have a <code>dist</code> directory, the entire contents is copied.</p>
+<fragment:listing rel="site" src="tasks/bower.rake" brush="ruby"/>
+	<footer>
+		Last Modified: 2017-05-03 14:21:19 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/bower-integration/index.html ADDED Viewed

@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Bower Integration - 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> › <a href="../bower-integration.html">Bower Integration</a></nav>
+	<h1 id="bower-integration">Bower Integration</h1>
+<p>Utopia integrates with Bower and provides a rake task to improve deployment of <code>dist</code> code.</p>
+<p>By default, utopia includes a <code>.bowerrc</code> file which installs modules into <code>lib/components</code>. This code can then be copied into <code>public/_components</code> using <code>rake bower:update</code>.</p>
+<h2 id="installing-jquery">Installing jQuery</h2>
+<p>Firstly install jquery using bower:</p>
+<pre><code>$ bower install jquery
+</code></pre>
+<p>Copy the distribution scripts to <code>public/_components</code>:</p>
+<pre><code>$ rake bower:update
+</code></pre>
+<p>Then add the appropriate <code>&lt;script&gt;</code> tags to <code>pages/_page.xnode</code>:</p>
+<pre><code>&lt;script src=&quot;/_components/jquery/jquery.min.js&quot; type=&quot;text/javascript&quot;&gt;&lt;/script&gt;
+</code></pre>
+<h2 id="what-does-rake-bowerupdate-do">What does <code>rake bower:update</code> do?</h2>
+<p>This task copies only the contents of the dist directory. This ensures that you only get files intended for distribution. If the bower package doesn’t have a <code>dist</code> directory, the entire contents is copied.</p>
+<fragment:listing rel="site" src="tasks/bower.rake" brush="ruby"/>
+	<footer>
+		Last Modified: 2017-05-03 14:21:19 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/development-environment-setup.html ADDED Viewed

@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Development Environment Setup - 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> › <a href="development-environment-setup.html">Development Environment Setup</a></nav>
+	<h1 id="development-environment-setup">Development Environment Setup</h1>
+<p>Utopia is built on Ruby and Rack. Therefore, Ruby (suggested 2.0+) should be installed and working. Then, simply run:</p>
+<pre><code class="language-bash">$ gem install utopia
+</code></pre>
+<p>To install all required dependencies.</p>
+<p>Utopia and it’s dependencies are built on Linux and Mac by default, and therefore compatibility with Windows is not guaranteed.</p>
+<h2 id="atom-integration">Atom Integration</h2>
+<p>Utopia uses <a href="https://github.com/ioquatix/trenni">Trenni</a> for templates and it has a syntax slightly different from ERB. However, there is a <a href="https://atom.io/packages/language-trenni">package for Atom</a> which provides accurate syntax highlighting.</p>
+	<footer>
+		Last Modified: 2016-12-07 17:37:12 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>