utopia-project 0.20.3 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 883f693f304d3d472fdcc8b978298eddcb6c509a79f32527d2af4513a3ae793a
-  data.tar.gz: f11205cf2b75b905c4e0e8993a63a5a07a73b77c9c0757b2de943ca3e01f8877
+  metadata.gz: af7ac04b71cc8b501069888bd23a5da5cd00bd25d7900016fe89de7e08170426
+  data.tar.gz: fba0add2c28c7712a0c6fd894b21aca3f0015c3fc13f3c4b0299aa053e4dca9a
 SHA512:
-  metadata.gz: c5ca69c795b5977ef5e458fb3a1aef5b092fa66efcb7d5efd78ca9e6894737e3ea34ca45e76cd5ec8bbb1d2e387e3088c4474fcb70cb160ca0ecb8c426e963c2
-  data.tar.gz: 035e256b161d7fa6777498fa20fb0eaa4f1b5ef092209d0ed339f0585f3401fdc331d3359b0b6459bbc596a357f9b2100f61837fc8c2bccbaa6628e8b3049aeb
+  metadata.gz: 0fd2ed330c03e2ba6b4dc2f5ffa7c31d88b6c974b2e1b349c03d882b11ba22cca2fd86aafef63aa09dc18a75d14c1daf766c27b7791c1d3832a67fab00ac22fa
+  data.tar.gz: 6d03bc32040379cfab0f3125da19bc05a21a860cded807c695c8b0592b8b6766c200b489988f9f867a42ab4053e5885a839e66c9774321217f59a4d0c0ab0d98

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

@@ -0,0 +1,50 @@
+
+require 'utopia/project'
+require 'trenni'
+
+def update(path: "readme.md", documentation_url: nil)
+	project = Utopia::Project::Base.new(context.root)
+	readme = project.readme_document
+	
+	documentation_url ||= public_documentation_url
+	
+	readme.replace_section("Usage") do |header|
+		current = header
+		
+		usage_section = self.usage_section(documentation_url, project)
+		usage_section.each do |child|
+			current.insert_after(child)
+			current = child
+		end
+	end
+	
+	File.write(path, readme.root.to_markdown)
+end
+
+private
+
+Scope = Struct.new(:documentation_url, :project)
+
+def gemspec_path
+	Dir.glob("*.gemspec", base: context.root).first
+end
+
+def gemspec
+	if gemspec_path = self.gemspec_path
+		@gemspec ||= Gem::Specification.load(gemspec_path)
+	end
+end
+
+# The public documentation URL if it can be determined.
+def public_documentation_url
+	gemspec&.homepage
+end
+
+def usage_section(documentation_url, project)
+	template = Trenni::Template.load_file(File.expand_path("usage.trenni", __dir__))
+	scope = Scope.new(documentation_url, project)
+	
+	output = template.to_string(scope)
+	
+	return Markly.parse(output)
+end

data/bake/utopia/project/readme/usage.trenni

@@ -0,0 +1,5 @@
+Please see the [project documentation](#{documentation_url}) for more details.
+
+<?r project.guides.each do |guide| ?>
+- [#{guide.title}](#{guide.href(documentation_url)}) - #{guide.description.to_markdown}
+<?r end ?>

data/lib/utopia/project/base.rb

@@ -180,7 +180,7 @@ module Utopia
 			end
 			
 			def readme_document
-				if path = self.path_for('readme.md')
+				if path = self.path_for('readme.md') || self.path_for('README.md')
 					Document.new(File.read(path), self)
 				end
 			end

data/lib/utopia/project/document.rb

@@ -46,11 +46,12 @@ module Utopia
 						if header.first_child.to_plaintext.include?(name)
 							# Now subsequent children:
 							current = header.next
-
+							
 							# Delete everything in the section until we encounter another header:
 							while current && current.type != :header
+								current_next = current.next
 								current.delete
-								current = current.next
+								current = current_next
 							end
 							
 							return yield(header)

data/lib/utopia/project/guide.rb

@@ -83,8 +83,8 @@ module Utopia
 			
 			# The hypertext reference to this guide.
 			# @returns [String]
-			def href
-				"/guides/#{self.name}/index"
+			def href(base = "/")
+				"#{base}guides/#{self.name}/index"
 			end
 			
 			# The best documentation, extracted from the source files of the guide.

data/lib/utopia/project/linkify.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 require 'decode/syntax/rewriter'
 

data/lib/utopia/project/version.rb

@@ -5,6 +5,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.20.3"
+		VERSION = "0.22.0"
 	end
 end

data/lib/utopia/project.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 require "utopia/project/version"
 

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2020-2022, by Samuel Williams.  
+Copyright, 2020-2023, by Samuel Williams.  
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2022, by dependabot[bot].  
 

data/pages/guides/controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 prepend Actions