docrb-html 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e032e7d421f2811ed73880d0e9b224ebf11b9027446baee4fbf58f8fe28efb5
-  data.tar.gz: 9ea3088213e3e09e31c12a81041ad3cab9f48d16b859a36597603d159bc8423d
+  metadata.gz: 4e8f34e78e39808248f3d91c29b2e751f27ef38d79c81ca48f5c8639accb9195
+  data.tar.gz: 17339acf6ab7f1c867872ac676a6fcb7ae5ce73fd059f9665fde66a3c070ca07
 SHA512:
-  metadata.gz: 6e4c417666d05eb251dfee6ffc8b1243f1db13e73d34b48e9c7a1645fedb6fbad9eec4679387d18e76f25e78fb0253ac9c44c6f3ff753ed78673884e7d26ab75
-  data.tar.gz: 6b4e542016f1c14f2f40a6adabddecc97afbde132021c1ac5f830a1b785255b79eb27078570296f287e39a9ef2f348e75612446b360c3a530b47f077748bfad2
+  metadata.gz: 82f1fb93629cc7e64c8972e34ca61b5d60006b3301b6c0b400bf38cb612ec729709d680d843c1efeaf19a9d85a8bf1b9739fd23f7a3457afff025df2530643ff
+  data.tar.gz: ab4c3e0001fec898dcf3955b5443bac4b8eb3142ec5d5f7712eaf5cd887abd6d6a2c722af786672d67f507c26ffde9e439b5e766f93deee1b9b906821ae67443

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docrb-html (0.3.1)
+    docrb-html (0.3.3)
       nokogiri (~> 1.14)
       redcarpet (~> 3.6)
       rouge (~> 4.1)
@@ -17,11 +17,9 @@ GEM
     ffi (1.15.5)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
-    nokogiri (1.14.2-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.14.2-x86_64-linux)
+    mini_portile2 (2.8.7)
+    nokogiri (1.14.2)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.4)
@@ -66,6 +64,7 @@ GEM
     unicode-display_width (2.5.0)
 
 PLATFORMS
+  aarch64-linux
   arm64-darwin-22
   arm64-darwin-23
   x86_64-darwin-22

data/docrb-html.gemspec

@@ -5,7 +5,7 @@ require_relative "lib/renderer/version"
 Gem::Specification.new do |spec|
   spec.name          = "docrb-html"
   spec.version       = Renderer::VERSION
-  spec.authors       = ["Victor Gama"]
+  spec.authors       = ["Vito Sartori"]
   spec.email         = ["hey@vito.io"]
 
   spec.summary       = "Docrb's HTML Generator"
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.2"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/trunk/lib/docrb-html"
+  spec.metadata["source_code_uri"] = "#{spec.homepage}/tree/master/lib/docrb-html"
   spec.metadata["changelog_uri"] = spec.homepage
   spec.metadata["rubygems_mfa_required"] = "true"
 

data/exe/docrb-html

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
+require "bundler"
+Bundler.setup
+
 require "renderer"
 
 if ARGV.length != 2

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,16 @@ 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.3"
 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.3
 platform: ruby
 authors:
-- Victor Gama
+- Vito Sartori
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-28 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -208,7 +208,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/heyvito/docrb
-  source_code_uri: https://github.com/heyvito/docrb/tree/trunk/lib/docrb-html
+  source_code_uri: https://github.com/heyvito/docrb/tree/master/lib/docrb-html
   changelog_uri: https://github.com/heyvito/docrb
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Docrb's HTML Generator