docrb-html 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bd7bd1e1ff89ebc50fb101145f1f36d51802c8c2c958e300b19964371218338
-  data.tar.gz: e6d10631f1f07e47cb21d0a4910a197c68f618195946d88e22e22e91187dbfcb
+  metadata.gz: 46ab65a6bab83355b8532920f7dfa26d9f9e05d99fbe6cdbe1677a9b75695861
+  data.tar.gz: e69e29e51b3e4bc491e058259be007910032607cce30e0e7223a4a1adad23c01
 SHA512:
-  metadata.gz: 8e59abc7fa98961e6afc70c56566b4ec0386f8f1ebd1dd9120bbcc3ea0592021fca8a230801d560d588111621d9d9549143b4f6e53b5d877e7da61f726abb14e
-  data.tar.gz: 2a1756a7e031b484c8cfe09af1fbf6897c3211cf8fedd35983f22df2e111796c3135a111c6d944f2a0aa049ea2155cbbdd144adb0b2ef0af7a00f4181cea08dc
+  metadata.gz: 935815ac11006ab359e5c489f57266d8de17691bc9035a45cd7564e8b3142e927313cef65e41401e1e713422ad77d3c3f7653c9cf0d9167eb8f3cb77c285ff05
+  data.tar.gz: 9e57cd852acb2f6bc459206e81088088bd85be92600a973e911c6cddb0e266c384e08b978cb53c7e0b364778358ec515cf21c7d86ede85b91a501c38b5e11103

data/.editorconfig

@@ -17,5 +17,5 @@ indent_size = 2
 [*.yml]
 indent_size = 2
 
