utopia 2.17.0 → 2.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5549c06603672129f49f5d8c7f00b9cc706786460ba6597c3459be007d508c5c
-  data.tar.gz: 7ee6b130a7a671944ec64c7a98cc8b01e7f579e64e978e3733462c2f60ead135
+  metadata.gz: 1f996bae57d16bd9ab485b96680ad4896673ec871127c2d313e72f4466f46a9c
+  data.tar.gz: b5841b727a69814fa3fc0b58b649de6a23aa10109fa376c6ef55a66e499c480c
 SHA512:
-  metadata.gz: ae1d066e702f89c544236458d8753bcc01ab07aade2eb9b7e89755d88d9ddce520e3f1453ee9c8535f5f2788ae1cd5f5d34d412b4fdd8ee0ef00008d476debfc
-  data.tar.gz: bba30364281ce80ff9c25597c7181a903579fe6fe28cf128e53ab730c768a216a3632e999a3c1f7a4ee249debe43c3e4afcfe59e1b4fee2a3f1df6c9f04f3f0e
+  metadata.gz: 742e356fd94839d94068c67b6857f8ee8e8ee0f6912eb29bf08f6c4042aa2962ab3b6d3c2cdaca7d7820fb554938cda80f40ac37600c65f678799966c7fe66f1
+  data.tar.gz: 8b7612f9a4090f796c340901295e13beaa41b380354eb428d0321e5a25687b509b1e536dee03dede5c8776a3284f58627089abf2b79ef4fbfcf47428673792f8

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
 			

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)
@@ -237,6 +243,7 @@ module Utopia
 			return self.class.new(result)
 		end
 		
+		# Returns the first path component.
 		def first
 			if absolute?
 				@components[1]
@@ -245,12 +252,19 @@ module Utopia
 			end
 		end
 		
+		# Returns the last path component.
 		def last
-			@components.last
+			if @components != ['']
+				@components.last
+			end
 		end
 		
+		# Pops the last path component.
 		def pop
-			@components.pop
+			# We don't want to convert an absolute path to a relative path.
+			if @components != ['']
+				@components.pop
+			end
 		end
 		
 		# @return [String] the last path component without any file extension.

data/lib/utopia/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 2.17.0
+  version: 2.18.3
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-09-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
@@ -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
@@ -393,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.