Merge branch 'feat/improve-renderer-structure' into trunk

.github/workflows/main.yml

@@ -3,11 +3,17 @@ name: Ruby
 on: [push, pull_request]
 
 jobs:
-  rubocop:
+  test:
+    strategy:
+      matrix:
+        lib:
+          - docrb
+          - docrb-html
+          - docrb-parser
     runs-on: ubuntu-latest
     defaults:
       run:
-        working-directory: ./lib/docrb
+        working-directory: ./lib/${{ matrix.lib }}
     steps:
     - uses: actions/checkout@v2
 
@@ -23,22 +29,5 @@ jobs:
     - name: Run Rubocop
       run: bundle exec rubocop
 
-  rspec:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./lib/docrb
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.2
-        bundler-cache: true
-
-    - name: Install dependencies
-      run: bundle install
-
-    - name: Run Rspec
+    - name: Run rspec
       run: bundle exec rspec

.gitignore

@@ -1,31 +1,13 @@
-lib/docrb/.bundle/
-lib/docrb/.yardoc
-lib/docrb/_yardoc/
-lib/docrb/coverage/
-lib/docrb/doc/
-lib/docrb/pkg/
-lib/docrb/spec/reports/
-lib/docrb/tmp/
-lib/docrb/.rspec_status
-lib/docrb/.byebug_history
-
-lib/docrb-react/node_modules
-lib/docrb-react/.pnp
-lib/docrb-react/.pnp.js
-lib/docrb-react/coverage
-lib/docrb-react/.next/
-lib/docrb-react/out/
-lib/docrb-react/build
-lib/docrb-react/npm-debug.log*
-lib/docrb-react/yarn-debug.log*
-lib/docrb-react/yarn-error.log*
-lib/docrb-react/.env.local
-lib/docrb-react/.env.development.local
-lib/docrb-react/.env.test.local
-lib/docrb-react/.env.production.local
-lib/docrb-react/.vercel
-lib/docrb-react/.docrb
-lib/docrb-react/.idea
+.bundle/
+.yardoc
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+.rspec_status
+.byebug_history
 
 .DS_Store
 *.pem

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Victor Gama de Oliveira
+Copyright (c) 2021-2023 Vito Sartori
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -143,7 +143,7 @@ chat rooms, and mailing lists is expected to follow it. Rule of thumb: be nice.
 ```
 The MIT License (MIT)
 
-Copyright (c) Victor Gama de Oliveira
+Copyright (c) 2021-2023 Vito Sartori
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

lib/docrb-html/.editorconfig

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

lib/docrb-html/.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

lib/docrb-html/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

lib/docrb-html/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

lib/docrb-html/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;
 

lib/docrb-html/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 {

lib/docrb-html/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;
+    }
+}