RBSによる型付け対応

.devcontainer/devcontainer.json

@@ -16,7 +16,7 @@
 
 	// The optional 'workspaceFolder' property is the path VS Code should open by default when
 	// connected. This is typically a file mount in .devcontainer/docker-compose.yml
-	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}"
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},
@@ -34,7 +34,14 @@
 	// "postCreateCommand": "cat /etc/os-release",
 
 	// Configure tool-specific properties.
-	// "customizations": {},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"soutaro.rbs-syntax",
+				"soutaro.steep-vscode"
+			]
+		}
+	}
 
 	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
 	// "remoteUser": "devcontainer"

.gitignore

@@ -1,3 +1,3 @@
-Gemfile.lock
 /pkg/
 /.bundle
+/.gem_rbs_collection/

Dockerfile

@@ -1,4 +1,5 @@
-FROM ruby:3.3.3-bookworm
+FROM ruby:3.3.5-bookworm
+RUN apt-get update -y && apt-get install -y less
 RUN useradd rurema --create-home --shell /bin/bash
 USER rurema:rurema
 ENV BUNDLE_AUTO_INSTALL true

Gemfile

@@ -1,6 +1,10 @@
 source "https://rubygems.org"
 
 gem "rake"
+gem "steep", "~> 1.9.0", require: false
+
+gem "uri"
+gem "pathname"
 
 # Specify your gem's dependencies in bitclust.gemspec
 gemspec :name => "bitclust-core"

Gemfile.lock

