docrb-html 0.2.0

data/templates/markdown.erb

@@ -0,0 +1,3 @@
+<% div("markdown-base", id:) do %>
+<%= source %>
+<% end %>

data/templates/method_argument.erb

@@ -0,0 +1,29 @@
+<% div("method-argument-base", id:) do %>
+    <% if computed[:rest] %>
+        <span class="rest-arg <%= computed[:rest] %>"></span>
+    <% end %>
+
+    <%= computed[:name] %>
+
+    <% if computed[:continuation] %>
+        <span class="continuation <%= computed[:continuation] %>"></span>
+    <% end %>
+
+    <% if computed.dig(:value, :kind) == :method_call_argument %>
+    <% elsif computed.dig(:value, :kind) == :const
+        last = computed.dig(:value, :value).pop
+    %>
+        <% computed.dig(:value, :value).each do |val| %>
+            <% if val[:kind] == :continuation %>
+                <span class="continuation colon double"></span>
+            <% elsif val[:kind] == :class_or_module %>
+                <span class="class_or_module">
+                    <%= val[:value] %>
+                </span>
+            <% end %>
+        <% end %>
+        <span class="simple-argument plain"><%= last[:value] %></span>
+    <% elsif computed.dig(:value, :kind) %>
+        <span class="simple-argument <%= computed[:value][:kind] %>"><%= computed[:value][:value] %></span>
+    <% end %>
+<% end %>

data/templates/method_display.erb

@@ -0,0 +1,28 @@
+<% div("method-display-base", id:) do %>
+    <%= decoration && !decoration.empty? && svg(decoration, class_name: "decoration", title: decoration == "inherited" ? "Inherited" : "Override") || "" %>
+    <%= type && typedef(name: type) %>
+    <% base = capture do %>
+        <div class="container">
+            <div class="method-name"><%= name %></div>
+            <% if args %>
+                <div class="argument-container<%= args.empty? ? "" : " not-empty" %>">
+                    <% args.map do |i| %>
+                        <%= method_argument(**i) %>
+                    <% end %>
+                </div>
+            <% end %>
+        </div>
+    <% end %>
+    <% if href && !href.empty? %>
+        <a class="dashed" href="<%= href %>">
+            <%= base %>
+        </a>
+    <% else %>
+        <%= base %>
+    <% end %>
+    <% if visibility&.downcase != 'public' %>
+        <div class="label"><%= visibility %></div>
+    <% elsif ![nil, 'public'].include? doc&.dig(:doc_visibility_annotation) %>
+        <div class="label"><%= doc.dig(:doc_visibility_annotation) %></div>
+    <% end %>
+<% end %>

data/templates/method_list.erb

@@ -0,0 +1,25 @@
+<% div("method-list-base", id:) do %>
+    <% list && list.length > 0 && list.each do |i| %>
+        <div class="method-definition"
+             id="<%= i[:type] %>-<%= i[:name] %>"
+             data-visibility="<%= i.dig(:doc, :doc_visibility_annotation) || '' %>"
+             data-origin="<%= i.dig(:origin) %>">
+            <div class="method-block">
+                <%= method_display(**i.merge(type: nil).slice(*Renderer::Component::MethodDisplay.instance_variable_get(:@props))) %>
+            </div>
+            <div class="doc-block">
+                <%= documentation_block(doc: i[:doc]) %>
+            </div>
+            <details class="source-block">
+                <summary>
+                    <span class="expanded">Hide Source</span>
+                    <span class="collapsed">Show Source</span>
+                </summary>
+                <%= markdown(source: i[:defined_by][:markdown_source]) %>
+                <div class="from">
+                    Defined in <a href="<%= git_url(i[:defined_by]) %>" class="dotted"><%= clean_file_path(i[:defined_by]) %>, <%= line_range(i[:defined_by]) %></a>
+                </div>
+            </details>
+        </div>
+    <% end %>
+<% end %>

data/templates/project_header.erb

