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/wiki/javascript/index.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>

data/docs/wiki/middleware/content/index.html DELETED

@@ -1,64 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-			<title>Content - 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="../content.html">Content</a></nav>
-	<h1 id="content">Content</h1>
-<p>A tag based content generation system which integrates nicely with HTML5. Supports structures which separate generic page templates from dynamically generated content in an easy and consistent way.</p>
-<pre><code class="language-ruby">use Utopia::Content,
-	cache_templates: (RACK_ENV == :production)
-</code></pre>
-<p>A basic template <code>create.xnode</code> looks something like:</p>
-<pre><code class="language-trenni">&lt;content:page&gt;
-	&lt;content:heading&gt;Create User&lt;/content:heading&gt;
-	&lt;form action=&quot;#&quot;&gt;
-		&lt;input name=&quot;name&quot; /&gt;
-		&lt;input type=&quot;submit&quot; /&gt;
-	&lt;/form&gt;
-&lt;/content:page&gt;
-</code></pre>
-<p>This template would typically be designed with supporting <code>_page.xnode</code> and <code>_heading.xnode</code> in the same directory or, more typically, somewhere further up the directory hierarchy.</p>
-	<footer>
-		Last Modified: 2017-05-03 14:21:19 +1200 —
-	</footer>
-		</div>
-	</body>
-</html>

data/docs/wiki/middleware/controller/actions/index.html DELETED

@@ -1,117 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-			<title>Actions - 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="../actions.html">Actions</a></nav>
-	<h1 id="controlleractions">Controller::Actions</h1>
-<p>Actions let you match path patterns in your controller and execute code. In your <code>controller.rb</code> simply add:</p>
-<pre><code class="language-ruby">prepend Actions
-</code></pre>
-<p>If you are adding multiple things, like rewriting, they should come earlier in the chain, e.g:</p>
-<pre><code class="language-ruby">prepend Rewrite, Actions
-</code></pre>
-<p>A simple CRUD controller might look like:</p>
-<pre><code class="language-ruby">prepend Actions
-on 'index' do
-	@users = User.all
-end
-on 'new' do |request|
-	@user = User.new
-	if request.post?
-		@user.update_attributes(request.params['user'])
-		redirect! "index"
-	end
-end
-on 'edit' do |request|
-	@user = User.find(request.params['id'])
-	if request.post?
-		@user.update_attributes(request.params['user'])
-		redirect! "index"
-	end
-end
-on 'delete' do |request|
-	User.find(request.params['id']).destroy
-	redirect! "index"
-end
-</code></pre>
-<h2 id="path-matching">Path Matching</h2>
-<p>Path matching works from right to left, and ‘**’ is a greedy operator. Controllers are invoked with a path relative to the controller’s <code>URI_PATH</code>, so all lookups are relative to the controller.</p>
-<dl>
-	<dt><code class="language-ruby">"*"</code></dt>
-	<dd>Match a single path element</dd>
-	<dt><code class="language-ruby">"**"</code></dt>
-	<dd>Match all remaining path elements</dd>
-	<dt><code class="language-ruby">String</code></dt>
-	<dd>Match a named path component, e.g. <code class="language-ruby">"edit"</code>.</dd>
-	<dt><code class="language-ruby">Symbol</code></dt>
-	<dd>Equivalent to <code class="language-ruby">["**", symbol.to_s]</code>, e.g. <code class="language-ruby">:logout</code>.</dd>
-</dl>
-<h2 id="otherwise-matching">Otherwise Matching</h2>
-<p>If no action was matched, it is sometimes useful to perform some specific behaviour. You can specify this by using the otherwise handler:</p>
-<pre><code class="language-ruby">otherwise do |request, path|
-	fail! :teapot
-end
-</code></pre>
-<p>If you are doing this to perform some kind of rewriting, it may be preferable to use the <a href="rewrite/index.html">Rewrite</a> controller layer.</p>
-	<footer>
-		Last Modified: 2017-05-03 14:21:19 +1200 —
-	</footer>
-		</div>
-	</body>
-</html>

data/docs/wiki/middleware/controller/actions/rewrite/index.html DELETED

@@ -1,48 +0,0 @@
-<!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="../../actions.html">Actions</a></nav>
-	<h1 id="rewrite">Rewrite</h1>
-<p>This page is empty.</p>
-	<footer>
-		Last Modified: N/A —
-	</footer>
-		</div>
-	</body>
-</html>

data/docs/wiki/middleware/controller/index.html DELETED

@@ -1,104 +0,0 @@
-<!DOCTYPE html>
-<html>
-	<head>
-			<title>Controller - 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></nav>
-	<h1 id="controller">Controller</h1>
-<p>A simple recursive controller layer which works in isolation from the view rendering middleware.</p>
-<pre><code class="language-ruby">use Utopia::Controller,
-	# The root directory where `controller.rb` files can be found.
-	root: 'path/to/root',
-	# The base class to use for all controllers:
-	base: Utopia::Controller::Base,
-	# Whether or not to cache controller classes:
-	cache_controllers: (RACK_ENV == :production)
-</code></pre>
-<p>A controller is a file within the root directory (or subdirectory) with the name <code>controller.rb</code>. This code is dynamically loaded into an anonymous class and executed. The default controller has only a single function:</p>
-<pre><code class="language-ruby">def passthrough(request, path)
-	# Call one of:
-	# This will cause the middleware to generate a response.
-	# def respond!(response)
-	# This will cause the controller to skip the request.
-	# def ignore!
-	# Request relative redirect. Respond with a redirect to the given target.
-	# def redirect! (target, status = 302)
-	# Controller relative redirect.
-	# def goto!(target, status = 302)
-	# Respond with an error which indiciates some kind of failure.
-	# def fail!(error = 400, message = nil)
-	# Succeed the request and immediately respond.
-	# def succeed!(status: 200, headers: {}, **options)
-	# options may include content: string or body: Enumerable (as per Rack specifications
-end
-</code></pre>
-<p>The controller layer can do more complex operations by prepending modules into it.</p>
-<pre><code class="language-ruby">prepend Rewrite, Actions
-# Extracts an Integer
-rewrite.extract_prefix id: Integer do
-	@user = User.find_by_id(@id)
-end
-on 'edit' do |request, path|
-	if request.post?
-		@user.update_attributes(request[:user])
-	end
-end
-otherwise do |request, path|
-	# Executed if no specific named actions were executed.
-	succeed!
-end
-</code></pre>
-	<footer>
-		Last Modified: 2016-12-13 12:38:35 +1300 —
-	</footer>
-		</div>
-	</body>
-</html>