typeprof 0.15.3 → 0.20.0

data/vscode/package.json

@@ -0,0 +1,71 @@
+{
+    "name": "ruby-typeprof",
+    "displayName": "Ruby TypeProf",
+    "version": "0.20.0",
+    "publisher": "mame",
+    "author": {
+        "name": "Yusuke Endoh"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/mame/vscode-typeprof"
+    },
+    "license": "MIT",
+    "categories": [
+        "Programming Languages"
+    ],
+    "keywords": [
+        "Ruby",
+        "language server"
+    ],
+    "engines": {
+        "vscode": "^1.54.0"
+    },
+    "extensionKind": [
+        "workspace"
+    ],
+    "activationEvents": [
+        "onLanguage:ruby"
+    ],
+    "contributes": {
+        "commands": [
+            {
+                "command": "typeprof.restart",
+                "title": "Restart",
+                "category": "TypeProf"
+            }
+        ],
+        "configuration": [
+            {
+                "title": "Ruby TypeProf",
+                "properties": {
+                    "typeprof.server.path": {
+                        "type": [
+                            "null",
+                            "string"
+                        ],
+                        "default": null,
+                        "description": "Path to typeprof executable. (e.g. /usr/local/bin/bundle)"
+                    }
+                }
+            }
+        ]
+    },
+    "main": "./out/src/extension",
+    "scripts": {
+        "vscode:prepublish": "tsc -p ./",
+        "compile": "tsc -watch -p ./",
+        "postinstall": "node ./node_modules/vscode/bin/install",
+        "test": "node ./node_modules/vscode/bin/test",
+        "package": "vsce package"
+    },
+    "devDependencies": {
+        "@types/node": "^14.14.37",
+        "typescript": "^4.2.3",
+        "vsce": "^1.96.1",
+        "vscode": "^1.1.37"
+    },
+    "dependencies": {
+        "vscode-languageclient": "^7.0.0"
+    }
+}

data/vscode/sandbox/test.rb

@@ -0,0 +1,24 @@
+class C  
+    def initialize
+    end
+
+    def get_foo
+        :Foo_foo
+    end
+
+    def get_bar
+        :Foo_bar
+    end
+end
+
+class D
+    def get_foo
+        :Foo2_foo
+    end
+end
+
+C.new.get_foo
+C.new.get_bar
+
+x = rand < 0.5 ? C.new : D.new
+x.get_foo 

data/vscode/src/extension.ts

