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

utopia 2.13.4 → 2.14.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 (353) hide show

data/docs/{wiki/middleware/static.html → middleware/static/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Static - Utopia</title>
+			<title>Static</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"/>
@@ -23,18 +21,13 @@
 		</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="static.html">Static</a></nav>
+	<body class="show">
+	<nav> › <a href="../../index.html">Wiki</a> › <span>Middleware</span> › <a href="index.html">Static</a></nav>
-	<h1 id="static">Static</h1>
+	<main>
+		<h1 id="static">Static</h1>
 <p>This middleware serves static files using the <code>mime-types</code> library. By default, it works with <code>Rack::Sendfile</code> and supports <code>ETag</code> based caching. Normally, you’d prefer to put static files into <code>public/_static</code> but it’s also acceptable to put static content into <code>pages/</code> if it makes sense.</p>
@@ -47,11 +40,12 @@
 	cache_control: 'public, max-age=7200'
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2016-12-13 12:36:48 +1300 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— middleware/static/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/server-setup.html → server-setup/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Server Setup - Utopia</title>
+			<title>Server Setup</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"/>
@@ -23,24 +21,19 @@
 		</script>
 	</head>
-	<body class="">
-		<header>
-			<img src="../_static/utopia.svg"/>
-		</header>
-		<div id="page">
-	<nav>
-	 › <a href="../wiki.html">Wiki</a> › <a href="server-setup.html">Server Setup</a></nav>
+	<body class="show">
+	<nav> › <a href="../index.html">Wiki</a> › <a href="index.html">Server Setup</a></nav>
-	<h1 id="server-setup">Server Setup</h1>
+	<main>
+		<h1 id="server-setup">Server Setup</h1>
 <p>Utopia is designed to make deployment to remote servers easy.</p>
 <h2 id="deployment">Deployment</h2>
-<p>The preferred method of deployment to a production server is via git. The <code>utopia</code> command assists with setup of a remote git repository on the server. It will setup a <code>git</code> <code>post-update</code> hook which will deploy the site correctly and restart passenger for that site.</p>
+<p>The preferred method of deployment to a production server is via git. The <code>utopia</code> command assists with setup of a remote git repository on the server. It will setup a <code>git</code> <code>post-update</code> hook which will deploy the site correctly and restart the application server for that site.</p>
 <p>To setup a server for deployment:</p>
@@ -70,32 +63,7 @@ ENV["DATABASE_ENV"] will default to "production_cluster_primary" unless otherwis
 <h2 id="platform">Platform</h2>
-<p>The best deployment platform for Utopia is Linux. Specifically, <a href="https://www.archlinux.org/">Arch Linux</a> with the following packages:</p>
-<ul>
-  <li><a href="https://aur.archlinux.org/packages/nginx-mainline-passenger/">nginx-mainline-passenger</a></li>
-  <li><a href="https://aur.archlinux.org/packages/passenger-nginx-module/">passenger-nginx-module</a></li>
-</ul>
-<p>There have been issues with the official packages and thus these packages were developed and tested with Utopia deployment in mind.</p>
-<h3 id="sample-nginx-configuration">Sample Nginx Configuration</h3>
-<p>Create a configuration file for your site, e.g. <code>/etc/nginx/sites/www.example.com</code>:</p>
-<pre><code class="language-nginx">server {
-	listen 80;
-	server_name www.example.com;
-	root /srv/http/www.example.com/public;
-	passenger_enabled on;
-}
-server {
-	listen 80;
-	server_name example.com;
-	rewrite ^ http://www.example.com$uri permanent;
-}
-</code></pre>
+<p>The best deployment platform for Utopia is Linux, using <a href="https://github.com/socketry/falcon">falcon</a>.</p>
 <h3 id="sudo-setup">Sudo Setup</h3>
@@ -108,11 +76,12 @@ server {
 <p>This allows the deploy task to correctly checkout code as user <code>http</code>.</p>
+	</main>
 	<footer>
-		Last Modified: 2018-03-24 20:49:16 +1300 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— server-setup/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/testing.html → testing/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Testing - Utopia</title>
+			<title>Testing</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"/>
@@ -23,20 +21,15 @@
 		</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>
+	<body class="show">
+	<nav> › <a href="../index.html">Wiki</a> › <a href="index.html">Testing</a></nav>
-	<h1 id="testing">Testing</h1>
+	<main>
+		<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>
+<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, <a href="https://github.com/socketry/covered">covered</a> is included for coverage testing.</p>
 <pre><code class="language-bash">$ rake coverage test
@@ -49,11 +42,12 @@ Finished in 0.44849 seconds (files took 0.15547 seconds to load)
 Coverage report generated for RSpec. 5 / 5 LOC (100.0%) covered.
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2016-12-13 12:41:41 +1300 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— testing/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/updating-utopia.html → updating-utopia/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Updating Utopia - Utopia</title>
+			<title>Updating 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"/>
@@ -23,18 +21,13 @@
 		</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>
+	<body class="show">
+	<nav> › <a href="../index.html">Wiki</a> › <a href="index.html">Updating Utopia</a></nav>
-	<h1 id="updating-utopia">Updating Utopia</h1>
+	<main>
+		<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>
@@ -98,11 +91,12 @@ end
 $ utopia server update
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2017-06-22 15:25:56 +1200 —
+		Last Modified: 2020-04-28 11:35:36 +1200
+		— updating-utopia/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/docs/{wiki/your-first-page.html → your-first-page/index.html} RENAMED

@@ -2,12 +2,10 @@
 <html>
 	<head>
-			<title>Your First Page - Utopia</title>
+			<title>Your First Page</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"/>
@@ -23,18 +21,13 @@
 		</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>
+	<body class="show">
+	<nav> › <a href="../index.html">Wiki</a> › <a href="index.html">Your First Page</a></nav>
-	<h1 id="your-first-page">Your First Page</h1>
+	<main>
+		<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>
@@ -44,7 +37,7 @@ $ utopia site create
 $ rake server
 </code></pre>
-<p>You will now have a basic template site running on <code>http://localhost:9292</code>.</p>
+<p>You will now have a basic template site running on <code>https://localhost:9292</code>.</p>
 <h2 id="welcome-page">Welcome Page</h2>
@@ -67,14 +60,15 @@ use Utopia::Redirection::Rewrite,
 <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
+  display: false
 </code></pre>
+	</main>
 	<footer>
-		Last Modified: 2017-11-11 02:12:21 +1300 —
+		Last Modified: 2020-04-28 23:17:10 +1200
+		— your-first-page/index.md
 	</footer>
-		</div>
 	</body>
 </html>

data/lib/utopia/content.rb CHANGED

@@ -59,7 +59,7 @@ module Utopia
 			# The core namespace for utopia specific functionality:
 			@namespaces[UTOPIA_NAMESPACE] ||= Tags
 		end
 		def freeze
 			return self if frozen?
@@ -72,6 +72,7 @@ module Utopia
 		attr :root
+		# TODO we should remove this method and expose `@links` directly.
 		def links(path, **options)
 			@links.index(path, **options)
 		end
@@ -91,20 +92,23 @@ module Utopia
 			end
 		end
-		# The request_path is an absolute uri path, e.g. /foo/bar. If an xnode file exists on disk for this exact path, it is instantiated, otherwise nil.
-		def lookup_node(request_path)
-			name = request_path.last
-			name_xnode = name.to_s + XNODE_EXTENSION
-			node_path = File.join(@root, request_path.dirname.components, name_xnode)
-			if File.exist? node_path
-				return Node.new(self, request_path.dirname + name, request_path, node_path)
+		# @param path [Path] the request_path is an absolute uri path, e.g. `/foo/bar`. If an xnode file exists on disk for this exact path, it is instantiated, otherwise nil.
+		def lookup_node(path, locale = nil)
+			resolve_link(
+				@links.for(path, locale)
+			)
+		end
+		def resolve_link(link)
+			if path = link&.path
+				full_path = File.join(@root, path.dirname, link.key + XNODE_EXTENSION)
+				if File.exist?(full_path)
+					return Node.new(self, path, path, full_path)
+				end
 			end
-			return nil
 		end
 		def call(env)
 			request = Rack::Request.new(env)
 			path = Path.create(request.path_info)
@@ -112,17 +116,17 @@ module Utopia
 			# Check if the request is to a non-specific index. This only works for requests with a given name:
 			basename = path.basename
 			directory_path = File.join(@root, path.dirname.components, basename)
 			# If the request for /foo/bar is actually a directory, rewrite it to /foo/bar/index:
 			if File.directory? directory_path
 				index_path = [basename, INDEX]
 				return [307, {HTTP::LOCATION => path.dirname.join(index_path).to_s}, []]
 			end
 			locale = env[Localization::CURRENT_LOCALE_KEY]
 			if link = @links.for(path, locale)
-				if link.path and node = lookup_node(link.path)
+				if node = resolve_link(link)
 					attributes = request.env.fetch(VARIABLES_KEY, {}).to_hash
 					return node.process!(request, attributes)
@@ -153,14 +157,14 @@ module Utopia
 			while components.any?
 				tag_path = File.join(@root, components, name_path)
 				if File.exist? tag_path
 					return Node.new(self, Path[components] + name, parent_path + name, tag_path)
 				end
 				if String === name_path
 					tag_path = File.join(@root, components, '_' + name_path)
 					if File.exist? tag_path
 						return Node.new(self, Path[components] + name, parent_path + name, tag_path)
 					end

data/lib/utopia/content/link.rb CHANGED

@@ -30,60 +30,55 @@ require_relative '../locale'
 module Utopia
 	class Content
-		INDEX = 'index'.freeze
 		# Represents a link to some content with associated metadata.
 		class Link
-			def initialize(kind, path, info = nil)
-				path = Path.create(path)
-				@info = info || {}
+			# @param kind [Symbol] the kind of link.
+			def initialize(kind, name, locale, path, info, title = nil)
 				@kind = kind
-				case @kind
-				when :file
-					@name, @locale = path.last.split('.', 2)
-					@path = path
-				when :directory
-					@name = path.basename
-					if @name == INDEX
-						@name = path.dirname.basename
-					end
-					@locale = path.extension
-					@path = path
-				when :virtual
-					@name, @locale = path.to_s.split('.', 2)
-					@path = @info[:path] ? Path.create(@info[:path]) : nil
+				@name = name
+				@locale = locale
+				@path = Path.create(path)
+				@info = info || {}
+				@title = Trenni::Strings.to_title(title || name)
+			end
+			def key
+				if locale
+					"#{@path.last}.#{@locale}"
 				else
-					raise ArgumentError.new("Unknown link kind #{@kind} with path #{path}")
+					@path.last
 				end
-				@title = Trenni::Strings.to_title(@name)
 			end
 			def href
 				@href ||= @info.fetch(:uri) do
 					(@path.dirname + @path.basename).to_s if @path
 				end
 			end
 			# Look up from the `links.yaml` metadata with a given symbolic key.
 			def [] key
 				@info[key]
 			end
 			attr :kind
 			attr :name
 			attr :path
 			attr :info
 			attr :locale
 			def href?
 				!!href
 			end
+			def index?
+				@kind == :index
+			end
+			def virtual?
+				@kind == :virtual
+			end
 			def relative_href(base = nil)
 				if base and href.start_with? '/'
 					Path.shortest_path(href, base)
@@ -91,11 +86,11 @@ module Utopia
 					href
 				end
 			end
 			def title
 				@info.fetch(:title, @title)
 			end
 			def to_anchor(base: nil, content: self.title, builder: nil, **attributes)
 				attributes[:class] ||= 'link'
@@ -124,7 +119,7 @@ module Utopia
 			def eql? other
 				self.class.eql?(other.class) and kind.eql?(other.kind) and name.eql?(other.name) and path.eql?(other.path) and info.eql?(other.info)
 			end
 			def == other
 				other and kind == other.kind and name == other.name and path == other.path
 			end