@@ -0,0 +1,199 @@
+PATH
+  remote: .
+  specs:
+    bitclust-core (1.4.0)
+      drb
+      json
+      nkf
+      progressbar (>= 1.9.0, < 2.0)
+      rack
+      webrick
+    bitclust-dev (1.4.0)
+      bitclust-core (= 1.4.0)
+    refe2 (1.4.0)
+      bitclust-core (= 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    csv (3.3.5)
+    drb (2.2.3)
+    ffi (1.17.3)
+    ffi (1.17.3-aarch64-linux-gnu)
+    ffi (1.17.3-aarch64-linux-musl)
+    ffi (1.17.3-arm-linux-gnu)
+    ffi (1.17.3-arm-linux-musl)
+    ffi (1.17.3-arm64-darwin)
+    ffi (1.17.3-x86-linux-gnu)
+    ffi (1.17.3-x86-linux-musl)
+    ffi (1.17.3-x86_64-darwin)
+    ffi (1.17.3-x86_64-linux-gnu)
+    ffi (1.17.3-x86_64-linux-musl)
+    fileutils (1.8.0)
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
+    json (2.19.1)
+    language_server-protocol (3.17.0.5)
+    listen (3.10.0)
+      logger
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.7.0)
+    minitest (6.0.2)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    nkf (0.2.0)
+    parser (3.3.10.2)
+      ast (~> 2.4.1)
+      racc
+    pathname (0.4.0)
+    power_assert (3.0.1)
+    prism (1.9.0)
+    progressbar (1.13.0)
+    racc (1.8.1)
+    rack (3.2.5)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.10.3)
+      logger
+      tsort
+    rr (3.1.2)
+    securerandom (0.4.1)
+    steep (1.9.4)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 3.8)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+      uri (>= 0.12.0)
+    strscan (3.1.7)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    test-unit (3.7.7)
+      power_assert
+    test-unit-notify (1.0.4)
+      test-unit (>= 2.4.9)
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+    uri (1.1.1)
+    webrick (1.9.2)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  bitclust-core!
+  bitclust-dev!
+  pathname
+  rake
+  refe2!
+  steep (~> 1.9.0)
+  test-unit (>= 2.3.0)
+  test-unit-notify
+  test-unit-rr
+  uri
+
+CHECKSUMS
+  activesupport (8.1.2) sha256=88842578ccd0d40f658289b0e8c842acfe9af751afee2e0744a7873f50b6fdae
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
+  bigdecimal (4.0.1) sha256=8b07d3d065a9f921c80ceaea7c9d4ae596697295b584c296fe599dd0ad01c4a7
+  bitclust-core (1.4.0)
+  bitclust-dev (1.4.0)
+  concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
+  connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
+  csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f
+  drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
+  ffi (1.17.3) sha256=0e9f39f7bb3934f77ad6feab49662be77e87eedcdeb2a3f5c0234c2938563d4c
+  ffi (1.17.3-aarch64-linux-gnu) sha256=28ad573df26560f0aedd8a90c3371279a0b2bd0b4e834b16a2baa10bd7a97068
+  ffi (1.17.3-aarch64-linux-musl) sha256=020b33b76775b1abacc3b7d86b287cef3251f66d747092deec592c7f5df764b2
+  ffi (1.17.3-arm-linux-gnu) sha256=5bd4cea83b68b5ec0037f99c57d5ce2dd5aa438f35decc5ef68a7d085c785668
+  ffi (1.17.3-arm-linux-musl) sha256=0d7626bb96265f9af78afa33e267d71cfef9d9a8eb8f5525344f8da6c7d76053
+  ffi (1.17.3-arm64-darwin) sha256=0c690555d4cee17a7f07c04d59df39b2fba74ec440b19da1f685c6579bb0717f
+  ffi (1.17.3-x86-linux-gnu) sha256=868a88fcaf5186c3a46b7c7c2b2c34550e1e61a405670ab23f5b6c9971529089
+  ffi (1.17.3-x86-linux-musl) sha256=f0286aa6ef40605cf586e61406c446de34397b85dbb08cc99fdaddaef8343945
+  ffi (1.17.3-x86_64-darwin) sha256=1f211811eb5cfaa25998322cdd92ab104bfbd26d1c4c08471599c511f2c00bb5
+  ffi (1.17.3-x86_64-linux-gnu) sha256=3746b01f677aae7b16dc1acb7cb3cc17b3e35bdae7676a3f568153fb0e2c887f
+  ffi (1.17.3-x86_64-linux-musl) sha256=086b221c3a68320b7564066f46fed23449a44f7a1935f1fe5a245bd89d9aea56
+  fileutils (1.8.0) sha256=8c6b1df54e2540bdb2f39258f08af78853aa70bad52b4d394bbc6424593c6e02
+  i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
+  json (2.19.1) sha256=dd94fdc59e48bff85913829a32350b3148156bc4fd2a95a2568a78b11344082d
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  listen (3.10.0) sha256=c6e182db62143aeccc2e1960033bebe7445309c7272061979bb098d03760c9d2
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  minitest (6.0.2) sha256=db6e57956f6ecc6134683b4c87467d6dd792323c7f0eea7b93f66bd284adbc3d
+  nkf (0.2.0) sha256=fbc151bda025451f627fafdfcb3f4f13d0b22ae11f58c6d3a2939c76c5f5f126
+  parser (3.3.10.2) sha256=6f60c84aa4bdcedb6d1a2434b738fe8a8136807b6adc8f7f53b97da9bc4e9357
+  pathname (0.4.0) sha256=d8bef9d54dd35667f057708ee4f8ed91818e493091f86788fd5ef21a7cbeee89
+  power_assert (3.0.1) sha256=8ce9876716cc74e863fcd4cdcdc52d792bd983598d1af3447083a3a9a4d34103
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  progressbar (1.13.0) sha256=18c921d1c527dbe7eba3c5a07a1e3bcdd5e42fc18276f5711187a7489448be78
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rack (3.2.5) sha256=4cbd0974c0b79f7a139b4812004a62e4c60b145cba76422e288ee670601ed6d3
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  rb-fsevent (0.11.2) sha256=43900b972e7301d6570f64b850a5aa67833ee7d87b458ee92805d56b7318aefe
+  rb-inotify (0.11.1) sha256=a0a700441239b0ff18eb65e3866236cd78613d6b9f78fea1f9ac47a85e47be6e
+  rbs (3.10.3) sha256=70627f3919016134d554e6c99195552ae3ef6020fe034c8e983facc9c192daa6
+  refe2 (1.4.0)
+  rr (3.1.2) sha256=cc4a5cc91f012327d317dc661154419f9d36d8f9c05031ac46accd89ceb0ff1b
+  securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
+  steep (1.9.4) sha256=09a941469b55d31cdc70a3812b5c1d4102d361f628f5fe5497b6a9aabc3cee05
+  strscan (3.1.7) sha256=5f76462b94a3ea50b44973225b7d75b2cb96d4e1bee9ef1319b99ca117b72c8c
+  terminal-table (3.0.2) sha256=f951b6af5f3e00203fb290a669e0a85c5dd5b051b3b023392ccfd67ba5abae91
+  test-unit (3.7.7) sha256=3c89d5ff0690a16bef9946156c4624390402b9d54dfcf4ce9cbd5b06bead1e45
+  test-unit-notify (1.0.4) sha256=db33d37c32c40f209b8c379b1fee2fb0696a1179ef2b7ce80e358f2f5013fbb7
+  test-unit-rr (1.0.5) sha256=346af09fe4c4d793a9107b978d9a62e3274972e5c17b8d4c0a8f348c77e78250
+  tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
+  tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
+  unicode-display_width (2.6.0) sha256=12279874bba6d5e4d2728cef814b19197dbb10d7a7837a869bab65da943b7f5a
+  uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
+  webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131
+
+BUNDLED WITH
+  4.0.7

Rakefile

@@ -15,6 +15,29 @@ task :test do
   sh 'ruby test/run_test.rb'
 end
 
