utopia 2.17.1 → 2.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271df583d52d5b53718ed38a322b2ed66d73d1e8ecfe460f18961e156ce92d10
-  data.tar.gz: eaa41f80ca7244853bb1a08acc9ca0b1d76932e1cc3ebff58771fee1686eb4a7
+  metadata.gz: 7d3b6e619bc7db476e12fb64c15765a84349a8aabc6ee8b2b4e46a8ea80936e4
+  data.tar.gz: 3fe0eeafcf89805747e888122545ac3ab73e0a87a61f6a157eb8c7a86a442135
 SHA512:
-  metadata.gz: b9d8cef96cde92e960559a9618d447512ec35905b75cb67a116899607181db2c7bc4de457fe7739a8aea20cd98f9f1e7ee56e33656cc84873aaacc1f4337e22a
-  data.tar.gz: 4b6df56fabfc179ca95c11db76e31689ec722c1bdd6d1f430e5ce8f0a2d613d390bcee7f22b4399f59311c7ed2dc1843a706da49fc63af03f745319b0e0c322b
+  metadata.gz: 1a3a7677b5ee5f54ceb5267614f46ca8791d6ac5db62db29485e9392cb993e4b6e39ab6be6a1bbbd9faa7182368612f3347cf4faa769e44ad00d35b9c2abe99b
+  data.tar.gz: 5f9b615c2fe980279cbc0a5516d0e69e7c94af88805dce6d1c5409b860b5fb2be29f575da05c21aa750056232ef95c0fb802a789cc6630b24ff3fcd8514d0d49

data/lib/utopia/command/site.rb

@@ -110,10 +110,10 @@ module Utopia
 					puts "make your life easier and more enjoyable.".center(78)
 					puts ""
 					puts "To start the development server, run:".center(78)
-					puts "rake server".center(78)
+					puts "bake utopia:development".center(78)
 					puts ""
 					puts "For extreme productivity, please consult the online documentation".center(78)
-					puts "https://github.com/ioquatix/utopia".center(78)
+					puts "https://github.com/socketry/utopia".center(78)
 					puts " ~ Samuel.  ".rjust(78)
 				end
 			end

data/lib/utopia/content/link.rb

@@ -52,7 +52,9 @@ module Utopia
 			
 			def href
 				@href ||= @info.fetch(:uri) do
-					(@path.dirname + @path.basename).to_s if @path
+					@info.fetch(:href) do
+						(@path.dirname + @path.basename).to_s if @path
+					end
 				end
 			end
 			
@@ -94,17 +96,17 @@ module Utopia
 			def to_anchor(base: nil, content: self.title, builder: nil, **attributes)
 				attributes[:class] ||= 'link'
 				
-				Trenni::Builder.fragment(builder) do |builder|
+				Trenni::Builder.fragment(builder) do |inner_builder|
 					if href?
 						attributes[:href] ||= relative_href(base)
 						attributes[:target] ||= @info[:target]
 						
-						builder.inline('a', attributes) do
-							builder.text(content)
+						inner_builder.inline('a', attributes) do
+							inner_builder.text(content)
 						end
 					else
-						builder.inline('span', attributes) do
-							builder.text(content)
+						inner_builder.inline('span', attributes) do
+							inner_builder.text(content)
 						end
 					end
 				end

data/lib/utopia/content/links.rb

@@ -142,7 +142,7 @@ module Utopia
 			def load_metadata(path)
 				yaml_path = File.join(path, LINKS_YAML)
 				
-				if File.exist?(yaml_path) && data = YAML::load_file(yaml_path)
+				if File.exist?(yaml_path) && data = YAML.load_file(yaml_path)
 					return symbolize_keys(data)
 				else
 					return {}
@@ -234,7 +234,7 @@ module Utopia
 				end
 				
 				def load_index(name, locale, info)
-					info ||=  {}
+					info ||= {}
 					
 					if locale and defaults = @metadata[name]
 						info = defaults.merge(info)
