utopia-project 0.28.1 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0591e6fd134a4db7b7d5cb2aa3544d95d0c4d735b2a8bbcc8641680ed0a989c
-  data.tar.gz: 18dff4e63c0f516141956f096fe4fb01126f96b25241d2f98350265ec98a03a3
+  metadata.gz: be23cff7691ea961b8a937c962b18d6f7b3154ad22af394cb9d6168020855e66
+  data.tar.gz: b9b89af946e962e8044cc12dfe9a050cedb55ea6f73b112b92d29a58c794130e
 SHA512:
-  metadata.gz: 7a3a2f447e0aaec0d45e16a2be94984d6f86563205a7f0eed7cd47473364dead009b7fcaf2f520fa81949803a17731f16ee4ed53e2bc51cc60767448429fd440
-  data.tar.gz: b01389c251adf4568196d36c58f5e0de345062e4dc4b19c7966dc57305492f27f57e93e09260b1a4bdd6d9e088a33e9b70c912dd50354d6d852b34182e444ae0
+  metadata.gz: '0781807983fefb1066fd513957c6140b092633cae6597a4e407f3d782dbc8b2c2515de7bac6dfafdb8907c580364efac230611cd8ff211e0c89f32c93e3a0113'
+  data.tar.gz: 11899a85d013208ecd9ff95d7c497f48e7ba5fb6eb792c8057c4aebfc677595125444cb28fb04a958fa93e061fa1a3c62d636eb4028407b12ccc34caeface47b

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/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,14 +57,6 @@ 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+/, "-")}"
 				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.29.0"
 	end
 end

data/pages/_releases.xnode

@@ -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/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.1
+  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

metadata.gz.sig

@@ -1,4 +1 @@
-F��$K𔙰\�p�zo_^�,�8��;�SR�!QI����z9�k�d��zN�q҅R�
-��{s�
-�\�]+�C8�ԋs�Q����2�D��c�_���G{{� ��X���#ܺG���<z)��<����$�j��HW���
�z����$���ثvA��+���mc���1	O"p�z���B�����2?�ӥ�0M96F����}��	�ܚ�M��>�/w����+�й�i�/D�4�b�h�y�ql���� }~�X�KEXUAf��^�T��Ѓ7�6*��O����=�'�2|���H�q/gf��W��e.���>9s�(H�㮉�pgOT1���l�
0�4P������їsE�+R����
-?�s����
+�Z�,o���v�c�ݟ�9���
�}�n��Frxu�Q�w���0Q7(,w)"*�@��q�������^�}U�L��aeu�d￬�G������7�&�WgA&�0�sAsn�۞���)%+��k��?��
�dTaF�2)����3_������һ�X8����X�tݘ,�ڮ�A�h�H����N-��ɡ-��A\͌EE:Y����׿<Q*k�bM����%�w��q�I��
�%c03)*�=��uIU|��_����]A�ЗE+�Q;�Z8yD�67G����'����~2Q���89p��@=��۠�#9�)�����YBW�����n�Q�;J�X婅�]{�����*��