+desc "Re-generate sig/prototype"
+task :sig do
+  out_dir = 'sig-prototype'
+  FileUtils.rm_rf out_dir
+  sh "rbs prototype rb --out-dir=#{out_dir} lib"
+  FileUtils.rm "#{out_dir}/bitclust/compat.rbs"
+  sh "rbs subtract --write #{out_dir} sig"
+  FileUtils.rmdir ["#{out_dir}/bitclust/generators", "#{out_dir}/bitclust/subcommands", "#{out_dir}/bitclust", "#{out_dir}"]
+  sh 'rbs validate'
+end
+
+namespace :rbs do
+  desc 'rbs collection install'
+  task :install do
+    sh 'rbs collection install'
+  end
+
+  desc 'rbs collection update'
+  task :update do
+    sh 'rbs collection update'
+  end
+end
+
 Bundler::GemHelper.install_tasks(:name => "bitclust-core")
 Bundler::GemHelper.install_tasks(:name => "bitclust-dev")
 Bundler::GemHelper.install_tasks(:name => "refe2")

Steepfile

@@ -0,0 +1,5 @@
+target :lib do
+  signature "sig"
+
+  check "lib"
+end

bitclust-core.gemspec

@@ -36,4 +36,5 @@ EOD
   s.add_runtime_dependency "webrick"
   s.add_runtime_dependency "drb"
   s.add_runtime_dependency "nkf"
+  s.add_runtime_dependency "json"
 end

lib/bitclust/app.rb

@@ -5,7 +5,7 @@
 module BitClust
 
   # Main class of BitClust server application.
-  # Actual actions are implemneted by RequestHandler.
+  # Actual actions are implemented by RequestHandler.
   #
   # Supports Rack and WEBrick.
   class App
@@ -26,10 +26,11 @@ def initialize(options)
       @interfaces = {}
       case dbpath
       when String
+        # @type var viewpath: String
         dbpath = File.expand_path(dbpath)
         db = BitClust::MethodDatabase.new(dbpath)
         if capi
-          db = [db, BitClust::FunctionDatabase.new(dbpath)]
+          db = [db, BitClust::FunctionDatabase.new(dbpath)] #: [MethodDatabase, FunctionDatabase]
         end
         manager = BitClust::ScreenManager.new(
           :base_url => baseurl,
@@ -42,12 +43,13 @@ def initialize(options)
         handler = request_handler_class.new(db, manager)
         @interfaces[viewpath] = BitClust::Interface.new { handler }
       when Array
+        # @type var viewpath: String?
         dbpaths = dbpath
         @versions = []
         dbpaths.each do |dbpath|
           next unless /db-([\d_\.]+)/ =~ dbpath
           dbpath = File.expand_path(dbpath)
-          version = $1.tr("_", ".")
+          version = ($1 || raise).tr("_", ".")
           @versions << version
           if viewpath
             version_viewpath = File.join(version, viewpath)
@@ -56,7 +58,7 @@ def initialize(options)
           end
           db = BitClust::MethodDatabase.new(dbpath)
           if capi
-            db = [db, BitClust::FunctionDatabase.new(dbpath)]
+            db = [db, BitClust::FunctionDatabase.new(dbpath)] #: [MethodDatabase, FunctionDatabase]
           end
           manager = BitClust::ScreenManager.new(
             :base_url => baseurl,
@@ -88,13 +90,15 @@ def index(req)
                          req.path_info
                        end
         if @versions.any?{|version| %r|\A/?#{version}/?\z| =~ request_path }
-          viewpath = File.join(request_path, @options[:viewpath])
+          viewpath = @options[:viewpath]
+          raise unless viewpath.is_a?(String)
+          viewpath = File.join(request_path || raise, viewpath)
           @index = "<html><head><meta http-equiv='Refresh' content='0;URL=#{viewpath}'></head></html>"
         else
           links = "<ul>"
           @interfaces.keys.sort.each do |v|
-            if @options[:viewpath]
-              version = v.sub(@options[:viewpath], '')
+            if (viewpath = @options[:viewpath]).is_a?(String)
+              version = v.sub(viewpath, '')
             else
               version = v
             end
@@ -108,15 +112,17 @@ def index(req)
             @index = "<html><head><title>bitclust</title></head><body>#{links}</body></html>"
           end
         end
+      else
+        raise '[BUG]'
       end
     end
 
-    def get_instance(server)
+    def get_instance(_server, *_)
       self
     end
 
     def service(req, res)
-      unless  %r|/#{File.basename(@options[:baseurl])}/?\z| =~ req.path
+      unless  %r|/#{File.basename(@options[:baseurl] || raise)}/?\z| =~ req.path
         raise WEBrick::HTTPStatus::NotFound
       end
       res.body = index(req)