utopia 2.15.1 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 642fe3cebd7ad176c3799e0f7f00c94578dcef9b5085e76db697d435983046f4
-  data.tar.gz: 13e6d529f447a8eacf7a71b703bb9f1fa116f02a23b31d701a20697086213182
+  metadata.gz: ddb5cc8a1bb593d344e0d2f2c8bf315704f297ae1e8063b4d7c0e5f3d71f4014
+  data.tar.gz: '09ff4febe6dd06945a3725e0c1354402e23bf837026c5aa09b6c2106b482e00d'
 SHA512:
-  metadata.gz: c0d1c8c6c1229282f5755b3359f8ec595edd3ac2f76c043e2e8a5db5821813a3d9f86eaf1f58767140d7c62af696369495802fef291877104d762580bb2bd9d6
-  data.tar.gz: 0d9652569e0c9194e25d89d85e6b7caa97bc0a219d738dd489d666fc260a27ffb0475b1a62a96ba7b3b2c6f41c76c53819c44688150e0a2f75d40c1219671784
+  metadata.gz: 6a5a89b6bf438d72007dd8617085125aae4a038ee8267716361810e149f9488166323c299aea04baf69ebd54e630e20093c32ec8e016553b11ad46bfa54fe22c
+  data.tar.gz: bf6fcfe77a7423b39fabd019b40309c52db7a15284661243119d32c279d32d51d2467e4bff409cf6d53924baca9cc60d7788b00bbaf4f9986b65e2b0522e5dbd

data/bake/utopia/{yarn.rb → node.rb}

@@ -6,18 +6,18 @@ def update
 	require 'utopia/path'
 	
 	root = Pathname.new(context.root)
-	yarn_package_root = root + "node_modules"
+	package_root = root + "node_modules"
 	
 	# This is a legacy path:
-	unless yarn_package_root.directory?
-		yarn_package_root = root + "lib/components"
+	unless package_root.directory?
+		package_root = root + "lib/components"
 	end
 	
-	yarn_install_root = root + "public/_components"
+	install_root = root + "public/_components"
 	
-	yarn_package_root.children.select(&:directory?).collect(&:basename).each do |package_directory|
-		install_path = yarn_install_root + package_directory
-		package_path = yarn_package_root + package_directory
+	package_root.children.select(&:directory?).collect(&:basename).each do |package_directory|
+		install_path = install_root + package_directory
+		package_path = package_root + package_directory
 		
 		dist_path = package_path + 'dist'
 		

data/lib/utopia/command.rb

@@ -28,8 +28,8 @@ require_relative 'command/environment'
 
 module Utopia
 	module Command
-		def self.call(*args)
-			Top.call(*args)
+		def self.call(*arguments)
+			Top.call(*arguments)
 		end
 		
 		# The top level utopia command.

data/lib/utopia/content/markup.rb

@@ -40,7 +40,7 @@ module Utopia
 				super key.to_sym, value
 			end
 			
-			def fetch(key, *args, &block)
+			def fetch(key, *arguments, &block)
 				key = key.to_sym
 				
 				super

data/lib/utopia/content/node.rb

@@ -128,12 +128,12 @@ module Utopia
 			
 			# This is a special context in which a limited set of well defined methods are exposed in the content view.
 			Context = Struct.new(:document, :state) do
-				def partial(*args, &block)
+				def partial(*arguments, &block)
 					if block_given?
 						state.defer(&block)
 					else
 						state.defer do |document|
-							document.tag(*args)
+							document.tag(*arguments)
 						end
 					end
 				end

data/lib/utopia/content/response.rb

@@ -23,9 +23,9 @@
 module Utopia
 	class Content
 		# Compatibility with older versions of rack:
-		EXPIRES = 'Expires'.freeze
-		CACHE_CONTROL = 'Cache-Control'.freeze
-		CONTENT_TYPE = 'Content-Type'.freeze
+		EXPIRES = 'expires'.freeze
+		CACHE_CONTROL = 'cache-control'.freeze
+		CONTENT_TYPE = 'content-type'.freeze
 		NO_CACHE = 'no-cache'.freeze
 		
 		# A basic content response, including useful defaults for typical HTML5 content.

data/lib/utopia/controller.rb

@@ -33,20 +33,6 @@ require_relative 'controller/actions'
 require 'concurrent/map'
 
 module Utopia
