utopia 1.9.1 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e43b609f07c8331def9621c56b40b2f9298d35b
-  data.tar.gz: d137536094afd723da06e757ab0112b85dd31c50
+  metadata.gz: 7f08603b8fc77e5ffe85cf2f402be73c09502643
+  data.tar.gz: 81540559da3ee6823a0a3f1754c7446b28228b5a
 SHA512:
-  metadata.gz: a6513105d8c673492b3f5c4269d6b25d28aab62e95f875c94a78fa48b727784c17c5a53b667c449ca60fdd6db88f04d5556b2f1e8d4f6320321dec3bb3956557
-  data.tar.gz: 79fc5393a3babeea2f1cb03328d551c11dc8166f0693e862855fee02a3e215114282a77e3fd4c353d547efafb86f9a639d80f7a4ad098e93abadc52dd94b34ec
+  metadata.gz: caa96b4c7e561170b1bcfc4a1d783561d3e46b4e65f8c3ecadce76a3b43846f6d4fa2d26765d644aca197a77206b775ed30bed79f8e1c58bdc97459e90f815ce
+  data.tar.gz: 8e000468cebb8b29e356269e83e3dd6f79cfd7d64f41ad4155ca79943f1e74a28f8b2e3fb3bd1df0da9c7e64da8595f8795c7e1b38bd0c398406716311a67a91

data/documentation/pages/wiki/_navigation.xnode

@@ -0,0 +1,15 @@
+<?r prev = nil ?>
+<nav>
+	<?r
+		Utopia::Path[attributes[:path]].descend do |path|
+			next unless path.last
+			
+			link = links(path.dirname, :name => path.last, :locale => localization.current_locale, :display => nil).first
+			
+			if link and File.exist?(current.node.local_path(link.path + "content.md"))
+				?> &rsaquo; <a href="#{link.path}">#{link.title}</a><?r
+			elsif link
+				?> &rsaquo; <span>#{link.title}</span><?r
+			end
+		end ?>
+</nav>

data/documentation/pages/wiki/content.md

@@ -1,4 +1,4 @@
-# Welcome to Utopia
+# Utopia Documentation Wiki
 
 This wiki includes documentation and examples showing how to use Utopia.
 
@@ -8,4 +8,5 @@ This wiki includes documentation and examples showing how to use Utopia.
 
 ## Advanced Topics
 
-- [Rewriting URLs](rewriting-urls/)
+- [Controller Actions](controller/actions/)
+- [Controller Rewrite](controller/rewrite/)

data/documentation/pages/wiki/controller.rb

@@ -2,6 +2,7 @@
 prepend Actions
 
 on '**' do |request, path|
+	@full_path = URI_PATH + path
 	@page_path = path.components[0..-2]
 	
 	@page_file = File.join(BASE_PATH, @page_path, "content.md")

data/documentation/pages/wiki/controller/actions/content.md

@@ -0,0 +1,68 @@
+# Controller::Actions
+
+Actions let you match path patterns in your controller and execute code. In your `controller.rb` simply add:
+
+	prepend Actions
+
+If you are adding multiple things, like rewriting, they should come earlier in the chain, e.g:
+
+	prepend Rewrite, Actions
+
+A simple CRUD controller might look like:
+
+	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>"*"</dt>
+	<dd>Match a single path element</dd>
+	<dt>"**"<dt>
+	<dd>Match all remaining path elements</dd>
+	<dt>String</dt>
+	<dd>Match a named path component</dd>
+	<dt>Symbol</dt>
+	<dd>Equivalent to ["**", symbol.to_s]</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:
+
+	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/documentation/pages/wiki/controller/links.yaml

@@ -0,0 +1,4 @@
+actions:
+  order: 1
+rewrite:
+  order: 2

data/documentation/pages/wiki/controller/rewrite/content.md

