utopia-project 0.15.2 → 0.15.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b291760470f3fac6826c055b7541f19dae489777f8e936dcb5426e236eb458a8
-  data.tar.gz: '09d320eadae6e0feed0ad04da6f2b6ce0d1be30b7c2571cca96215e27d881a37'
+  metadata.gz: 328a7d6f0c1c504487c9d6bd1819b76c00b43710ab7723599efbe192da2147a1
+  data.tar.gz: 7ca0ce6e72b8ee1098b5dfd4e030115a2486da727d2c05c37c0e8183c39ffc2b
 SHA512:
-  metadata.gz: 447a3b0cd6dd9323a75e8198265c9cb559a52693d5bb18d774d25071b39e23df5f540daa8194b5a730ce8375b948287adea0cd1b79b196a397fd5e88f79b002b
-  data.tar.gz: abead9c8e587061805d96ed5f2549ce87f0aacbe5b25d0c62b4389f4a5830015155ca298e769942375fe487102d508e4e3a2cb3537b3bf5dd219c163c146c2b2
+  metadata.gz: 23412ec5df8a024bcd82bd9ff383304ba1f1c95ee781e5ec7c166ad96186d1d7b776e74ede14a40dd446a2a8e55f21bf5f90cbc68c406b78c70ad666f470a031
+  data.tar.gz: 03abc625c0f905a5e3e438454aa2aea1bdccd8fda1e8407d40ada29fc995fc7fc19b3f28ad07aee672234fab87e5f63bd8113383f3e160ce187cb3eb9f1183a9

data/lib/utopia/project/base.rb

@@ -133,7 +133,7 @@ module Utopia
 			# Format the given text in the context of the given definition and language.
 			# See {document} for details.
 			# @returns [Trenni::MarkupString]
-			def format(text, definition = nil, language: definition&.language)
+			def format(text, definition = nil, language: definition&.language, **options)
 				case text
 				when Enumerable
 					text = text.to_a.join("\n")
@@ -143,7 +143,7 @@ module Utopia
 				
 				if document = self.document(text, definition, language: language)
 					return Trenni::MarkupString.raw(
-						document.to_html
+						document.to_html(**options)
 					)
 				end
 			end

data/lib/utopia/project/document.rb

@@ -68,8 +68,8 @@ module Utopia
 				end
 			end
 			
-			def to_html(node = self.root)
-				renderer = Markly::HTMLRenderer.new(ids: true, flags: Markly::UNSAFE)
+			def to_html(node = self.root, **options)
+				renderer = Markly::HTMLRenderer.new(ids: true, flags: Markly::UNSAFE, **options)
 				Trenni::MarkupString.raw(renderer.render(node))
 			end
 			

data/lib/utopia/project/version.rb

@@ -22,6 +22,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.15.2"
+		VERSION = "0.15.3"
 	end
 end

data/pages/index.xnode

@@ -14,7 +14,11 @@
 			when :image
 				self.document.attributes[:title] ||= title.to_plaintext
 				
-				?><h1 style="text-align: center"><img src="#{title.url}" /></h1><?r
+				if title.url =~ /\.svg/
+					?><h1 style="text-align: center"><object type="image/svg+xml" data="#{title.url}"></object></h1><?r
+				else
+					?><h1 style="text-align: center"><img src="#{title.url}" /></h1><?r
+				end
 			else
 				?><content:heading>Project</content:heading><?r
 			end

data/pages/source/_pragmas.xnode

@@ -0,0 +1,20 @@
+<?r
+base = self[:base]
+
+symbol = attributes[:symbol] 
+documentation = symbol.documentation
+
+pragmas = documentation&.filter(Decode::Comment::Pragma).to_a
+
+if pragmas&.any? ?>
+<ul class="pragmas">
+	<?r pragmas.each do |pragma| ?>
+		<li class="pragma #{pragma.directive}">
+			<span class="directive">#{pragma.directive}</span>
+			<?r if text = pragma.text ?>
+			<span class="details">#{base.format(text.first, symbol, tight: true)}</span>
+			<?r end ?>
+		</li>
+	<?r end ?>
+</ul>
+<?r end ?>

data/pages/source/_signature.xnode

@@ -10,6 +10,7 @@
 	<dl><?r
 		documentation.traverse do |node, descend|
 			node.each do |child|
+				next if child.is_a?(Decode::Comment::Pragma)
 				?><dt>
 					<strong>#{child.directive}</strong><?r
 						case child

data/pages/source/index.xnode

@@ -1,5 +1,5 @@
 <content:page>
-	<content:heading>Source</content:heading>
+	<content:heading>Overview</content:heading>
 	
 	<?r
 	base = controller[:base]
@@ -11,10 +11,12 @@
 			
 			if documentation = symbol.documentation or symbol.container?
 				?><li>
-					<a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></a>
-					
-					<?r if documentation and text = documentation.text ?>
-						#{base.format(text.first, symbol)}
+					<?r if symbol.container? ?>
+						<a href="#{base.link_for(symbol)}"><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></a>
+						
+						<?r if documentation and text = documentation.text ?>
+							#{base.format(text.first, symbol)}
+						<?r end ?>
 					<?r end ?>
 					
 					<?r if symbol.container?

data/pages/source/show.xnode

@@ -6,6 +6,8 @@
 	?>
 	<content:heading><code class="language-#{symbol.language.name}">#{symbol.qualified_name}</code></content:heading>
 	
+	#{partial 'content:pragmas', symbol: symbol}
+	
 	<?r
 	if document = base.document_for(symbol)
 		?>#{document.to_html}<?r
@@ -42,6 +44,7 @@
 				?><section id="#{base.id_for(symbol)}"><h3><code class="language-#{symbol.language.name}">#{symbol.long_form}</code></h3><?r
 				
 				if documentation = symbol.documentation
+					?>#{partial 'content:pragmas', symbol: symbol}<?r
 					?>#{base.format(documentation.text, symbol)}<?r
 					?>#{partial 'content:signature', symbol: symbol}<?r
 				end

data/public/_static/site.css

@@ -259,3 +259,49 @@ table thead {
 table tr:hover {
 	background-color: var(--header-color);
 }
+
+ul.pragmas {
+	margin: 0 1rem;
+	padding: 0;
+	
+	font-size: 80%;
+}
+
+ul.pragmas .directive {
+	font-weight: bold;
+}
+
+ul.pragmas li {
+	list-style: none;
+	
+	border: 1px solid #ccf;
+	border-radius: 0.5em;
+	
+	box-shadow: 0 0 2px #eee;
+	padding: 0.1rem 0.2rem;
+	
+	display: inline-block;
+}
+
+ul.pragmas li + li {
+	margin-left: 0.5rem;
+}
+
+ul.pragmas li.public {
+	border-color: #8CFF00;
+	box-shadow: 0 0 0.3rem #8CFF00;
+	color: #8CFF00;
+}
+
+ul.pragmas li.private,
+ul.pragmas li.deprecated {
+	border-color: #FF8C00;
+	box-shadow: 0 0 0.3rem #FF8C00;
+	color: #FF8C00;
+}
+
+ul.pragmas li.asynchronous {
+	border-color: #8C00FF;
+	box-shadow: 0 0 0.3rem #8C00FF;
+	color: #8C00FF;
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.15.3
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decode
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: falcon
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rackula
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - pages/guides/show.xnode
 - pages/index.xnode
 - pages/links.yaml
+- pages/source/_pragmas.xnode
 - pages/source/_signature.xnode
 - pages/source/controller.rb
 - pages/source/index.xnode
@@ -298,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A project documentation tool based on Utopia.