utopia-project 0.44.0 → 0.44.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f02594d75aca403abee0bf56e3e2ec4e398a81df172f6c62cf73cdccba11bc5
-  data.tar.gz: bc73b831e8e44df2de6759154a24d91d0d228e062e5c790d5956788ebddc5177
+  metadata.gz: bb1b060b61a6a2d8217400a95a0902c6a5445a9a7aa19cd1336ef5271c6ad109
+  data.tar.gz: 0dddf9399507803260102a0bcf2b2a3d8218b3ff59ab3f8857b3937c7f72b74d
 SHA512:
-  metadata.gz: 3dd75a8af1c68d0b7d4b64856f569d13468e6b3296303bcad6b02f3595709821c88de4387212aad33a629caa2854b8f5e6ebfdebfe1e0b7a17975ba44f846d68
-  data.tar.gz: 0e731e759758f27e1d64a721a9e5aa9eb275e76bf7e01e3e4fe027d2baad520c3b3f249a28bd049fb392278e47a3f646322d54488648136fdba389adc4f0b5c0
+  metadata.gz: 839445ba2548a2c7784828ca9e198f3929cb19a628395ef06ecd78d4d88c3766adf478c42d47e0707e9407032e3ff9a6a60d5e512261af1507012128201232e3
+  data.tar.gz: 2c31c2a1c6991967ebe93429413fa3c6f4b28d77275da4890c353f86b43eabf504219732e10a0a680c0cb953d37a048e505eb84e8d3c0d229e7b71721232dd8b

data/lib/utopia/project/base.rb

@@ -7,7 +7,7 @@
 require "utopia/path"
 require "utopia/content/links"
 
-require "xrb/reference"
+require "protocol/url/reference"
 require "decode"
 
 require "thread/local"
@@ -187,7 +187,7 @@ module Utopia
 			end
 			
 			# Compute a link href to the given definition for use within the HTML output.
-			# @returns [XRB::Reference]
+			# @returns [Protocol::URL::Reference]
 			#
 			# @example Link to a definition
 			# 	base = Utopia::Project::Base.local
@@ -195,13 +195,15 @@ module Utopia
 			# 	base.link_for(definition).to_s # => "/reference/utopia/project/index#Utopia::Project::Base"
 			def link_for(definition)
 				path = definition.lexical_path.map{|entry| entry.to_s}
+				fragment = nil
 				
-				if definition.container?
-					return XRB::Reference.new(@reference_path + path + "index")
-				else
-					name = path.pop
-					return XRB::Reference.new(@reference_path + path + "index", fragment: id_for(definition))
+				unless definition.container?
+					path.pop
+					fragment = id_for(definition)
 				end
+				
+				path = (@reference_path + path + "index").to_url_path
+				return Protocol::URL::Reference.new(path, nil, fragment)
 			end
 			
 			# Resolve inheritance information for the given definition.

data/lib/utopia/project/document.rb

@@ -147,7 +147,7 @@ module Utopia
 			
 			# Build a link node around a child node.
 			# @parameter title [String | Nil] The link title.
-			# @parameter url [String | XRB::Reference] The link target.
+			# @parameter url [String | Protocol::URL::Reference] The link target.
 			# @parameter child [Markly::Node] The linked child node.
 			# @returns [Markly::Node] The link node.
 			def link_node(title, url, child)
@@ -174,30 +174,53 @@ module Utopia
 			
 			private
 			
-			# Replace source code references in the given text with HTML anchors.
+			# Resolve a source code reference to HTML.
 			# @parameter content [String] The source code reference.
 			# @parameter language [String | Nil] The explicit source language.
-			# @returns [Markly::Node] The resolved link or code node.
+			# @returns [Markly::Node] The inline HTML node.
 			def reference_node(content, language: nil)
+				reference, definition = resolve_reference(content, language: language)
+				
+				if definition
+					content = definition.qualified_form
+					language = reference.language.name
+				elsif reference
+					content = reference.identifier
+					language = reference.language.name
+				end
+				
+				attributes = {}
+				attributes[:class] = "language-#{language}" if language
+				
+				markup = XRB::Builder.fragment do |builder|
+					builder.inline("code", attributes) do
+						if definition
+							builder.inline("a", href: @base.link_for(definition), title: reference.identifier) do
+								builder.text(content)
+							end
+						else
+							builder.text(content)
+						end
+					end
+				end
+				
+				return inline_html_node(markup.to_s)
+			end
+			
+			# Resolve source code reference metadata and its indexed definition.
+			# @parameter content [String] The source code reference.
+			# @parameter language [String | Nil] The explicit source language.
+			# @returns [Array] The parsed reference and resolved definition.
+			def resolve_reference(content, language: nil)
 				reference = if language
 					@index.languages.reference_for(language, content)
 				else
 					@index.languages.parse_reference(content, default_language: @default_language)
 				end
 				
-				if reference
-					definition = @index.lookup(reference, relative_to: @definition)
-				end
+				definition = @index.lookup(reference, relative_to: @definition) if reference
 				
-				if definition
-					link_node(reference.identifier, @base.link_for(definition),
-						code_node(definition.qualified_form, reference.language.name)
-					)
-				elsif reference
-					code_node(reference.identifier, reference.language.name)
-				else
-					code_node(content, language)
-				end
+				return reference, definition
 			end
 			
 			def resolve(root)

data/lib/utopia/project/guide.rb

@@ -4,7 +4,7 @@
 # Copyright, 2020-2026, by Samuel Williams.
 
 require "utopia/path"
-require "xrb/reference"
+require "xrb/strings"
 require "decode"
 
 require_relative "sidebar"

data/lib/utopia/project/renderer.rb

@@ -11,10 +11,9 @@ module Utopia
 		# Renders project Markdown with support for Mermaid code blocks.
 		class Renderer < Markly::Renderer::HTML
 			# Initialize the project renderer.
-			# @parameter inline_code_resolver [Proc | Nil] Resolves language-prefixed inline code into a replacement node.
+			# @parameter inline_code_resolver [Proc | Nil] Resolves language-prefixed inline code into an inline HTML node.
 			def initialize(inline_code_resolver: nil, **options)
 				@inline_code_resolver = inline_code_resolver
-				@resolving_inline_code = false
 				
 				super(**options)
 			end
@@ -58,13 +57,8 @@ module Utopia
 			# Render inline code, resolving language-prefixed references when possible.
 			# @parameter node [Markly::Node] The inline code node.
 			def code(node)
-				if @inline_code_resolver && !@resolving_inline_code && (language = node.code_language)
-					begin
-						@resolving_inline_code = true
-						out(@inline_code_resolver.call(node.string_content, language: language))
-					ensure
-						@resolving_inline_code = false
-					end
+				if @inline_code_resolver && (language = node.code_language)
+					out(@inline_code_resolver.call(node.string_content, language: language))
 				else
 					super
 				end

data/lib/utopia/project/version.rb

@@ -5,6 +5,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.44.0"
+		VERSION = "0.44.2"
 	end
 end

data/readme.md

@@ -33,6 +33,10 @@ Please see the [project documentation](https://socketry.github.io/utopia-project
 
 Please see the [project releases](https://socketry.github.io/utopia-project/releases/index) for all releases.
 
+### v0.44.1
+
+  - Render resolved inline code references with links inside their code elements so hover and keyboard focus affect the complete reference.
+
 ### v0.44.0
 
   - Add support for language-prefixed inline code references such as ruby:`Object.new`.
@@ -72,10 +76,6 @@ Please see the [project releases](https://socketry.github.io/utopia-project/rele
 
   - Fixed handling of segmented code guides when rendered into a `readme.md` file.
 
-### v0.33.0
-
-  - Fix presentation of release notes on releases page.
-
 ## See Also
 
   - [Utopia](https://github.com/socketry/utopia) — The website framework which powers this web application.

data/releases.md

@@ -1,5 +1,9 @@
 # Changes
 
+## v0.44.1
+
+  - Render resolved inline code references with links inside their code elements so hover and keyboard focus affect the complete reference.
+
 ## v0.44.0
 
   - Add support for language-prefixed inline code references such as ruby:`Object.new`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.44.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -83,6 +83,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: protocol-url
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: thread-local
   requirement: !ruby/object:Gem::Requirement