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/testing.html ADDED Viewed

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Testing - 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="testing.html">Testing</a></nav>
+	<h1 id="testing">Testing</h1>
+<p>Utopia websites include a default set of tests, and associated <code>rake test</code> tasks. These specs can test against the actual running website. By default, <code>simplecov</code> is included for coverage testing.</p>
+<pre><code class="language-bash">$ rake coverage test
+my website
+	should have an accessible front page
+Finished in 0.44849 seconds (files took 0.15547 seconds to load)
+1 example, 0 failures
+Coverage report generated for RSpec. 5 / 5 LOC (100.0%) covered.
+</code></pre>
+	<footer>
+		Last Modified: 2016-12-13 12:41:41 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/testing/index.html ADDED Viewed

@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Testing - 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="../testing.html">Testing</a></nav>
+	<h1 id="testing">Testing</h1>
+<p>Utopia websites include a default set of tests, and associated <code>rake test</code> tasks. These specs can test against the actual running website. By default, <code>simplecov</code> is included for coverage testing.</p>
+<pre><code class="language-bash">$ rake coverage test
+my website
+	should have an accessible front page
+Finished in 0.44849 seconds (files took 0.15547 seconds to load)
+1 example, 0 failures
+Coverage report generated for RSpec. 5 / 5 LOC (100.0%) covered.
+</code></pre>
+	<footer>
+		Last Modified: 2016-12-13 12:41:41 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/updating-utopia.html ADDED Viewed

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Updating Utopia - 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="updating-utopia.html">Updating Utopia</a></nav>
+	<h1 id="updating-utopia">Updating Utopia</h1>
+<p>Utopia provides a model for both local development (<code>utopia site create</code>) and deployment (<code>utopia server create</code>). In addition, Utopia provides a basic upgrade path for existing sites when things within the framework change. These are not always automatic, so below are some recipes for how to update your site.</p>
+<h2 id="site-update">Site Update</h2>
+<p>Utopia as a framework introduces changes and versions change according to semantic versioning.</p>
+<h3 id="controller-update-19x-to-2x">Controller Update 1.9.x to 2.x</h3>
+<p>The controller layer no longer automatically prepends the <code>Actions</code> layer. The following program does a best effort attempt to update existing controllers:</p>
+<pre><code class="language-ruby">#!/usr/bin/env ruby
+paths = Dir.glob("**/controller.rb")
+paths.each do |path|
+	lines = File.readlines(path)
+	prepend_line_index = lines.first(5).find_index{|line| line =~ /prepend/}
+	unless prepend_line_index
+		puts "Updating #{path}.."
+		File.open(path, "w") do |file|
+			file.puts "\nprepend Actions"
+			file.write lines.join
+		end
+	else
+		prepend_line = lines[prepend_line_index]
+		unless prepend_line =~ /Actions/
+			if lines.any?{|line| line =~ /on/}
+				lines[prepend_line_index] = "#{prepend_line.chomp}, Actions\n"
+				puts "Updating #{path}.."
+				File.open(path, "w") do |file|
+					file.write lines.join
+				end
+			end
+		end
+	end
+end
+</code></pre>
+<h3 id="view-update-19x-to-2x">View Update 1.9.x to 2.x</h3>
+<p>Dynamic tags in 2.x require namespaces. This affects all <code>.xnode</code> files, in particular the following 3 cases:</p>
+<ol>
+  <li>Rewrite <code>&lt;(/?)(NAME)(\W)</code> to <code>&lt;$1content:$2$3</code> where NAME is a tag which would expand using a <code>_NAME.xnode</code> file.</li>
+  <li>Rewrite <code>&lt;content/&gt;</code> to <code>&lt;utopia:content/&gt;</code>. This affects <code>&lt;node&gt;</code>, <code>&lt;deferred&gt;</code>, <code>&lt;environment&gt;</code> tags.</li>
+  <li>Rewrite <code>partial 'NAME'</code> to be <code>partial 'content:NAME'</code>.</li>
+</ol>
+<h2 id="server-update">Server Update</h2>
+<p>The utopia server git hooks are updated occasionally to improve the deployment process or to handle changes in the underlying process.</p>
+<p>You can run the update process on the server to bring the git hooks up to the latest version.</p>
+<pre><code class="language-bash">$ cd /srv/http/website
+$ utopia server update
+</code></pre>
+	<footer>
+		Last Modified: 2017-06-22 15:25:56 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/updating-utopia/index.html ADDED Viewed

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Updating Utopia - 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="../updating-utopia.html">Updating Utopia</a></nav>
+	<h1 id="updating-utopia">Updating Utopia</h1>
+<p>Utopia provides a model for both local development (<code>utopia site create</code>) and deployment (<code>utopia server create</code>). In addition, Utopia provides a basic upgrade path for existing sites when things within the framework change. These are not always automatic, so below are some recipes for how to update your site.</p>
+<h2 id="site-update">Site Update</h2>
+<p>Utopia as a framework introduces changes and versions change according to semantic versioning.</p>
+<h3 id="controller-update-19x-to-2x">Controller Update 1.9.x to 2.x</h3>
+<p>The controller layer no longer automatically prepends the <code>Actions</code> layer. The following program does a best effort attempt to update existing controllers:</p>
+<pre><code class="language-ruby">#!/usr/bin/env ruby
+paths = Dir.glob("**/controller.rb")
+paths.each do |path|
+	lines = File.readlines(path)
+	prepend_line_index = lines.first(5).find_index{|line| line =~ /prepend/}
+	unless prepend_line_index
+		puts "Updating #{path}.."
+		File.open(path, "w") do |file|
+			file.puts "\nprepend Actions"
+			file.write lines.join
+		end
+	else
+		prepend_line = lines[prepend_line_index]
+		unless prepend_line =~ /Actions/
+			if lines.any?{|line| line =~ /on/}
+				lines[prepend_line_index] = "#{prepend_line.chomp}, Actions\n"
+				puts "Updating #{path}.."
+				File.open(path, "w") do |file|
+					file.write lines.join
+				end
+			end
+		end
+	end
+end
+</code></pre>
+<h3 id="view-update-19x-to-2x">View Update 1.9.x to 2.x</h3>
+<p>Dynamic tags in 2.x require namespaces. This affects all <code>.xnode</code> files, in particular the following 3 cases:</p>
+<ol>
+  <li>Rewrite <code>&lt;(/?)(NAME)(\W)</code> to <code>&lt;$1content:$2$3</code> where NAME is a tag which would expand using a <code>_NAME.xnode</code> file.</li>
+  <li>Rewrite <code>&lt;content/&gt;</code> to <code>&lt;utopia:content/&gt;</code>. This affects <code>&lt;node&gt;</code>, <code>&lt;deferred&gt;</code>, <code>&lt;environment&gt;</code> tags.</li>
+  <li>Rewrite <code>partial 'NAME'</code> to be <code>partial 'content:NAME'</code>.</li>
+</ol>
+<h2 id="server-update">Server Update</h2>
+<p>The utopia server git hooks are updated occasionally to improve the deployment process or to handle changes in the underlying process.</p>
+<p>You can run the update process on the server to bring the git hooks up to the latest version.</p>
+<pre><code class="language-bash">$ cd /srv/http/website
+$ utopia server update
+</code></pre>
+	<footer>
+		Last Modified: 2017-06-22 15:25:56 +1200 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/your-first-page.html ADDED Viewed

