repl_type_completor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1a82aeb5a01426335efe986d61dcb745051091bc6dedc93d332cf6bacaa0351
+  data.tar.gz: 6b669b71a1d01fb394e0bb2ec8776bb3d68ecade407ed6fbb36f87400cba4fae
+SHA512:
+  metadata.gz: 03b215d8f2123c52047513e321b30f8d32159f318ca233b10de48df5b53ba04223b979024afe8d44d7e2a0e6f78595d2b4c4354f23fa90e3aae4f7b5de83e4bf
+  data.tar.gz: 879d342d1b77f30ebdc328ce1a4dc2cc4dc60d7179c7d2af384ae236d4b7e830c410d3c78c8750c70f4ea06b6612417cae26d9b18deb5b11d609be29798f5c34

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in repl_type_completor.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'test-unit'
+gem 'test-unit-ruby-core'
+
+if ENV['GEMFILE_PRISM_VERSION']
+  if ENV['GEMFILE_PRISM_VERSION'] == 'latest'
+    gem 'prism', github: 'ruby/prism'
+  else
+    gem 'prism', ENV['GEMFILE_PRISM_VERSION']
+  end
+end
+
+if ENV['GEMFILE_RBS_VERSION']
+  if ENV['GEMFILE_RBS_VERSION'] == 'latest'
+    gem 'rbs', github: 'ruby/rbs'
+  else
+    gem 'rbs', ENV['GEMFILE_RBS_VERSION']
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 tompng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# ReplTypeCompletor
+
+ReplTypeCompletor is a type based completor for REPL.
+It uses RBS type information, performs static type analytics, uses dynamic runtime information from binding.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+Require the library
+```ruby
+require 'repl_type_completor'
+```
+
+Load RBS with one of these. It will load core library signatures, `./rbs_collection.yaml` and `./sig/**/*.rbs`.
+```ruby
+ReplTypeCompletor.preload_rbs # Recommended. Preload using thread
+ReplTypeCompletor.load_rbs # Could take a seconds in large projects
+```
+
+Now you can get completion candidates.
+```ruby
+array = [1, 2, 3]
+code_to_complete = 'array.map do str = _1.chr; str.up'
+result = ReplTypeCompletor.analyze(code_to_complete, binding: binding, filename: __FILE__)
+result.completion_candidates #=> ["case", "case!", "to"]
+result.doc_namespace('case') #=> "String#upcase"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/repl_type_completor.
+
+When something is wrong, these methods will provide some debug information.
+```ruby
+ReplTypeCompletor.info
+ReplTypeCompletor.rbs_load_started?
+ReplTypeCompletor.rbs_loaded?
+ReplTypeCompletor.rbs_load_error
+ReplTypeCompletor.last_completion_error
+ReplTypeCompletor.analyze(code_to_complete, binding: binding, filename: __FILE__)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/repl_type_completor/test_*.rb"]
+end
+
+# To make sure they have been correctly setup for Ruby CI.
+desc "Run each repl_type_completor test file in isolation."
+task :test_in_isolation do
+  failed = false
+
+  FileList["test/repl_type_completor/test_*.rb"].each do |test_file|
+    ENV["TEST"] = test_file
+    begin
+      Rake::Task["test"].execute
+    rescue => e
+      failed = true
+      msg = "Test '#{test_file}' failed when being executed in isolation. Please make sure 'rake test TEST=#{test_file}' passes."
+      separation_line = '=' * msg.length
+
+      puts <<~MSG
+        #{separation_line}
+        #{msg}
+        #{separation_line}
+      MSG
+    end
+  end
+
+  fail "Some tests failed when being executed in isolation" if failed
+end
+
+task default: %i[test test_in_isolation]

data/lib/repl_type_completor/methods.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ReplTypeCompletor
+  module Methods
+    OBJECT_SINGLETON_CLASS_METHOD = Object.instance_method(:singleton_class)
+    OBJECT_INSTANCE_VARIABLES_METHOD = Object.instance_method(:instance_variables)
+    OBJECT_INSTANCE_VARIABLE_GET_METHOD = Object.instance_method(:instance_variable_get)
+    OBJECT_CLASS_METHOD = Object.instance_method(:class)
+    MODULE_NAME_METHOD = Module.instance_method(:name)
+  end
+end

