utopia 2.25.0 → 2.26.1

data/lib/utopia/controller/actions.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2014-2024, by Samuel Williams.
+# Copyright, 2014-2025, by Samuel Williams.
 
-require_relative '../http'
+require_relative "../http"
 
 module Utopia
 	class Controller
@@ -45,10 +45,10 @@ module Utopia
 				end
 				
 				# Matches 0 or more path components.
-				WILDCARD_GREEDY = '**'.freeze
+				WILDCARD_GREEDY = "**".freeze
 				
 				# Matches any 1 path component.
-				WILDCARD = '*'.freeze
+				WILDCARD = "*".freeze
 				
 				# Given a path, iterate over all actions that match. Actions match from most specific to most general.
 				# @return nil if nothing matched, or true if something matched.
@@ -121,7 +121,7 @@ module Utopia
 				
 				def on(first, *path, **options, &block)
 					if first.is_a? Symbol
-						first = ['**', first.to_s]
+						first = ["**", first.to_s]
 					end
 					
 					actions.define(Path.split(first) + path, **options, &block)

data/lib/utopia/controller/base.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014-2025, by Samuel Williams.
 
-require_relative '../http'
+require_relative "../http"
 
 module Utopia
 	class Controller

data/lib/utopia/controller/respond.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2022, by Samuel Williams.
+# Copyright, 2016-2025, by Samuel Williams.
 
-require_relative '../http'
-require_relative '../responder'
+require_relative "../http"
+require_relative "../responder"
 
 module Utopia
 	class Controller
@@ -16,14 +16,14 @@ module Utopia
 			
 			module Handlers
 				module JSON
-					APPLICATION_JSON = HTTP::Accept::ContentType.new('application', 'json').freeze
+					APPLICATION_JSON = HTTP::Accept::ContentType.new("application", "json").freeze
 					
 					def self.split(*arguments)
 						APPLICATION_JSON.split(*arguments)
 					end
 					
 					def self.call(context, request, media_range, object, **options)
-						if version = media_range.parameters['version']
+						if version = media_range.parameters["version"]
 							options[:version] = version.to_s
 						end
 						
@@ -32,7 +32,7 @@ module Utopia
 				end
 				
 				module Passthrough
-					WILDCARD = HTTP::Accept::MediaTypes::MediaRange.new('*', '*').freeze
+					WILDCARD = HTTP::Accept::MediaTypes::MediaRange.new("*", "*").freeze
 					
 					def self.split(*arguments)
 						WILDCARD.split(*arguments)

data/lib/utopia/controller/rewrite.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2022, by Samuel Williams.
+# Copyright, 2015-2025, by Samuel Williams.
 
-require_relative '../http'
-require_relative '../path/matcher'
+require_relative "../http"
+require_relative "../path/matcher"
 
 module Utopia
 	class Controller

data/lib/utopia/controller.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2025, by Samuel Williams.
 
-require_relative 'path'
+require_relative "path"
 
-require_relative 'middleware'
-require_relative 'controller/variables'
-require_relative 'controller/base'
+require_relative "middleware"
+require_relative "controller/variables"
+require_relative "controller/base"
 
-require_relative 'controller/rewrite'
-require_relative 'controller/respond'
-require_relative 'controller/actions'
+require_relative "controller/rewrite"
+require_relative "controller/respond"
+require_relative "controller/actions"
 
-require 'concurrent/map'
+require "concurrent/map"
 
 module Utopia
 	# A middleware which loads controller classes and invokes functionality based on the requested path.
 	class Controller
 		# The controller filename.
-		CONTROLLER_RB = 'controller.rb'.freeze
+		CONTROLLER_RB = "controller.rb".freeze
 		
 		def self.[] request
 			request.env[VARIABLES_KEY]

data/lib/utopia/exceptions/handler.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014-2025, by Samuel Williams.
 
 module Utopia
 	module Exceptions
 		# A middleware which catches exceptions and performs an internal redirect.
 		class Handler
 			# @param location [String] Peform an internal redirect to this location when an exception is raised.
