utopia-project 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f72fdf878294e638e5053f5b0e4cdc19e5d1ee28aa1c51732a1ec467c9a9cb
-  data.tar.gz: bfb6d2e71535e496d6f1c42db8a89be441bfc33a881e8e49d00e6bdaea19df00
+  metadata.gz: 4e03635789e50ada548501b8220d49ae33e6ee4ec89aa993cddb358d7a8efc30
+  data.tar.gz: a97fb27c10530e9d5cd66d4caae0c173eb5f40b72dd48d2a92d35fd52e1b12a7
 SHA512:
-  metadata.gz: e2fecc25e48c3573d61fec6db7a8ca9120b6b3580f62a8e7a249b1012b5ba1c88f341831bcb65409af6c1df82512f63fdcd56704ef7e6c5396d38bda110c5196
-  data.tar.gz: e1b11e6f7566973149e116bc0cf8f1c886d269c0d116e1f8e4b2eb357367abc7208adea969db77cb35d399b0f8016e93908fe65867dee8bcaa747851680dab80
+  metadata.gz: 38468ed82c56f4048427dd94d7f687d5a45c978d7f398e3033483cfdcb9689c78e23a5b6c4cbefc8d1ae65fb9d62ae06fa05d0c85cdf21721fe5bde350ab5f68
+  data.tar.gz: 6035c40a3578098292f084f63614c3bac24ac396774466b8c649ac7770b745d74b0e75676bb4d1d03555a888f65efe2008e2d8790da9e0e67ca0463b35dd5341

data/context/index.yaml

@@ -3,9 +3,11 @@
 ---
 description: A project documentation tool based on Utopia.
 metadata:
+  bug_tracker_uri: https://github.com/socketry/utopia-project/issues
+  changelog_uri: https://github.com/socketry/utopia-project/blob/main/releases.md
   documentation_uri: https://socketry.github.io/utopia-project/
   funding_uri: https://github.com/sponsors/ioquatix/
-  source_code_uri: https://github.com/socketry/utopia-project/
+  source_code_uri: https://github.com/socketry/utopia-project.git
 files:
 - path: getting-started.md
   title: Getting Started

data/lib/utopia/project/inheritance.rb

@@ -13,8 +13,8 @@ module Utopia
 			# A method inherited from another definition.
 			Method = Struct.new(:name, :definition)
 			
-			# A group of inherited methods with the same origin.
-			Group = Struct.new(:definition, :methods)
+			# Methods inherited through a direct relationship.
+			Group = Struct.new(:kind, :definition, :methods)
 			
 			# Initialize inheritance resolution for the given definition.
 			# @parameter index [Decode::Index] The index used to resolve relationships.
@@ -55,10 +55,10 @@ module Utopia
 			end
 			
 			# Enumerate documented public and protected methods inherited by the definition.
-			# @returns [Array(Group)] Methods grouped by the definition which provides them.
+			# @returns [Array(Group)] Methods grouped by the direct relationship which provides them.
 			def inherited_methods
 				@groups = []
-				@groups_by_definition = {}
+				@groups_by_relationship = {}
 				
 				collect_instance_methods(@definition, false, {}, {})
 				collect_class_methods(@definition, false, {}, {})
@@ -113,46 +113,46 @@ module Utopia
 				end
 			end
 			
-			def collect_instance_methods(definition, include_own, seen, visited, display_prefix = "#")
+			def collect_instance_methods(definition, include_own, seen, visited, display_prefix: "#", kind: nil, provider: nil)
 				key = [definition.qualified_name, display_prefix]
 				return if visited[key]
 				visited[key] = true
 				
 				relationship_definitions(definition, :prepends).reverse_each do |relationship|
-					collect_instance_methods(relationship, true, seen, visited, display_prefix)
+					collect_instance_methods(relationship, true, seen, visited, display_prefix: display_prefix, kind: kind || :prepend, provider: provider || relationship)
 				end
 				
