utopia-project 0.9.0 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9fece64054731c29fd23e542e548d9da6e0105e62fef66fc6588b3a2637e5fe
-  data.tar.gz: acda1b55bb672b64969496b9cc64f9e91c397ae3799c39af15417a3153d1628d
+  metadata.gz: '098dae8af0637c57f6b27ada06dd8a550b477187a40762681004fd147cd28590'
+  data.tar.gz: d3691badfcde2d47e3a174a9f8512d20ae6192f9f3ddd0f22a29d486b1ac22d4
 SHA512:
-  metadata.gz: b0a9ceb4a8ac9cf660ca05f8941874ef16dd724f438b3be44033b96177227327087855058accfa8a6f34bbd6370c02a41cfdacf215d3a5c2956267c38b25a7ba
-  data.tar.gz: c8b1f67c938eb4af0ae6be43a027a7fdea622e4e0253e481f82107965d547acdf3e54477de0f2019382b672fd7f9b237ab46aaa2161d45830ed82afccd44ea1e
+  metadata.gz: 4d119c825fd9da5284c3abfbb340a1bcf07458358c97a45ae01b567dd6bab64573d851632bb75c81b8b79a5b624d9269e0d199787ca816b64be1952d8a57eab9
+  data.tar.gz: c498be4408dd7b4397322145b55b77b1dbd10e91f24d2793072e722d700028d046b651ca4c7cff57958ff8ab8f6dd0f551d2ca3b9bd7491c4cc56e45d2831492

data/bake/utopia/project.rb

@@ -24,7 +24,7 @@ def serve(port: nil, bind: nil)
 	end
 	
 	if port
-		opttions << "--port" << port
+		options << "--port" << port
 	end
 	
 	system("falcon", "serve", "--config", config_path, "--preload", preload_path, *options)

data/lib/utopia/project/base.rb

@@ -28,9 +28,9 @@ require 'decode'
 
 require 'thread/local'
 
-require 'kramdown'
-
+require_relative 'document'
 require_relative 'guide'
+require_relative 'linkify'
 
 module Utopia
 	module Project
@@ -106,6 +106,16 @@ module Utopia
 				end
 			end
 			
+			def linkify(text, definition, language: definition&.language)
+				rewriter = Linkify.new(self, language, text)
+				
+				code = language.code_for(text, @index, relative_to: definition)
+				
+				code.extract(rewriter)
+				
+				return rewriter.apply
+			end
+			
 			# Format the given text in the context of the given definition and language.
 			# See {document} for details.
 			# @returns [Trenni::MarkupString]
@@ -126,41 +136,11 @@ module Utopia
 			
 			# Convert the given markdown text into HTML.
 			#
-			# - Updates source code references (`{language identifier}`) into links.
-			# - Uses {Kramdown} to convert the text into HTML.
+			# Updates source code references (`{language identifier}`) into links.
 			#
-			# @returns [Kramdown::Document]
+			# @returns [Document]
 			def document(text, definition = nil, language: definition&.language)