-	# A container for controller classes which are loaded from disk.
-	module Controllers
-		def self.class_name_for_controller(controller)
-			controller.uri_path.to_a.collect{|_| _.capitalize}.join + "_#{controller.object_id}"
-		end
-		
-		def self.define(klass)
-			self.const_set(
-				class_name_for_controller(klass),
-				klass,
-			)
-		end
-	end
-	
 	# A middleware which loads controller classes and invokes functionality based on the requested path.
 	class Controller
 		# The controller filename.
@@ -105,9 +91,6 @@ module Utopia
 				
 				klass.class_eval(File.read(controller_path), controller_path)
 				
-				# Give the controller a useful name:
-				# Controllers.define(klass)
-				
 				# We lock down the controller class to prevent unsafe modifications:
 				klass.freeze
 				

data/lib/utopia/controller/base.rb

@@ -24,6 +24,8 @@ require_relative '../http'
 
 module Utopia
 	class Controller
+		CONTENT_TYPE = HTTP::CONTENT_TYPE
+		
 		# The base implementation of a controller class.
 		class Base
 			# A string which is the full path to the directory which contains the controller.
@@ -41,6 +43,24 @@ module Utopia
 				self.const_get(:CONTROLLER)
 			end
 			
+			def self.inspect
+				"Controller#{self.uri_path}"
+			end
+			
+			def self.to_s
+				self.inspect
+			end
+			
+			def to_s
+				"\#<#{self.class}>"
+			end
+			
+			def inspect
+				details = self.instance_variables.map{|name| " #{name}=#{self.instance_variable_get(name)}"}
+				
+				"\#<#{self.class}#{details.join}>"
+			end
+			
 			class << self
 				def freeze
 					# This ensures that all class variables are frozen.
@@ -116,11 +136,11 @@ module Utopia
 			end
 			
 			# Succeed the request and immediately respond.
-			def succeed!(status: 200, headers: {}, **options)
+			def succeed!(status: 200, headers: {}, type: nil, **options)
 				status = HTTP::Status.new(status, 200...300)
 				
-				if options[:type]
-					headers[Rack::CONTENT_TYPE] = options[:type].to_s
+				if type
+					headers[CONTENT_TYPE] = type.to_s
 				end
 				
 				body = body_for(status, headers, options)

data/lib/utopia/controller/respond.rb

@@ -21,7 +21,7 @@
 # THE SOFTWARE.
 
 require_relative '../http'
-require_relative '../path/matcher'
+require_relative '../responder'
 
 module Utopia
 	class Controller
@@ -31,139 +31,82 @@ module Utopia
 				base.extend(ClassMethods)
 			end
 			
-			module Converter
-				def self.update_response(response, updated_headers)
-					status, headers, body = response
+			module Handlers
+				module JSON
+					APPLICATION_JSON = HTTP::Accept::ContentType.new('application', 'json').freeze
 					
-					# Generate a new body:
-					body = body.collect{|content| yield content}
-					
-					# Update the headers with the requested content type:
-					headers = headers.merge(updated_headers)
-					
-					return [status, headers, body]
-				end
-				
-				Callback = Struct.new(:content_type, :block) do
-					def headers
-						{HTTP::CONTENT_TYPE => self.content_type}
+					def self.split(*arguments)
+						APPLICATION_JSON.split(*arguments)
 					end
 					
-					def split(*args)
-						self.content_type.split(*args)
-					end
-					
-					def call(context, response, media_range)
-						Converter.update_response(response, headers) do |content|
-							context.instance_exec(content, media_range, &block)
+					def self.call(context, request, media_range, object, **options)
+						if version = media_range.parameters['version']
+							options[:version] = version.to_s
 						end
+						
+						context.succeed! content: object.to_json(options), type: APPLICATION_JSON
 					end
 				end
 				
-				def self.new(*args)
-					Callback.new(*args)
-				end
-				
-				# To accept incoming requests with content-type JSON (e.g. POST with JSON data), consider using `Rack::PostBodyContentTypeParser`.
-				module ToJSON
-					APPLICATION_JSON = HTTP::Accept::ContentType.new('application', 'json', charset: 'utf-8').freeze
-					HEADERS = {HTTP::CONTENT_TYPE => APPLICATION_JSON.to_s}.freeze
+				module Passthrough
+					WILDCARD = HTTP::Accept::MediaTypes::MediaRange.new('*', '*').freeze
 					
-					def self.content_type
-						APPLICATION_JSON
+					def self.split(*arguments)
+						WILDCARD.split(*arguments)
 					end
 					