@@ -0,0 +1,64 @@
+# Controller::Rewrite
+
+The `Controller::Rewrite` layer 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`:
+
+	prepend Actions, Rewrite
+	
+	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:
+
+	<page>
+		<heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</heading>
+		
+		<p>#{attributes[:post].content}</p>
+	</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:
+
+	prepend Actions, Rewrite
+	
+	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 Integer("123") to `@post_id`.
+
+### Matching.. other things
+
+It's possible to match using `Integer`, `Float`, `String`, 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/documentation/pages/wiki/links.yaml

@@ -0,0 +1,2 @@
+index:
+  title: "Wiki"

data/documentation/pages/wiki/show.xnode

@@ -1,7 +1,7 @@
 <page>
-	<?r 
-		transaction.attributes[:title] ||= @page_title
-	?>
+	<?r transaction.attributes[:title] ||= @page_title ?>
+	
+	#{partial 'navigation', path: attributes[:full_path].dirname}
 	
 	#{MarkupString.raw Kramdown::Document.new(self[:content]).to_html}
 	

data/lib/utopia/content/markup.rb

@@ -60,23 +60,23 @@ module Utopia
 				attr :offset
 				
 				def to_s
-					@tag.to_s
+					"<#{@tag.name}#{@tag.attributes.empty? ? '' : ' ...'}>"
 				end
 			end
 			
 			class UnbalancedTagError < StandardError
 				def initialize(buffer, opening_tag, closing_tag = nil)
 					@buffer = buffer
-					@opening_tag = current_tag
+					@opening_tag = opening_tag
 					@closing_tag = closing_tag
 				end
 
 				attr :buffer
-				attr :current_tag
+				attr :opening_tag
 				attr :closing_tag
 				
 				def start_location
-					Trenni::Location.new(@buffer.read, current_tag.offset)
+					Trenni::Location.new(@buffer.read, opening_tag.offset)
 				end
 				
 				def end_location
@@ -144,7 +144,7 @@ module Utopia
 				tag = @current.tag
 				
 				if tag.name != name
-					raise UnbalancedTagError.new(@buffer, tag, ParsedTag.new(name, offset))
+					raise UnbalancedTagError.new(@buffer, @current, ParsedTag.new(name, offset))
 				end
 				
 				@delegate.tag_end(tag)

data/lib/utopia/path/matcher.rb

@@ -52,14 +52,16 @@ module Utopia
 			
 			def coerce(klass, value)
 				if klass == Integer
-					Integer(value) rescue nil
+					Integer(value)
 				elsif klass == Float
-					Float(value) rescue nil
+					Float(value)
 				elsif klass == String
 					value.to_s
 				else
 					klass.new(value)
 				end
+			rescue
+				return nil
 			end
 			
 			# This is a path prefix matching algorithm. The pattern is an array of String, Symbol, Regexp, or nil. The components is an array of String.

data/lib/utopia/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "1.9.1"
+	VERSION = "1.9.2"
 end

data/setup/site/public/_static/site.css

@@ -104,6 +104,13 @@ footer {
 	color: #aaa;
 }
 
+nav {
+	position: absolute;
+	margin: 2.5rem;
+	font-size: 0.8rem;
+	color: #aaa;
+}
+
 section.features {
 	display: flex;
 	flex-wrap: wrap;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.9.2
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -200,11 +200,15 @@ files:
 - documentation/pages/errors/file-not-found.xnode
 - documentation/pages/links.yaml
 - documentation/pages/welcome/index.xnode
+- documentation/pages/wiki/_navigation.xnode
 - documentation/pages/wiki/content.md
 - documentation/pages/wiki/controller.rb
+- documentation/pages/wiki/controller/actions/content.md
+- documentation/pages/wiki/controller/links.yaml
+- documentation/pages/wiki/controller/rewrite/content.md
 - documentation/pages/wiki/development-environment-setup/content.md
 - documentation/pages/wiki/edit.xnode
-- documentation/pages/wiki/rewriting-urls/content.md
+- documentation/pages/wiki/links.yaml
 - documentation/pages/wiki/server-setup/content.md
 - documentation/pages/wiki/show.xnode
 - documentation/pages/wiki/your-first-page/content.md

data/documentation/pages/wiki/rewriting-urls/content.md

@@ -1,41 +0,0 @@
-# Rewriting URLs
-
-The `Controller::Rewrite` layer can match and rewrite requests before they processed. This allows you to have URLs like `/post/15/view` or `/blog/123-pictures-of-my-cat`. The basic rewrite operation is to extract some part of the path prefix. That means that the path is modified before being passed on to the next layer in the controller.
-
-## Permalink Example
-
-In your `controller.rb`:
-
-	prepend Actions, Rewrite
-	
-	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:
-
-	<page>
-		<heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</heading>
-		
-		<p>#{attributes[:post].content}</p>
-	</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.