-			def initialize(app, location = '/errors/exception')
+			def initialize(app, location = "/errors/exception")
 				@app = app
 				
 				@location = location
@@ -34,7 +34,7 @@ module Utopia
 			
 			def log_exception(env, exception)
 				# An error has occurred, log it:
-				output = env['rack.errors'] || $stderr
+				output = env["rack.errors"] || $stderr
 				write_exception_to_stream(output, env, exception, true)
 			end
 			

data/lib/utopia/exceptions/mailer.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2022, by Samuel Williams.
+# Copyright, 2016-2025, by Samuel Williams.
 
-require 'net/smtp'
-require 'mail'
+require "net/smtp"
+require "mail"
 
 module Utopia
 	module Exceptions
@@ -17,8 +17,8 @@ module Utopia
 				:enable_starttls_auto => false
 			}]
 			
-			DEFAULT_FROM = (ENV['USER'] || 'utopia').freeze
-			DEFAULT_SUBJECT = '%{exception} [PID %{pid} : %{cwd}]'.freeze
+			DEFAULT_FROM = (ENV["USER"] || "utopia").freeze
+			DEFAULT_SUBJECT = "%{exception} [PID %{pid} : %{cwd}]".freeze
 			
 			# @param to [String] The address to email error reports to.
 			# @param from [String] The from address for error reports.
@@ -66,6 +66,21 @@ module Utopia
 				:user_agent,
 			]
 			
+			ENV_KEYS = [
+				"PATH_INFO",
+				"REQUEST_METHOD",
+				"REQUEST_PATH",
+				"REQUEST_URI",
+				"SCRIPT_NAME",
+				"QUERY_STRING",
+				"SERVER_PROTOCOL",
+				"SERVER_NAME",
+				"SERVER_PORT",
+				"REMOTE_ADDR",
+				"CONTENT_TYPE",
+				"CONTENT_LENGTH",
+			]
+			
 			def generate_backtrace(io, exception, prefix: "Exception")
 				io.puts "#{prefix} #{exception.class.name}: #{exception.to_s}"
 				
@@ -104,7 +119,14 @@ module Utopia
 				
 				io.puts
 				
-				env.select{|key,_| key.start_with? 'HTTP_'}.each do |key, value|
+				ENV_KEYS.each do |key|
+					value = env[key]
+					io.puts "env[#{key.inspect}]: #{value.inspect}"
+				end
+				
+				io.puts
+				
+				env.select{|key,_| key.start_with? "HTTP_"}.each do |key, value|
 					io.puts "#{key}: #{value.inspect}"
 				end
 				
@@ -134,11 +156,11 @@ module Utopia
 				mail.text_part.body = generate_body(exception, env)
 			
 				if body = extract_body(env) and body.size > 0
-					mail.attachments['body.bin'] = body
+					mail.attachments["body.bin"] = body
 				end
 				
 				if @dump_environment
-					mail.attachments['environment.yaml'] = YAML.dump(env)
+					mail.attachments["environment.yaml"] = YAML.dump(env)
 				end
 
 				return mail
@@ -156,7 +178,7 @@ module Utopia
 			end
 
 			def extract_body(env)
-				if io = env['rack.input']
+				if io = env["rack.input"]
 					io.rewind if io.respond_to?(:rewind)
 					io.read
 				end

data/lib/utopia/exceptions.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2022, by Samuel Williams.
+# Copyright, 2016-2025, by Samuel Williams.
 
-require_relative 'exceptions/handler'
-require_relative 'exceptions/mailer'
+require_relative "exceptions/handler"
+require_relative "exceptions/mailer"
 
 module Utopia
 	# Middleware for handling exceptional situations.

data/lib/utopia/extensions/date_comparisons.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2010-2022, by Samuel Williams.
+# Copyright, 2010-2025, by Samuel Williams.
 