@@ -0,0 +1,38 @@
+<% div("project-header-base", id:) do %>
+    <div class="project">
+        <h1><%= name %></h1>
+        <h3><%= description %></h3>
+    </div>
+    <div class="right">
+        <div class="label">
+            <a href="https://github.com/heyvito/docrb" rel="noreferrer" target="_blank">
+                <%= svg('docrb-label') %>
+            </a>
+        </div>
+        <div class="link-panel">
+            <% if owner %>
+                <div class="link-row">
+                    <span><%= owner %></span>
+                    <%= svg('user') %>
+                </div>
+            <% end %>
+            <% if license %>
+            <div class="link-row">
+                <span><%= license %></span>
+                <%= svg('balance') %>
+            </div>
+            <% end %>
+            <% links.each do |link| %>
+                <div class="link-row">
+                    <span><a href="<%= link[:href] %>"
+                        class="dashed"
+                        rel="noreferrer"
+                        target="_blank">
+                        <%= link[:href].gsub(/^https?:\/\//, '') %>
+                    </a></span>
+                    <%= svg(link[:kind]) %>
+                </div>
+            <% end %>
+        </div>
+    </div>
+<% end %>

data/templates/reference.erb

@@ -0,0 +1,14 @@
+<% div("reference-base", id:) do %>
+    <% if unresolved %>
+        <span class="unresolved" title="Docrb could not resolve this reference. It may be from an external library or dynamically-generated method.">
+            <%= svg('questionmark') %>
+            <span><%= ref[:contents] %></span>
+        </span>
+    <% else %>
+    <a href="<%= path.join('/') %>">
+        <span class="resolved <%= ref[:ref_type] %>">
+            <span><%= ref[:contents] %></span>
+        </span>
+    </a>
+    <% end %>
+<% end %>

data/templates/symbol.erb

@@ -0,0 +1,3 @@
+<% div("symbol-base", id:) do %>
+    <%= name %>
+<% end %>

data/templates/tab_bar.erb

@@ -0,0 +1,7 @@
+<% div("tab-bar-base", id:) do %>
+    <% items.each.with_index do |i, idx| %>
+        <a href="<%= i[:href] %>" class="<%= idx == selected_index ? "selected" : "" %>">
+            <%= i[:name] %>
+        </a>
+    <% end %>
+<% end %>

data/templates/text_block.erb

@@ -0,0 +1,16 @@
+<% div("text-block-base", id:) do %>
+    <% list.each do |i| %>
+        <% if i[:type] == 'span' %>
+            <div class="html inline"><%= i[:contents] %></div>
+        <% elsif i[:type] == 'ref' %>
+            <%= reference(ref: i) %>
+        <% elsif i[:type] == 'html' %>
+            <div class="html"><%= i[:contents] %></div>
+        <% elsif i[:type] == 'sym_ref' %>
+            <%= symbol(name: i[:contents]) %>
+        <% else %>
+            Unknown textblock item <%= i[:kind] %><br/>
+            <%= i.to_json %>
+        <% end %>
+    <% end %>
+<% end %>

data/templates/type_definition.erb

@@ -0,0 +1,4 @@
+<% div("type-definition-base", id:) do %>
+    <%= typedef(name: type) %>
+    <%= class_mod_name(href: href, name: name) %>
+<% end %>

data/templates/typedef.erb

@@ -0,0 +1,3 @@
+<% div("typedef-base", id:) do %>
+    <%= name %>
+<% end %>

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: docrb-html
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Victor Gama
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Docrb's HTML Generator
+email:
+- hey@vito.io
+executables:
+- docrb-html
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- assets/breadcrumb.scss
+- assets/checkbox.scss
+- assets/class_header.scss
+- assets/class_mod_name.scss
+- assets/component_list.scss
+- assets/container.scss
+- assets/doc_box.scss
+- assets/documentation_block.scss
+- assets/favicon.ico
+- assets/fonts.scss
+- assets/footer.scss
+- assets/images/balance.svg
+- assets/images/breadcrumb_separator.svg
+- assets/images/checkbox-off.svg
+- assets/images/checkbox-on.svg
+- assets/images/chevron.svg
+- assets/images/docrb-label.svg
+- assets/images/github.svg
+- assets/images/home.svg
+- assets/images/inherited.svg
+- assets/images/override.svg
+- assets/images/questionmark.svg
+- assets/images/rubygems.svg
+- assets/images/user.svg
+- assets/js/filtering.js
+- assets/links.scss
+- assets/markdown.scss
+- assets/method_argument.scss
+- assets/method_display.scss
+- assets/method_list.scss
+- assets/project_header.scss
+- assets/reference.scss
+- assets/shared.scss
+- assets/style.scss
+- assets/symbol.scss
+- assets/tab_bar.scss
+- assets/text_block.scss
+- assets/type_definition.scss
+- assets/typedef.scss
+- bin/console
+- bin/setup
+- exe/docrb-html
+- lib/renderer.rb
+- lib/renderer/component.rb
+- lib/renderer/component/breadcrumb.rb
+- lib/renderer/component/checkbox.rb
+- lib/renderer/component/class_header.rb
+- lib/renderer/component/class_mod_name.rb
+- lib/renderer/component/component_list.rb
+- lib/renderer/component/doc_box.rb
+- lib/renderer/component/documentation_block.rb
+- lib/renderer/component/footer.rb
+- lib/renderer/component/markdown.rb
+- lib/renderer/component/method_argument.rb
+- lib/renderer/component/method_display.rb
+- lib/renderer/component/method_list.rb
+- lib/renderer/component/project_header.rb
+- lib/renderer/component/reference.rb
+- lib/renderer/component/symbol.rb
+- lib/renderer/component/tab_bar.rb
+- lib/renderer/component/text_block.rb
+- lib/renderer/component/type_definition.rb
+- lib/renderer/component/typedef.rb
+- lib/renderer/core_extensions.rb
+- lib/renderer/defs.rb
+- lib/renderer/defs/specialized_object.rb
+- lib/renderer/defs/specialized_projection.rb
+- lib/renderer/helpers.rb
+- lib/renderer/metadata.rb
+- lib/renderer/page.rb
+- lib/renderer/template.rb
+- lib/renderer/version.rb
+- renderer.gemspec
+- script/makecomponent
+- script/reload.js
+- script/serve
+- script/watch
+- templates/base.erb
+- templates/breadcrumb.erb
+- templates/checkbox.erb
+- templates/class_header.erb
+- templates/class_mod_name.erb
+- templates/component_list.erb
+- templates/doc_box.erb
+- templates/documentation_block.erb
+- templates/footer.erb
+- templates/markdown.erb
+- templates/method_argument.erb
+- templates/method_display.erb
+- templates/method_list.erb
+- templates/project_header.erb
+- templates/reference.erb
+- templates/symbol.erb
+- templates/tab_bar.erb
+- templates/text_block.erb
+- templates/type_definition.erb
+- templates/typedef.erb
+homepage: https://github.com/heyvito/docrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/heyvito/docrb
+  source_code_uri: https://github.com/heyvito/docrb/tree/trunk/lib/docrb-html
+  changelog_uri: https://github.com/heyvito/docrb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: Docrb's HTML Generator
+test_files: []