utopia 2.13.4 → 2.16.1

data/lib/utopia/localization.rb

@@ -35,6 +35,10 @@ module Utopia
 				@env[LOCALIZATION_KEY]
 			end
 			
+			def localized?
+				localization != nil
+			end
+			
 			# Returns the current locale or nil if not localized.
 			def current_locale
 				@env[CURRENT_LOCALE_KEY]
@@ -49,6 +53,10 @@ module Utopia
 			def all_locales
 				localization && localization.all_locales || []
 			end
+			
+			def localized_path(path, locale)
+				"/#{locale}#{path}"
+			end
 		end
 		
 		def self.[] request
@@ -66,15 +74,19 @@ module Utopia
 		# @param default_locales [String] The locales to try in order if none is provided.
 		# @param hosts [Hash<Pattern, String>] Specify a mapping of the HTTP_HOST header to a given locale.
 		# @param ignore [Array<Pattern>] A list of patterns matched against PATH_INFO which will not be localized.
-		def initialize(app, locales:, default_locale: nil, default_locales: nil, hosts: {}, ignore: [], **options)
+		def initialize(app, locales:, default_locale: nil, default_locales: nil, hosts: {}, ignore: [])
 			@app = app
 			
 			@all_locales = HTTP::Accept::Languages::Locales.new(locales)
 			
 			# Locales here are represented as an array of strings, e.g. ['en', 'ja', 'cn', 'de'] and are used in order if no locale is specified by the user.
 			unless @default_locales = default_locales
-				# We append nil, i.e. no localization.
-				@default_locales = @all_locales.names + [nil]
+				if default_locale
+					@default_locales = [default_locale, nil]
+				else
+					# We append nil, i.e. no localization.
+					@default_locales = @all_locales.names + [nil]
+				end
 			end
 			
 			@default_locale = default_locale || @default_locales.first
@@ -87,6 +99,8 @@ module Utopia
 			@hosts = hosts
 			
 			@ignore = ignore || options[:nonlocalized]
+			
+			@methods = methods
 		end
 		
 		def freeze
@@ -166,13 +180,7 @@ module Utopia
 			return []
 		end
 		
-		SAFE_METHODS = ['GET', 'HEAD']
-		
 		def localized?(env)
-			# Only SAFE_METHODS can be localized:
-			request_method = env[Rack::REQUEST_METHOD]
-			return false unless SAFE_METHODS.include?(request_method)
-			
 			# Ignore requests which match the ignored paths:
 			path_info = env[Rack::PATH_INFO]
 			return false if @ignore.any? { |pattern| path_info[pattern] != nil }
@@ -206,7 +214,7 @@ module Utopia
 			
 			# We have a non-localized request, but there might be a localized resource. We return the best localization possible:
 			preferred_locales(env) do |localized_env|
-				# puts "Trying locale: #{env[CURRENT_LOCALE_KEY]}: #{env[Rack::PATH_INFO]}..."
+				# puts "Trying locale: #{localized_env[CURRENT_LOCALE_KEY]}: #{localized_env[Rack::PATH_INFO]}..."
 				
 				response = @app.call(localized_env)
 				

data/lib/utopia/middleware.rb

@@ -39,7 +39,7 @@ module Utopia
 	
 	# The same as {default_root} but returns an instance of {Path}.
 	# @return [Path] The path as requested.
-	def self.default_path(*args)
-		Path[default_root(*args)]
+	def self.default_path(*arguments)
+		Path[default_root(*arguments)]
 	end
 end

data/lib/utopia/path.rb

@@ -30,9 +30,9 @@ module Utopia
 		def initialize(components = [])
 			@components = components
 		end
-
+		
 		attr_accessor :components
-
+		
 		def freeze
 			@components.freeze
 			
@@ -65,22 +65,22 @@ module Utopia
 			
 			return self.create([".."] * up + path.components[i..-1])
 		end
-
+		
 		def shortest_path(root)
 			self.class.shortest_path(self, root)
 		end
-
+		
 		# 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*')
 			}
 		end
-
+		
 		def self.[] path
 			self.create(path)
 		end
-
+		
 		def self.split(path)
 			case path
 			when Path
@@ -115,23 +115,25 @@ module Utopia
 				return self.new(path)
 			when String
 				return self.new(unescape(path).split(SEPARATOR, -1))
+			when nil
+				return nil
 			else
 				return self.new([path])
 			end
 		end
-
+		
 		def replace(other_path)
 			@components = other_path.components.dup
 		end
-
-		def include?(*args)
-			@components.include?(*args)
+		
+		def include?(*arguments)
+			@components.include?(*arguments)
 		end
 		
 		def directory?
 			return @components.last == ''
 		end
-
+		
 		def to_directory
 			if directory?
 				return self
@@ -139,15 +141,15 @@ module Utopia
 				return join([''])
 			end
 		end
-
+		
 		def relative?
 			@components.first != ''
 		end
-
+		
 		def absolute?
 			@components.first == ''
 		end
-
+		
 		def to_absolute
 			if absolute?
 				return self
@@ -155,11 +157,11 @@ module Utopia
 				return self.class.new([''] + @components)
 			end
 		end
-
+		
 		def to_relative!
 			@components.shift if relative?
 		end
-
+		
 		def to_str
 			if @components == ['']
 				SEPARATOR
@@ -167,21 +169,21 @@ module Utopia
 				@components.join(SEPARATOR)
 			end
 		end
-
+		
 		alias to_s to_str
 		
 		def to_a
 			@components
 		end