-require 'date'
+require "date"
 
 module Utopia
 	module Extensions

data/lib/utopia/http.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2010-2022, by Samuel Williams.
+# Copyright, 2010-2025, by Samuel Williams.
 
-require 'rack'
+require "rack"
 
-require 'http/accept'
+require "http/accept"
 
 module Utopia
 	# HTTP protocol implementation.
@@ -41,41 +41,41 @@ module Utopia
 		# A list of human readable descriptions for a given status code.
 		# For a more detailed description, see https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
 		STATUS_DESCRIPTIONS = {
-			200 => 'OK'.freeze,
-			201 => 'Created'.freeze,
-			202 => 'Accepted'.freeze,
-			203 => 'Non-Authoritive Information'.freeze,
-			204 => 'No Content'.freeze,
-			205 => 'Reset Content'.freeze,
-			206 => 'Partial Content'.freeze,
-			300 => 'Multiple Choices'.freeze,
-			301 => 'Moved Permanently'.freeze,
-			302 => 'Found'.freeze,
-			303 => 'See Other'.freeze,
-			304 => 'Not Modified'.freeze,
-			305 => 'Use Proxy'.freeze,
-			307 => 'Temporary Redirect'.freeze,
-			308 => 'Permanent Redirect'.freeze,
-			400 => 'Bad Request'.freeze,
-			401 => 'Permission Denied'.freeze,
-			402 => 'Payment Required'.freeze,
-			403 => 'Access Forbidden'.freeze,
-			404 => 'Resource Not Found'.freeze,
-			405 => 'Unsupported Method'.freeze,
-			406 => 'Not Acceptable'.freeze,
-			408 => 'Request Timeout'.freeze,
-			409 => 'Request Conflict'.freeze,
-			410 => 'Resource Removed'.freeze,
-			416 => 'Byte range unsatisfiable'.freeze,
-			422 => 'Unprocessible Entity'.freeze,
-			500 => 'Internal Server Error'.freeze,
-			501 => 'Not Implemented'.freeze,
-			503 => 'Service Unavailable'.freeze
+			200 => "OK".freeze,
+			201 => "Created".freeze,
+			202 => "Accepted".freeze,
+			203 => "Non-Authoritive Information".freeze,
+			204 => "No Content".freeze,
+			205 => "Reset Content".freeze,
+			206 => "Partial Content".freeze,
+			300 => "Multiple Choices".freeze,
+			301 => "Moved Permanently".freeze,
+			302 => "Found".freeze,
+			303 => "See Other".freeze,
+			304 => "Not Modified".freeze,
+			305 => "Use Proxy".freeze,
+			307 => "Temporary Redirect".freeze,
+			308 => "Permanent Redirect".freeze,
+			400 => "Bad Request".freeze,
+			401 => "Permission Denied".freeze,
+			402 => "Payment Required".freeze,
+			403 => "Access Forbidden".freeze,
+			404 => "Resource Not Found".freeze,
+			405 => "Unsupported Method".freeze,
+			406 => "Not Acceptable".freeze,
+			408 => "Request Timeout".freeze,
+			409 => "Request Conflict".freeze,
+			410 => "Resource Removed".freeze,
+			416 => "Byte range unsatisfiable".freeze,
+			422 => "Unprocessible Entity".freeze,
+			500 => "Internal Server Error".freeze,
+			501 => "Not Implemented".freeze,
+			503 => "Service Unavailable".freeze
 		}.merge(Rack::Utils::HTTP_STATUS_CODES)
 		
-		CONTENT_TYPE = 'content-type'.freeze
-		LOCATION = 'location'.freeze
-		CACHE_CONTROL = 'cache-control'.freeze
+		CONTENT_TYPE = "content-type".freeze
+		LOCATION = "location".freeze
+		CACHE_CONTROL = "cache-control".freeze
 		
 		# A small HTTP status wrapper that verifies the status code within a given range.
 		class Status

