docrb-html 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ab65a6bab83355b8532920f7dfa26d9f9e05d99fbe6cdbe1677a9b75695861
-  data.tar.gz: e69e29e51b3e4bc491e058259be007910032607cce30e0e7223a4a1adad23c01
+  metadata.gz: 5e032e7d421f2811ed73880d0e9b224ebf11b9027446baee4fbf58f8fe28efb5
+  data.tar.gz: 9ea3088213e3e09e31c12a81041ad3cab9f48d16b859a36597603d159bc8423d
 SHA512:
-  metadata.gz: 935815ac11006ab359e5c489f57266d8de17691bc9035a45cd7564e8b3142e927313cef65e41401e1e713422ad77d3c3f7653c9cf0d9167eb8f3cb77c285ff05
-  data.tar.gz: 9e57cd852acb2f6bc459206e81088088bd85be92600a973e911c6cddb0e266c384e08b978cb53c7e0b364778358ec515cf21c7d86ede85b91a501c38b5e11103
+  metadata.gz: 6e4c417666d05eb251dfee6ffc8b1243f1db13e73d34b48e9c7a1645fedb6fbad9eec4679387d18e76f25e78fb0253ac9c44c6f3ff753ed78673884e7d26ab75
+  data.tar.gz: 6b4e542016f1c14f2f40a6adabddecc97afbde132021c1ac5f830a1b785255b79eb27078570296f287e39a9ef2f348e75612446b360c3a530b47f077748bfad2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docrb-html (0.3.0)
+    docrb-html (0.3.1)
       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

@@ -73,9 +73,14 @@ 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(

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/helpers.rb

@@ -90,7 +90,7 @@ 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

data/lib/renderer/version.rb

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

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.last %></span>
     <% elsif ref_type == :pure %>
         <a href="<%= link_for(object) %>">
         <span class="resolved <%= ref_type %>">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docrb-html
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Victor Gama
@@ -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