utopia 2.11.1 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df68f6673051f098f2217495d1e53ef7231ebe5c8708c0b348c55578af4fe3ff
-  data.tar.gz: 5f89035aa648667e597e9620935568ce3290b3af9bce8302bad9a7540c32f89d
+  metadata.gz: 9f1ccbf6d14948ea0dba9dc444126117dcecfec2723bd6bda6278c8cb61e33f2
+  data.tar.gz: 5d3bceb49b3e9d08bb7a88720445238b3fd6603afdc2862c918afae33ebd70b0
 SHA512:
-  metadata.gz: d09cae540773f16b23ab72451de89a3854c68883f856a7e5de0f6535acf2c4b035f1cb0240f66ae272ab6cf127d0415e1994390e99d5df75f858b670bb2aa902
-  data.tar.gz: cb7c3e8b7f0b4ae063b4cf2e7bb47914dd6457290a0ea4527d8c1ba54264db749564f4e5fc76e6ecedb7ec69237ec6b10f2191a2a9edfb2ec85f4a866a6b825c
+  metadata.gz: 45e93d16075a9f89a49fe3f1797ce2e337fb95abdc5a286b9d85c88320920ce020e14285f80f48bc5c25d7f1b45d5378a05157c7bd7354a9f5b5787a2b5b413f
+  data.tar.gz: d9cbdaf061fc4d22e6657318adb33e59d6df1b1b07e93150f705b481e0561a6dfd376c0afbecc3a946203dd9c3b05ae05f6c5b932bc54f6f2c345afc630a1d0c

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in utopia.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/benchmarks/call_vs_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark/ips'
 
 class A

data/benchmarks/const_vs_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark/ips'
 
 module Foo

data/benchmarks/hash_vs_openstruct.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark/ips'
 require 'ostruct'
 

data/benchmarks/string_vs_symbol.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark/ips'
 
 STRING_HASH = { "foo" => "bar" }

data/benchmarks/struct_vs_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark/ips'
 
 # This benchmark compares accessing an instance variable vs accessing a struct member (via a function). The actual method dispatch is about 25% slower.

data/documentation/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 source "https://rubygems.org"
 

data/documentation/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'pathname'
 SITE_ROOT = Pathname.new(__dir__).realpath

data/documentation/config.ru

@@ -1,4 +1,5 @@
 #!/usr/bin/env rackup
+# frozen_string_literal: true
 
 require_relative 'config/environment'
 

data/documentation/config/environment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'bundler/setup'
 Bundler.setup

data/documentation/pages/wiki/controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 prepend Actions
 

data/documentation/spec/website_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'rack/test'
 

data/documentation/spec/website_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require_relative 'website_context'
 

data/lib/utopia.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/command/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/command/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/command/site.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -21,6 +23,7 @@
 require_relative 'middleware'
 require_relative 'localization'
 
+require_relative 'content/links'
 require_relative 'content/node'
 require_relative 'content/markup'
 require_relative 'content/tags'
@@ -46,6 +49,8 @@ module Utopia
 			@template_cache = Concurrent::Map.new
 			@node_cache = Concurrent::Map.new
 			
+			@links = Links.new(@root)
+			
 			@namespaces = namespaces
 			
 			# Default content namespace for dynamic path based lookup:
@@ -67,6 +72,10 @@ module Utopia
 		
 		attr :root
 		
+		def links(path, **options)
+			@links.index(path, options)
+		end
+		
 		def fetch_template(path)
 			@template_cache.fetch_or_store(path.to_s) do
 				Trenni::MarkupTemplate.load_file(path)
@@ -112,7 +121,7 @@ module Utopia
 			end
 
 			locale = env[Localization::CURRENT_LOCALE_KEY]
-			if link = Links.for(@root, path, locale)
+			if link = @links.for(path, locale)
 				if link.path and node = lookup_node(link.path)
 					attributes = request.env.fetch(VARIABLES_KEY, {}).to_hash
 					

data/lib/utopia/content/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/content/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy

data/lib/utopia/content/links.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,15 +22,35 @@
 
 require_relative 'link'
 
+require 'concurrent/map'
+
 module Utopia
 	class Content
 		# The file extension for markup nodes on disk.
 		XNODE_EXTENSION = '.xnode'.freeze
 		
-		# Represents a list of {Link} instances relating to the structure of the content. They are formed from the `links.yaml` file and the actual directory structure on disk.
 		class Links
 			def self.for(root, path, locale = nil)
-				links = self.new(root, path.dirname)
+				warn "Using uncached links metadata!"
+				self.new(root).for(path, locale)
+			end
+			
+			def self.index(root, path, **options)
+				warn "Using uncached links metadata!"
+				self.new(root).index(path, **options)
+			end
+			
+			XNODE_FILTER = /^(.+)#{Regexp.escape XNODE_EXTENSION}$/
+			INDEX_XNODE_FILTER = /^(index(\..+)*)#{Regexp.escape XNODE_EXTENSION}$/
+			
+			def initialize(root)
+				@root = root
+				
+				@cache = Concurrent::Map.new
+			end
+			
+			def for(path, locale = nil)
+				links = Resolved.new(self, path.dirname)
 				
 				links.lookup(path.last, locale)
 			end