data/lib/utopia/locale.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2022, by Samuel Williams.
+# Copyright, 2015-2025, by Samuel Williams.
 
 module Utopia
 	# A structured representation of locale based on RFC3066.
 	Locale = Struct.new(:language, :country, :variant) do
 		def to_s
-			to_a.compact.join('-')
+			to_a.compact.join("-")
 		end
 		
 		def self.dump(instance)
@@ -18,7 +18,7 @@ module Utopia
 		
 		def self.load(instance)
 			if instance.is_a? String
-				self.new(*instance.split('-', 3))
+				self.new(*instance.split("-", 3))
 			elsif instance.is_a? Array
 				return self.new(*instance)
 			elsif instance.is_a? self

data/lib/utopia/localization.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2025, by Samuel Williams.
 
-require_relative 'middleware'
+require_relative "middleware"
 
 module Utopia
 	# A middleware which attempts to find localized content.
@@ -48,9 +48,9 @@ module Utopia
 		
 		RESOURCE_NOT_FOUND = [400, {}, []].freeze
 		
-		HTTP_ACCEPT_LANGUAGE = 'HTTP_ACCEPT_LANGUAGE'.freeze
-		LOCALIZATION_KEY = 'utopia.localization'.freeze
-		CURRENT_LOCALE_KEY = 'utopia.localization.current_locale'.freeze
+		HTTP_ACCEPT_LANGUAGE = "HTTP_ACCEPT_LANGUAGE".freeze
+		LOCALIZATION_KEY = "utopia.localization".freeze
+		CURRENT_LOCALE_KEY = "utopia.localization.current_locale".freeze
 		
 		# @param locales [Array<String>] An array of all supported locales.
 		# @param default_locale [String] The default locale if none is provided.
@@ -176,12 +176,12 @@ module Utopia
 			headers = response[1].to_a
 			
 			# This response was based on the Accept-Language header:
-			headers << ['Vary', 'Accept-Language']
+			headers << ["Vary", "Accept-Language"]
 			
 			# Althought this header is generally not supported, we supply it anyway as it is useful for debugging:
 			if locale = env[CURRENT_LOCALE_KEY]
 				# Set the Content-Location to point to the localized URI as requested:
-				headers['Content-Location'] = "/#{locale}" + env[Rack::PATH_INFO]
+				headers["Content-Location"] = "/#{locale}" + env[Rack::PATH_INFO]
 			end
 			
 			return response

data/lib/utopia/middleware.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2025, by Samuel Williams.
 
-require_relative 'http'
-require_relative 'path'
+require_relative "http"
+require_relative "path"
 
 module Utopia
 	# The default pages path for {Utopia::Content} middleware.
-	PAGES_PATH = 'pages'.freeze
+	PAGES_PATH = "pages".freeze
 	
 	# This is used for shared controller variables which get consumed by the content middleware.
-	VARIABLES_KEY = 'utopia.variables'.freeze
+	VARIABLES_KEY = "utopia.variables".freeze
 	
 	# The default root directory for middleware to operate within, e.g. the web-site directory. Convention over configuration.
 	# @param subdirectory [String] Appended to the default root to make a more specific path.

data/lib/utopia/path/matcher.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2015-2022, by Samuel Williams.
+# Copyright, 2015-2025, by Samuel Williams.
 
-require_relative '../path'
+require_relative "../path"
 
 module Utopia
 	class Path

data/lib/utopia/path.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2025, by Samuel Williams.
 
 module Utopia
 	# Represents a path as an array of path components. Useful for efficient URL manipulation.
 	class Path
 		include Comparable
 		
-		SEPARATOR = '/'
+		SEPARATOR = "/"
 		
 		def initialize(components = [])
 			@components = components
@@ -29,7 +29,7 @@ module Utopia
 		end
 		
 		def self.root
-			self.new([''])
+			self.new([""])
 		end
 		
 		# Returns the length of the prefix which is shared by two strings.