@@ -0,0 +1,80 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Your First Page - 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="your-first-page.html">Your First Page</a></nav>
+	<h1 id="your-first-page">Your First Page</h1>
+<p>To setup the default site, simply create a directory and use the <code>utopia</code> command:</p>
+<pre><code class="language-bash">$ mkdir www.example.com
+$ cd www.example.com
+$ utopia site create
+$ rake server
+</code></pre>
+<p>You will now have a basic template site running on <code>http://localhost:9292</code>.</p>
+<h2 id="welcome-page">Welcome Page</h2>
+<p>Utopia includes a redirection middleware to redirect all root-level requests to a given URI. The default being <code>/welcome/index</code>:</p>
+<pre><code class="language-ruby"># in config.ru
+use Utopia::Redirection::Rewrite,
+	'/' =&gt; '/welcome/index'
+</code></pre>
+<p>This page includes a basic overview of Utopia. Most of it’s standard HTML, except for the outer <code>&lt;content:page&gt;</code> tag. Utopia uses the name <code>page</code> to lookup the file-system hierarchy. First, it looks for <code>/welcome/_page.xnode</code>, and then it looks for <code>/_page.xnode</code> which it finds. This page template includes a tag <code>&lt;utopia:content/&gt;</code> which is replaced with the inner body of the <code>&lt;content:page&gt;</code> tag. This recursive lookup is the heart of Utopia.</p>
+<h2 id="links">Links</h2>
+<p>Utopia is a content-centric web application platform. It leverages the file-system to provide a mapping between logical resources and files on disk. The primary mode of mapping incoming requests to specific nodes (content) is done using the <code>links.yaml</code> file.</p>
+<p>The links file associates metadata with node names for a given directory. This can include things like redirects, titles, descriptions, etc. You can add any metadata you like, to support your specific use-case. The primary use of the links files is to provide site structure, e.g. menus. In addition, they can function as a rudimentary data-store for static information, e.g. a list of applications (each with it’s own page), a list of features, etc.</p>
+<p>You’ll notice that there is a file <code>/links.yaml</code>. This file contains important metadata relating to the <code>errors</code> subdirectory. As we don’t want these nodes showing up in a top level menu, we mark them as <code>display: false</code></p>
+<pre><code class="language-yaml">errors:
+    display: false
+</code></pre>
+	<footer>
+		Last Modified: 2017-11-11 02:12:21 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>