-				collect_methods(definition, "#", display_prefix, include_own, seen)
+				collect_methods(definition, "#", display_prefix, include_own, seen, kind: kind, provider: provider)
 				
 				relationship_definitions(definition, :includes).reverse_each do |relationship|
-					collect_instance_methods(relationship, true, seen, visited, display_prefix)
+					collect_instance_methods(relationship, true, seen, visited, display_prefix: display_prefix, kind: kind || :include, provider: provider || relationship)
 				end
 				
 				if display_prefix == "#" && (super_class = super_class_for(definition))
-					collect_instance_methods(super_class, true, seen, visited, display_prefix)
+					collect_instance_methods(super_class, true, seen, visited, display_prefix: display_prefix, kind: kind || :super_class, provider: provider || super_class)
 				end
 			end
 			
-			def collect_class_methods(definition, include_own, seen, visited)
+			def collect_class_methods(definition, include_own, seen, visited, kind: nil, provider: nil)
 				key = definition.qualified_name
 				return if visited[key]
 				visited[key] = true
 				
-				collect_methods(definition, ".", ".", include_own, seen)
+				collect_methods(definition, ".", ".", include_own, seen, kind: kind, provider: provider)
 				if singleton = singleton_for(definition)
-					collect_methods(singleton, "#", ".", include_own, seen, definition)
+					collect_methods(singleton, "#", ".", include_own, seen, kind: kind, provider: provider)
 				end
 				
 				relationship_definitions(definition, :extends).reverse_each do |relationship|
-					collect_instance_methods(relationship, true, seen, {}, ".")
+					collect_instance_methods(relationship, true, seen, {}, display_prefix: ".", kind: kind || :extend, provider: provider || relationship)
 				end
 				
 				if super_class = super_class_for(definition)
-					collect_class_methods(super_class, true, seen, visited)
+					collect_class_methods(super_class, true, seen, visited, kind: kind || :super_class, provider: provider || super_class)
 				end
 			end
 			
-			def collect_methods(definition, source_prefix, display_prefix, include_own, seen, origin = definition)
+			def collect_methods(definition, source_prefix, display_prefix, include_own, seen, kind:, provider:)
 				methods_for(definition, source_prefix).each do |method|
 					name = "#{display_prefix}#{method.name}"
 					next if seen[name]
@@ -168,13 +168,14 @@ module Utopia
 					next unless method.documented?
 					next if method.respond_to?(:private?) && method.private?
 					
-					add_method(origin, name, method)
+					add_method(kind, provider, name, method)
 				end
 			end
 			
-			def add_method(definition, name, method)
-				group = @groups_by_definition[definition.qualified_name] ||= begin
-					group = Group.new(definition, [])
+			def add_method(kind, provider, name, method)
+				key = [kind, provider.qualified_name]
+				group = @groups_by_relationship[key] ||= begin
+					group = Group.new(kind, provider, [])
 					@groups << group
 					group
 				end

data/lib/utopia/project/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2025, by Samuel Williams.
+# Copyright, 2020-2026, by Samuel Williams.
 
 module Utopia
 	module Project
-		VERSION = "0.42.0"
+		VERSION = "0.43.0"
 	end
 end

data/pages/_header.xnode

@@ -12,7 +12,7 @@
 				?><a href="#{link.href}" class="#{active ? 'active' : nil}" aria-current="#{active ? 'page' : 'false'}">#{link.title}</a><?r
 			end ?>
 			<?r if github_url = base.source_code_uri ?>
-				<a href="#{github_url}" class="github" target="_blank" rel="noopener noreferrer" aria-label="View source on GitHub">GitHub <span aria-hidden="true">↗</span></a>
+				<a href="#{github_url}" class="github" target="_blank" rel="noopener noreferrer" aria-label="View source on GitHub">GitHub</a>
 			<?r end ?>
 		</div>
 		<div class="header-actions">

data/pages/reference/_declaration.xnode

@@ -2,8 +2,9 @@
 base = self[:base]
 symbol = self[:symbol]
 link = self[:link]
+inheritance = self[:inheritance] != false
 
