utopia-project 0.20.0 → 0.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb20d4e30052d026d73a9d81d0aa4834756c0f0ab6b8bd352ba51e3cabadabf3
-  data.tar.gz: d1503c89cf8383adca84b0c47a91a7d224fbde80e2aa7363c9bb7cd5958b95f4
+  metadata.gz: 883f693f304d3d472fdcc8b978298eddcb6c509a79f32527d2af4513a3ae793a
+  data.tar.gz: f11205cf2b75b905c4e0e8993a63a5a07a73b77c9c0757b2de943ca3e01f8877
 SHA512:
-  metadata.gz: 46c2fed2d33cbd886057eb31c86b540dd8d66abce8a09bf80dfde36dcc1cc6fe3cfc6d7c140d05c4b30aabfd523cdbc78b6998133e0fc7cc5f5ef92e88fae5d1
-  data.tar.gz: 20eb201ef1cca0e746e25da9f2db3210881ebf2709131831f672f2e0daa66f53009a9b656c3eb638a2391a8cfb8eec095bf7bbdbefcd25a897b1cd187d3f7d71
+  metadata.gz: c5ca69c795b5977ef5e458fb3a1aef5b092fa66efcb7d5efd78ca9e6894737e3ea34ca45e76cd5ec8bbb1d2e387e3088c4474fcb70cb160ca0ecb8c426e963c2
+  data.tar.gz: 035e256b161d7fa6777498fa20fb0eaa4f1b5ef092209d0ed339f0585f3401fdc331d3359b0b6459bbc596a357f9b2100f61837fc8c2bccbaa6628e8b3049aeb

data/bake/utopia/project.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 # Create an empty project in the current directory.
 def create

data/lib/utopia/project/base.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require 'utopia/path'
 require 'utopia/content/links'
@@ -71,7 +54,7 @@ module Utopia
 			attr :index
 			
 			# Return the absolute path for the given file name, if it exists in the project.
-			# @parameter file_name [String] The relative path to the project file, e.g. `README.md`.
+			# @parameter file_name [String] The relative path to the project file, e.g. `readme.md`.
 			# @returns [String] The file-system path.
 			def path_for(file_name)
 				full_path = File.expand_path(file_name, @root)
@@ -195,6 +178,16 @@ module Utopia
 					yield Guide.new(self, guide_path)
 				end
 			end
+			
+			def readme_document
+				if path = self.path_for('readme.md')
+					Document.new(File.read(path), self)
+				end
+			end
+			
+			def project_title
+				readme_document&.title || "Project"
+			end
 		end
 	end
 end

data/lib/utopia/project/document.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require_relative 'renderer'
 
@@ -40,6 +23,14 @@ module Utopia
 				@root ||= resolve(Markly.parse(@text, extensions: [:table]))
 			end
 			
+			def title
+				child = self.root.first_child
+				
+				if child && child.type == :header
+					return child.first_child.to_plaintext
+				end
+			end
+			
 			def first_child
 				self.root.first_child
 			end
@@ -55,9 +46,11 @@ module Utopia
 						if header.first_child.to_plaintext.include?(name)
 							# Now subsequent children:
 							current = header.next
-							while current.type != :header and following = current.next
+
+							# Delete everything in the section until we encounter another header:
+							while current && current.type != :header
 								current.delete
-								current = following
+								current = current.next
 							end
 							
 							return yield(header)

data/lib/utopia/project/guide.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require 'utopia/path'
 require 'trenni/reference'
@@ -48,18 +31,18 @@ module Utopia
 			# @attribute [String | Nil]
 			attr :description
 			
-			README = "README.md"
+			README = "readme.md"
 			
 			# The path to the README file for the guide.
 			# @returns [String] The file-system path.
 			def readme_path
-				File.expand_path(README, @root)
+				Dir[File.expand_path(README, @root)].first
 			end
 			
 			# Does a README file exist for this guide?
 			# @returns [Boolean]
 			def readme?
-				File.exist?(readme_path)
+				!readme_path.nil?
 			end
 			
 			# The document for the README, if one exists.

data/lib/utopia/project/linkify.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020, by Samuel Williams.
 
 require 'decode/syntax/rewriter'
 

data/lib/utopia/project/renderer.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
 
 require 'markly'
 require 'markly/renderer/html'

data/lib/utopia/project/version.rb

@@ -1,27 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 module Utopia
 	module Project
-		VERSION = "0.20.0"
+		VERSION = "0.20.3"
 	end
 end

data/lib/utopia/project.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# Released under the MIT License.
+# Copyright, 2020, by Samuel Williams.
 
 require "utopia/project/version"
 

data/license.md