@@ -0,0 +1,285 @@
+"use strict";
+
+import * as vscode from "vscode";
+import {
+  LanguageClient,
+  LanguageClientOptions,
+  ServerOptions,
+} from "vscode-languageclient/node";
+import * as net from "net";
+import * as child_process from "child_process";
+import { existsSync } from "fs";
+
+interface Invoking {
+  kind: "invoking";
+  workspaceFolder: vscode.WorkspaceFolder;
+  process: child_process.ChildProcessWithoutNullStreams;
+}
+interface Running {
+  kind: "running";
+  workspaceFolder: vscode.WorkspaceFolder;
+  client: LanguageClient;
+}
+type State = Invoking | Running;
+
+const CONFIGURATION_ROOT_SECTION = "typeprof";
+
+function addToggleButton(context: vscode.ExtensionContext) {
+  let statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
+  statusBarItem.command = "typeprof.toggle";
+  statusBarItem.text = "TypeProf $(eye)";
+  statusBarItem.show();
+
+  const disposable = vscode.commands.registerCommand("typeprof.toggle",
+    (arg0: any, arg1: any, arg2: any, arg3: any) => {
+      if (statusBarItem.text == "TypeProf $(eye)") {
+        statusBarItem.text = "TypeProf $(eye-closed)";
+        vscode.commands.executeCommand("typeprof.disableSignature");
+      }
+      else {
+        statusBarItem.text = "TypeProf $(eye)";
+        vscode.commands.executeCommand("typeprof.enableSignature");
+      }
+    }
+  );
+
+  context.subscriptions.push(disposable);
+}
+
+function addJumpToRBS(context: vscode.ExtensionContext) {
+  const disposable = vscode.commands.registerCommand("typeprof.jumpToRBS",
+    (arg0: any, arg1: any, arg2: any, arg3: any) => {
+      const uri0 = vscode.Uri.parse(arg0);
+      const pos0 = new vscode.Position(arg1.line, arg1.character);
+      const uri1 = vscode.Uri.parse(arg2);
+      const pos1 = new vscode.Position(arg3.start.line, arg3.start.character);
+      const pos2 = new vscode.Position(arg3.end.line, arg3.end.character);
+      const range = new vscode.Range(pos1, pos2);
+      const loc = new vscode.Location(uri1, range);
+      vscode.commands.executeCommand("editor.action.peekLocations", uri0, pos0, [loc], "peek");
+    }
+  );
+
+  context.subscriptions.push(disposable);
+}
+
+function executeTypeProf(folder: vscode.WorkspaceFolder, arg: String): child_process.ChildProcessWithoutNullStreams {
+  const configuration = vscode.workspace.getConfiguration(CONFIGURATION_ROOT_SECTION);
+  const customServerPath = configuration.get<string | null>("server.path");
+  const cwd = folder.uri.fsPath;
+
+  let cmd: string;
+  if (existsSync(`${cwd}/bin/typeprof`)) {
+    cmd = "./bin/typeprof";
+  }
+  else if (customServerPath) {
+    cmd = customServerPath;
+  }
+  else if (existsSync(`${cwd}/Gemfile`)) {
+    cmd = "bundle exec typeprof";
+  }
+  else {
+    cmd = "typeprof";
+  }
+  cmd = cmd + " " + arg;
+
+  const shell = process.env.SHELL;
+  let typeprof: child_process.ChildProcessWithoutNullStreams;
+  if (shell && (shell.endsWith("bash") || shell.endsWith("zsh") || shell.endsWith("fish"))) {
+    typeprof = child_process.spawn(shell, ["-c", "-l", cmd], { cwd });
+  }
+  else {
+    typeprof = child_process.spawn(cmd, { cwd });
+  }
+
+  return typeprof;
+}
+
+function getTypeProfVersion(folder: vscode.WorkspaceFolder, callback: (version: string) => void): child_process.ChildProcessWithoutNullStreams {
+  const typeprof = executeTypeProf(folder, "--version");
+  let output = "";
+
+  typeprof.stdout?.on("data", out => { output += out; });
+  typeprof.stderr?.on("data", out => { console.log(out); });
+  typeprof.on("error", e => {
+    console.info(`typeprof is not supported for this folder: ${folder}`);
+    console.info(`because: ${e}`);
+  });
+  typeprof.on("exit", (code) => {
+    if (code == 0) {
+      console.info(`typeprof version: ${output}`)
+      const str = output.trim();
+      const version = /^typeprof (\d+).(\d+).(\d+)$/.exec(str);
+      if (version) {
+        const major = Number(version[1]);
+        const minor = Number(version[2]);
+        const _teeny = Number(version[3]);
+        if (major >= 1 || (major == 0 && minor >= 20)) {
+          callback(str);
+        }
+        else {
+          console.info(`typeprof version ${str} is too old; please use 0.20.0 or later for IDE feature`);
+        }
+      }
+      else {
+        console.info(`typeprof --version showed unknown message`);
+      }
+    }
+    else {
+      console.info(`failed to invoke typeprof: error code ${code}`);
+    }
+    typeprof.kill()
+  });
+  return typeprof;
+}
+
+function getTypeProfStream(folder: vscode.WorkspaceFolder, error: (msg: string) => void):
+  Promise<{ host: string; port: number; pid: number; stop: () => void }>
+{
+  return new Promise((resolve, reject) => {
+    const typeprof = executeTypeProf(folder, "--lsp");
+
+    let buffer = "";
+    typeprof.stdout.on("data", (data) => {
+      buffer += data;
+      try {
+        const json = JSON.parse(data);
+        json["stop"] = () => typeprof.kill("SIGINT");
+        resolve(json);
+      } catch (err) {}
+    });
+
+    let err = "";
+    typeprof.stderr.on("data", (data) => {
+      err += data;
+      while (true) {
+        const i = err.indexOf("\n");
+        if (i < 0) break;
+        error(err.slice(0, i));
+        err = err.slice(i + 1);
+      }
+    });
+
+    typeprof.on("exit", (code) => reject(`error code ${code}`));
+  });
+}
+
+function invokeTypeProf(folder: vscode.WorkspaceFolder): LanguageClient {
+  let client: LanguageClient;
+
+  const reportError = (msg: string) => client.info(msg);
+
+  const serverOptions: ServerOptions = async () => {
+    const { host, port, stop } = await getTypeProfStream(folder, reportError);
+    const socket: net.Socket = net.createConnection(port, host);
+    socket.on("close", (_had_error) => stop());
+
+    return {
+      reader: socket,
+      writer: socket,
+    };
+  };
+
+  const clientOptions: LanguageClientOptions = {
+    documentSelector: [
+      { scheme: "file", language: "ruby" },
+      { scheme: "file", language: "rbs" },
+    ],
+    synchronize: {
+      fileEvents:
+        vscode.workspace.createFileSystemWatcher("{**/*.rb,**/*.rbs}"),
+    },
+  };
+
+  client = new LanguageClient("Ruby TypeProf", serverOptions, clientOptions);
+
+  return client;
+}
+
+const clientSessions: Map<vscode.WorkspaceFolder, State> = new Map();
+
+function startTypeProf(folder: vscode.WorkspaceFolder) {
+  const showStatus = (msg: string) => vscode.window.setStatusBarMessage(msg, 3000);
+  console.log(`start: ${folder}`);
+
+  const typeprof = getTypeProfVersion(folder, (version) => {
+    if (!version) {
+      showStatus(`Ruby TypeProf is not configured; Try to add "gem 'typeprof'" to Gemfile`);
+      clientSessions.delete(folder);
+      return;
+    }
+    showStatus(`Starting Ruby TypeProf (${version})...`);
+    const client = invokeTypeProf(folder);
+    client.onReady()
+    .then(() => {
+      showStatus("Ruby TypeProf is running");
+    })
+    .catch((e: any) => {
+      showStatus(`Failed to start Ruby TypeProf: ${e}`);
+    });
+    client.start();
+    clientSessions.set(folder, { kind: "running", workspaceFolder: folder, client });
+  });
+
+  clientSessions.set(folder, { kind: "invoking", workspaceFolder: folder, process: typeprof });
+}
+
+function stopTypeProf(state: State) {
+  console.log(`stop: ${state.workspaceFolder}`);
+  switch (state.kind) {
+    case "invoking":
+      state.process.kill();
+
+      break;
+    case "running":
+      state.client.stop();
+      break;
+  }
+  clientSessions.delete(state.workspaceFolder);
+}
+
+function restartTypeProf() {
+  vscode.workspace.workspaceFolders?.forEach((folder) => {
+    let state = clientSessions.get(folder);
+    if (state) stopTypeProf(state);
+    startTypeProf(folder);
+  });
+}
+
+function ensureTypeProf() {
+  if (!vscode.workspace.workspaceFolders) return;
+
+  const activeFolders = new Set(vscode.workspace.workspaceFolders);
+
+  clientSessions.forEach((state) => {
+    if (!activeFolders.has(state.workspaceFolder)) {
+      stopTypeProf(state);
+    }
+  });
+
+  activeFolders.forEach((folder) => {
+    if (folder.uri.scheme === "file" && !clientSessions.has(folder)) {
+      startTypeProf(folder);
+    }
+  });
+}
+
+function addRestartCommand(context: vscode.ExtensionContext) {
+  const disposable = vscode.commands.registerCommand("typeprof.restart", () => {
+    restartTypeProf();
+  });
+  context.subscriptions.push(disposable);
+}
+
+export function activate(context: vscode.ExtensionContext) {
+  addToggleButton(context);
+  addJumpToRBS(context);
+  addRestartCommand(context)
+  ensureTypeProf();
+}
+
+export function deactivate() {
+  clientSessions.forEach((state) => {
+    stopTypeProf(state);
+  });
+}