-					def self.split(*args)
-						self.content_type.split(*args)
-					end
-					
-					def self.serialize(content, media_range)
-						options = {}
-						
-						if version = media_range.parameters['version']
-							options[:version] = version.to_s
-						end
-						
-						return content.to_json(options)
-					end
-					
-					def self.call(context, response, media_range)
-						Converter.update_response(response, HEADERS) do |content|
-							self.serialize(content, media_range)
-						end
+					def self.call(context, request, media_range, object, **options)
+						# Do nothing.
 					end
 				end
 			end
 			
-			module Passthrough
-				WILDCARD = HTTP::Accept::MediaTypes::MediaRange.new('*', '*').freeze
-				
-				def self.split(*args)
-					self.media_range.split(*args)
+			class Responder < Utopia::Responder
+				def with_json
+					@handlers << Handlers::JSON
 				end
 				
-				def self.media_range
-					WILDCARD
+				def with_passthrough
+					@handlers << Handlers::Passthrough
 				end
 				
-				def self.call(context, response, media_range)
-					return nil
+				def with(content_type, &block)
+					handle(content_type, &block)
 				end
 			end
 			
-			class Responder
-				HTTP_ACCEPT = 'HTTP_ACCEPT'.freeze
-				NOT_ACCEPTABLE_RESPONSE = [406, {}, []].freeze
-				
-				def initialize
-					@converters = HTTP::Accept::MediaTypes::Map.new
+			module ClassMethods
+				def responds
+					@responder ||= Responder.new
 				end
 				
-				def freeze
-					@converters.freeze
-					
-					super
-				end
+				alias respond responds
 				
-				# Add a converter for the specified content type. Call the block with the response content if the request accepts the specified content_type.
-				def with(content_type, &block)
-					@converters << Converter::Callback.new(content_type, block)
+				def respond_to(context, request)
+					@responder&.respond_to(context, request)
 				end
 				
-				def with_passthrough
-					@converters << Passthrough
-				end
-				
-				# Add a converter for JSON when requests accept 'application/json'
-				def with_json
-					@converters << Converter::ToJSON
-				end
-				
-				def call(context, request, path, response)
-					# Parse the list of browser preferred content types and return ordered by priority:
-					media_types = HTTP::Accept::MediaTypes.browser_preferred_media_types(request.env)
-					
-					converter, media_range = @converters.for(media_types)
-					
-					if converter
-						converter.call(context, response, media_range)
-					else
-						NOT_ACCEPTABLE_RESPONSE
-					end
+				def response_for(context, request, response)
+					@responder&.respond_to(context, request).with(*response[2])
 				end
 			end
 			
-			module ClassMethods
-				def respond
-					@responder ||= Responder.new
+			def respond_to(request)
+				self.class.respond_to(self, request)
+			end
+			
+			def response_for(request, original_response)
+				response = catch(:response) do
+					self.class.response_for(self, request, original_response)
+					
+					# If the above code did not throw a new response, we return the original:
+					return original_response
 				end
 				
-				def response_for(context, request, path, response)
-					if @responder
-						@responder.call(context, request, path, response)
-					else
-						response
-					end
+				# If the user called {Base#ignore!}, it's possible response is nil:
+				if response
+					# There was an updated response so merge it:
+					return [original_response[0], original_response[1].merge(response[1]), response[2] || original_response[2]]
 				end
 			end
 			
@@ -173,11 +116,11 @@ module Utopia
 					headers = response[1]
 					
 					# Don't try to convert the response if a content type was explicitly specified.
-					unless headers[Rack::CONTENT_TYPE]
-						response = self.class.response_for(self, request, path, response)
+					if headers[HTTP::CONTENT_TYPE]
+						return response
+					else
+						return self.response_for(request, response)
 					end
-					
-					response
 				end
 			end
 		end

data/lib/utopia/extensions/array_split.rb

@@ -23,8 +23,8 @@
 module Utopia
 	module Extensions
 		module ArraySplit
-			def split_at(*args, &block)
-				if middle = index(*args, &block)
+			def split_at(*arguments, &block)
+				if middle = index(*arguments, &block)
 					[self[0...middle], self[middle], self[middle+1..-1]]
 				else
 					[[], nil, []]

data/lib/utopia/http.rb

@@ -90,9 +90,9 @@ module Utopia
 			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/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

@@ -126,8 +126,8 @@ module Utopia
 			@components = other_path.components.dup
 		end
 		
-		def include?(*args)
-			@components.include?(*args)
+		def include?(*arguments)
+			@components.include?(*arguments)
 		end
 		
 		def directory?
@@ -200,8 +200,8 @@ module Utopia
 			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.

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