@@ -42,10 +64,10 @@ module Utopia
 				:display => :display,
 			}
 			
-			def self.index(root, path, **options)
+			def index(path, **options)
 				options = DEFAULT_INDEX_OPTIONS.merge(options)
 				
-				ordered = self.new(root, path, options).ordered
+				ordered = Resolved.new(self, path, options).ordered
 				
 				# This option filters a link based on the display parameter.
 				if display_key = options[:display]
@@ -81,152 +103,166 @@ module Utopia
 				return ordered
 			end
 			
-			XNODE_FILTER = /^(.+)#{Regexp.escape XNODE_EXTENSION}$/
-			INDEX_XNODE_FILTER = /^(index(\..+)*)#{Regexp.escape XNODE_EXTENSION}$/
-			LINKS_YAML = "links.yaml"
-			
-			DEFAULT_OPTIONS = {
-				:directories => true,
-				:files => true,
-				:virtuals => true,
-				:indices => true,
-			}
+			attr :root
 			
-			def initialize(root, top = Path.root, options = DEFAULT_OPTIONS)
-				raise ArgumentError.new("top path must be absolute") unless top.absolute?
-				
-				@top = top
-				@options = options
+			# Represents a list of {Link} instances relating to the structure of the content. They are formed from the `links.yaml` file and the actual directory structure on disk.
+			class Resolved
+				DEFAULT_OPTIONS = {
+					:directories => true,
+					:files => true,
+					:virtuals => true,
+					:indices => true,
+				}
 				
-				# top.components.first == '', but this isn't a problem here.
-				@path = File.join(root, top.components)
-				@metadata = self.class.metadata(@path)
+				def initialize(links, top = Path.root, options = DEFAULT_OPTIONS)
+					raise ArgumentError.new("top path must be absolute") unless top.absolute?
+					
+					@links = links
+					
+					@top = top
+					@options = options
+					
+					# top.components.first == '', but this isn't a problem here.
+					@path = File.join(links.root, top.components)
+					
+					@ordered = []
+					@named = Hash.new{|h,k| h[k] = []}
+					
+					if File.directory? @path
+						@metadata = links.metadata(@path)
+						
+						load_links(@metadata.dup) do |link|
+							@ordered << link
+							@named[link.name] << link
+						end
+					else
+						@metadata = {}
+					end
+				end
 				
-				@ordered = []
-				@named = Hash.new{|h,k| h[k] = []}
+				attr :top
+				attr :ordered
+				attr :named
 				
-				if File.directory? @path
-					load_links(@metadata.dup) do |link|
-						@ordered << link
-						@named[link.name] << link
+				def each(locale)
+					return to_enum(:each, locale) unless block_given?
+					
+					ordered.each do |links|
+						yield links.find{|link| link.locale == locale}
 					end
 				end
-			end
-			
-			attr :top
-			attr :ordered
-			attr :named
-			
-			def each(locale)
-				return to_enum(:each, locale) unless block_given?
 				
-				ordered.each do |links|
-					yield links.find{|link| link.locale == locale}
-				end
-			end
-			
-			def lookup(name, locale = nil)
-				# This allows generic links to serve any locale requested.
-				if links = @named[name]
-					links.find{|link| link.locale == locale} || links.find{|link| link.locale == nil}
-				end
-			end
-			
-			private
-			
-			def self.symbolize_keys(hash)
-				# Second level attributes should be symbolic:
-				hash.each do |key, info|
-					hash[key] = info.each_with_object({}) { |(k,v),result| result[k.to_sym] = v }
+				def lookup(name, locale = nil)
+					# This allows generic links to serve any locale requested.
+					if links = @named[name]
+						links.find{|link| link.locale == locale} || links.find{|link| link.locale == nil}
+					end
 				end
 				
-				return hash
-			end
-			
-			def self.metadata(path)
-				links_path = File.join(path, LINKS_YAML)
+				private
 				
-				hash = if File.exist?(links_path)
-					YAML::load_file(links_path) || {}
-				else
-					{}
+				def indices(path, &block)
+					Dir.entries(path).select{|filename| filename.match(INDEX_XNODE_FILTER)}
 				end
 				
-				return symbolize_keys(hash)
-			end
-			
-			def indices(path, &block)
-				Dir.entries(path).select{|filename| filename.match(INDEX_XNODE_FILTER)}
-			end
-			
-			def load_indices(name, path, metadata)
-				directory_metadata = metadata.delete(name) || {}
-				indices_metadata = Links.metadata(path)
-				
-				indices_count = 0
-				
-				indices(path).each do |filename|
-					index_name = File.basename(filename, XNODE_EXTENSION)
-					# Values in indices_metadata will override values in directory_metadata:
-					index_metadata = directory_metadata.merge(indices_metadata[index_name] || {})
+				def load_indices(name, path, metadata)
+					directory_metadata = metadata.delete(name) || {}
+					indices_metadata = @links.metadata(path)
 					