data/vscode/tsconfig.json

@@ -0,0 +1,15 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "outDir": "out",
+        "lib": ["es6"],
+        "sourceMap": true,
+        "rootDir": ".",
+        "strict": true
+    },
+    "exclude": [
+        "node_modules",
+        ".vscode-test"
+    ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typeprof
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.20.0
 platform: ruby
 authors:
 - Yusuke Endoh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.6.2
 description: |
   TypeProf performs a type analysis of non-annotated Ruby code.
 
@@ -56,12 +56,14 @@ files:
 - lib/typeprof/block.rb
 - lib/typeprof/builtin.rb
 - lib/typeprof/cli.rb
+- lib/typeprof/code-range.rb
 - lib/typeprof/config.rb
 - lib/typeprof/container-type.rb
 - lib/typeprof/export.rb
 - lib/typeprof/import.rb
 - lib/typeprof/insns-def.rb
 - lib/typeprof/iseq.rb
+- lib/typeprof/lsp.rb
 - lib/typeprof/method.rb
 - lib/typeprof/type.rb
 - lib/typeprof/utils.rb
@@ -397,7 +399,18 @@ files:
 - testbed/goodcheck-Gemfile.lock
 - tools/coverage.rb
 - tools/setup-insns-def.rb
+- typeprof-lsp
 - typeprof.gemspec
+- vscode/.gitignore
+- vscode/.vscode/launch.json
+- vscode/.vscodeignore
+- vscode/README.md
+- vscode/development.md
+- vscode/package-lock.json
+- vscode/package.json
+- vscode/sandbox/test.rb
+- vscode/src/extension.ts
+- vscode/tsconfig.json
 homepage: https://github.com/ruby/typeprof
 licenses:
 - MIT
@@ -419,7 +432,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.0.dev
 signing_key: 
 specification_version: 4
 summary: TypeProf is a type analysis tool for Ruby code based on abstract interpretation