-
+		
 		def join(other)
 			self.class.new(@components + other).simplify
 		end
-
+		
 		def expand(root)
 			root + self
 		end
-
+		
 		def +(other)
 			if other.kind_of? Path
 				if other.absolute?
@@ -197,11 +199,11 @@ module Utopia
 				return join([other.to_s])
 			end
 		end
-
-		def with_prefix(*args)
-			self.class.create(*args) + self
+		
+		def with_prefix(*arguments)
+			self.class.create(*arguments) + self
 		end
-
+		
 		# Computes the difference of the path.
 		# /a/b/c - /a/b -> c
 		# a/b/c - a/b -> c
@@ -216,10 +218,10 @@ module Utopia
 			
 			return self.class.new(@components[i,@components.size])
 		end
-
+		
 		def simplify
 			result = absolute? ? [''] : []
-
+			
 			@components.each do |bit|
 				if bit == ".."
 					result.pop
@@ -227,18 +229,20 @@ module Utopia
 					result << bit
 				end
 			end
-
+			
 			result << '' if directory?
 			
 			return self.class.new(result)
 		end
-
+		
+		# @return [String] the last path component without any file extension.
 		def basename
 			basename, _ = @components.last.split('.', 2)
 			
 			return basename || ''
 		end
 		
+		# @return [String] the last path component's file extension.
 		def extension
 			_, extension = @components.last.split('.', 2)
 			
@@ -247,14 +251,14 @@ module Utopia
 		
 		def dirname(count = 1)
 			path = self.class.new(@components[0...-count])
-
+			
 			return absolute? ? path.to_absolute : path
 		end
-
-		def to_local_path(separator = File::SEPARATOR)
+		
+		def local_path(separator = File::SEPARATOR)
 			@components.join(separator)
 		end
-
+		
 		def descend(&block)
 			return to_enum(:descend) unless block_given?
 			
@@ -278,7 +282,7 @@ module Utopia
 				components.pop
 			end
 		end
-
+		
 		def split(at)
 			if at.kind_of? String
 				at = @components.index(at)
@@ -290,15 +294,15 @@ module Utopia
 				return nil
 			end
 		end
-
+		
 		def dup
 			return Path.new(components.dup)
 		end
-
+		
 		def <=> other
 			@components <=> other.components
 		end
-
+		
 		def eql? other
 			self.class.eql?(other.class) and @components.eql?(other.components)
 		end

data/lib/utopia/redirection.rb

@@ -54,8 +54,6 @@ module Utopia
 				super
 			end
 			
-			CONTENT_TYPE = 'Content-Type'.freeze
-			
 			def unhandled_error?(response)
 				response[0] >= 400 && response[1].empty?
 			end

data/lib/utopia/responder.rb

@@ -0,0 +1,76 @@
+# 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
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'middleware'
+
+module Utopia
+	class Responder
+		Handler = Struct.new(:content_type, :block) do
+			def split(*arguments)
+				self.content_type.split(*arguments)
+			end
+			
+			def call(context, request, media_range, *arguments, **options)
+				context.instance_exec(media_range, *arguments, **options, &self.block)
+			end
+		end
+		
+		Responds = Struct.new(:responder, :context, :request) do
+			# @todo Refactor `object` -> `*arguments`...
+			def with(object, **options)
+				responder.call(context, request, object, **options)
+			end
+		end
+		
+		def initialize
+			@handlers = HTTP::Accept::MediaTypes::Map.new
+		end
+		
+		attr :handlers
+		
+		def freeze
+			@handlers.freeze
+			
+			super
+		end
+		
+		def call(context, request, *arguments, **options)
+			# Parse the list of browser preferred content types and return ordered by priority:
+			media_types = HTTP::Accept::MediaTypes.browser_preferred_media_types(request.env)
+			
+			handler, media_range = @handlers.for(media_types)
+			
+			if handler
+				handler.call(context, request, media_range, *arguments, **options)
+			end
+		end
+		
+		# Add a converter for the specified content type. Call the block with the response content if the request accepts the specified content_type.
+		def handle(content_type, &block)
+			@handlers << Handler.new(content_type, block)
+		end
+		
+		def respond_to(context, request)
+			Responds.new(self, context, request)
+		end
+	end
+end

data/lib/utopia/version.rb

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

data/setup/site/.gitignore

@@ -1,14 +1,15 @@
 # Development specific:
-.rspec_status
-.tags*
-.bundle
-bin/
+/.rspec_status
+/.bundle
 
 # Temporary data should not be added to the repository:
-tmp/
+/tmp
+
+# Node modules are 3rd party dependencies which can be fetched easily:
+/node_modules
 
 # This file should only ever exist on production, and may contain sensitive information:
-config/environment.yaml
+/config/environment.yaml
 
 # Ignore resized gallery photos:
-public/_gallery/
+/public/_gallery

data/setup/site/Gemfile

@@ -2,15 +2,17 @@
 
 source 'https://rubygems.org'
 
-gem 'utopia', '~> $UTOPIA_VERSION'
-# gem 'utopia-gallery'
-# gem 'utopia-analytics'
+group :preload do
+	gem 'utopia', '~> $UTOPIA_VERSION'
+	# gem 'utopia-gallery'
+	# gem 'utopia-analytics'
+	
+	gem 'variant'
+end
 
 gem 'rake'
 gem 'bake'
-gem 'variant'
 gem 'bundler'
-
 gem 'rack-test'
 
 group :development do