@@ -245,17 +245,20 @@ module Utopia
 					yield Link.new(:index, name, locale, path, info, path[-2])
 				end
 				
+				DEFAULT_INDEX_INFO = {href: nil}.freeze
+				
+				# The default index for a directory which has no contents.
 				def load_default_index(name = INDEX, info = {})
 					path = @top + name
 					
 					if info
-						info = {uri: nil}.merge(info)
+						info = DEFAULT_INDEX_INFO.merge(info)
 					else
-						info = {uri: nil}
+						info = DEFAULT_INDEX_INFO
 					end
 					
 					# Specify a nil uri if no index could be found for the directory:
-					yield Link.new(:index, name, nil, @top, info, path[-2])
+					yield Link.new(:index, name, nil, @top.to_directory, info, path[-2])
 				end
 				
 				def load_file(name, locale, info)

data/lib/utopia/controller/actions.md

@@ -0,0 +1,76 @@
+# Utopia::Controller::Actions
+
+Actions let you match path patterns in your controller and execute code. In your `controller.rb` simply add:
+
+```ruby
+prepend Actions
+```
+
+If you are adding multiple things, like rewriting, they should come earlier in the chain, e.g:
+
+```ruby
+prepend Rewrite, Actions
+```
+
+A simple CRUD controller might look like:
+
+```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
+```
+	
+## Path Matching
+
+Path matching works from right to left, and `'**'` is a greedy operator. Controllers are invoked with a path relative to the controller's `URI_PATH`, so all lookups are relative to the controller.
+
+<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>
+
+## Otherwise Matching
+
+If no action was matched, it is sometimes useful to perform some specific behaviour. You can specify this by using the otherwise handler:
+
+```ruby
+otherwise do |request, path|
+	fail! :teapot
+end
+```
+
+If you are doing this to perform some kind of rewriting, it may be preferable to use the [Rewrite](../rewrite/) controller layer.

data/lib/utopia/controller/rewrite.md

@@ -0,0 +1,69 @@
+# Utopia::Controller::Rewrite
+
+This module can match and rewrite requests before they processed. This allows you to handle URLs like `/post/15/view` or `/blog/123-pictures-of-my-cat` easily. The basic rewrite operation is to extract some part of the path and optionally executes a block. That means that the path is modified before being passed on to the next layer in the controller, and controller instance variables may be set.
+
+## Regular Expressions
+
+In your `controller.rb`:
+
+```ruby
+prepend Rewrite, Actions
+
+rewrite.extract_prefix permalink: /(?<id>\d+)-(?<title>.*)/ do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@permalink[:id])
+	
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components << "post"
+	end
+end
+
+on 'post' do
+	# You can do further processing here.
+	fail! unless @post.published?
+	
+	@comments = @post.comments.first(5)
+end
+
+on 'edit' do
+	# You can do further processing here.
+	fail! unless @current_user&.editor?
+end
+```
+
+In your `post.xnode`, as an example:
+
+```trenni
+<content:page>
+	<content:heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</content:heading>
+	
+	<p>#{attributes[:post].content}</p>
+</content:page>
+```
+
+Keep in mind, that URLs like `/123-pictures-of-my-cat/edit` will work as expected, and hit the `edit` action of the controller.
+
+## Restful Resources
+
+Similar to the above, if we were solely interested in IDs, we could do the following:
+
+```ruby
+prepend Rewrite, Actions
+
+rewrite.extract_prefix post_id: Integer do |request, path, match|
+	# The rewrite matched, but there was no valid post, so we fail:
+	fail! unless @post = Post.find(@post_id)
+	
+	# If the path matched, but there was no suffix, we make it default to the post action:
+	if match.post_match.empty?
+		match.post_match.components << "post"
+	end
+end
+```
+
+This will only match complete integers. Assuming this code is in `/blog/controller.rb`, it would match something like `/blog/123/view` and assign <code class="language-ruby">Integer("123")</code> to <code class="language-ruby">@post_id</code>.
+
+### Matching.. other things
+
+It's possible to match using <code class="language-ruby">Integer</code>, <code class="language-ruby">Float</code>, <code class="language-ruby">String</code>, and you can provide your own class which will be instantiated. If it doesn't match, raise an exception and the rewrite rule will fail.

