utopia 2.16.1 → 2.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f7a327d1848543592fbdf7a17fa1f45893852cff6ff763ddfdb08c9cb64ad80
-  data.tar.gz: 0bcf595720fb09061dfb130e9ca3fc68f6ac071b279e661b9a76a186736fec42
+  metadata.gz: 2e27bab1354cbb8b2d4ab415c3c2570db443ece1628692bbd17ef1f6e7bd2329
+  data.tar.gz: 155b3b5ff07f33d836297db25be41d534c84e50ed9133b4d2ab69eec6730aeb8
 SHA512:
-  metadata.gz: 6a246d50f6dd455582454f62e49c313c1e9c851094febfc20929d4ead609532c7b8e9673ab05c4ed037994960ece9e3a59c9de364b2074d0845fe2c50aaa298b
-  data.tar.gz: 906526e65a9c040d781ac7544cec1425556bb78614e89c0a63ae39d2b805a25a1ede314d78c17830a2348adf094bb5be1b2a748792742d477421377f06c5d1f6
+  metadata.gz: d73b02adae74b577cff9e5a9b47f2d226f5bf97b9e246baeb325c21728d83e3c46069c20b6b6e38309900951c74d72985800864e7c682e39b27681fc3bc58cf2
+  data.tar.gz: 8038fbd4bd0334ec21391e86e2c0e55cb3a0caeef59b7700f310c5772fdc50c71997e8fa4ab258a34ca1d36fe5f17f7c3363dc6645dcd1d25eed06e42795b2db

data/lib/utopia/command/server.rb

@@ -68,7 +68,8 @@ module Utopia
 						system("git", "config", "receive.denyCurrentBranch", "ignore") or fail "could not set configuration"
 						system("git", "config", "core.worktree", destination_root) or fail "could not set configuration"
 						
-						system("bundle", "config", "set", "--local", "deployment", "true")
+						# Doing this invokes a lot of behaviour that isn't always ideal...
+						# system("bundle", "config", "set", "--local", "deployment", "true")
 						system("bundle", "config", "set", "--local", "without", "development")
 						
 						# In theory, to convert from non-shared to shared:

data/lib/utopia/command/site.rb

@@ -33,7 +33,7 @@ module Utopia
 		# Local site setup commands.
 		class Site < Samovar::Command
 			# Configuration files which should be installed/updated:
-			CONFIGURATION_FILES = ['.gitignore', 'config.ru', 'config/environment.rb', 'falcon.rb', 'Gemfile', 'Guardfile', 'bake.rb', 'spec/spec_helper.rb', 'spec/website_context.rb', 'spec/website_spec.rb']
+			CONFIGURATION_FILES = ['.gitignore', 'config.ru', 'config/environment.rb', 'falcon.rb', 'gems.rb', 'Guardfile', 'bake.rb', 'spec/spec_helper.rb', 'spec/website_context.rb', 'spec/website_spec.rb']
 			
 			# Directories that should exist:
 			DIRECTORIES = ["config", "lib", "pages", "public", "tasks", "spec"]
@@ -142,6 +142,15 @@ module Utopia
 					end
 				end
 				
+				# Move `Gemfile` to `gems.rb`.
+				def update_gemfile!
+					# If `Gemfile` doens't exist, we are done:
+					return unless File.exist?('Gemfile')
+					
+					system("git", "mv", "Gemfile", "gems.rb")
+					system("git", "mv", "Gemfile.lock", "gems.locked")
+				end
+				
 				def call
 					destination_root = parent.root
 					branch_name = "utopia-upgrade-#{Utopia::VERSION}"
@@ -184,6 +193,7 @@ module Utopia
 							system("git", "add", *Site::CONFIGURATION_FILES) or fail "could not add files"
 							
 							move_static!
+							update_gemfile!
 							
 							# Commit all changes:
 							system("git", "commit", "-m", "Upgrade to utopia #{Utopia::VERSION}.") or fail "could not commit changes"

data/lib/utopia/content.rb

@@ -177,17 +177,19 @@ module Utopia
 		end
 		
 		def content_tag(name, node)
-			parent_path = node.parent_path
+			full_path = node.parent_path + name
+			
+			name = full_path.pop
 			
 			# If the current node is called 'foo', we can't lookup 'foo' in the current directory or we will have infinite recursion.
-			if name == node.name
-				parent_path = parent_path.dirname
+			while full_path.last == name
+				full_path.pop
 			end
 			
-			cache_key = parent_path + name
+			cache_key = full_path + name
 			
 			@node_cache.fetch_or_store(cache_key) do
-				lookup_content(name, parent_path)
+				lookup_content(name, full_path)
 			end
 		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
 			

data/lib/utopia/content/links.rb

