RubyGems - utopia - Versions diffs - 2.13.4 → 2.14.0 - Mend

utopia 2.13.4 → 2.14.0

Files changed (353) hide show

data/docs/code/top-level-namespace.html DELETED

@@ -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.18
-</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  9 12:01:52 2019 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.18 (ruby-2.6.1).
-</div>
-    </div>
-  </body>
-</html>

data/docs/wiki.html DELETED

@@ -1,92 +0,0 @@
-<!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/javascript/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: 2019-03-09 11:28:57 +1300 —
-	</footer>
-		</div>
-	</body>
-</html>

data/docs/wiki/development-environment-setup/index.html DELETED

@@ -1,60 +0,0 @@
-<!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>

data/docs/wiki/edit.html DELETED

@@ -1,103 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-			<title>Editing Wiki</title>
-		<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>
-		<style type="text/css">
-			.editor form {
-				position: absolute;
-				display: flex;
-				flex-direction: column;
-				align-items: center;
-				width: 100%;
-				height: 100%;
-			}
-			.editor .header {
-				flex-grow: 0;
-				width: 100%;
-				display: flex;
-				justify-content: space-between;
-				align-items: center;
-				box-shadow: 0px 1px 0.5rem rgba(0, 0, 0, 0.5);
-				z-index: 10;
-			}
-			.editor .header * {
-				margin: 0.5rem;
-			}
-			.editor textarea {
-				flex-grow: 1;
-				width: 100%;
-				resize: none;
-				outline: none;
-				box-sizing: border-box;
-				margin: 0; padding: 0.5rem;
-				border: none;
-				background: none;
-			}
-		</style>
-	</head>
-	<body class="editor">
-	<form action="edit.html#" method="post">
-		<div class="header">
-			<div>Editing &quot;Wiki&quot;</div>
-			<input type="submit"/>
-		</div>
-		<textarea name="content"># Utopia Documentation Wiki
-This wiki includes documentation and examples showing how to use Utopia. You can also browse the [code documentation](/code/index.html) for more detail. Feel free to [edit](edit) any part of this documentation and submit a PR.
-## Introduction Guide
-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.
-- [Development Environment Setup](development-environment-setup/)
-- [Server Setup](server-setup/)
-- [Your First Page](your-first-page/)
-  - [What is `.xnode`?](faq/what-is-xnode/)
-- [Installing JavaScript Libraries](javascript/)
-- [Website Tests](testing/)
-- [Updating Your Site](updating-utopia/)
-## Middleware
-The following are Rack Middleware which provide the core of Utopia.
-- [Static](middleware/static/) — Serve static files efficiently.
-- [Redirection](middleware/redirection/) — Redirect URL patterns and status codes.
-- [Localization](middleware/localization/) — Non-intrusive localization of resources.
-- [Controller](middleware/controller/) — Flexible nested controllers with efficient behaviour.
-  - [Controller Actions](middleware/controller/actions/) — Invoke named actions.
-  - [Controller Rewrite](middleware/controller/rewrite/) — Pattern match requests.
-- [Content](middleware/content/) — XML-style template engine with dynamic markup.
-- [Session](middleware/session/) — Session storage using encrypted client-side cookies.
-## Examples
-Here are some open-source sites built on Utopia.
-- [www.codeotaku.com](http://www.codeotaku.com) ([source](https://github.com/ioquatix/www.codeotaku.com)) — Personal website, blog.
-- Financier ([source](https://github.com/ioquatix/financier)) — Small business management platform, invoicing.
-</textarea>
-	</form>
-	</body>
-</html>

data/docs/wiki/faq/what-is-xnode/index.html DELETED

@@ -1,79 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-			<title>What Is Xnode - 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>FAQ</span> › <a href="../what-is-xnode.html">What Is Xnode</a></nav>
-	<h1 id="what-is-xnode">What Is <code>.xnode</code>?</h1>
-<p>Xnodes are the files on disk which are used as part of Utopia’s content/view layer. Xnode templates are designed to maximise the ratio of content to markup. They improve separation of concerns and semantic organisation because repeated markup can be reused easily.</p>
-<p>Here is a example of a blog post:</p>
-<pre><code class="language-xml">&lt;content:entry title=&quot;My day as a fish&quot;&gt;
-	&lt;p&gt;It was not very exciting&lt;/p&gt;
-&lt;/content:entry&gt;
-</code></pre>
-<p>The <code>Utopia::Content</code> middleware is built on top of the <a href="https://github.com/ioquatix/trenni">Trenni</a> template language which uses two-phase evaluation.</p>
-<h2 id="phase-1-evaluation">Phase 1: Evaluation</h2>
-<p>Trenni processes the view content by evaluation <code>#{expressions}</code> and <code>&lt;?r statements ?&gt;</code>. This generates an output buffer. The output buffer should contain valid markup (i.e. balanced tags, no invalid characters).</p>
-<h2 id="phase-2-markup">Phase 2: Markup</h2>
-<p>Once the template is evaluated to text, it is parsed again into an event stream which is used to generate the final output. The event stream contains things like “open tag”, “attribute”, “close tag”, and so on, and these are fed into the <code>Utopia::Content</code> middleware which generates the actual content. Tags without namespaces are output verbatim, while tags with namespaces invoke the tag lookup machinery. This uses the tag name to invoke further behaviour, e.g. inserting more content. Here is a simple example of a basic page:</p>
-<pre><code class="language-xml">&lt;content:page&gt;
-	&lt;content:heading&gt;Welcome to my page&lt;/content:heading&gt;
-	&lt;p&gt;This page is so awesome&lt;/p&gt;
-&lt;/content:page&gt;
-</code></pre>
-<p>In order to render this, you will need two additional files, <code>_page.xnode</code> and <code>_heading.xnode</code>. As a short example, <code>_heading.xnode</code> might look like this:</p>
-<pre><code class="language-xml">&lt;h1&gt;&lt;utopia:content/&gt;&lt;/h1&gt;
-</code></pre>
-<p>When the parser encounters <code>&lt;content:heading&gt;...</code> in the main page, it would evaluate the above template. <code>&lt;utopia:content/&gt;</code> is a special tag that evaluates to the content that the parent tag provided, so in this case: <code>"Welcome to my page"</code>.  Thus, the final output is <code>&lt;h1&gt;Welcome to my page&lt;/h1&gt;</code>.</p>
-	<footer>
-		Last Modified: 2018-01-26 09:29:57 +1300 —
-	</footer>
-		</div>
-	</body>
-</html>

data/docs/wiki/javascript.html DELETED

@@ -1,153 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-			<title>Javascript - 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="javascript.html">JavaScript</a></nav>
-	<h1 id="yarn-integration">Yarn Integration</h1>
-<p>Utopia integrates with Yarn and provides a rake task to simplify deployment packages distributed using <code>yarn</code> that implement the <code>dist</code> sub-directory convention.</p>
-<p>By default, utopia includes a <code>.yarnrc</code> file which installs modules into <code>lib/components</code>. This code can then be copied into <code>public/_components</code> using <code>rake yarn:update</code>.</p>
-<h2 id="installing-yarn">Installing Yarn</h2>
-<p>If you don’t already have yarn installed, make sure you have npm installed and then run the following command:</p>
-<pre><code>$ sudo npm install -g yarn
-</code></pre>
-<h2 id="installing-jquery">Installing jQuery</h2>
-<p>Firstly, ensure your project has a <code>package.json</code> file:</p>
-<pre><code>$ yarn init
-</code></pre>
-<p>Then install jquery using <code>yarn</code>:</p>
-<pre><code>$ bower install jquery
-</code></pre>
-<p>Copy the distribution scripts to <code>public/_components</code>:</p>
-<pre><code>$ rake yarn:update
-</code></pre>
-<p>Then add the appropriate <code>&lt;script&gt;</code> tags to <code>pages/_page.xnode</code>:</p>
-<pre><code class="language-html">&lt;script type=&quot;text/javascript&quot; src=&quot;/_components/jquery/jquery.min.js&quot;&gt;&lt;/script&gt;
-</code></pre>
-<h3 id="what-does-rake-yarnupdate-do">What does <code>rake yarn:update</code> do?</h3>
-<p>This task copies only the contents of the <code>dist</code> 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>
-	<pre><code class="syntax brush-ruby">
-namespace :yarn do
-	desc 'Load the .bowerrc file and setup the environment for other tasks.'
-	task :environment do
-		@yarn_package_root = SITE_ROOT + &quot;lib/components&quot;
-		@yarn_install_root = SITE_ROOT + &quot;public/_components&quot;
-	end
-	desc 'Update the bower packages and link into the public directory.'
-	task :update =&gt; :environment do
-		require 'fileutils'
-		require 'utopia/path'
-		@yarn_package_root.children.select(&amp;:directory?).collect(&amp;:basename).each do |package_directory|
-			install_path = @yarn_install_root + package_directory
-			package_path = @yarn_package_root + package_directory
-			dist_path = package_path + 'dist'
-			FileUtils::Verbose.rm_rf install_path
-			FileUtils::Verbose.mkpath(install_path.dirname)
-			# If a package has a dist directory, we only symlink that... otherwise we have to do the entire package, and hope that bower's ignore was setup correctly:
-			if File.exist? dist_path
-				link_path = Utopia::Path.shortest_path(dist_path, install_path)
-			else
-				link_path = Utopia::Path.shortest_path(package_path, install_path)
-			end
-			FileUtils::Verbose.cp_r File.expand_path(link_path, install_path), install_path
-		end
-	end
-end
-</code></pre>
-<h2 id="using-javascript">Using JavaScript</h2>
-<p>You can use JavaScript by embedding it directly into your HTML, or by creating a JavaScript source file and referencing that.</p>
-<h3 id="embedding-code">Embedding Code</h3>
-<p>In your HTML view:</p>
-<pre><code class="language-trenni">&lt;html&gt;
-  &lt;body&gt;
-    &lt;script type=&quot;text/javascript&quot;&gt;
-      //&lt;![CDATA[
-      console.log(&quot;Hello World&quot;)
-      //]]&gt;
-    &lt;/script&gt;
-  &lt;/body&gt;
-&lt;/html&gt;
-</code></pre>
-<h3 id="external-script">External Script</h3>
-<p>In <code>script.js</code>:</p>
-<pre><code class="language-javascript">console.log("Hello World")
-</code></pre>
-<p>In your HTML view:</p>
-<pre><code class="language-trenni">&lt;html&gt;
-  &lt;body&gt;
-    &lt;script type=&quot;text/javascript&quot; src=&quot;script.js&quot;&gt;&lt;/script&gt;
-  &lt;/body&gt;
-&lt;/html&gt;
-</code></pre>
-	<footer>
-		Last Modified: 2019-03-09 11:29:35 +1300 —
-	</footer>
-		</div>
-	</body>
-</html>