data/lib/repl_type_completor/require_paths.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module ReplTypeCompletor
+  module RequirePaths
+    class << self
+      def require_completions(target_path)
+        *dir, target = target_path.split('/', -1)
+        target ||= ''
+        paths = with_cache [:require_completions, dir] do
+          gem_and_system_load_paths.flat_map do |load_path|
+            base_dir = File.absolute_path(File.join(load_path, *dir))
+            with_cache [:requireable_paths, base_dir] do
+              requireable_paths(base_dir)
+            end
+          end.sort
+        end
+        paths.filter_map do |path|
+          [*dir, path].join('/') if path.start_with?(target)
+        end
+      end
+
+      def require_relative_completions(target_path, source_file)
+        source_dir = source_file ? File.dirname(source_file) : Dir.pwd
+        *dir, target = target_path.split('/', -1)
+        target ||= ''
+        base_dir = File.absolute_path(File.join(source_dir, *dir))
+        paths = with_cache [:requireable_paths, base_dir] do
+          requireable_paths(base_dir)
+        end
+        paths.filter_map do |path|
+          [*dir, path].join('/') if path.start_with?(target)
+        end
+      end
+
+      private
+
+      def with_cache(key)
+        @cache ||= {}
+        @cache[key] ||= yield
+      end
+
+      def gem_paths
+        return [] unless defined?(Gem::Specification)
+
+        Gem::Specification.latest_specs(true).flat_map do |spec|
+          spec.require_paths.map do |path|
+            File.absolute_path?(path) ? path : File.join(spec.full_gem_path, path)
+          end
+        end
+      end
+
+      def gem_and_system_load_paths
+        @gem_and_system_load_paths ||= (gem_paths | $LOAD_PATH).filter_map do |path|
+          if path.respond_to?(:to_path)
+            path.to_path
+          else
+            String(path) rescue nil
+          end
+        end.sort
+      end
+
+      def requireable_paths(base_dir)
+        ext = ".{rb,#{RbConfig::CONFIG['DLEXT']}}"
+        ext_regexp = /\.(rb|#{RbConfig::CONFIG['DLEXT']})\z/
+        files = Dir.glob(["*#{ext}", "*/*#{ext}"], base: base_dir).map { |p| p.sub(ext_regexp, '') }
+        dirs = Dir.glob('*/*', base: base_dir).filter_map do |path|
+          "#{path}/" if File.directory?(File.join(base_dir, path))
+        end
+        (files + dirs).sort
+      rescue Errno::EPERM
+        []
+      end
+    end
+  end
+end

data/lib/repl_type_completor/result.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require_relative 'require_paths'
+
+module ReplTypeCompletor
+  class Result
+    HIDDEN_METHODS = %w[Namespace TypeName] # defined by rbs, should be hidden
+    RESERVED_WORDS = %w[
+      __ENCODING__ __LINE__ __FILE__
+      BEGIN END
+      alias and
+      begin break
+      case class
+      def defined? do
+      else elsif end ensure
+      false for
+      if in
+      module
+      next nil not
+      or
+      redo rescue retry return
+      self super
+      then true
+      undef unless until
+      when while
+      yield
+    ]
+
+    def initialize(analyze_result, binding, source_file)
+      @analyze_result = analyze_result
+      @binding = binding
+      @source_file = source_file
+    end
+
+    def completion_candidates
+      verbose, $VERBOSE = $VERBOSE, nil
+      candidates = case @analyze_result
+      in [:require, name]
+        RequirePaths.require_completions(name)
+      in [:require_relative, name]
+        RequirePaths.require_relative_completions(name, @source_file)
+      in [:call_or_const, name, type, self_call]
+        ((self_call ? type.all_methods : type.methods).map(&:to_s) - HIDDEN_METHODS) | type.constants
+      in [:const, name, type, scope]
+        if type
+          scope_constants = type.types.flat_map do |t|
+            scope.table_module_constants(t.module_or_class) if t.is_a?(Types::SingletonType)
+          end
+          (scope_constants.compact | type.constants.map(&:to_s)).sort
+        else
+          scope.constants.sort | RESERVED_WORDS
+        end
+      in [:ivar, name, scope]
+        ivars = scope.instance_variables.sort
+        name == '@' ? ivars + scope.class_variables.sort : ivars
+      in [:cvar, name, scope]
+        scope.class_variables
+      in [:gvar, name, scope]
+        scope.global_variables
+      in [:symbol, name]
+        Symbol.all_symbols.map { _1.inspect[1..] }
+      in [:call, name, type, self_call]
+        (self_call ? type.all_methods : type.methods).map(&:to_s) - HIDDEN_METHODS
+      in [:lvar_or_method, name, scope]
+        scope.self_type.all_methods.map(&:to_s) | scope.local_variables | RESERVED_WORDS
+      else
+        []
+      end
+      candidates.select { _1.start_with?(name) }.map { _1[name.size..] }
+    rescue Exception => e
+      ReplTypeCompletor.handle_exception(e)
+      []
+    ensure
+      $VERBOSE = verbose
+    end
+
+    def doc_namespace(matched)
+      verbose, $VERBOSE = $VERBOSE, nil
+      case @analyze_result
+      in [:call_or_const, prefix, type, _self_call]
+        call_or_const_doc type, prefix + matched
+      in [:const, prefix, type, scope]
+        if type
+          call_or_const_doc type, prefix + matched
+        else
+          value_doc scope[prefix + matched]
+        end
+      in [:gvar, prefix, scope]
+        value_doc scope[prefix + matched]
+      in [:ivar, prefix, scope]
+        value_doc scope[prefix + matched]
+      in [:cvar, prefix, scope]
+        value_doc scope[prefix + matched]
+      in [:call, prefix, type, _self_call]
+        method_doc type, prefix + matched
+      in [:lvar_or_method, prefix, scope]
+        if scope.local_variables.include?(prefix + matched)
+          value_doc scope[prefix + matched]
+        else
+          method_doc scope.self_type, prefix + matched
+        end
+      else
+      end
+    rescue Exception => e
+      ReplTypeCompletor.handle_exception(e)
+      nil
+    ensure
+      $VERBOSE = verbose
+    end
+
+    private
+
+    def method_doc(type, name)
+      type = type.types.find { _1.all_methods.include? name.to_sym }
+      case type
+      when Types::SingletonType
+        "#{Types.class_name_of(type.module_or_class)}.#{name}"
+      when Types::InstanceType
+        "#{Types.class_name_of(type.klass)}##{name}"
+      end
+    end
+
+    def call_or_const_doc(type, name)
+      if name =~ /\A[A-Z]/
+        type = type.types.grep(Types::SingletonType).find { _1.module_or_class.const_defined?(name) }
+        type.module_or_class == Object ? name : "#{Types.class_name_of(type.module_or_class)}::#{name}" if type
+      else
+        method_doc(type, name)
+      end
+    end
+
+    def value_doc(type)
+      return unless type
+      type.types.each do |t|
+        case t
+        when Types::SingletonType
+          return Types.class_name_of(t.module_or_class)
+        when Types::InstanceType
+          return Types.class_name_of(t.klass)
+        end
+      end
+      nil
+    end
+  end
+end