-if symbol.respond_to?(:super_class)
+if inheritance && symbol.respond_to?(:super_class)
 	super_class = symbol.super_class
 end
 

data/pages/reference/_relationships.xnode

@@ -5,6 +5,9 @@ inheritance = base.inheritance_for(symbol)
 
 relationships = inheritance.relationships
 inherited_methods = inheritance.inherited_methods
+inherited_methods_by_relationship = inherited_methods.to_h do |group|
+	[[group.kind, group.definition.qualified_name], group.methods]
+end
 
 relationship_labels = {
 	super_class: "Inherits from",
@@ -14,32 +17,35 @@ relationship_labels = {
 }
 ?>
 <?r if relationships.any? ?>
-	<dl class="relationships"><?r
+	<dl class="relationships" data-pagefind-ignore><?r
 		relationships.group_by(&:kind).each do |kind, entries|
 			?><dt>#{relationship_labels.fetch(kind)}</dt>
 			<dd><?r
 				entries.each_with_index do |relationship, index|
 					if index > 0
-						?>, <?r
+						?>; <?r
 					end
 					
 					?>#{base.linkify(relationship.name, symbol)}<?r
+					
+					methods = if relationship.definition
+						key = [kind, relationship.definition.qualified_name]
+						inherited_methods_by_relationship[key]
+					end
+					
+					if methods&.any?
+						?><code>: <?r
+						methods.each_with_index do |method, method_index|
+							if method_index > 0
+								?>, <?r
+							end
+							
+							?><a href="#{base.link_for(method.definition)}">#{method.name}</a><?r
+						end
+						?></code><?r
+					end
 				end
 			?></dd><?r
 		end
 	?></dl>
 <?r end ?>
-
-<?r if inherited_methods.any? ?>
-	<section>
-		<h2>Inherited Methods</h2><?r
-		inherited_methods.each do |group|
-			?><p>From <a href="#{base.link_for(group.definition)}"><code>#{group.definition.qualified_name}</code></a>:</p>
-			<ul class="index"><?r
-				group.methods.each do |method|
-					?><li><a href="#{base.link_for(method.definition)}"><code>#{method.name}</code></a></li><?r
-				end
-			?></ul><?r
-		end
-	?></section>
-<?r end ?>

data/pages/reference/controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2025, by Samuel Williams.
+# Copyright, 2020-2026, by Samuel Williams.
 
 prepend Actions
 

data/pages/reference/show.xnode

@@ -30,7 +30,7 @@
 	if nested.any?
 	?>
 	<section>
-		<h2>Classes and Modules</h2>
+		<h2>Nested Classes and Modules</h2>
 		
 		<dl class="nested-definitions">
 			<?r nested.each do |symbol|
@@ -40,7 +40,7 @@
 				end
 			?>
 			<div>
-				<dt>#{partial 'content:declaration', symbol: symbol, link: true}</dt>
+				<dt>#{partial 'content:declaration', symbol: symbol, link: true, inheritance: false}</dt>
 				<dd><?r unless description&.empty? ?>#{base.format(description, symbol)}<?r end ?></dd>
 			</div>
 			<?r end ?>

data/public/_static/site.css

@@ -170,10 +170,6 @@ header .sections .github {
 	opacity: 0.7;
 }
 
-header .sections .github span {
-	font-size: 0.85em;
-}
-
 header .sections .github:hover {
 	opacity: 1;
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -378,13 +378,15 @@ files:
 - template/config/serve.rb
 - template/gems.rb
 - template/preload.rb
-homepage: https://socketry.github.io/utopia-project
+homepage: https://github.com/socketry/utopia-project
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/socketry/utopia-project/issues
+  changelog_uri: https://github.com/socketry/utopia-project/blob/main/releases.md
   documentation_uri: https://socketry.github.io/utopia-project/
   funding_uri: https://github.com/sponsors/ioquatix/
-  source_code_uri: https://github.com/socketry/utopia-project/
+  source_code_uri: https://github.com/socketry/utopia-project.git
 rdoc_options: []
 require_paths:
 - lib