docrb-html 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e032e7d421f2811ed73880d0e9b224ebf11b9027446baee4fbf58f8fe28efb5
-  data.tar.gz: 9ea3088213e3e09e31c12a81041ad3cab9f48d16b859a36597603d159bc8423d
+  metadata.gz: 2d537de0bf7498e0737d3e5fa22fdce806a5fc60cd43db277654bf6d29e5f166
+  data.tar.gz: 8ad531ba61d72206428b7c51146407e64b67e31d52831e46871f0511c868aab4
 SHA512:
-  metadata.gz: 6e4c417666d05eb251dfee6ffc8b1243f1db13e73d34b48e9c7a1645fedb6fbad9eec4679387d18e76f25e78fb0253ac9c44c6f3ff753ed78673884e7d26ab75
-  data.tar.gz: 6b4e542016f1c14f2f40a6adabddecc97afbde132021c1ac5f830a1b785255b79eb27078570296f287e39a9ef2f348e75612446b360c3a530b47f077748bfad2
+  metadata.gz: 64bed70222a7dca33da8f1d63f744da880bd8a1cd5e94f2a32816f77453b9d0d99c4529104a106b900f081591e4fb1ed2b897279b7bbdc53c0f5d0e28a0ecafc
+  data.tar.gz: 2f4c229846d54b5447283693eadb795d1e2c460959bafe6ebe8614d248b8b0b92ac8d6a923b159ff6e7d3b87f5e5e842aed788cd30aa402768e1a65e57ae6194

data/Gemfile.lock

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

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:,
@@ -86,8 +93,8 @@ class Renderer
         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,
@@ -101,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/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

@@ -96,13 +96,14 @@ class Renderer
       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.1"
+  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/reference.erb

@@ -1,6 +1,6 @@
 <% div("reference-base", id:) do %>
     <% if unresolved %>
-        <span class="broken"><%= 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.1
+  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