typeprof 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 109bbaf7daec0e4dce2f23c17a73d9528c51441cf61f1e23f5dc5d3c2c47dbff
-  data.tar.gz: bbd47838c15aa0e2a12645a8c9d5f56b0587323e96d919240681d747e2b73696
+  metadata.gz: b3938be1edd2b64861739d4ea2f801972c32fc67b4b791837e2b238d9be3a5bb
+  data.tar.gz: 8ba23caae4ab25ea713a1b4fca1850cbc44954aaecabcfd9a3e7a3db18c6ea4b
 SHA512:
-  metadata.gz: 6e1ff8245d59eb81f253544b9a1a0e6a54f154fb17634e739210d4320e96619d59b70f9efd6811f600ab67e52ea341d3d9a886ab2b00d397ede5594f23ce8340
-  data.tar.gz: 2723c535e5f42e13e419e2646607ba9a5ec0a90c266fd2a927e658b133703f658af0cdfc2f392c6acd7f6f96fbbb54019251163f2109b1624158a48e019a56f2
+  metadata.gz: e946bed7229effa1d0d95fd665875b39344d8aa959e6fa126631b914e8f9ead55a2a5cababd2ea390f1275b04d1e73bec2b4969c3ccc549acfdeb09512ed8626
+  data.tar.gz: e31d656a00087bb096c91e2c3da129e7d81ee480e99d67685b1c458a5cbf1a2e97c3ea0feef1657b1a895fc44bd2011ba3fd6ef8b387833967e99c1c728b6e4b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typeprof (0.20.0)
+    typeprof (0.20.1)
       rbs (>= 1.6.2)
 
 GEM

data/doc/ide.md

