utopia-project 0.28.1 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0591e6fd134a4db7b7d5cb2aa3544d95d0c4d735b2a8bbcc8641680ed0a989c
-  data.tar.gz: 18dff4e63c0f516141956f096fe4fb01126f96b25241d2f98350265ec98a03a3
+  metadata.gz: e612f6bb7f73ee5ae451c51be1d67936b1789bf189fa8de35f371524e56b1985
+  data.tar.gz: f09d2b33fc0c5b5dbf01de0bd663fb1500ef299231e6dd5fff5bfc18bbc439f9
 SHA512:
-  metadata.gz: 7a3a2f447e0aaec0d45e16a2be94984d6f86563205a7f0eed7cd47473364dead009b7fcaf2f520fa81949803a17731f16ee4ed53e2bc51cc60767448429fd440
-  data.tar.gz: b01389c251adf4568196d36c58f5e0de345062e4dc4b19c7966dc57305492f27f57e93e09260b1a4bdd6d9e088a33e9b70c912dd50354d6d852b34182e444ae0
+  metadata.gz: fc14c8c05a5ffaa8be42329b5279af0135fd5f4d2159f184cac6aceb88b2d007913ba1c9f1e3dc831e2fea84589b40e07641186641f1ccc882e8f5d269f95c7a
+  data.tar.gz: 8d506cdcd2134bc4e2a5790fea2b1a3871cfe4f7255b27d63be67eeb76458748f3da0572cf8eba7d20c9b932edfe6b89873dc1e38c32a68740ea4526b72c1319

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

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

data/lib/utopia/project/base.rb

@@ -13,7 +13,7 @@ require 'decode'
 require 'thread/local'
 
 require_relative 'document'
-require_relative 'changes_document'
+require_relative 'releases_document'
 
 require_relative 'guide'
 require_relative 'linkify'
@@ -192,15 +192,15 @@ module Utopia
 				readme_document&.title || "Project"
 			end
 			
-			def changes_document
-				if path = self.path_for('changes.md')
-					ChangesDocument.new(File.read(path), self)
+			def releases_document
+				if path = self.path_for('releases.md')
+					ReleasesDocument.new(File.read(path), self)
 				end
 			end
 			
 			def releases
-				if changes_document = self.changes_document
-					changes_document.releases
+				if releases_document = self.releases_document
+					releases_document.releases
 				end
 			end
 		end

data/lib/utopia/project/{changes_document.rb → releases_document.rb}

@@ -7,7 +7,27 @@ require_relative 'document'
 
 module Utopia
 	module Project
-		class ChangesDocument < Document
+		class ReleasesDocument < 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 = "/", anchor:)
-					"#{base}changes/index##{anchor.downcase.gsub(/\s+/, "-")}"
+					"#{base}releases/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.1"
+		VERSION = "0.30.0"
 	end
 end

data/pages/_releases.xnode

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

data/pages/{changes → releases}/controller.rb

@@ -6,5 +6,5 @@
 prepend Actions
 
 on 'index' do
-	@document = @base.changes_document
+	@document = @base.releases_document
 end

data/pages/{changes → releases}/index.xnode

@@ -6,7 +6,7 @@
 		?>
 		<content:heading>Project</content:heading>
 		
-		<p>This project does not have a <code>changes.md</code> file.</p>
+		<p>This project does not have a <code>releases.md</code> file.</p>
 		<?r
 	end
 	?>

data/readme.md

@@ -29,9 +29,19 @@ 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.
+
+### v0.30.0
+
+  - [Rename `changes.md` to `releases.md`](https://socketry.github.io/utopia-project/releases/index#rename-changes.md-to-releases.md)
+
+### v0.29.0
+
+  - [Improve `changes.md` document organization](https://socketry.github.io/utopia-project/releases/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/releases/index#introduce-changes.md-document)
 
 ## See Also
 

data/releases.md

@@ -0,0 +1,21 @@
+# Changes
+
+This document outlines major changes and new features in each release of the project.
+
+## v0.30.0
+
+### Rename `changes.md` to `releases.md`
+
+The `changes.md` document has been renamed to `releases.md` to better reflect its purpose.
+
+## v0.29.0
+
+### 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.28.1
+  version: 0.30.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-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decode
@@ -136,14 +136,13 @@ files:
 - bake/utopia/project/readme/releases.xrb
 - bake/utopia/project/readme/update.rb
 - bake/utopia/project/readme/usage.xrb
-- changes.md
 - lib/utopia/project.rb
 - lib/utopia/project/base.md
 - lib/utopia/project/base.rb
-- lib/utopia/project/changes_document.rb
 - lib/utopia/project/document.rb
 - lib/utopia/project/guide.rb
 - lib/utopia/project/linkify.rb
+- lib/utopia/project/releases_document.rb
 - lib/utopia/project/renderer.rb
 - lib/utopia/project/version.rb
 - license.md
@@ -155,8 +154,6 @@ files:
 - pages/_thumbnail.xnode
 - pages/_usage.xnode
 - pages/_youtube-video.xnode
-- pages/changes/controller.rb
-- pages/changes/index.xnode
 - pages/controller.rb
 - pages/errors/exception.xnode
 - pages/errors/file-not-found.xnode
@@ -165,6 +162,8 @@ files:
 - pages/guides/show.xnode
 - pages/index.xnode
 - pages/links.yaml
+- pages/releases/controller.rb
+- pages/releases/index.xnode
 - pages/source/_discuss.xnode
 - pages/source/_pragmas.xnode
 - pages/source/_signature.xnode
@@ -255,6 +254,7 @@ files:
 - public/_static/site.css
 - public/robots.txt
 - readme.md
+- releases.md
 - template/Gemfile
 - template/config.ru
 - template/preload.rb

data/changes.md

@@ -1,5 +0,0 @@
-# v0.28.0
-
-## Introduce Changes 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.