@@ -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/path.rb

@@ -25,7 +25,7 @@ module Utopia
 	class Path
 		include Comparable
 		
-		SEPARATOR = '/'.freeze
+		SEPARATOR = '/'
 		
 		def initialize(components = [])
 			@components = components
@@ -34,6 +34,8 @@ module Utopia
 		attr_accessor :components
 		
 		def freeze
+			return self if frozen?
+			
 			@components.freeze
 			
 			super
@@ -176,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)
@@ -235,6 +243,30 @@ module Utopia
 			return self.class.new(result)
 		end
 		
+		# Returns the first path component.
+		def first
+			if absolute?
+				@components[1]
+			else
+				@components[0]
+			end
+		end
+		
+		# Returns the last path component.
+		def last
+			if @components != ['']
+				@components.last
+			end
+		end
+		
+		# Pops the last path component.
+		def 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.
 		def basename
 			basename, _ = @components.last.split('.', 2)
@@ -284,7 +316,7 @@ module Utopia
 		end
 		
 		def split(at)
-			if at.kind_of? String
+			if at.kind_of?(String)
 				at = @components.index(at)
 			end
 			
@@ -342,22 +374,6 @@ module Utopia
 			@components.delete_at(component_offset(index))
 		end
 		
-		def first
-			if absolute?
-				@components[1]
-			else
-				@components[0]
-			end
-		end
-		
-		def last
-			if directory?
-				@components[-2]
-			else
-				@components[-1]
-			end
-		end
-		
 		private
 		
 		# We adjust the index slightly so that indices reference path components rather than the directory markers at the start and end of the path components array.

data/lib/utopia/version.rb

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

data/setup/server/git/hooks/post-receive

@@ -62,7 +62,7 @@ Dir.chdir(GIT_WORK_TREE) do
 	sudo %W{git checkout -f}
 	sudo %W{git submodule update -i}
 	
-	if File.exist? 'Gemfile'
+	if File.exist? 'gems.rb'
 		sudo %W{bundle install}
 	end
 	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 2.16.1
+  version: 2.18.1
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-08-01 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,22 +248,8 @@ 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: 
+description:
+email:
 executables:
 - utopia
 extensions: []
@@ -303,15 +261,12 @@ files:
 - bake/utopia/static.rb
 - bake/utopia/test.rb
 - bin/utopia
-- lib/.DS_Store
 - lib/utopia.rb
-- lib/utopia/.DS_Store
 - lib/utopia/command.rb
 - lib/utopia/command/environment.rb
 - lib/utopia/command/server.rb
 - lib/utopia/command/site.rb
 - lib/utopia/content.rb
-- lib/utopia/content/.DS_Store
 - lib/utopia/content/document.rb
 - lib/utopia/content/link.rb
 - lib/utopia/content/links.rb
@@ -322,10 +277,11 @@ files:
 - lib/utopia/content/tags.rb
 - lib/utopia/content_length.rb
 - lib/utopia/controller.rb
-- lib/utopia/controller/.DS_Store
+- 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
@@ -351,13 +307,9 @@ files:
 - lib/utopia/static/local_file.rb
 - lib/utopia/static/mime_types.rb
 - lib/utopia/version.rb
-- setup/.DS_Store
-- setup/server/.DS_Store
 - setup/server/git/hooks/post-receive
-- setup/site/.DS_Store
 - setup/site/.gitignore
 - setup/site/.rspec
-- setup/site/Gemfile
 - setup/site/Guardfile
 - setup/site/README.md
 - setup/site/bake.rb
@@ -365,15 +317,14 @@ files:
 - setup/site/config/README.md
 - setup/site/config/environment.rb
 - setup/site/falcon.rb
+- setup/site/gems.rb
 - setup/site/lib/readme.txt
-- setup/site/pages/.DS_Store
 - setup/site/pages/_heading.xnode
 - setup/site/pages/_page.xnode
 - setup/site/pages/errors/exception.xnode
 - setup/site/pages/errors/file-not-found.xnode
 - setup/site/pages/links.yaml
 - setup/site/pages/welcome/index.xnode
-- setup/site/public/.DS_Store
 - setup/site/public/_static/icon.png
 - setup/site/public/_static/site.css
 - setup/site/public/_static/utopia-background.svg
@@ -382,13 +333,12 @@ files:
 - setup/site/spec/spec_helper.rb
 - setup/site/spec/website_context.rb
 - setup/site/spec/website_spec.rb
-- setup/site/tmp/Gemfile
 homepage: https://github.com/ioquatix/utopia
 licenses:
 - MIT
 metadata:
   funding_uri: https://github.com/sponsors/ioquatix/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -404,7 +354,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.
 test_files: []