@@ -0,0 +1,81 @@
+# How to use TypeProf for IDE
+
+First, try it with an already-configured repository!
+
+1. `rbenv install 3.1.0-dev`
+2. `git clone https://github.com/mame/rbswiki`
+3. `cd rbswiki && bundle install`
+4. `rbs collection install`
+5. install [VSCode extension for TypeProf](https://marketplace.visualstudio.com/items?itemName=mame.ruby-typeprof) to your VSCode
+6. open the `rbswiki` folder by VSCode
+7. open `lib/rbswiki/wiki.rb`
+
+If everything goes well, you will see guessed signatures for each method:
+
+![Screenshot](typeprof-for-ide.png)
+
+### Troubleshooting
+
+* Make sure that you are using ruby 3.1.0-dev.
+
+```
+$ ruby -v
+ruby 3.1.0dev (2021-09-28T11:03:54Z master 545e01645f) [x86_64-linux]
+```
+
+* Check if typeprof version is 0.20.0 or later.
+
+```
+$ bundle exec typeprof --version
+typeprof 0.20.0
+```
+
+* Check if TypeProf can analyze `lib/rbswiki/wiki.rb` within one second.
+
+```
+$ bundle exec typeprof lib/rbswiki/wiki.rb
+warning: rbs collection is experimental, and the behavior may change until RBS v2.0
+# TypeProf 0.20.0
+
+# Classes
+module RBSWiki
+  class Wiki
+    @content: Hash[String, String]
+...
+```
+
+* See the log of "Ruby TypeProf" in vscode's "OUTPUT" panel.
+
+![Log of TypeProf for IDE](typeprof-for-ide-log.png)
+
+## How to configure TypeProf for your code
+
+1. Write `gem "typeprof"` to your `Gemfile`, and run `bundle install`
+2. Write `rbs_collection.yaml`, and run `rbs collection install`
+3. Test if TypeProf works well by running `bundle exec typeprof your_code.rb`
+4. Open your repository with vscode
+
+### Troubleshooting
+
+*TBD*
+
+## Protips, limitation, unimplemented features, ...
+
+TypeProf for IDE is extremely preliminary! Please give it a try with a warm heart...
+
+* Write a simple (type-level) test in each file with `if $0 == __FILE__` guard to guide TypeProf to infer method signatures.
+* Use `require` only for loading gems. To load your code, use `require_relative` instead of `require`. (Or, create `bin/typeprof` and pass `-Ilib`. TBD for details)
+* Currently, TypeProf for IDE loads `typeprof.rbs` at the top folder. (I'll need to improve it to read `sig/` directory)
+* TypeProf for IDE analyzes each file within one second. Unfortunately, it takes very long to analyze big code, or complex code, or code that requires a big gem. In this case, TypeProf for IDE cannot show any guesses. Splitting a file or manually writing RBS may make the analysis faster. (TBD for details)
+* Unfortunately, TypeProf may report some false positive errors that you cannot stop. I'll create an option to configure error level.
+* TypeProf for IDE tries to invoke TypeProf as follows:
+    * If your repository has `bin/typeprof` executable, it is invoked.
+    * Otherwise, it will try to invoke a command specified in VS`typeprof.server.path`.
+    * Otherwise, it will try to invoke `bundle exec typeprof`.
+    * Otherwise, it will try to invoke `typeprof`.
+    * Otherwise, TypeProf for IDE gives up.
+* Some people says TypeProf for IDE works with vim! (TBD for details)
+
+## How to develop TypeProf for IDE
+
+See `../vscode/development.md`.

data/lib/typeprof/analyzer.rb

@@ -1933,8 +1933,13 @@ module TypeProf
       when :setconstant
         name, = operands
         env, (ty, cbase) = env.pop(2)
-        old_ty, = get_constant(cbase, name)
-        if old_ty != Type.any # XXX???
+        old_ty, old_locs = get_constant(cbase, name)
+        if old_locs == [nil] # RBS defined
+          # TODO: it would be better to check if ty is consistent with old_ty (defined in RBS)
+          # instead of extending the type
+          env, old_ty = localize_type(globalize_type(old_ty, env, ep), env, ep)
+          ty = ty.union(old_ty)
+        elsif old_ty != Type.any # XXX???
           warn(ep, "already initialized constant #{ Type::Instance.new(cbase).screen_name(self) }::#{ name }")
         end
         ty.each_child do |ty|

data/lib/typeprof/cli.rb

@@ -21,7 +21,6 @@ module TypeProf
       lsp_options = {}
       dir_filter = nil
       gem_rbs_features = []
-      gem_repo_dirs = []
       show_version = false
       max_sec = max_iter = nil
       collection_path = RBS::Collection::Config::PATH
@@ -36,7 +35,6 @@ module TypeProf
       opt.on("--version", "Display typeprof version") { show_version = true }
       opt.on("-I DIR", "Add DIR to the load/require path") {|v| load_path_ext << v }
       opt.on("-r FEATURE", "Require RBS of the FEATURE gem") {|v| gem_rbs_features << v }
-      opt.on("--repo DIR", "Add DIR to the RBS repository") {|v| gem_repo_dirs << v }
       opt.on("--collection PATH", "File path of collection configuration") { |v| collection_path = v }
       opt.on("--no-collection", "Ignore collection configuration") { collection_path = nil }
       opt.on("--lsp", "LSP mode") {|v| options[:lsp] = true }
@@ -78,6 +76,7 @@ module TypeProf
       opt.separator ""
       opt.separator "LSP options:"
       opt.on("--port PORT", Integer, "Specify a port number to listen for requests on") {|v| lsp_options[:port] = v }
+      opt.on("--stdio", "Use stdio for LSP transport") {|v| lsp_options[:stdio] = v }
 
       opt.parse!(argv)
 
@@ -110,7 +109,6 @@ module TypeProf
         rbs_files: rbs_files,
         output: output,
         gem_rbs_features: gem_rbs_features,
-        gem_repo_dirs: gem_repo_dirs,
         collection_path: collection_path,
         verbose: verbose,
         dir_filter: dir_filter,

data/lib/typeprof/config.rb

@@ -6,7 +6,6 @@ module TypeProf
     :rbs_files,
     :output,
     :gem_rbs_features,
-    :gem_repo_dirs,
     :collection_path,
     :verbose,
     :dir_filter,
@@ -29,7 +28,6 @@ module TypeProf
     def initialize(**opt)
       opt[:output] ||= $stdout
       opt[:gem_rbs_features] ||= []
-      opt[:gem_repo_dirs] ||= []
       opt[:dir_filter] ||= DEFAULT_DIR_FILTER
       opt[:verbose] ||= 0
       opt[:options] ||= {}
@@ -48,6 +46,7 @@ module TypeProf
       }.merge(opt[:options])
       opt[:lsp_options] = {
         port: 0,
+        stdio: false,
       }.merge(opt[:lsp_options] || {})
       super(**opt)
     end
@@ -94,9 +93,6 @@ module TypeProf
       Import.import_library(scratch, feature)
     end
 
-    collection_path = config.collection_path
-    Import.import_rbs_collection(scratch, collection_path) if collection_path&.exist?
-
     rbs_files = []
     rbs_codes = []
     Config.current.rbs_files.each do |rbs|

data/lib/typeprof/import.rb

@@ -4,36 +4,49 @@ module TypeProf
   class RBSReader
     def initialize
       @repo = RBS::Repository.new
-      Config.current.gem_repo_dirs.each do |dir|
-        @repo.add(Pathname(dir))
-      end
       collection_path = Config.current.collection_path
       if collection_path&.exist?
         collection_lock = RBS::Collection::Config.lockfile_of(collection_path)
         @repo.add(collection_lock.repo_path)
       end
-      @env, @builtin_env_json = RBSReader.get_builtin_env
+      @env, @loaded_gems, @builtin_env_json = RBSReader.get_builtin_env
     end
 
     @builtin_env = @builtin_env_json = nil
     def self.get_builtin_env
+      @loaded_gems = []
       unless @builtin_env
         @builtin_env = RBS::Environment.new
 
-        loader = RBS::EnvironmentLoader.new(repository: @repo)
+        loader = RBS::EnvironmentLoader.new
+
+        # TODO: invalidate this cache when rbs_collection.yml was changed
+        collection_path = Config.current.collection_path
+        if collection_path&.exist?
+          collection_lock = RBS::Collection::Config.lockfile_of(collection_path)
+          collection_lock.gems.each {|gem| @loaded_gems << gem["name"] }
+          loader.add_collection(collection_lock)
+        end
+
         new_decls = loader.load(env: @builtin_env).map {|decl,| decl }
         @builtin_env_json = load_rbs(@builtin_env, new_decls)
       end
 
-      return @builtin_env.dup, @builtin_env_json
+      return @builtin_env.dup, @loaded_gems.dup, @builtin_env_json
     end
 
     def load_builtin
       @builtin_env_json
     end
 
+    class RBSCollectionDefined < StandardError; end
+
     def load_library(lib)
       loader = RBS::EnvironmentLoader.new(core_root: nil, repository: @repo)
+      if @loaded_gems.include?(lib)
+        raise RBSCollectionDefined
+      end
+      @loaded_gems << lib
       loader.add(library: lib)
 
       case lib
@@ -71,14 +84,6 @@ module TypeProf
       RBSReader.load_rbs(@env, new_decls)
     end
 
-    def load_rbs_collection(collection_path)
-      loader = RBS::EnvironmentLoader.new(core_root: nil)
-      collection_lock = RBS::Collection::Config.lockfile_of(collection_path)
-      loader.add_collection(collection_lock)
-      new_decls = loader.load(env: @env).map {|decl,| decl }
-      RBSReader.load_rbs(@env, new_decls)
-    end
-
     def self.load_rbs(env, new_decls)
       all_env = env.resolve_type_names
       resolver = RBS::TypeNameResolver.from_env(all_env)
@@ -483,6 +488,7 @@ module TypeProf
       when RBS::Types::Interface
         # XXX: Currently, only a few builtin interfaces are supported
         case ty.to_s
+        when "::_ToS" then [:str]
         when "::_ToStr" then [:str]
         when "::_ToInt" then [:int]
         when "::_ToAry[U]" then [:array, [:Array], [], [:var, :U]]
@@ -490,6 +496,7 @@ module TypeProf
           [:instance, conv_type_name(ty.name)]
         end
       when RBS::Types::Bases::Instance then [:any] # XXX: not implemented yet
+      when RBS::Types::Bases::Class then [:any] # XXX: not implemented yet
       when RBS::Types::Record
         [:hash_record, [:Hash], ty.fields.map {|key, ty| [key, conv_type(ty)] }]
       when RBS::Types::Proc
@@ -515,7 +522,7 @@ module TypeProf
         json = scratch.rbs_reader.load_library(feature)
       rescue RBS::EnvironmentLoader::UnknownLibraryError
         return nil
-      rescue RBS::DuplicatedDeclarationError
+      rescue RBS::DuplicatedDeclarationError, RBSReader::RBSCollectionDefined
         return true
       end
       # need cache?
@@ -531,10 +538,6 @@ module TypeProf
       Import.new(scratch, scratch.rbs_reader.load_rbs_string(rbs_name, rbs_code)).import(true)
     end
 
-    def self.import_rbs_collection(scratch, collection_path)
-      Import.new(scratch, scratch.rbs_reader.load_rbs_collection(collection_path)).import(true)
-    end
-
     def initialize(scratch, json)
       @scratch = scratch
       @json = json

data/lib/typeprof/iseq.rb

@@ -34,6 +34,11 @@ module TypeProf
         parse_opts = {}
         parse_opts[:keep_script_lines] = true if RICH_AST
 
+        unless defined?(RubyVM::InstructionSequence)
+          puts "Currently, TypeProf can work on a Ruby implementation that supports RubyVM::InstructionSequence, such as CRuby."
+          exit 1
+        end
+
         if str
           node = RubyVM::AbstractSyntaxTree.parse(str, **parse_opts)
           iseq = RubyVM::InstructionSequence.compile(str, path, **opt)

data/lib/typeprof/lsp.rb

@@ -4,27 +4,35 @@ require "uri"
 
 module TypeProf
   def self.start_lsp_server(config)
-    Socket.tcp_server_sockets("localhost", config.lsp_options[:port]) do |servs|
-      serv = servs[0].local_address
-      $stdout << JSON.generate({
-        host: serv.ip_address,
-        port: serv.ip_port,
-        pid: $$,
-      })
-      $stdout.flush
-
+    if config.lsp_options[:stdio]
+      reader = LSP::Reader.new($stdin)
+      writer = LSP::Writer.new($stdout)
+      # pipe all builtin print output to stderr to avoid conflicting with lsp
       $stdout = $stderr
-
-      Socket.accept_loop(servs) do |sock|
-        sock.set_encoding("UTF-8")
-        begin
-          reader = LSP::Reader.new(sock)
-          writer = LSP::Writer.new(sock)
-          TypeProf::LSP::Server.new(config, reader, writer).run
-        ensure
-          sock.close
+      TypeProf::LSP::Server.new(config, reader, writer).run
+    else
+      Socket.tcp_server_sockets("localhost", config.lsp_options[:port]) do |servs|
+        serv = servs[0].local_address
+        $stdout << JSON.generate({
+          host: serv.ip_address,
+          port: serv.ip_port,
+          pid: $$,
+        })
+        $stdout.flush
+
+        $stdout = $stderr
+
+        Socket.accept_loop(servs) do |sock|
+          sock.set_encoding("UTF-8")
+          begin
+            reader = LSP::Reader.new(sock)
+            writer = LSP::Writer.new(sock)
+            TypeProf::LSP::Server.new(config, reader, writer).run
+          ensure
+            sock.close
+          end
+          exit
         end
-        exit
       end
     end
   end
@@ -330,8 +338,8 @@ module TypeProf
         end
 
         diagnostics = {}
-        res[:errors].each do |(file, code_range), msg|
-          next unless file
+        res[:errors]&.each do |(file, code_range), msg|
+          next unless file and code_range
           uri0 = "file://" + file
           diagnostics[uri0] ||= []
           diagnostics[uri0] << {
@@ -675,6 +683,11 @@ module TypeProf
             triggerKind: trigger_kind
           },
         }
+        in {
+          textDocument: { uri:, },
+          position: loc,
+        }
+          trigger_kind = 1
         else
           raise
         end
@@ -705,6 +718,11 @@ module TypeProf
             triggerKind: trigger_kind
           },
         }
+        in {
+          textDocument: { uri:, },
+          position: loc,
+        }
+          trigger_kind = 1
         else
           raise
         end
@@ -783,6 +801,7 @@ module TypeProf
       def write(**json)
         json = JSON.generate(json.merge(jsonrpc: "2.0"))
         @io << "Content-Length: #{ json.bytesize }\r\n\r\n" << json
+        @io.flush
       end
 
       module ErrorCodes

data/lib/typeprof/version.rb

@@ -1,3 +1,3 @@
 module TypeProf
-  VERSION = "0.20.0"
+  VERSION = "0.20.1"
 end

data/lib/typeprof.rb

@@ -1,8 +1,3 @@
-unless defined?(RubyVM::InstructionSequence)
-  puts "Currently, TypeProf can work on a Ruby implementation that supports RubyVM::InstructionSequence, such as CRuby."
-  exit 1
-end
-
 module TypeProf end
 
 require_relative "typeprof/version"

data/typeprof.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|smoke|testbed)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }