utopia-project 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af7ac04b71cc8b501069888bd23a5da5cd00bd25d7900016fe89de7e08170426
-  data.tar.gz: fba0add2c28c7712a0c6fd894b21aca3f0015c3fc13f3c4b0299aa053e4dca9a
+  metadata.gz: b00882c35aab73934edead7de90d4f2aaba8ec31081651503da8df4649711d5c
+  data.tar.gz: 841d1282002133580fa8679dd2d4ab34c0a4c5d4b3f2d3fb23df688e104bbdb5
 SHA512:
-  metadata.gz: 0fd2ed330c03e2ba6b4dc2f5ffa7c31d88b6c974b2e1b349c03d882b11ba22cca2fd86aafef63aa09dc18a75d14c1daf766c27b7791c1d3832a67fab00ac22fa
-  data.tar.gz: 6d03bc32040379cfab0f3125da19bc05a21a860cded807c695c8b0592b8b6766c200b489988f9f867a42ab4053e5885a839e66c9774321217f59a4d0c0ab0d98
+  metadata.gz: ac775fc076391b94fef45612b6222c188b42321dccee54cfa87062e6655774aa991f6b665404d9ca3e8657a2d9f63251ce28fdebdc228adac956dd862c68ec2d
+  data.tar.gz: 7fab1fe6726ae94c8917f0c790557ae5baf44cf1008264b93dc62ae58bfcfcab8fefdd0257327d95dd80777e185c9bc018c1bd6ab67f3fe723d81cd3998c9090

data/bake/utopia/project/readme/update.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023-2024, by Samuel Williams.
 
 require 'utopia/project'
-require 'trenni'
+require 'xrb'
 
 def update(path: "readme.md", documentation_url: nil)
 	project = Utopia::Project::Base.new(context.root)
@@ -37,11 +41,17 @@ end
 
 # The public documentation URL if it can be determined.
 def public_documentation_url
-	gemspec&.homepage
+	if metadata = gemspec.metadata
+		if documentation_uri = metadata['documentation_uri']
+			return documentation_uri
+		end
+	end
+	
+	return gemspec&.homepage
 end
 
 def usage_section(documentation_url, project)
-	template = Trenni::Template.load_file(File.expand_path("usage.trenni", __dir__))
+	template = XRB::Template.load_file(File.expand_path("usage.xrb", __dir__))
 	scope = Scope.new(documentation_url, project)
 	
 	output = template.to_string(scope)

data/lib/utopia/project/base.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2023, by Michael Adams.
 
 require 'utopia/path'
 require 'utopia/content/links'
 
-require 'trenni/reference'
+require 'xrb/reference'
 require 'decode'
 
 require 'thread/local'
@@ -115,7 +116,7 @@ module Utopia
 			
 			# Format the given text in the context of the given definition and language.
 			# See {document} for details.
-			# @returns [Trenni::MarkupString]
+			# @returns [XRB::MarkupString]
 			def format(text, definition = nil, language: definition&.language, **options)
 				case text
 				when Enumerable
@@ -125,7 +126,7 @@ module Utopia
 				end
 				
 				if document = self.document(text, definition, language: language)
-					return Trenni::MarkupString.raw(
+					return XRB::MarkupString.raw(
 						document.to_html(**options)
 					)
 				end
@@ -151,15 +152,15 @@ module Utopia
 			end
 			
 			# Compute a link href to the given definition for use within the HTML output.
-			# @returns [Trenni::Reference]
+			# @returns [XRB::Reference]
 			def link_for(definition)
 				path = definition.lexical_path.map{|entry| entry.to_s}
 				
 				if definition.container?
-					return Trenni::Reference.new(@source_path + path + "index")
+					return XRB::Reference.new(@source_path + path + "index")
 				else
 					name = path.pop
-					return Trenni::Reference.new(@source_path + path + "index", fragment: id_for(definition))
+					return XRB::Reference.new(@source_path + path + "index", fragment: id_for(definition))
 				end
 			end
 			

data/lib/utopia/project/document.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require_relative 'renderer'
 
@@ -64,7 +64,7 @@ module Utopia
 			
 			def to_html(node = self.root, **options)
 				renderer = Renderer.new(ids: true, flags: Markly::UNSAFE, **options)
-				Trenni::MarkupString.raw(renderer.render(node))
+				XRB::MarkupString.raw(renderer.render(node))
 			end
 			
 			def paragraph_node(child)
@@ -104,7 +104,7 @@ module Utopia
 			def code_node(content, language = nil)
 				if language
 					node = inline_html_node(
-						"<code class=\"language-#{language}\">#{Trenni::Strings.to_html(content)}</code>"
+						"<code class=\"language-#{language}\">#{XRB::Strings.to_html(content)}</code>"
 					)
 				else
 					node = Markly::Node.new(:code)

data/lib/utopia/project/guide.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'utopia/path'
-require 'trenni/reference'
+require 'xrb/reference'
 require 'decode'
 
 module Utopia
@@ -78,7 +78,7 @@ module Utopia
 			# The title of the guide.
 			# @returns [String]
 			def title
-				@title || Trenni::Strings.to_title(self.name)
+				@title || XRB::Strings.to_title(self.name)
 			end
 			
 			# The hypertext reference to this guide.

data/lib/utopia/project/linkify.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'decode/syntax/rewriter'
 
@@ -19,18 +19,18 @@ module Utopia
 			def text_for(range)
 				text = super(range)
 				
-				return Trenni::Strings.to_html(text)
+				return XRB::Strings.to_html(text)
 			end
 			
 			def link_to(definition, text)
-				Trenni::Builder.fragment do |builder|
+				XRB::Builder.fragment do |builder|
 					builder.inline('a', href: @base.link_for(definition), title: definition.qualified_name) do
 						builder.text(text)
 					end
 				end
 			end
 			
-			def apply(output = Trenni::Builder.new)
+			def apply(output = XRB::Builder.new)
 				output.inline('code', class: "language-#{@language.name}") do
 					super
 				end

data/lib/utopia/project/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 module Utopia
 	module Project
-		VERSION = "0.22.0"
+		VERSION = "0.24.0"
 	end
 end

data/license.md

@@ -1,8 +1,9 @@
 # MIT License
 
-Copyright, 2020-2023, by Samuel Williams.  
+Copyright, 2020-2024, by Samuel Williams.  
 Copyright, 2020, by Olle Jonsson.  
-Copyright, 2022, by dependabot[bot].  
+Copyright, 2022-2023, by dependabot[bot].  
+Copyright, 2023, by Michael Adams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -2,7 +2,7 @@
 
 A simple Ruby project documentation website.
 
-[![Test](https://github.com/socketry/utopia-project/actions/workflows/test.yaml/badge.svg)](https://github.com/socketry/utopia-project/actions/workflows/test.yaml)
+[![Development Status](https://github.com/socketry/utopia-project/workflows/Test/badge.svg)](https://github.com/socketry/utopia-project/actions?workflow=Test)
 
 ## Motivation
 
@@ -40,6 +40,14 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+
 ## See Also
 
   - [Utopia](https://github.com/socketry/utopia) — The website framework which powers this web application.

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Samuel Williams
 - Olle Jonsson
 - dependabot[bot]
+- Michael Adams
 autorequire:
 bindir: bin
 cert_chain:
@@ -39,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decode
@@ -117,70 +118,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.24'
 description:
 email:
 executables: []
@@ -220,10 +165,13 @@ files:
 - pages/source/controller.rb
 - pages/source/index.xnode
 - pages/source/show.xnode
+- public/.DS_Store
 - public/.nojekyll
+- public/_components/.DS_Store
 - public/_components/jquery-litebox/jquery.litebox.css
 - public/_components/jquery-litebox/jquery.litebox.gallery.css
 - public/_components/jquery-litebox/jquery.litebox.js
+- public/_components/jquery-syntax/.DS_Store
 - public/_components/jquery-syntax/base/jquery.syntax.brush.apache.css
 - public/_components/jquery-syntax/base/jquery.syntax.brush.applescript.css
 - public/_components/jquery-syntax/base/jquery.syntax.brush.assembly.css
@@ -294,6 +242,7 @@ files:
 - public/_components/jquery/jquery.slim.js
 - public/_components/jquery/jquery.slim.min.js
 - public/_components/jquery/jquery.slim.min.map
+- public/_components/mermaid/.DS_Store
 - public/_components/mermaid/mermaid.min.js
 - public/_components/mermaid/mermaid.min.js.map
 - public/_static/icon.png
@@ -303,7 +252,7 @@ files:
 - template/Gemfile
 - template/config.ru
 - template/preload.rb
-homepage: https://socketry.github.io/utopia-project/
+homepage: https://socketry.github.io/utopia-project
 licenses:
 - MIT
 metadata:
@@ -317,14 +266,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A project documentation tool based on Utopia.