@@ -57,8 +57,8 @@ module Utopia
 		
 		# Converts '+' into whitespace and hex encoded characters into their equivalent characters.
 		def self.unescape(string)
-			string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) {
-				[$1.delete('%')].pack('H*')
+			string.tr("+", " ").gsub(/((?:%[0-9a-fA-F]{2})+)/n) {
+				[$1.delete("%")].pack("H*")
 			}
 		end
 		
@@ -116,34 +116,34 @@ module Utopia
 		end
 		
 		def directory?
-			return @components.last == ''
+			return @components.last == ""
 		end
 		
 		def file?
-			return @components.last != ''
+			return @components.last != ""
 		end
 		
 		def to_directory
 			if directory?
 				return self
 			else
-				return self.class.new(@components + [''])
+				return self.class.new(@components + [""])
 			end
 		end
 		
 		def relative?
-			@components.first != ''
+			@components.first != ""
 		end
 		
 		def absolute?
-			@components.first == ''
+			@components.first == ""
 		end
 		
 		def to_absolute
 			if absolute?
 				return self
 			else
-				return self.class.new([''] + @components)
+				return self.class.new([""] + @components)
 			end
 		end
 		
@@ -152,7 +152,7 @@ module Utopia
 		end
 		
 		def to_str
-			if @components == ['']
+			if @components == [""]
 				SEPARATOR
 			else
 				@components.join(SEPARATOR)
@@ -168,7 +168,7 @@ module Utopia
 		# @parameter other [Array(String)] The path components to append.
 		def join(other)
 			# Check whether other is an absolute path:
-			if other.first == ''
+			if other.first == ""
 				self.class.new(other)
 			else
 				self.class.new(@components + other).simplify
@@ -215,17 +215,17 @@ module Utopia
 		end
 		
 		def simplify
-			result = absolute? ? [''] : []
+			result = absolute? ? [""] : []
 			
 			@components.each do |bit|
 				if bit == ".."
 					result.pop
-				elsif bit != "." && bit != ''
+				elsif bit != "." && bit != ""
 					result << bit
 				end
 			end
 			
-			result << '' if directory?
+			result << "" if directory?
 			
 			return self.class.new(result)
 		end
@@ -241,7 +241,7 @@ module Utopia
 		
 		# Returns the last path component.
 		def last
-			if @components != ['']
+			if @components != [""]
 				@components.last
 			end
 		end
@@ -251,21 +251,21 @@ module Utopia
 		# Pops the last path component.
 		def pop
 			# We don't want to convert an absolute path to a relative path.
-			if @components != ['']
+			if @components != [""]
 				@components.pop
 			end
 		end
 		
 		# @return [String] the last path component without any file extension.
 		def basename
-			basename, _ = @components.last.split('.', 2)
+			basename, _ = @components.last.split(".", 2)
 			
-			return basename || ''
+			return basename || ""
 		end
 		
 		# @return [String] the last path component's file extension.
 		def extension
-			_, extension = @components.last.split('.', 2)
+			_, extension = @components.last.split(".", 2)
 			
 			return extension
 		end

data/lib/utopia/redirection.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2024, by Samuel Williams.
+# Copyright, 2009-2025, by Samuel Williams.
 
-require_relative 'middleware'
+require_relative "middleware"
 
 module Utopia
 	# A middleware which assists with redirecting from one path to another.
@@ -114,7 +114,7 @@ module Utopia
 		
 		# Redirect urls that end with a `/`, e.g. directories.
 		class DirectoryIndex < ClientRedirect
-			def initialize(app, index: 'index')
+			def initialize(app, index: "index")
 				@app = app
 				@index = index
 				
@@ -122,7 +122,7 @@ module Utopia
 			end
 			
 			def [] path
-				if path.end_with?('/')
+				if path.end_with?("/")
 					return redirect(path + @index)
 				end
 			end

data/lib/utopia/responder.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require_relative 'middleware'
+require_relative "middleware"
 
 module Utopia
 	class Responder