data/docs/wiki/your-first-page/index.html ADDED Viewed

@@ -0,0 +1,80 @@
+<!DOCTYPE html>
+<html>
+	<head>
+			<title>Your First Page - 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="../your-first-page.html">Your First Page</a></nav>
+	<h1 id="your-first-page">Your First Page</h1>
+<p>To setup the default site, simply create a directory and use the <code>utopia</code> command:</p>
+<pre><code class="language-bash">$ mkdir www.example.com
+$ cd www.example.com
+$ utopia site create
+$ rake server
+</code></pre>
+<p>You will now have a basic template site running on <code>http://localhost:9292</code>.</p>
+<h2 id="welcome-page">Welcome Page</h2>
+<p>Utopia includes a redirection middleware to redirect all root-level requests to a given URI. The default being <code>/welcome/index</code>:</p>
+<pre><code class="language-ruby"># in config.ru
+use Utopia::Redirection::Rewrite,
+	'/' =&gt; '/welcome/index'
+</code></pre>
+<p>This page includes a basic overview of Utopia. Most of it’s standard HTML, except for the outer <code>&lt;content:page&gt;</code> tag. Utopia uses the name <code>page</code> to lookup the file-system hierarchy. First, it looks for <code>/welcome/_page.xnode</code>, and then it looks for <code>/_page.xnode</code> which it finds. This page template includes a tag <code>&lt;utopia:content/&gt;</code> which is replaced with the inner body of the <code>&lt;content:page&gt;</code> tag. This recursive lookup is the heart of Utopia.</p>
+<h2 id="links">Links</h2>
+<p>Utopia is a content-centric web application platform. It leverages the file-system to provide a mapping between logical resources and files on disk. The primary mode of mapping incoming requests to specific nodes (content) is done using the <code>links.yaml</code> file.</p>
+<p>The links file associates metadata with node names for a given directory. This can include things like redirects, titles, descriptions, etc. You can add any metadata you like, to support your specific use-case. The primary use of the links files is to provide site structure, e.g. menus. In addition, they can function as a rudimentary data-store for static information, e.g. a list of applications (each with it’s own page), a list of features, etc.</p>
+<p>You’ll notice that there is a file <code>/links.yaml</code>. This file contains important metadata relating to the <code>errors</code> subdirectory. As we don’t want these nodes showing up in a top level menu, we mark them as <code>display: false</code></p>
+<pre><code class="language-yaml">errors:
+    display: false
+</code></pre>
+	<footer>
+		Last Modified: 2017-11-11 02:12:21 +1300 —
+	</footer>
+		</div>
+	</body>
+</html>