refactor: move code under tools/, data under spec/ (#797)

This also:

- Creates proper Ruby Gems for
    - The IDL Compiler (idlc)
    - The Ruby UDB interface (udb)
- Backend helpers (udb_helpers) and an idl highlighter (idl_highlighter)
- Adds a `./bin/udb` command line interface to query the data
- Adds a `./bin/idlc` command line interface to engage the IDL compiler
- A lot more type checking in Ruby code

BREAKING CHANGE: major file refactoring

---------

Signed-off-by: Derek Hower <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Author: dhower-qc

.github/workflows/pages.yml

@@ -25,7 +25,7 @@ jobs:
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
       - name: Create many artifacts in the _site directory
-        run: /bin/bash lib/deploy.sh
+        run: /bin/bash tools/scripts/deploy.sh
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Upload artifact

.gitignore

@@ -10,6 +10,7 @@
 .vscode/*
 !.vscode/launch.json
 !.vscode/extensions.json
+!.vscode/settings.json
 .container-type
 diag-ditaa-*
 arch/manual/isa/**/riscv-isa-manual
@@ -23,4 +24,6 @@ __pycache__/
 *.bak
 *.log
 sorbet
+!tools/ruby-gems/idlc/sorbet
+!tools/ruby-gems/udb/sorbet
 coverage

.rubocop.yml

@@ -1,4 +1,11 @@
-require: rubocop-minitest
+plugins:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-sorbet
+
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
 
 AllCops:
   TargetRubyVersion: 3.2.3

.sorbet-config

@@ -0,0 +1,70 @@
+{
+  "solargraph.bundlerPath": "bin/bundle",
+  "solargraph.useBundler": true,
+  "sorbet.lspConfigs": [
+
+    {
+      "id": "container",
+      "name": "Sorbet (UDB)",
+      "description": "Sorbet in the UDB container",
+      "command": [
+        "/local/mnt/workspace/dhower/riscv-unified-db/worktrees/udbgem/bin/bundle",
+        "exec",
+        "srb",
+        "tc",
+        "--lsp",
+        "--dir",
+        "tools/gems",
+        "--ignore",
+        "api_doc",
+        "--ignore",
+        "doc",
+        "--ignore",
+        "ext",
+        "--ignore",
+        "python",
+        "-v",
+        "3",
+        "--debug-log-file=srb-lsp.out",
+        "--disable-watchman"
+      ]
+    },
+    {
+      "id": "host",
+      "name": "Sorbet (Host)",
+      "description": "Sorbet on the host",
+      "command": [
+        "/usr2/dhower/.rbenv/shims/bundle",
+        "exec",
+        "srb",
+        "typecheck",
+        "--lsp",
+        "--dir",
+        "tools/gems",
+        "--ignore",
+        "api_doc",
+        "--ignore",
+        "doc",
+        "--ignore",
+        "ext",
+        "--ignore",
+        "python",
+        "--disable-watchman"
+      ]
+    },
+    {
+      "id": "experimental",
+      "name": "Sorbet (Experimental)",
+      "description": "Experimental Sorbet Ruby IDE features (warning: crashy, for developers only)",
+      "command": [
+        "bundle",
+        "exec",
+        "srb",
+        "typecheck",
+        "--lsp",
+        "--enable-all-experimental-lsp-features"
+      ]
+    }
+  ],
+  "sorbet.selectedLspConfigId": "host"
+}

.tapioca-config.yml

@@ -1,23 +1,29 @@
 # frozen_string_literal: true
 
-ruby "3.2.3"
+ruby "~> 3.2"
+
+# local gems in UDB
+gem "idlc", path: "tools/ruby-gems/idlc"
+gem "idl_highlighter", path: "tools/ruby-gems/idl_highlighter"
+gem "udb_helpers", path: "tools/ruby-gems/udb_helpers"
+gem "udb", path: "tools/ruby-gems/udb"
 
 source "https://rubygems.org"
 
-gem "activesupport"
+# gem "activesupport"
 gem "asciidoctor-diagram", "~> 2.2"
 gem "asciidoctor-pdf"
 gem "base64"
 gem "bigdecimal"
 gem "concurrent-ruby", require: "concurrent"
 gem "concurrent-ruby-ext"
 gem "json_schemer", "~> 1.0"
-gem "pygments.rb"
+# gem "pygments.rb"
 gem "rake", "~> 13.0"
-gem "rouge"
+#gem "rouge"
 gem "ruby-progressbar", "~> 1.13"
 gem "sorbet-runtime"
-gem "treetop", "1.6.12"
+#gem "treetop", "1.6.12"
 gem "ttfunk", "1.7" # needed to avoid having asciidoctor-pdf dependencies pulling in a buggy version of ttunk (1.8)
 gem "webrick"
 gem "write_xlsx"
@@ -26,11 +32,12 @@ gem "yard"
 group :development do
   gem "awesome_print"
   gem "debug"
-  gem "minitest"
   gem "rdbg"
+  gem "rubocop-github"
   gem "rubocop-minitest"
+  gem "rubocop-performance"
+  gem "rubocop-sorbet"
   gem "ruby-prof"
-  gem "ruby-prof-flamegraph", git: "https://github.com/oozou/ruby-prof-flamegraph.git", ref: "fc3c437", require: false
   gem "solargraph"
   gem "sorbet"
   gem "spoom"