utopia-project 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8525ca6b514187584429c1bf7c4ac86bd54a1d206ebe36e4c465fbef69982152
-  data.tar.gz: 308dcc520b52ade7bf5607ea0d9a1228948be22b1e719d3c983583d2fd12ffd0
+  metadata.gz: fbdcc336360ff1d15a59373bf8b092e65903e7b08db3f160d8f98552a44b1ad5
+  data.tar.gz: e1d4ec64476493cec60ba46c08016f76d0c599d378ceb8de6c4e607605f8bad1
 SHA512:
-  metadata.gz: c79be4678eef55bae1ad2bf062ef71b1b66703c77be86184b1e364dddd0775fac48b3e1b4e6963050a5c6605a97199837ecef86baf8b3dbb32ac83cc8cc79f95
-  data.tar.gz: 66030584f58cc4c58559c8e1b3b0bf5454c75746608c859cd12d5981f46566388d79ad9cb0b86aec00889aa6e5590415836cfd2a93befa3d52574bace168130d
+  metadata.gz: 7d1bdeee7c8d2723f794020b4ccde19585d5d391203df95afb5853a778fdf70f4e3cfb6e49500aef612b39535a6f0782184a261647f23df829319f1d1ccc0c85
+  data.tar.gz: '087944905a965cbc0acfde35694d27795ee130440d85932e0e89c8e3a763c2829336db85cfc3ac748904045d2d40926b621afdcc894fef31c0ca7111b8cde420'

data/lib/utopia/project/base.md

@@ -0,0 +1,7 @@
+# Utopia::Project::Base
+
+Provides structured access to a project directory which contains source code and guides.
+
+## Usage
+
+To get an instance for the current project, use {Base#instance}.

data/lib/utopia/project/base.rb

@@ -106,6 +106,20 @@ module Utopia
 				end
 			end
 			
+			def document_for(definition)
+				document_path = File.join("lib", definition.lexical_path.map{|_| _.to_s.downcase}) + ".md"
+				
+				if File.exist?(document_path)
+					document = self.document(File.read(document_path), definition)
+					
+					if document.first_child.type == :header
+						document.first_child.delete
+					end
+					
+					return document
+				end
+			end
+			
 			def linkify(text, definition, language: definition&.language)
 				rewriter = Linkify.new(self, language, text)
 				

data/lib/utopia/project/version.rb

@@ -22,6 +22,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.13.0"
+		VERSION = "0.14.1"
 	end
 end

data/pages/_page.xnode

@@ -18,9 +18,7 @@
 		<script src="/_components/jquery/jquery.min.js"></script>
 		<script src="/_components/jquery-syntax/jquery.syntax.min.js"></script>
 		
-		<script src="/_components/lunr/lunr.min.js"></script>
-		<script src="/_static/links.js?#{rand}"></script>
-		<script src="/_static/search.js?#{rand}"></script>
+		<script src="/_static/links.js"></script>
 		
 		<script type="text/javascript">
 		//<![CDATA[

data/pages/_usage.xnode

@@ -5,15 +5,17 @@
 	
 	base.guides do |guide|
 ?>
-	<h3><a href="#{guide.href}">#{guide.title}</a></h3>
-	
-	<?r if documentation = guide.documentation ?>
-		#{base.format(documentation.text, language: guide.documentation.language)}
-	<?r elsif description = guide.description ?>
-		#{MarkupString.raw description.to_html}
-	<?r else ?>
-		<p>No description.</p>
-	<?r end ?>
+	<section>
+		<h3><a href="#{guide.href}">#{guide.title}</a></h3>
+		
+		<?r if documentation = guide.documentation ?>
+			#{base.format(documentation.text, language: guide.documentation.language)}
+		<?r elsif description = guide.description ?>
+			#{MarkupString.raw description.to_html}
+		<?r else ?>
+			<p>No description.</p>
+		<?r end ?>
+	</section>
 <?r
 	end
 ?>

data/pages/index.xnode

@@ -12,7 +12,9 @@
 			when :text
 				?><content:heading>#{title.string_content}</content:heading><?r
 			when :image
-				?><header><img src="#{title.url}" /></header><?r
+				self.document.attributes[:title] ||= title.to_plaintext
+				
+				?><h1><img src="#{title.url}" /></h1><?r
 			else
 				?><content:heading>Project</content:heading><?r
 			end

data/pages/source/show.xnode

@@ -7,7 +7,9 @@
 	<content:heading><code class="language-#{symbol.language.name}">#{symbol.qualified_name}</code></content:heading>
 	
 	<?r
-	if documentation = symbol.documentation
+	if document = base.document_for(symbol)
+		?>#{document.to_html}<?r
+	elsif documentation = symbol.documentation
 		?>#{base.format(documentation.text.join("\n"), symbol)}<?r
 	end
 	?>

data/public/_components/jquery-syntax/base/jquery.syntax.brush.xml.css

@@ -16,3 +16,20 @@
   color: #666;
   background-color: #ddd;
   border-radius: 0.5em; }
+
+@media (prefers-color-scheme: dark) {
+  .syntax-theme-base .xml .cdata-content {
+    color: #a46; }
+  .syntax-theme-base .xml .xml-tag, .syntax-theme-base .xml .cdata {
+    color: #c59de7; }
+  .syntax-theme-base .xml .tag-name, .syntax-theme-base .xml .cdata-tag {
+    color: #9ae; }
+  .syntax-theme-base .xml .namespace {
+    color: #c59de7; }
+  .syntax-theme-base .xml .attribute {
+    color: #c59de7; }
+  .syntax-theme-base .xml .instruction {
+    color: #c59de7; }
+  .syntax-theme-base .xml .entity, .syntax-theme-base .xml .percent-escape {
+    color: #999;
+    background-color: #333; } }

data/public/_components/jquery-syntax/jquery.syntax.core.js

@@ -9,8 +9,8 @@ Syntax.lib.camelCaseType={pattern:/\b_*[A-Z][\w]*\b/g,klass:"type"};Syntax.lib.c
 Syntax.lib.doubleQuotedString={pattern:/"([^\\"\n]|\\.)*"/g,klass:"string"};Syntax.lib.singleQuotedString={pattern:/'([^\\'\n]|\\.)*'/g,klass:"string"};Syntax.lib.multiLineDoubleQuotedString={pattern:/"([^\\"]|\\.)*"/g,klass:"string"};Syntax.lib.multiLineSingleQuotedString={pattern:/'([^\\']|\\.)*'/g,klass:"string"};Syntax.lib.stringEscape={pattern:/\\./g,klass:"escape",only:["string"]};
 Syntax.Match=function(b,a,c,d){this.offset=b;this.endOffset=b+a;this.length=a;this.expression=c;this.value=d;this.children=[];this.next=this.parent=null};Syntax.Match.prototype.shift=function(b,a){this.adjust(b,null,a);for(var c=0;c<this.children.length;c++)this.children[c].shift(b,a)};Syntax.Match.prototype.adjust=function(b,a,c){this.offset+=b;this.endOffset+=b;a&&(this.length=a,this.endOffset=this.offset+a);c&&(this.value=c.substr(this.offset,this.length))};
 Syntax.Match.sort=function(b,a){return b.offset-a.offset||a.length-b.length};Syntax.Match.prototype.contains=function(b){return b.offset>=this.offset&&b.endOffset<=this.endOffset};Syntax.Match.defaultReduceCallback=function(b,a){"string"===typeof b&&(b=document.createTextNode(b));a.appendChild(b)};
-Syntax.Match.prototype.reduce=function(b,a){var c=this.offset,d=document.createElement("span");b=b||Syntax.Match.defaultReduceCallback;this.expression&&this.expression.klass&&(0<d.className.length&&(d.className+=" "),d.className+=this.expression.klass);this.className&&(d.className+=" ",d.className+=this.className);for(var e=0;e<this.children.length;e+=1){var f=this.children[e],g=f.offset;f.offset<this.offset&&console.log("Syntax Warning: Offset of child",f,"is before offset of parent",this);c=this.value.substr(c-
-this.offset,g-c);b(c,d);b(f.reduce(b,a),d);c=f.endOffset}c===this.offset?b(this.value,d):c<this.endOffset?b(this.value.substr(c-this.offset,this.endOffset-c),d):c>this.endOffset&&console.log("Syntax Warning: Start position "+c+" exceeds end of value "+this.endOffset);a&&(d=a(d,this));return d};
+Syntax.Match.prototype.reduce=function(b,a){var c=this.offset;var d=this.expression&&this.expression.element?this.expression.element.cloneNode(!1):document.createElement("span");b=b||Syntax.Match.defaultReduceCallback;this.expression&&this.expression.klass&&(0<d.className.length&&(d.className+=" "),d.className+=this.expression.klass);this.className&&(d.className+=" ",d.className+=this.className);for(var e=0;e<this.children.length;e+=1){var f=this.children[e],g=f.offset;f.offset<this.offset&&console.log("Syntax Warning: Offset of child",
+f,"is before offset of parent",this);c=this.value.substr(c-this.offset,g-c);b(c,d);b(f.reduce(b,a),d);c=f.endOffset}c===this.offset?b(this.value,d):c<this.endOffset?b(this.value.substr(c-this.offset,this.endOffset-c),d):c>this.endOffset&&console.log("Syntax Warning: Start position "+c+" exceeds end of value "+this.endOffset);a&&(d=a(d,this));return d};
 Syntax.Match.prototype.canContain=function(b){return b.expression.force?!0:this.complete?!1:b.expression.only?!0:"undefined"===typeof this.expression.allow||jQuery.isArray(this.expression.disallow)&&-1!==jQuery.inArray(b.expression.klass,this.expression.disallow)?!1:"*"===this.expression.allow||jQuery.isArray(this.expression.allow)&&-1!==jQuery.inArray(b.expression.klass,this.expression.allow)?!0:!1};
 Syntax.Match.prototype.canHaveChild=function(b){if(b=b.expression.only){for(var a=this;null!==a;){if(-1!==jQuery.inArray(a.expression.klass,b))return!0;if((a=a.parent)&&a.complete)break}return!1}return!0};Syntax.Match.prototype._splice=function(b,a){return this.canHaveChild(a)?(this.children.splice(b,0,a),a.parent=this,a.expression.owner||(a.expression.owner=this.expression.owner),this):null};
 Syntax.Match.prototype.insert=function(b,a){if(!this.contains(b))return null;if(a){a=this;for(var c=0;c<a.children.length;)a.children[c].contains(b)?(a=a.children[c],c=0):c+=1;return a._insertWhole(b)}return this._insert(b)};

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: utopia
@@ -187,6 +187,7 @@ extra_rdoc_files: []
 files:
 - bake/utopia/project.rb
 - lib/utopia/project.rb
+- lib/utopia/project/base.md
 - lib/utopia/project/base.rb
 - lib/utopia/project/document.rb
 - lib/utopia/project/guide.rb