-				text = text&.gsub(/(?<!`){(.*?)}/) do |match|
-					linkify($1, definition, language: language)
-				end
-				
-				return Kramdown::Document.new(text, syntax_highlighter: nil)
-			end
-			
-			# Replace source code references in the given text with HTML anchors.
-			#
-			# @returns [Trenni::Builder]
-			def linkify(text, definition = nil, language: definition&.language)
-				reference = @index.languages.parse_reference(text, default_language: language)
-				
-				Trenni::Builder.fragment do |builder|
-					if reference and definition = @index.lookup(reference, relative_to: definition)&.first
-						builder.inline('a', href: link_for(definition)) do
-							builder.inline('code', class: "language-#{definition.language.name}") do
-								builder.text definition.qualified_form
-							end
-						end
-					elsif reference
-						builder.inline('code', class: "language-#{reference.language.name}") do
-							builder.text text
-						end
-					else
-						builder.inline('code') do
-							builder.text text
-						end
-					end
-				end
+				Document.new(text, self, definition: definition, default_language: language)
 			end
 			
 			# Compute a unique string which can be used as `id` attribute in the HTML output.

data/lib/utopia/project/document.rb

@@ -0,0 +1,180 @@
+# 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.
+
+require 'markly'
+
+module Utopia
+	module Project
+		class Document
+			def initialize(text, base = nil, definition: nil, default_language: nil)
+				@text = text
+				@base = base
+				@index = base&.index
+				
+				@definition = definition
+				@default_language = default_language
+				
+				@root = nil
+			end
+			
+			def root
+				@root ||= resolve(Markly.parse(@text))
+			end
+			
+			def first_child
+				self.root.first_child
+			end
+			
+			def replace_section(name)
+				child = self.first_child
+				
+				while child
+					if child.type == :header
+						header = child
+						
+						# We found the matched header:
+						if header.first_child.to_plaintext.include?(name)
+							# Now subsequent children:
+							current = header.next
+							while current.type != :header and following = current.next
+								current.delete
+								current = following
+							end
+							
+							return yield(header)
+						end
+					end
+					
+					child = child.next
+				end
+			end
+			
+			def to_html(node = self.root)
+				renderer = Markly::HTMLRenderer.new(ids: true, flags: Markly::UNSAFE)
+				Trenni::MarkupString.raw(renderer.render(node))
+			end
+			
+			def paragraph_node(child)
+				node = Markly::Node.new(:paragraph)
+				node.append_child(child)
+				return node
+			end
+			
+			def html_node(content, type = :html)
+				node = Markly::Node.new(:html)
+				node.string_content = content
+				return node
+			end
+			
+			def inline_html_node(content)
+				node = Markly::Node.new(:inline_html)
+				node.string_content = content
+				return node
+			end
+			
+			def text_node(content)
+				node = Markly::Node.new(:text)
+				node.string_content = content
+				return node
+			end
+			
+			def link_node(title, url, child)
+				node = Markly::Node.new(:link)
+				node.title = title
+				node.url = url.to_s
+				
+				node.append_child(child)
+				
+				return node
+			end
+			
+			def code_node(content, language)
+				if language
+					node = inline_html_node(
+						"<code class=\"language-#{language}\">#{Trenni::Strings.to_html(content)}</code>"
+					)
+				else
+					node = Markly::Node.new(:code)
+					node.string_content = content
+					return node
+				end
+				
+				return node
+			end
+			
+			private
+			
+			# Replace source code references in the given text with HTML anchors.
+			#
+			def reference_node(content)
+				if reference = @index.languages.parse_reference(content, default_language: @default_language)
+					definition = @index.lookup(reference, relative_to: @definition)
+				end
+				
+				if definition
+					link_node(reference.identifier, @base.link_for(definition),
+						code_node(definition.qualified_form, reference.language.name)
+					)
+				elsif reference
+					code_node(reference.identifier, reference.language.name)
+				else
+					code_node(content)
+				end
+			end
+			
+			def resolve(root)
+				return root if @index.nil?
+				
+				root.walk do |node|
+					if node.type == :text
+						content = node.string_content
+						offset = 0
+						
+						while match = content.match(/{(?<reference>.*?)}/, offset)
+							a, b = match.offset(0)
+							
+							if a > offset
+								node.insert_before(
+									text_node(content[offset...a])
+								)
+							end
+							
+							node.insert_before(
+								reference_node(match[:reference])
+							)
+							
+							offset = b
+						end
+						
+						if offset == content.bytesize
+							node.delete
+						else
+							node.string_content = content[offset..-1]
+						end
+					end
+				end
+				
+				return root
+			end
+		end
+	end
+end

data/lib/utopia/project/guide.rb

@@ -23,7 +23,6 @@
 require 'utopia/path'
 require 'trenni/reference'
 require 'decode'
-require 'kramdown'
 
 module Utopia
 	module Project
@@ -64,25 +63,16 @@ module Utopia
 			end
 			
 			# The document for the README, if one exists.
-			# @returns [Kramdown::Document]
 			def document
 				if self.readme?
 					@document ||= self.readme_document.tap do |document|
-						root = document.root
-						if element = root.children.first
-							if element.type == :header
-								@title = element.children.first.value
-								
-								# Remove the title:
-								root.children.shift
-								
-								# Remove any blank lines:
-								root.children.shift while root.children.first&.type == :blank
-								
-								# Read the description:
-								root.children.first.options[:encoding] = root.options[:encoding]
-								@description = Kramdown::Converter::Kramdown.convert(root.children.first).first
-							end
+						child = document.first_child
+						
+						if child.type == :header
+							@title = child.first_child.string_content
+							
+							@description = child.next
+							child.delete
 						end
 					end
 				end

data/lib/utopia/project/linkify.rb

@@ -0,0 +1,59 @@
+# 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.
+
+require 'decode/syntax/rewriter'
+
+module Utopia
+	module Project
+		class Linkify < Decode::Syntax::Rewriter
+			# @parameter base [Base] The base data.
+			def initialize(base, language, text)
+				@base = base
+				@language = language
+				
+				super(text)
+			end
+			
+			def text_for(range)
+				text = super(range)
+				
+				return Trenni::Strings.to_html(text)
+			end
+			
+			def link_to(definition, text)
+				Trenni::Builder.fragment do |builder|
+					builder.inline('a', href: @base.link_for(definition)) do
+						builder.text(definition.qualified_name)
+					end
+				end
+			end
+			
+			def apply(output = Trenni::Builder.new)
+				output.inline('code', class: "language-#{@language.name}") do
+					super
+				end
+				
+				return output.to_str
+			end
+		end
+	end
+end

data/lib/utopia/project/version.rb

@@ -22,6 +22,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.9.0"
+		VERSION = "0.11.3"
 	end
 end

data/pages/_navigation.xnode

@@ -20,4 +20,4 @@
 		end
 		?>)<?r
 	end
-?></nav>
+?></nav>

data/pages/_usage.xnode

@@ -1,5 +1,3 @@
-<h2>Usage</h2>
-
 <p>Please browse the <a href="source/">source code index</a> or refer to the guides below.</p>
 
 <?r
@@ -12,10 +10,10 @@
 	<?r if documentation = guide.documentation ?>
 		#{base.format(documentation.text, language: guide.documentation.language)}
 	<?r elsif description = guide.description ?>
-		#{MarkupString.raw Kramdown::Document.new(description, syntax_highlighter: nil).to_html}
+		#{MarkupString.raw description.to_html}
 	<?r else ?>
 		<p>No description.</p>
 	<?r end ?>
 <?r
 	end
-?>
+?>

data/pages/controller.rb

@@ -5,21 +5,10 @@ on 'index' do
 	@base = Utopia::Project::Base.instance
 	
 	if readme_path = @base.path_for('README.md')
-		@document = Kramdown::Document.new(File.read(readme_path), syntax_highlighter: nil)
+		@document = Utopia::Project::Document.new(File.read(readme_path), @base)
 		
-		start = @document.root.children.index{|node| node.children.first&.value == "Usage"}
-		finish = start + 1
-		
-		while node = @document.root.children[finish]
-			if node.type == :header
-				break
-			else
-				finish += 1
-			end
+		@document.replace_section("Usage") do |header|
+			header.insert_after(@document.html_node("<content:usage/>"))
 		end
-		
-		@document.root.children[start...finish] = [
-			Kramdown::Element.new(:raw, "<content:usage/>")
-		]
 	end
 end

data/pages/index.xnode

@@ -1,17 +1,18 @@
 <content:page>
 	<?r
 	if document = self[:document]
-		children = document.root.children
+		child = document.first_child
 		
-		if children.first.type == :header
-			header = children.shift
-			title = header.children.first
+		if child.type == :header
+			header = child
+			child.delete
+			title = header.first_child
+			
 			case title.type
 			when :text
-				?><content:heading>#{title.value}</content:heading><?r
-			when :img
-				self.document.attributes[:title] ||= title.attr["alt"]
-				?><header><img src="#{title.attr["src"]}" /></header><?r
+				?><content:heading>#{title.string_content}</content:heading><?r
+			when :image
+				?><header><img src="#{title.url}" /></header><?r
 			else
 				?><content:heading>Project</content:heading><?r
 			end