-					directory_link = Link.new(:directory, @top + [name, index_name], index_metadata)
+					indices_count = 0
 					
-					# Merge metadata from foo.en into foo/index.en
-					if directory_link.locale
-						localized_key = "#{directory_link.name}.#{directory_link.locale}"
-						if localized_metadata = metadata.delete(localized_key)
-							directory_link.info.update(localized_metadata)
+					indices(path).each do |filename|
+						index_name = File.basename(filename, XNODE_EXTENSION)
+						# Values in indices_metadata will override values in directory_metadata:
+						index_metadata = directory_metadata.merge(indices_metadata[index_name] || {})
+						
+						directory_link = Link.new(:directory, @top + [name, index_name], index_metadata)
+						
+						# Merge metadata from foo.en into foo/index.en
+						if directory_link.locale
+							localized_key = "#{directory_link.name}.#{directory_link.locale}"
+							if localized_metadata = metadata.delete(localized_key)
+								directory_link.info.update(localized_metadata)
+							end
 						end
+						
+						yield directory_link
+						
+						indices_count += 1
 					end
 					
-					yield directory_link
-					
-					indices_count += 1
+					if indices_count == 0
+						# Specify a nil uri if no index could be found for the directory:
+						yield Link.new(:directory, top + [name], {:uri => nil}.merge(directory_metadata))
+					end
 				end
 				
-				if indices_count == 0
-					# Specify a nil uri if no index could be found for the directory:
-					yield Link.new(:directory, top + [name], {:uri => nil}.merge(directory_metadata))
+				def entries(path)
+					Dir.entries(path).reject{|filename| filename.match(/^[\._]/)}
+				end
+				
+				def load_links(metadata, &block)
+					# Load all metadata for a given path:
+					metadata = @metadata.dup
+					
+					# Check all entries in the given directory:
+					entries(@path).each do |filename|
+						path = File.join(@path, filename)
+						
+						# There are two types of filelinks based links:
+						# 1/ Named files, e.g. foo.xnode, name=foo
+						# 2/ Directories, e.g. bar/index.xnode, name=bar
+						if File.directory?(path) and @options[:directories]
+							load_indices(filename, path, metadata, &block)
+						elsif filename.match(INDEX_XNODE_FILTER) and @options[:indices] == false
+							metadata.delete($1) # We don't include indices in the list of pages.
+						elsif filename.match(XNODE_FILTER) and @options[:files]
+							yield Link.new(:file, @top + $1, metadata.delete($1))
+						end
+					end
+					
+					if @options[:virtuals]
+						# After processing all directory entries, we are left with virtual entries in the metadata:
+						metadata.each do |name, info|
+							virtual_link = Link.new(:virtual, name, info)
+							
+							# Given a virtual named such as "welcome.cn", merge it with metadata from "welcome" if it exists:
+							if virtual_metadata = @metadata[virtual_link.name]
+								virtual_link.info.update(virtual_metadata)
+							end
+							
+							yield virtual_link
+						end
+					end
 				end
 			end
 			
-			def entries(path)
-				Dir.entries(path).reject{|filename| filename.match(/^[\._]/)}
+			def metadata(path)
+				@cache.fetch_or_store(path.to_s) do
+					load(path).freeze
+				end
 			end
 			
-			def load_links(metadata, &block)
-				# Load all metadata for a given path:
-				metadata = @metadata.dup
-				
-				# Check all entries in the given directory:
-				entries(@path).each do |filename|
-					path = File.join(@path, filename)
-					
-					# There are two types of filesystem based links:
-					# 1/ Named files, e.g. foo.xnode, name=foo
-					# 2/ Directories, e.g. bar/index.xnode, name=bar
-					if File.directory?(path) and @options[:directories]
-						load_indices(filename, path, metadata, &block)
-					elsif filename.match(INDEX_XNODE_FILTER) and @options[:indices] == false
-						metadata.delete($1) # We don't include indices in the list of pages.
-					elsif filename.match(XNODE_FILTER) and @options[:files]
-						yield Link.new(:file, @top + $1, metadata.delete($1))
-					end
+			private
+			
+			def symbolize_keys(hash)
+				# Second level attributes should be symbolic:
+				hash.each do |key, info|
+					hash[key] = info.each_with_object({}) { |(k,v),result| result[k.to_sym] = v }
 				end
 				
-				if @options[:virtuals]
-					# After processing all directory entries, we are left with virtual entries in the metadata:
-					metadata.each do |name, info|
-						virtual_link = Link.new(:virtual, name, info)
-						
-						# Given a virtual named such as "welcome.cn", merge it with metadata from "welcome" if it exists:
-						if virtual_metadata = @metadata[virtual_link.name]
-							virtual_link.info.update(virtual_metadata)
-						end
-						
-						yield virtual_link
-					end
+				return hash
+			end
+			
+			LINKS_YAML = "links.yaml"
+			
+			def load(path)
+				yaml_path = File.join(path, LINKS_YAML)
+				
+				if File.exist?(yaml_path) && data = YAML::load_file(yaml_path)
+					return symbolize_keys(data)
+				else
+					return {}
 				end
 			end
 		end