data/lib/utopia/exceptions/mailer.rb

@@ -155,7 +155,7 @@ module Utopia
 				end
 				
 				if @dump_environment
-					mail.attachments['environment.yaml'] = YAML::dump(env)
+					mail.attachments['environment.yaml'] = YAML.dump(env)
 				end
 
 				return mail

data/lib/utopia/path.rb

@@ -140,7 +140,7 @@ module Utopia
 			if directory?
 				return self
 			else
-				return join([''])
+				return self.class.new(@components + [''])
 			end
 		end
 		
@@ -178,8 +178,14 @@ module Utopia
 			@components
 		end
 		
+		# @parameter other [Array(String)] The path components to append.
 		def join(other)
-			self.class.new(@components + other).simplify
+			# Check whether other is an absolute path:
+			if other.first == ''
+				self.class.new(other)
+			else
+				self.class.new(@components + other).simplify
+			end
 		end
 		
 		def expand(root)

data/lib/utopia/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "2.17.1"
+	VERSION = "2.18.4"
 end

data/setup/site/README.md

@@ -6,11 +6,11 @@ Welcome to Utopia, a Ruby framework for web site and application development. Fo
 
 To start the development server, simply execute
 
-	> rake
+	> bake
 	Generating transient session key for development...
 	20:57:36 - INFO - Starting Falcon HTTP server on localhost:9292
 	20:57:36 - INFO - Guard::RSpec is running
 	20:57:36 - INFO - Guard is now watching at '...'
 	[1] guard(main)>
 
-Then browse http://localhost:9292 (or as specified) to see your new site.
+Then browse https://localhost:9292 (or as specified) to see your new site.

data/setup/site/config.ru

@@ -14,6 +14,7 @@ else
 	use Rack::ShowExceptions unless UTOPIA.testing?
 end
 
