docrb-html 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ab65a6bab83355b8532920f7dfa26d9f9e05d99fbe6cdbe1677a9b75695861
-  data.tar.gz: e69e29e51b3e4bc491e058259be007910032607cce30e0e7223a4a1adad23c01
+  metadata.gz: 2d537de0bf7498e0737d3e5fa22fdce806a5fc60cd43db277654bf6d29e5f166
+  data.tar.gz: 8ad531ba61d72206428b7c51146407e64b67e31d52831e46871f0511c868aab4
 SHA512:
-  metadata.gz: 935815ac11006ab359e5c489f57266d8de17691bc9035a45cd7564e8b3142e927313cef65e41401e1e713422ad77d3c3f7653c9cf0d9167eb8f3cb77c285ff05
-  data.tar.gz: 9e57cd852acb2f6bc459206e81088088bd85be92600a973e911c6cddb0e266c384e08b978cb53c7e0b364778358ec515cf21c7d86ede85b91a501c38b5e11103
+  metadata.gz: 64bed70222a7dca33da8f1d63f744da880bd8a1cd5e94f2a32816f77453b9d0d99c4529104a106b900f081591e4fb1ed2b897279b7bbdc53c0f5d0e28a0ecafc
+  data.tar.gz: 2f4c229846d54b5447283693eadb795d1e2c460959bafe6ebe8614d248b8b0b92ac8d6a923b159ff6e7d3b87f5e5e842aed788cd30aa402768e1a65e57ae6194

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docrb-html (0.3.0)
+    docrb-html (0.3.2)
       nokogiri (~> 1.14)
       redcarpet (~> 3.6)
       rouge (~> 4.1)

data/assets/class_path_reference.scss

@@ -0,0 +1,30 @@
+.html div.class-path-reference-base {
+    @include mono;
+    display: flex;
+    flex-wrap: wrap;
+
+    span {
+        white-space: unset;
+
+        a {
+            @include mono;
+        }
+
+        &.segment {
+            &:not(:last-child) {
+                ::after {
+                    content: '::'
+                }
+            }
+
+
+            &.class a {
+                color: #FFAB42;
+            }
+
+            &.module a {
+                color: #579AD1;
+            }
+        }
+    }
+}

data/assets/markdown.scss

@@ -38,4 +38,8 @@ div.markdown-base {
     code, pre {
         @include mono($size: 15);
     }
+
+    .faded {
+        @include faded;
+    }
 }

data/assets/reference.scss

