utopia-project 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b31386125a2a1880b8d162ff278234e5c969b5ad658639e93ecf543b259b55d5
-  data.tar.gz: 35cab271274f82f93153d527631c3798342c5f08e2dd8a1e317a521730b89866
+  metadata.gz: be23cff7691ea961b8a937c962b18d6f7b3154ad22af394cb9d6168020855e66
+  data.tar.gz: b9b89af946e962e8044cc12dfe9a050cedb55ea6f73b112b92d29a58c794130e
 SHA512:
-  metadata.gz: 98738871025a6afa851a009f41ea8a4d8cd47b54ace8ecf64fce5fe78b90e31e8bf0923ce9bed3ee2cd18de1a69e92e0b01d22ca61542dc68ed5d969c428758a
-  data.tar.gz: 96fa148979e16c1cea5d46c9ff8e669c4588b8183d47005bf6d3f41484aca4013232127c4dcbfea4dd12b7b2388895e35f70d83695ae1bcad72416d190967c18
+  metadata.gz: '0781807983fefb1066fd513957c6140b092633cae6597a4e407f3d782dbc8b2c2515de7bac6dfafdb8907c580364efac230611cd8ff211e0c89f32c93e3a0113'
+  data.tar.gz: 11899a85d013208ecd9ff95d7c497f48e7ba5fb6eb792c8057c4aebfc677595125444cb28fb04a958fa93e061fa1a3c62d636eb4028407b12ccc34caeface47b

data/bake/utopia/project/readme/releases.xrb

@@ -1,10 +1,12 @@
+Please see the [project changes](#{documentation_url}changes/index) for all releases.
+
 <?r
-project.releases.each do |release|
+project.releases.first(10).each do |release|
 ?>
 ### #{release.name}
 
-<?r release.summary do |title| ?>
-  - [#{title}](#{release.href(documentation_url, title)})
+<?r release.changes do |change| ?>
+  - [#{change.to_markdown}](#{release.href(documentation_url, anchor: change.id)})
 <?r
 	end
 end 

data/changes.md

@@ -1,5 +1,15 @@
-# v0.28.0
+# Changes
 
-## Introduce Changes Document
+This document outlines major changes and new features in each release of the project.
+
+## Next
+
+### Improve `changes.md` document organization
+
+Previously, level 1 headings were considered releases. This was changed to level 2 headings to allow for a level 1 heading to be used as the title of the document.
+
+## v0.28.0
+
+### Introduce `changes.md` document
 
 A new changes document, if present, will be used to display changes in the release notes. The changes document should be named `changes.md` and should be placed in the root of the project. The changes document should be written in markdown format.

data/lib/utopia/project/changes_document.rb

@@ -8,6 +8,26 @@ require_relative 'document'
 module Utopia
 	module Project
 		class ChangesDocument < Document
+			class Summary
+				def initialize(node)
+					@node = node
+				end
+				
+				attr :node
+				
+				def id
+					@node.to_plaintext.chomp.downcase.gsub(/\s+/, "-")
+				end
+				
+				def to_markdown
+					@node.dup.extract_children.to_markdown
+				end
+				
+				def to_html
+					@node.dup.extract_children.to_html
+				end
+			end
+			
 			class Release
 				def initialize(node)
 					@node = node
@@ -25,7 +45,7 @@ module Utopia
 							end
 							
 							if node.header_level == @node.header_level + 1
-								yield node
+								yield Summary.new(node)
 							end
 						end
 						
@@ -37,16 +57,8 @@ module Utopia
 					@node.to_plaintext.chomp
 				end
 				
-				def summary
-					return to_enum(:summary) unless block_given?
-					
-					changes.each do |node|
-						yield node.to_plaintext.chomp
-					end
-				end
-				
-				def href(base = "/", change)
-					"#{base}changes/index##{change.downcase.gsub(/\s+/, "-")}"
+				def href(base = "/", anchor:)
+					"#{base}changes/index##{anchor.downcase.gsub(/\s+/, "-")}"
 				end
 			end
 			
@@ -54,7 +66,7 @@ module Utopia
 				return to_enum(:release_names) unless block_given?
 				
 				self.root.each do |node|
-					if node.type == :header and node.header_level == 1
+					if node.type == :header and node.header_level == 2
 						yield node.to_plaintext.chomp
 					end
 				end
@@ -62,7 +74,7 @@ module Utopia
 			
 			def release(name)
 				self.root.each do |node|
-					if node.type == :header and node.header_level == 1 and node.to_plaintext.chomp == name
+					if node.type == :header and node.header_level == 2 and node.to_plaintext.chomp == name
 						return Release.new(node)
 					end
 				end

data/lib/utopia/project/version.rb

@@ -5,6 +5,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.28.0"
+		VERSION = "0.29.0"
 	end
 end

data/pages/_releases.xnode

@@ -0,0 +1,19 @@
+<p>Please browse the <a href="changes/index">changes</a> for all releases.</p>
+
+<?r
+	base = self[:base]
+	
+	base.releases.first(10).each do |release|
+?>
+	<section>
+		<h3>#{release.name}</h3>
+		
+		<ul>
+			<?r release.changes do |change| ?>
+				<li><a href="#{release.href(anchor: change.id)}">#{MarkupString.raw(change.to_html)}</a></li>
+			<?r end ?>
+		</ul>
+	</section>
+<?r
+	end
+?>

data/pages/controller.rb

@@ -14,5 +14,9 @@ on 'index' do
 		@document.replace_section("Usage") do |header|
 			header.insert_after(@document.html_node("<content:usage/>"))
 		end
+		
+		@document.replace_section("Releases", children: true) do |header|
+			header.insert_after(@document.html_node("<content:releases/>"))
+		end
 	end
 end

data/readme.md

@@ -29,9 +29,15 @@ Please see the [project documentation](https://socketry.github.io/utopia-project
 
 ## Releases
 
+Please see the [project changes](https://socketry.github.io/utopia-project/changes/index) for all releases.
+
+### Next
+
+  - [Improve `changes.md` document organization](https://socketry.github.io/utopia-project/changes/index#improve-changes.md-document-organization)
+
 ### v0.28.0
 
-  - [Introduce Changes Document](https://socketry.github.io/utopia-project/changes/index#introduce-changes-document)
+  - [Introduce `changes.md` document](https://socketry.github.io/utopia-project/changes/index#introduce-changes.md-document)
 
 ## See Also
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decode
@@ -151,6 +151,7 @@ files:
 - pages/_heading.xnode
 - pages/_navigation.xnode
 - pages/_page.xnode
+- pages/_releases.xnode
 - pages/_thumbnail.xnode
 - pages/_usage.xnode
 - pages/_youtube-video.xnode