+# serve static files from public/
 use Utopia::Static, root: 'public'
 
 use Utopia::Redirection::Rewrite, {
@@ -39,6 +40,7 @@ use Utopia::Session,
 
 use Utopia::Controller
 
+# serve static files from pages/
 use Utopia::Static
 
 # Serve dynamic content

data/setup/site/pages/_page.xnode

@@ -14,7 +14,7 @@
 		
 		<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="icon" type="image/png" href="/_static/icon.svg" />
 		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
 	</head>
 

data/setup/site/public/_static/icon.svg

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg width="100%" height="100%" viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linecap:square;stroke-miterlimit:1.5;">
+    <g transform="matrix(0.922789,0,0,0.922789,16.591,0.837867)">
+        <path d="M120.731,31.594L212.702,84.694L212.702,190.893L120.731,243.993L28.759,190.893L28.759,84.694L120.731,31.594Z" style="fill:none;"/>
+        <clipPath id="_clip1">
+            <path d="M120.731,31.594L212.702,84.694L212.702,190.893L120.731,243.993L28.759,190.893L28.759,84.694L120.731,31.594Z"/>
+        </clipPath>
+        <g clip-path="url(#_clip1)">
+            <g transform="matrix(18.3943,0,0,10.62,-1929.57,-966.601)">
+                <g transform="matrix(1,0,0,0.178571,106.463,93.9922)">
+                    <rect x="0" y="0" width="10" height="56" style="fill:#f79433;"/>
+                </g>
+                <g transform="matrix(1,0,0,0.416667,106.463,80.6588)">
+                    <rect x="0" y="56" width="10" height="24" style="fill:#4e8dd8;"/>
+                </g>
+            </g>
+        </g>
+        <path d="M120.731,31.594L212.702,84.694L212.702,190.893L120.731,243.993L28.759,190.893L28.759,84.694L120.731,31.594Z" style="fill:none;stroke:black;stroke-width:26.01px;"/>
+    </g>
+</svg>

data/setup/site/public/_static/utopia-background.svg

@@ -1 +1,11 @@
-<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 10 80" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421;"><rect x="0" y="0" width="10" height="56" style="fill:#f79433;"/><rect x="0" y="56" width="10" height="24" style="fill:#4e8dd8;"/></svg>
+<?xml version="1.0" standalone="no"?>
+<svg 
+	width="100%" height="100%" 
+	viewBox="0 0 10 80"
+	preserveAspectRatio="none"
+	version="1.1"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink= "http://www.w3.org/1999/xlink">
+	<rect x="0" y="0" width="10" height="56" style="fill:#f79433;"/>
+	<rect x="0" y="56" width="10" height="24" style="fill:#4e8dd8;"/>
+</svg>

data/setup/site/public/_static/utopia.svg

@@ -1 +1,19 @@
-<?xml version="1.0" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 420 80" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:1.41421;"><g><rect x="0" y="0" width="420" height="56" style="fill:#f79433;"/><rect x="0" y="56" width="420" height="24" style="fill:#4e8dd8;"/><g><path d="M75.145,70.819c2.37,-3.097 4.173,-6.921 5.111,-11.365c0.91,-4.318 1.498,-9.261 1.498,-14.692l0,-44.762l-62.754,0l0,44.762c0,2.628 0.244,5.333 0.407,8.035c0.168,2.782 0.674,5.515 1.345,8.118c0.68,2.644 1.739,5.173 3.067,7.517c1.363,2.405 3.263,4.526 5.609,6.303c2.319,1.755 5.245,3.163 8.677,4.172c1.617,0.478 3.416,1.093 5.354,1.093l13.856,0c3.071,0 5.797,-1.058 8.131,-2.001c4.042,-1.631 7.305,-4.049 9.699,-7.18Z" style="fill:#fff;fill-rule:nonzero;"/><path d="M151.481,18.701l0,-18.701l-62.754,-0.022l0,18.723l22.246,0l0.02,61.299l17.93,0l-0.02,-61.299l22.578,0Z" style="fill:#fff;fill-rule:nonzero;"/><path d="M229.926,39.999c0,-22.051 -16.979,-39.992 -37.852,-39.992c-20.872,0 -37.851,17.942 -37.851,39.992c0,22.054 16.979,39.994 37.851,39.994c20.873,0 37.852,-17.94 37.852,-39.994Z" style="fill:#fff;fill-rule:nonzero;"/><path d="M269.238,50.909c9.717,0 17.181,-2.066 22.183,-6.395c5.087,-4.399 7.667,-10.942 7.667,-19.575c0,-3.257 -0.393,-5.962 -1.167,-8.476c-0.778,-2.528 -1.883,-4.934 -3.281,-6.814c-1.401,-1.882 -3.098,-3.458 -5.045,-4.703c-1.895,-1.21 -4.003,-2.198 -6.264,-2.943c-2.239,-0.737 -4.64,-1.263 -7.139,-1.56c-2.464,-0.292 -5.016,-0.443 -7.587,-0.443l-29.468,0l0,80l17.93,0l0,-29.091l12.171,0Z" style="fill:#fff;fill-rule:nonzero;"/><rect x="304.879" y="0" width="17.93" height="80" style="fill:#fff;"/><path d="M362.589,0l-29.477,80l75.888,0l-31.247,-80l-15.164,0Z" style="fill:#fff;fill-rule:nonzero;"/></g></g></svg>
+<?xml version="1.0" standalone="no"?>
+<svg 
+	width="100%" height="100%" 
+	viewBox="0 0 420 80"
+	preserveAspectRatio="none"
+	version="1.1"
+	xmlns="http://www.w3.org/2000/svg"
+	xmlns:xlink= "http://www.w3.org/1999/xlink">
+	<rect x="0" y="0" width="420" height="56" style="fill:#f79433;"/>
+	<rect x="0" y="56" width="420" height="24" style="fill:#4e8dd8;"/>
+	<g>
+		<path d="M75.145,70.819c2.37,-3.097 4.173,-6.921 5.111,-11.365c0.91,-4.318 1.498,-9.261 1.498,-14.692l0,-44.762l-62.754,0l0,44.762c0,2.628 0.244,5.333 0.407,8.035c0.168,2.782 0.674,5.515 1.345,8.118c0.68,2.644 1.739,5.173 3.067,7.517c1.363,2.405 3.263,4.526 5.609,6.303c2.319,1.755 5.245,3.163 8.677,4.172c1.617,0.478 3.416,1.093 5.354,1.093l13.856,0c3.071,0 5.797,-1.058 8.131,-2.001c4.042,-1.631 7.305,-4.049 9.699,-7.18Z" style="fill:#fff;fill-rule:nonzero;"/>
+		<path d="M151.481,18.701l0,-18.701l-62.754,-0.022l0,18.723l22.246,0l0.02,61.299l17.93,0l-0.02,-61.299l22.578,0Z" style="fill:#fff;fill-rule:nonzero;"/>
+		<path d="M229.926,39.999c0,-22.051 -16.979,-39.992 -37.852,-39.992c-20.872,0 -37.851,17.942 -37.851,39.992c0,22.054 16.979,39.994 37.851,39.994c20.873,0 37.852,-17.94 37.852,-39.994Z" style="fill:#fff;fill-rule:nonzero;"/>
+		<path d="M269.238,50.909c9.717,0 17.181,-2.066 22.183,-6.395c5.087,-4.399 7.667,-10.942 7.667,-19.575c0,-3.257 -0.393,-5.962 -1.167,-8.476c-0.778,-2.528 -1.883,-4.934 -3.281,-6.814c-1.401,-1.882 -3.098,-3.458 -5.045,-4.703c-1.895,-1.21 -4.003,-2.198 -6.264,-2.943c-2.239,-0.737 -4.64,-1.263 -7.139,-1.56c-2.464,-0.292 -5.016,-0.443 -7.587,-0.443l-29.468,0l0,80l17.93,0l0,-29.091l12.171,0Z" style="fill:#fff;fill-rule:nonzero;"/>
+		<path d="M362.589,0l-29.477,80l75.888,0l-31.247,-80l-15.164,0Z" style="fill:#fff;fill-rule:nonzero;"/>
+		<rect x="304.879" y="0" width="17.93" height="80" style="fill:#fff;"/>
+	</g>
+</svg>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 2.17.1
+  version: 2.18.4
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -192,34 +192,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-modernize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -276,20 +248,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: utopia-project
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
 executables:
@@ -319,9 +277,11 @@ files:
 - lib/utopia/content/tags.rb
 - lib/utopia/content_length.rb
 - lib/utopia/controller.rb
+- lib/utopia/controller/actions.md
 - lib/utopia/controller/actions.rb
 - lib/utopia/controller/base.rb
 - lib/utopia/controller/respond.rb
+- lib/utopia/controller/rewrite.md
 - lib/utopia/controller/rewrite.rb
 - lib/utopia/controller/variables.rb
 - lib/utopia/exceptions.rb
@@ -365,7 +325,7 @@ files:
 - setup/site/pages/errors/file-not-found.xnode
 - setup/site/pages/links.yaml
 - setup/site/pages/welcome/index.xnode
-- setup/site/public/_static/icon.png
+- setup/site/public/_static/icon.svg
 - setup/site/public/_static/site.css
 - setup/site/public/_static/utopia-background.svg
 - setup/site/public/_static/utopia.svg
@@ -384,7 +344,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement