typeprof 0.30.1 → 0.31.0

data/lib/typeprof/lsp/server.rb

@@ -1,3 +1,6 @@
+require "cgi/escape"
+require "cgi/util" if RUBY_VERSION < "3.5"
+
 module TypeProf::LSP
   module ErrorCodes
     ParseError = -32700
@@ -8,17 +11,17 @@ module TypeProf::LSP
   end
 
   class Server
-    def self.start_stdio(core)
+    def self.start_stdio(core_options)
       $stdin.binmode
       $stdout.binmode
       reader = Reader.new($stdin)
       writer = Writer.new($stdout)
       # pipe all builtin print output to stderr to avoid conflicting with lsp
       $stdout = $stderr
-      new(core, reader, writer).run
+      new(core_options, reader, writer).run
     end
 
-    def self.start_socket(core)
+    def self.start_socket(core_options)
       Socket.tcp_server_sockets("localhost", nil) do |servs|
         serv = servs[0].local_address
         $stdout << JSON.generate({
@@ -35,7 +38,7 @@ module TypeProf::LSP
           begin
             reader = Reader.new(sock)
             writer = Writer.new(sock)
-            new(core, reader, writer).run
+            new(core_options, reader, writer).run
           ensure
             sock.close
           end
@@ -44,9 +47,9 @@ module TypeProf::LSP
       end
     end
 
-    def initialize(core, reader, writer, url_schema: nil, publish_all_diagnostics: false)
-      @core = core
-      @workspaces = {}
+    def initialize(core_options, reader, writer, url_schema: nil)
+      @core_options = core_options
+      @cores = {}
       @reader = reader
       @writer = writer
       @request_id = 0
@@ -56,52 +59,139 @@ module TypeProf::LSP
       @exit = false
       @signature_enabled = true
       @url_schema = url_schema || (File::ALT_SEPARATOR != "\\" ? "file://" : "file:///")
-      @publish_all_diagnostics = publish_all_diagnostics # TODO: implement more dedicated publish feature
+      @diagnostic_severity = :error
     end
 
-    attr_reader :core, :open_texts
+    attr_reader :open_texts
     attr_accessor :signature_enabled
 
+    #: (String) -> String
     def path_to_uri(path)
-      @url_schema + File.expand_path(path)
+      @url_schema + File.expand_path(path).split("/").map {|s| CGI.escapeURIComponent(s) }.join("/")
     end
 
-    def uri_to_path(url)
-      url.delete_prefix(@url_schema)
+    def uri_to_path(uri)
+      uri.delete_prefix(@url_schema).split("/").map {|s| CGI.unescapeURIComponent(s) }.join("/")
     end
 
+    #: (Array[String]) -> void
     def add_workspaces(folders)
       folders.each do |path|
-        conf_path = File.join(path, "typeprof.conf.json")
-        if File.readable?(conf_path)
-          conf = TypeProf::LSP.load_json_with_comments(conf_path, symbolize_names: true)
-          if conf
-            if conf[:typeprof_version] == "experimental"
-              if conf[:analysis_unit_dirs].size >= 2
-                 puts "currently analysis_unit_dirs can have only one directory"
-              end
-              conf[:analysis_unit_dirs].each do |dir|
-                dir = File.expand_path(dir, path)
-                @workspaces[dir] = true
-                @core.add_workspace(dir, conf[:rbs_dir])
+        conf_path = [".json", ".jsonc"].map do |ext|
+          File.join(path, "typeprof.conf" + ext)
+        end.find do |path|
+          File.readable?(path)
+        end
+        unless conf_path
+          puts "typeprof.conf.json is not found in #{ path }"
+          next
+        end
+        conf = TypeProf::LSP.load_json_with_comments(conf_path, symbolize_names: true)
+        if conf
+          if conf[:rbs_dir]
+            rbs_dir = File.expand_path(conf[:rbs_dir])
+          else
+            rbs_dir = File.expand_path(File.expand_path("sig", path))
+          end
+          @rbs_dir = rbs_dir
+          if conf[:typeprof_version] == "experimental"
+            if conf[:diagnostic_severity]
+              severity = conf[:diagnostic_severity].to_sym
+              case severity
+              when :error, :warning, :info, :hint
+                @diagnostic_severity = severity
+              else
+                puts "unknown severity: #{ severity }"
               end
-            else
-              puts "Unknown typeprof_version: #{ conf[:typeprof_version] }"
             end
+            conf[:analysis_unit_dirs].each do |dir|
+              dir = File.expand_path(dir, path)
+              core = @cores[dir] = TypeProf::Core::Service.new(@core_options)
+              core.add_workspace(dir, @rbs_dir)
+            end
+          else
+            puts "Unknown typeprof_version: #{ conf[:typeprof_version] }"
           end
-        else
-          puts "typeprof.conf.json is not found"
         end
       end
     end
 
+    #: (String) -> bool
     def target_path?(path)
-      @workspaces.each do |folder, _|
+      return true if @rbs_dir && path.start_with?(@rbs_dir)
+      @cores.each do |folder, _|
         return true if path.start_with?(folder)
       end
       return false
     end
 
+    def each_core(path)
+      @cores.each do |folder, core|
+        if path.start_with?(folder) || @rbs_dir && path.start_with?(@rbs_dir)
+          yield core
+        end
+      end
+    end
+
+    def aggregate_each_core(path)
+      ret = []
+      each_core(path) do |core|
+        r = yield(core)
+        ret.concat(r) if r
+      end
+      ret
+    end
+
+    def update_file(path, text)
+      each_core(path) do |core|
+        core.update_file(path, text)
+      end
+    end
+
+    def definitions(path, pos)
+      aggregate_each_core(path) do |core|
+        core.definitions(path, pos)
+      end
+    end
+
+    def type_definitions(path, pos)
+      aggregate_each_core(path) do |core|
+        core.type_definitions(path, pos)
+      end
+    end
+
+    def references(path, pos)
+      aggregate_each_core(path) do |core|
+        core.references(path, pos)
+      end
+    end
+
+    def hover(path, pos)
+      ret = []
+      each_core(path) do |core|
+        ret << core.hover(path, pos)
+      end
+      ret.compact.first # TODO
+    end
+
+    def code_lens(path, &blk)
+      each_core(path) do |core|
+        core.code_lens(path, &blk)
+      end
+    end
+
+    def completion(path, trigger, pos, &blk)
+      each_core(path) do |core|
+        core.completion(path, trigger, pos, &blk)
+      end
+    end
+
+    def rename(path, pos)
+      aggregate_each_core(path) do |core|
+        core.rename(path, pos)
+      end
+    end
+
     def run
       @reader.read do |json|
         if json[:method]
@@ -147,19 +237,22 @@ module TypeProf::LSP
       @exit = true
     end
 
-    def publish_diagnostics(uri)
-      (@publish_all_diagnostics ? @open_texts : [[uri, @open_texts[uri]]]).each do |uri, text|
+    def publish_updated_diagnostics
+      @cores.each do |_, core|
         diags = []
-        if text
-          @core.diagnostics(text.path) do |diag|
-            diags << diag.to_lsp
+        core.process_diagnostic_paths do |path|
+          uri = path_to_uri(path)
+          next false unless @open_texts[uri]
+          core.diagnostics(path) do |diag|
+            diags << diag.to_lsp(severity: @diagnostic_severity)
           end
+          send_notification(
+            "textDocument/publishDiagnostics",
+            uri: uri,
+            diagnostics: diags
+          )
+          true
         end
-        send_notification(
-          "textDocument/publishDiagnostics",
-          uri: uri,
-          diagnostics: diags
-        )
       end
     end
   end

data/lib/typeprof/lsp/text.rb

@@ -1,5 +1,6 @@
 module TypeProf::LSP
   class Text
+    #: (String, String, Integer) -> void
     def initialize(path, text, version)
       @path = path
       @lines = Text.split(text)

data/lib/typeprof/version.rb

@@ -1,3 +1,3 @@
 module TypeProf
-  VERSION = "0.30.1"
+  VERSION = "0.31.0"
 end

data/typeprof.conf.jsonc

@@ -0,0 +1,22 @@
+// Experimental TypeProf configuration
+
+// The format is completely tentative and subject to change
+// (including whether to use JSON with Comments or TOML or Ruby DSL or something else)
+{
+    // The version of TypeProf; you need to specify "experimental"
+    "typeprof_version": "experimental",
+
+    // The directory containing RBS files that defines the interface between the analysis units
+    "rbs_dir": "sig/",
+
+    // The directories containing Ruby files to be analyzed by TypeProf
+    // Each directory will be independently analyzed
+    "analysis_unit_dirs": [
+        "lib/typeprof/core/",
+        "lib/typeprof/lsp"
+    ],
+
+    // Severity of diagnosis, selectable from "error", "warning", "info", "hint", and "none".
+    // Currently, TypeProf reports many false positives, so it is recommended to use "hint" or "none".
+    "diagnostic_severity": "warning"
+}

data/typeprof.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "prism", ">= 1.4.0"
   spec.add_runtime_dependency "rbs", ">= 3.6.0"
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: typeprof
 version: !ruby/object:Gem::Version
-  version: 0.30.1
+  version: 0.31.0
 platform: ruby
 authors:
 - Yusuke Endoh
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +77,7 @@ files:
 - lib/typeprof/core/env/method.rb
 - lib/typeprof/core/env/method_entity.rb
 - lib/typeprof/core/env/module_entity.rb
+- lib/typeprof/core/env/narrowing.rb
 - lib/typeprof/core/env/static_read.rb
 - lib/typeprof/core/env/type_alias_entity.rb
 - lib/typeprof/core/env/value_entity.rb
@@ -81,6 +95,7 @@ files:
 - lib/typeprof/lsp/text.rb
 - lib/typeprof/lsp/util.rb
 - lib/typeprof/version.rb
+- typeprof.conf.jsonc
 - typeprof.gemspec
 homepage: https://github.com/ruby/typeprof
 licenses:
@@ -88,7 +103,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/typeprof
   source_code_uri: https://github.com/ruby/typeprof
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: TypeProf is a type analysis tool for Ruby code based on abstract interpretation
 test_files: []