@@ -0,0 +1,23 @@
+# MIT License
+
+Copyright, 2020-2022, by Samuel Williams.  
+Copyright, 2020, by Olle Jonsson.  
+Copyright, 2022, by dependabot[bot].  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/pages/_header.xnode

@@ -7,12 +7,29 @@
 		end
 		
 		if link = links(path.dirname, name: path.last, locale: localization.current_locale, indices: true).first
-			?> &rsaquo; #{link.to_href}<?r
+			if replace = link[:replace]&.to_sym
+				?> &rsaquo; #{link.to_href(content: controller[:base].public_send(replace))}<?r
+			else
+				?> &rsaquo; #{link.to_href}<?r
+			end
 		else
 			?> &rsaquo; <span>#{path.last}</span><?r
 		end
 	end
-	
+
+	if lexical_path = controller[:lexical_path]
+		current = []
+		lexical_path.each do |part|
+			current << part
+
+			?> &rsaquo; <a href="/source/#{current.join('/')}/index">#{part}</a> <?r
+		end
+	end
+
+	if guide = controller[:guide]
+		?> &rsaquo; <a href="/guides/#{guide.name}/index">#{guide.title}</a> <?r
+	end
+
 	if localization.localized?
 		?> &bull; (<?r
 		localization.all_locales.each.with_index do |locale, index|

data/pages/controller.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 prepend Actions
 
 on 'index' do
 	@base = Utopia::Project::Base.instance
 	
-	if readme_path = @base.path_for('README.md')
-		@document = Utopia::Project::Document.new(File.read(readme_path), @base)
+	if @document = @base.readme_document
 		
 		@document.replace_section("Usage") do |header|
 			header.insert_after(@document.html_node("<content:usage/>"))

data/pages/guides/controller.rb

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

data/pages/index.xnode

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

data/pages/links.yaml

@@ -1,4 +1,5 @@
 index:
   title: Project
+  replace: project_title
 errors:
   display: false

data/pages/source/controller.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 prepend Actions
 
@@ -8,11 +12,11 @@ end
 on '**/*/index' do |request, path|
 	@base = Utopia::Project::Base.instance
 	
-	lexical_path = path.components.dup
+	@lexical_path = path.components.dup
 	# Remove the last "index" part:
-	lexical_path.pop
+	@lexical_path.pop
 	
-	@node, @symbol = @base.lookup(lexical_path)
+	@node, @symbol = @base.lookup(@lexical_path)
 	
 	unless @symbol
 		fail! :not_found

data/pages/source/show.xnode

@@ -3,12 +3,12 @@
 	base = self[:base]
 	node = self[:node]
 	symbol = self[:symbol]
+	document.attributes[:title] ||= symbol.qualified_name
 	?>
-	<content:heading>#{symbol.qualified_name}</content:heading>
-	
-	<p>
-		<code class="language-#{symbol.language.name}">#{symbol.long_form}</code>
-	</p>
+
+	<h1>
+		<code class="language-#{symbol.language.name}">#{symbol.short_form}</code>
+	</h1>
 	
 	<?r
 	if document = base.document_for(symbol)
@@ -17,33 +17,39 @@
 		?>#{base.format(text.join("\n"), symbol)}<?r
 	end
 	?>
-	
 	#{partial 'content:signature', symbol: symbol}
-	
 	<?r
-	nested = node.children.map{|name, child| base.best(child.values)}.select{|symbol| symbol.container?}
+	nested = node.children.map do |name, child|
+		base.best(child.values)
+	end.select do |symbol|
+		symbol.container?
+	end
 	
 	if nested.any?
 	?>
 	<section>
-	<h2>Nested</h2>
-	
-	<ul>
-		<?r nested.each do |symbol| ?>
-		<li><a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.qualified_name}</code></a></li>
-		<?r end ?>
-	</ul>
+		<h2>Nested</h2>
+		
+		<ul>
+			<?r nested.each do |symbol| ?>
+			<li><a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.nested_name}</code></a></li>
+			<?r end ?>
+		</ul>
 	</section>
 	<?r
 	end
-	?>
 	
+	definitions = node.children.map do |name, child|
+		child.values.select{|symbol| symbol.documentation and !symbol.container?}
+	end.flatten
+
+	if definitions.any?
+	?>
 	<section>
-	<h2>Definitions</h2>
-	
-	<?r
-	node.children.each do |name, child|
-		child.values.each do |symbol|
+		<h2>Definitions</h2>
+		
+		<?r
+		definitions.each do |symbol|
 			if symbol.documentation and !symbol.container?
 				?><section id="#{base.id_for(symbol)}"><h3><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></h3><?r
 				
@@ -62,9 +68,10 @@
 				?></section><?r
 			end
 		end
+		?>
+	</section>
+	<?r
 	end
 	?>
-	</section>
-	
 	<content:discuss/>
 </content:page>