utopia-project 0.15.0 → 0.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0e365f1d79016583ca1eca558712eb3e314953bc74bd6404a399628972b3168
-  data.tar.gz: a06103edc45d87120f2c531252f5399884eee051efb7f7b0b7fd6edac4de4d90
+  metadata.gz: 2b57a18176afa9434511f28f02302fee700be285f2b758619354753af53577a3
+  data.tar.gz: 6ae9b2ef4860fcf69a94fa374f45e593398888e14410b0dc646e0823f9b4feee
 SHA512:
-  metadata.gz: bb1887c856a24b2360c1101b1c377eff4c15d7bb3322f8318057815a3ff056c712427a2c70164337987905b58b0bdcaad134cdad4c44ef3baedca4be0fcba85e
-  data.tar.gz: 00a55cfb9f18fd62e3e178c3fb183375d5640eedcac3f204957f6582b84a07875b458c8022ebe3bfde8ead2d9791a2905eae8fa6f2554e8d938378ad501e7f20
+  metadata.gz: 63d9424f566e31010506ab7cef1dacd28495967d86ac08c29dec93bb11158c4c43fd7751e3adb920e4df1f4d14d3e941d9dce612530dc62ba37640098d520dd4
+  data.tar.gz: cca320d9ebdb86b78e6b8f655028ef0e3978776f2df6f300dd4f693b0225e447a81a28c3eb1f1601fae58eef2962afcde674b13b3bb4de899a2a36d53c1d94d1

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.0"
+		VERSION = "0.15.4"
 	end
 end

data/pages/_header.xnode

@@ -1,4 +1,4 @@
-<header><label for="toggle">☰</label> <?r
+<header><?r
 	page_path = first.node.uri_path.dirname
 	
 	Utopia::Path[page_path].descend do |path|

data/pages/index.xnode

@@ -14,7 +14,11 @@
 			when :image
 				self.document.attributes[:title] ||= title.to_plaintext
 				
-				?><h1><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,17 @@
+<?r
+base = self[:base]
+
+symbol = attributes[:symbol] 
+documentation = symbol.documentation
+
+pragmas = documentation&.filter(Decode::Comment::Pragma).to_a
+
+if pragmas&.any? ?>
+<ul class="pragmas #{attributes[:class]}">
+	<?r pragmas.each do |pragma| ?>
+		<li class="pragma #{pragma.directive}">
+			<span class="directive">#{pragma.directive}</span>
+		</li>
+	<?r end ?>
+</ul>
+<?r end ?>

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,14 @@
 			
 			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>
+						
+						#{partial 'content:pragmas', symbol: symbol, class: 'inline'}
+						
+						<?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:signature', 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/links.js

@@ -6,11 +6,11 @@ jQuery(function() {
 			document.createTextNode("¶")
 		);
 		
-		anchor.title = element.innerText;
 		anchor.href = "#" + element.id;
 		anchor.className = "self";
 		
 		let heading = element.firstChild;
+		anchor.title = heading.innerText;
 		
 		heading.appendChild(
 			document.createTextNode(' ')

data/public/_static/site.css

@@ -6,6 +6,8 @@ html {
 	/* Fix odd text-size in `display: flex` elements on Safari iOS */
 	text-size-adjust: 100%;
 	-webkit-text-size-adjust: 100%;
+	
+	line-height: 1.5;
 }
 
 @media (min-width: 40em) {
@@ -257,3 +259,53 @@ table thead {
 table tr:hover {
 	background-color: var(--header-color);
 }
+
+ul.pragmas {
+	margin: 0 1rem;
+	padding: 0;
+	
+	font-size: 80%;
+}
+
+ul.pragmas.inline {
+	display: inline;
+}
+
+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,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.4
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: utopia
+  name: decode
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
-  name: markly
+  name: falcon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: decode
+  name: markly
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rackula
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: falcon
+  name: thread-local
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thread-local
+  name: utopia
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,23 +164,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bake-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -208,10 +193,12 @@ 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
 - pages/source/show.xnode
+- public/.nojekyll
 - public/_components/jquery-litebox/jquery.litebox.css
 - public/_components/jquery-litebox/jquery.litebox.gallery.css
 - public/_components/jquery-litebox/jquery.litebox.js
@@ -295,15 +282,15 @@ homepage: https://socketry.github.io/utopia-project/
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/socketry/utopia-project/
   funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/utopia-project/
 post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -312,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.