@@ -11,6 +11,11 @@ div.reference-base {
         &.module { color: #579AD1; border-color: #579AD1; }
     }
 
+    .broken {
+        @include mono;
+        cursor: initial;
+    }
+
     .unresolved {
         border: 1px dotted #D8D8D8;
         border-radius: 10px 3px 3px 10px;

data/assets/style.scss

@@ -44,3 +44,4 @@ body {
 @import './constant_display';
 @import './field_block';
 @import './svg';
+@import './class_path_reference';

data/lib/docrb-html.rb

@@ -29,6 +29,8 @@ require_relative "renderer/metadata"
 require_relative "renderer/entities"
 
 class Renderer
+  attr_reader :spec
+
   def now = Time.now.strftime("%A, %-d %b %Y %H:%M:%S %Z")
 
   def output_path(*args) = File.join(@output, *args.map(&:to_s))
@@ -55,6 +57,11 @@ class Renderer
       .map { outline(_1) }
   end
 
+  def make_path(*args)
+    root = spec.fetch(:base_path, "/")
+    File.join(root, *args.flatten.map(&:to_s))
+  end
+
   def outline(object, level = 0)
     {
       level:,
@@ -73,16 +80,21 @@ class Renderer
       links: Metadata.project_links(@spec)
     )
 
-    index = Page.new(title: "#{@spec[:name]} - Docrb") do
-      readme = Component::Markdown.new(source: Markdown.render(@spec[:readme]))
+    readme = if @spec[:readme]
+      Component::Markdown.new(source: Markdown.render(@spec[:readme]))
+    else
+      Component::Markdown.new(source: "<div class=\"html\">" \
+                                      "<div class=\"faded\">This project does not contain a README.</div></div>")
+    end
 
+    index = Page.new(title: "#{@spec[:name]} - Docrb") do
       [
         project_header,
         Component::TabBar.new(
           selected_index: 0,
           items: [
-            { name: "Readme", href: "/" },
-            { name: "Components", href: "/components.html" }
+            { name: "Readme", href: make_path("/") },
+            { name: "Components", href: make_path("/components.html") }
           ]
         ),
         readme,
@@ -96,8 +108,8 @@ class Renderer
         Component::TabBar.new(
           selected_index: 1,
           items: [
-            { name: "Readme", href: "/" },
-            { name: "Components", href: "/components.html" }
+            { name: "Readme", href: make_path("/") },
+            { name: "Components", href: make_path("/components.html") }
           ]
         ),
         Component::ComponentList.new(list: make_outline),

data/lib/renderer/component/class_path_reference.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Renderer
+  class Component
+    class ClassPathReference < Component
+      prop :doc
+    end
+  end
+end

data/lib/renderer/component/doc_box.rb

@@ -12,7 +12,7 @@ class Renderer
         :page_components
 
       def prepare
-        @has_class_docs = (item.doc && !item.doc.empty?) || false
+        @has_class_docs = (item.doc && !item.doc.empty? && !item.doc[:value].empty?) || false
         @instance_methods = item.all_instance_methods
         @class_methods = item.all_class_methods
         @instance_attributes = item.kind == :class ? item.all_instance_attributes : []

data/lib/renderer/component/reference.rb

@@ -9,7 +9,7 @@ class Renderer
         case @object
         when Docrb::Parser::Reference
           @unresolved = !@object.fulfilled?
-          @path = [@object.path.last]
+          @path = @object.path
           return if @unresolved
 
           @object = @object.dereference!

data/lib/renderer/helpers.rb

@@ -90,19 +90,20 @@ class Renderer
       parent ||= obj.parent
 
       case (v = parent.source_of(obj))
-      when :inherited, :included, :extended then v.to_s
+      when :inherited, :included, :extended then "inherited"
       when :self then ("override" if obj.try(:overriding))
       else raise "WTF? Source of #{obj} is #{v.inspect}!"
       end
     end
 
+    def make_path(*) = self.class.current_renderer.make_path(*)
+
     def path_of(object, root: true)
       return [] if object.nil? && !root
       return [object.name] + path_of(object.parent, root: false) unless root
 
       path = ["#{object.name}.html"] + path_of(object.parent, root: false)
-      path << ""
-      path.reverse.join("/")
+      make_path(*path.reverse)
     end
 
     def link_for(object)

data/lib/renderer/page.rb

@@ -8,9 +8,17 @@ class Renderer
       @title = "#{title} - Docrb"
       @body = body || -> { "" }
       @level = level
+      @make_path = -> (path) { Helpers.current_renderer.make_path(path) }
     end
 
-    def render = PAGE_BASE.render(Object.new, title: @title, level: @level, body: @body.call)
+    def render
+      PAGE_BASE.render(Object.new,
+        make_path: @make_path,
+        title: @title,
+        level: @level,
+        body: @body.call
+      )
+    end
 
     def render_to(path) = File.write(path, render)
   end

data/lib/renderer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Renderer
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

data/templates/base.erb

@@ -7,12 +7,9 @@
     <link rel="preconnect" href="https://fonts.googleapis.com" />
     <link rel="preconnect" href="https://fonts.gstatic.com" crossOrigin="true" />
     <link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@300;400;500&family=Inter:wght@300;400;500&display=swap" rel="stylesheet" />
-    <% unless level.zero? %>
-    <base href="<%= ([".."] * level).join("/") %>" />
-    <% end %>
-    <link rel="stylesheet" type="text/css" href="style.css" />
-    <link rel="shortcut icon" href="favicon.ico" type="image/x-icon"/>
-    <link rel="icon" href="favicon.ico" type="image/x-icon"/>
+    <link rel="stylesheet" type="text/css" href="<%= make_path.call("style.css") %>" />
+    <link rel="shortcut icon" href="<%= make_path.call("favicon.ico") %>" type="image/x-icon"/>
+    <link rel="icon" href="<%= make_path.call("favicon.ico") %>" type="image/x-icon"/>
 </head>
 <body>
     <% if body.is_a? Array %>
@@ -20,6 +17,6 @@
     <% else %>
         <%= body %>
     <% end %>
-    <script type="text/javascript" src="filtering.js"></script>
+    <script type="text/javascript" src="<%= make_path.call("filtering.js") %>"></script>
 </body>
 </html>

data/templates/breadcrumb.erb

@@ -1,6 +1,6 @@
 <% div("breadcrumb-base", id:) do %>
     <div class="link">
-        <a href="/">
+        <a href="<%= make_path %>">
             <%= svg("home") %>
             <span class="padded">
             <%= project_name %>
@@ -11,13 +11,13 @@
         <%= svg("breadcrumb_separator") %>
         <div class="link">
             <% if i[:parents].empty? && idx == 0 %>
-                <a href="components.html">
+                <a href="<%= make_path("/components.html") %>">
                 <span class="padded">
                     <%= i[:name] %>
                 </span>
                 </a>
             <% else %>
-                <a href="<%= (i[:parents] + [idx == 0 ? nil : i[:name]]).flatten.compact.join("/") %>.html">
+                <a href="<%= make_path((i[:parents] + [idx == 0 ? nil : i[:name]]).flatten.compact) %>.html">
             <span class="padded">
                 <%= i[:name] %>
             </span>

data/templates/class_path_reference.erb

@@ -0,0 +1,9 @@
+<% div("class-path-reference-base", id:) do %>
+    <% if doc[:prefix] %>
+        <span><%= doc[:prefix] %></span>
+    <% end %>
+    <% doc[:segments].each do |segment| %>
+        <span class="segment <%= segment.kind %>"><a class="dashed" href="<%= link_for(segment) %>"><%= segment.name %></a></span>
+    <% end %>
+    <span class="segment <%= doc[:target].kind %>"><a class="dashed" href="<%= link_for(doc[:target]) %>"><%= doc[:target].name %></a></span>
+<% end %>

data/templates/documentation_block.erb

@@ -1,5 +1,5 @@
 <% div("documentation-block-base", id:) do %>
-    <% if doc.nil? || doc.empty? %>
+    <% if doc.nil? || doc.empty? || doc[:value].empty? %>
         <div class="faded">(No documentation available)</div>
     <% else %>
         <% doc[:value].each do |block| %>

data/templates/documentation_comment.erb

@@ -8,12 +8,13 @@
     <% elsif doc[:type] == :neutral_identifier || doc[:type] == :unresolved_identifier %>
         <code><%= doc[:value] %></code>
     <% elsif doc[:type] == :reference %>
-        <%= reference(object: i) %>
+        <%= reference(object: doc) %>
     <% elsif doc[:type] == :symbol %>
         <%= symbol(name: doc[:value]) %>
     <% elsif doc[:type] == :method_ref %>
         <a class="method-ref dashed" href="<%= link_for(doc[:object]) %>"><%= doc[:value] %></a>
-        <!-- <%= doc.to_json %> -->
+    <% elsif doc[:type] == :class_path_reference %>
+        <%= class_path_reference(doc: doc) %>
     <% else %>
         <div class="unknown-object">
             Unknown object <%= doc[:type] %>

data/templates/method_argument.erb

@@ -3,7 +3,12 @@
         <span class="rest-arg <%= computed[:rest] %>"></span>
     <% end %>
 
-    <%= computed[:name] %>
+    <% if computed[:rest] || computed[:block] %>
+        <%= computed[:name].to_s.gsub(/^([*]{1,2}|&)$/, '') %>
+    <% else %>
+        <%= computed[:name] %>
+    <% end %>
+
 
     <% if computed[:continuation] %>
         <span class="continuation <%= computed[:continuation] %>"></span>

data/templates/reference.erb

@@ -1,6 +1,6 @@
 <% div("reference-base", id:) do %>
     <% if unresolved %>
-        <span><%= value || path.last %></span>
+        <span class="broken"><%= value || path.join("::") %></span>
     <% elsif ref_type == :pure %>
         <a href="<%= link_for(object) %>">
         <span class="resolved <%= ref_type %>">
@@ -8,7 +8,7 @@
         </span>
         </a>
     <% else %>
-        <a href="<%= path.join('/') %>.html">
+        <a href="<%= make_path(*path) %>.html">
         <span class="resolved <%= ref_type %>">
             <span><%= value || path.last %></span>
         </span>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docrb-html
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Victor Gama
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-28 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -83,6 +83,7 @@ files:
 - assets/checkbox.scss
 - assets/class_header.scss
 - assets/class_mod_name.scss
+- assets/class_path_reference.scss
 - assets/component_list.scss
 - assets/constant_display.scss
 - assets/container.scss
@@ -134,6 +135,7 @@ files:
 - lib/renderer/component/checkbox.rb
 - lib/renderer/component/class_header.rb
 - lib/renderer/component/class_mod_name.rb
+- lib/renderer/component/class_path_reference.rb
 - lib/renderer/component/component_list.rb
 - lib/renderer/component/constant_display.rb
 - lib/renderer/component/doc_box.rb
@@ -182,6 +184,7 @@ files:
 - templates/checkbox.erb
 - templates/class_header.erb
 - templates/class_mod_name.erb
+- templates/class_path_reference.erb
 - templates/component_list.erb
 - templates/constant_display.erb
 - templates/doc_box.erb