-[./bin/*]
+[bin/*]
 indent_size = 2

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 3.2
+  SuggestExtensions: false
   NewCops: enable
 
 Style/StringLiterals:
@@ -13,40 +14,56 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
-Metrics/ClassLength:
-  Enabled: false
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 
-Metrics/MethodLength:
-  Enabled: false
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
 
-Metrics/BlockLength:
-  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
 
-Metrics/PerceivedComplexity:
+Style/Documentation:
   Enabled: false
 
-Metrics/CyclomaticComplexity:
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent_relative_to_receiver
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Style/EmptyCaseCondition:
   Enabled: false
 
-Lint/ShadowingOuterLocalVariable:
-  Exclude:
-    - bin/*
+Metrics/BlockLength:
+  Enabled: false
 
-Metrics/AbcSize:
+Metrics/ClassLength:
   Enabled: false
 
 Metrics/ModuleLength:
   Enabled: false
 
-Lint/BooleanSymbol:
+Metrics/MethodLength:
   Enabled: false
 
-Style/Documentation:
+Metrics/AbcSize:
   Enabled: false
 
-Naming/MethodParameterName:
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
   Exclude:
     - lib/renderer/helpers.rb
+    - lib/renderer/template.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/docrb-html.rb

data/Gemfile

@@ -4,4 +4,14 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "byebug", "~> 11.1"
+group :development do
+  gem "rake", "~> 13.0"
+
+  gem "rspec", "~> 3.0"
+
+  gem "rubocop", "~> 1.21"
+
+  gem "byebug"
+
+  gem "awesome_print"
+end

data/Gemfile.lock

@@ -1,33 +1,83 @@
 PATH
   remote: .
   specs:
-    docrb-html (0.2.5)
+    docrb-html (0.3.0)
       nokogiri (~> 1.14)
+      redcarpet (~> 3.6)
+      rouge (~> 4.1)
       sassc (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
+    awesome_print (1.9.2)
     byebug (11.1.3)
+    diff-lcs (1.5.0)
     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)
       racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
     racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redcarpet (3.6.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rouge (4.2.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     sassc (2.4.0)
       ffi (~> 1.9)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
-  byebug (~> 11.1)
+  awesome_print
+  byebug
   docrb-html!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
 
 BUNDLED WITH
    2.4.2

data/assets/breadcrumb.scss

@@ -4,7 +4,6 @@ div.breadcrumb-base {
     background-color: #161617;
     height: 57px;
     display: flex;
-    align-items: center;
     overflow-x: scroll;
     overflow-y: hidden;
 

data/assets/class_header.scss

@@ -19,6 +19,7 @@ div.class-header-base {
     .class-name {
         @include body($weight: 300, $size: 64);
         color: white;
+        margin-bottom: 8px;
     }
 
     .def-link {

data/assets/constant_display.scss

@@ -0,0 +1,16 @@
+div.constant-display-base {
+    @include container;
+    margin-top: 8px;
+    .container {
+        @include container;
+    }
+
+    .constant-name {
+        @include mono;
+        color: #FFAB42;
+    }
+
+    .label {
+        @include label;
+    }
+}

data/assets/doc_box.scss

@@ -13,7 +13,6 @@ div.doc-box-base {
 
     .left {
         flex: 1;
-        max-width: 100%;
         flex-wrap: wrap;
 
         .section-container {
@@ -53,6 +52,37 @@ div.doc-box-base {
             .faded {
                 @include faded;
             }
+
+            .doc-block {
+                margin-top: 8px;
+            }
+        }
+
+        .constant-container {
+            margin-bottom: 12px;
+
+            .decoration {
+                display: inline-block;
+                margin-right: 8px;
+                margin-left: -18px;
+            }
+
+            .name {
+                @include mono;
+                color: #FFAB42;
+            }
+
+            .label {
+                @include label;
+            }
+
+            .faded {
+                @include faded;
+            }
+
+            .doc-block {
+                margin-top: 8px;
+            }
         }
     }
 
@@ -71,9 +101,9 @@ div.doc-box-base {
         }
 
         a {
-          color: #FFF;
-          @include body;
-          text-decoration: none;
+            color: #FFF;
+            @include body;
+            text-decoration: none;
         }
     }
 }

data/assets/documentation_block.scss

@@ -1,5 +1,33 @@
-div.documentation-block-base {
+
+.documentation-comment-base, div.documentation-block-base {
+    line-height: 1.5;
     .faded {
         @include faded;
     }
+
+    .inline { display: inline-block }
+
+    .method-ref {
+        @include mono;
+    }
+
+    code {
+        @include mono;
+        font-size: 95%;
+        padding: 3px 4px;
+        background-color: #29292B;
+        border-radius: 3px;
+    }
+}
+
+.unknown-object {
+    @include body;
+    display: inline-block;
+    padding: 0.2em 0.4em;
+    margin: 0;
+    font-size: 85%;
+    background: #ffd842;
+    border-radius: 6px;
+    text-shadow: 0 0 1px #988128;
+    color: black;
 }

data/assets/field_block.scss

@@ -0,0 +1,46 @@
+.field-block-base {
+    margin-left: 8px;
+
+    .documentation-comment-base {
+        display: inline-block;
+    }
+
+    h3 {
+        @include faded;
+        text-transform: uppercase;
+        margin: 15px 0 0;
+        font-size: 0.8em;
+        font-weight: 500;
+        letter-spacing: 2px;
+        line-height: 1;
+    }
+
+    table {
+        margin-bottom: 5px;
+        border-spacing: 10px 5px;
+
+        .name {
+            @include mono;
+            color: white;
+            vertical-align: top;
+        }
+
+        .value {
+            vertical-align: center;
+            .inline > .html {
+                margin: 0;
+            }
+        }
+    }
+
+    code {
+        padding: 0.2em 0.4em;
+        margin: 0;
+        font-size: 85%;
+        white-space: break-spaces;
+        background: #48484d;
+        border-radius: 6px;
+        text-shadow: 0 0 3px black;
+        color: white;
+    }
+}

data/assets/js/filtering.js

@@ -20,9 +20,9 @@
       '[data-visibility="internal"]': !hideInternalCheck.checked,
       '[data-visibility="private"]': !hidePrivateCheck.checked,
       '[data-type="attribute"]': !hideAttrsCheck.checked,
-      '[data-origin="inheritance"]': !hideInheritedCheck.checked,
-      '[data-origin="inclusion"]': showIncludedCheck.checked,
-      '[data-origin="extension"]': showExtendedCheck.checked,
+      '[data-origin="inherited"]': !hideInheritedCheck.checked,
+      '[data-origin="included"]': showIncludedCheck.checked,
+      '[data-origin="extended"]': showExtendedCheck.checked,
     });
     const attrs = ["data-visibility", "data-type", "data-origin"];
     const filters = Object.keys(determineVisibility());

data/assets/links.scss

@@ -6,11 +6,9 @@ a {
 
     &.dotted {
         border-bottom: white 1px dotted;
-        padding-bottom: 3px;
     }
 
     &.dashed {
         border-bottom: white 1px dashed;
-        padding-bottom: 3px;
     }
 }

data/assets/method_argument.scss

@@ -1,6 +1,5 @@
 div.method-argument-base {
     color: #FFAB42;
-    display: inline;
     display: flex;
 
     span { display: inline-block; }
@@ -63,13 +62,8 @@ div.method-argument-base {
     .simple-argument {
         &.symbol { color: #CF91C9; }
         &.number { color: #FF724C; }
-        &.string {
-            color: #8CC98F;
-            :before, :after {
-                content: '"';
-                color: #39B6B5;
-            }
-        }
+        &.string { color: #8CC98F; }
         &.plain  { color: white; }
+        &.call   { color: white; }
     }
 }

data/assets/method_display.scss

@@ -5,6 +5,10 @@ div.method-display-base {
         @include container;
     }
 
+    a.dashed {
+        padding-bottom: 3px;
+    }
+
     .method-name {
         @include mono;
         color: #39B6B5;

data/assets/method_list.scss

@@ -3,6 +3,46 @@ div.method-list-base {
         margin-bottom: 23px;
     }
 
+    .override-info-box {
+        @include faded;
+        padding-top: 8px;
+        font-size: 85%;
+        a {
+            @include mono;
+            font-size: inherit;
+            opacity: 80%;
+        }
+    }
+
+    .overridden-by-block {
+        @include faded;
+        font-size: 85%;
+        padding-top: 8px;
+
+        span {
+            @include mono;
+            font-size: inherit;
+        }
+
+        summary {
+            cursor: pointer;
+        }
+
+        a {
+            font-size: inherit;
+            opacity: 85%;
+        }
+
+        ul {
+            padding-top: 5px;
+            padding-left: 25px;
+
+            li {
+                padding-bottom: 8px;
+            }
+        }
+    }
+
     .doc-block {
         margin-top: 8px;
     }

data/assets/reference.scss

@@ -1,5 +1,5 @@
 div.reference-base {
-    display: inline-flex;
+    display: inline-block;
     cursor: pointer;
     color: white;
 

data/assets/style.scss

@@ -41,3 +41,6 @@ body {
 @import './reference';
 @import './symbol';
 @import './method_list';
+@import './constant_display';
+@import './field_block';
+@import './svg';

data/assets/svg.scss

@@ -0,0 +1,37 @@
+.svg-container {
+    cursor: help;
+    position: relative;
+
+    .svg-title {
+        @include body;
+        cursor: default;
+        padding: 0.4em 0.8em;
+        white-space: break-spaces;
+        background: #48484d;
+        border-radius: 6px;
+        text-shadow: 0 0 3px black;
+
+        display: none;
+        position: absolute;
+        font-size: 14px;
+        color: white;
+        left: 22px;
+        top: -5px;
+
+        &::before {
+            content: '';
+            display: block;
+            background-color: #48484d;
+            height: 10px;
+            width: 10px;
+            position: absolute;
+            top: calc(50% - 5px);
+            left: -5px;
+            transform: rotate(45deg);
+        }
+    }
+
+    &:hover {
+        .svg-title { display: block; }
+    }
+}

data/assets/symbol.scss

@@ -1,5 +1,5 @@
 div.symbol-base {
-    display: inline;
+    display: inline-block;
     @include mono;
     color: #CF91C9;
 }

data/assets/text_block.scss

@@ -1,23 +1,23 @@
 div.text-block-base {
     .html {
-        display: block;
+        display: flex;
+        flex-wrap: wrap;
+
         &.inline {
-            display: inline;
+            display: inline-block;
         }
 
-        margin-bottom: 12px;
         &.no-margin {
             margin-bottom: 0;
         }
 
         @include body;
         color: #FFFFFF;
-        p code {
-            @include mono;
-            font-size: 95%;
-            padding: 3px 4px;
-            background-color: #29292B;
-            border-radius: 3px;
+
+        .documentation-comment-base { display: inline-block; }
+
+        span {
+            white-space: pre-wrap;
         }
     }
 }

data/bin/smoke

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "renderer"

data/{renderer.gemspec → docrb-html.gemspec}

@@ -27,5 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "nokogiri", "~> 1.14"
+  spec.add_dependency "redcarpet", "~> 3.6"
+  spec.add_dependency "rouge", "~> 4.1"
   spec.add_dependency "sassc", "~> 2.4"
 end

data/exe/docrb-html

@@ -9,4 +9,4 @@ if ARGV.length != 2
   exit 1
 end
 
-Renderer.new(ARGV.shift, ARGV.shift).render
+Renderer.configure(ARGV.shift, ARGV.shift).render