irb 1.8.1 → 1.9.0

data/lib/irb/type_completion/completor.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+require 'prism'
+require 'irb/completion'
+require_relative 'type_analyzer'
+
+module IRB
+  module TypeCompletion
+    class Completor < BaseCompletor # :nodoc:
+      HIDDEN_METHODS = %w[Namespace TypeName] # defined by rbs, should be hidden
+
+      class << self
+        attr_accessor :last_completion_error
+      end
+
+      def inspect
+        name = 'TypeCompletion::Completor'
+        prism_info = "Prism: #{Prism::VERSION}"
+        if Types.rbs_builder
+          "#{name}(#{prism_info}, RBS: #{RBS::VERSION})"
+        elsif Types.rbs_load_error
+          "#{name}(#{prism_info}, RBS: #{Types.rbs_load_error.inspect})"
+        else
+          "#{name}(#{prism_info}, RBS: loading)"
+        end
+      end
+
+      def completion_candidates(preposing, target, _postposing, bind:)
+        @preposing = preposing
+        verbose, $VERBOSE = $VERBOSE, nil
+        code = "#{preposing}#{target}"
+        @result = analyze code, bind
+        name, candidates = candidates_from_result(@result)
+
+        all_symbols_pattern = /\A[ -\/:-@\[-`\{-~]*\z/
+        candidates.map(&:to_s).select { !_1.match?(all_symbols_pattern) && _1.start_with?(name) }.uniq.sort.map do
+          target + _1[name.size..]
+        end
+      rescue SyntaxError, StandardError => e
+        Completor.last_completion_error = e
+        handle_error(e)
+        []
+      ensure
+        $VERBOSE = verbose
+      end
+
+      def doc_namespace(preposing, matched, postposing, bind:)
+        name = matched[/[a-zA-Z_0-9]*[!?=]?\z/]
+        method_doc = -> type do
+          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
+        call_or_const_doc = -> type do
+          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.call(type)
+          end
+        end
+
+        value_doc = -> type do
+          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
+
+        case @result
+        in [:call_or_const, type, _name, _self_call]
+          call_or_const_doc.call type
+        in [:const, type, _name, scope]
+          if type
+            call_or_const_doc.call type
+          else
+            value_doc.call scope[name]
+          end
+        in [:gvar, _name, scope]
+          value_doc.call scope["$#{name}"]
+        in [:ivar, _name, scope]
+          value_doc.call scope["@#{name}"]
+        in [:cvar, _name, scope]
+          value_doc.call scope["@@#{name}"]
+        in [:call, type, _name, _self_call]
+          method_doc.call type
+        in [:lvar_or_method, _name, scope]
+          if scope.local_variables.include?(name)
+            value_doc.call scope[name]
+          else
+            method_doc.call scope.self_type
+          end
+        else
+        end
+      end
+
+      def candidates_from_result(result)
+        candidates = case result
+        in [:require, name]
+          retrieve_files_to_require_from_load_path
+        in [:require_relative, name]
+          retrieve_files_to_require_relative_from_current_dir
+        in [:call_or_const, type, name, self_call]
+          ((self_call ? type.all_methods : type.methods).map(&:to_s) - HIDDEN_METHODS) | type.constants
+        in [:const, type, name, 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 | ReservedWords
+          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, type, name, 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 | ReservedWords
+        else
+          []
+        end
+        [name || '', candidates]
+      end
+
+      def analyze(code, binding = Object::TOPLEVEL_BINDING)
+        # Workaround for https://github.com/ruby/prism/issues/1592
+        return if code.match?(/%[qQ]\z/)
+
+        ast = Prism.parse(code, scopes: [binding.local_variables]).value
+        name = code[/(@@|@|\$)?\w*[!?=]?\z/]
+        *parents, target_node = find_target ast, code.bytesize - name.bytesize
+        return unless target_node
+
+        calculate_scope = -> { TypeAnalyzer.calculate_target_type_scope(binding, parents, target_node).last }
+        calculate_type_scope = ->(node) { TypeAnalyzer.calculate_target_type_scope binding, [*parents, target_node], node }
+
+        case target_node
+        when Prism::StringNode, Prism::InterpolatedStringNode
+          call_node, args_node = parents.last(2)
+          return unless call_node.is_a?(Prism::CallNode) && call_node.receiver.nil?
+          return unless args_node.is_a?(Prism::ArgumentsNode) && args_node.arguments.size == 1
+
+          case call_node.name
+          when :require
+            [:require, name.rstrip]
+          when :require_relative
+            [:require_relative, name.rstrip]
+          end
+        when Prism::SymbolNode
+          if parents.last.is_a? Prism::BlockArgumentNode # method(&:target)
+            receiver_type, _scope = calculate_type_scope.call target_node
+            [:call, receiver_type, name, false]
+          else
+            [:symbol, name] unless name.empty?
+          end
+        when Prism::CallNode
+          return [:lvar_or_method, name, calculate_scope.call] if target_node.receiver.nil?
+
+          self_call = target_node.receiver.is_a? Prism::SelfNode
+          op = target_node.call_operator
+          receiver_type, _scope = calculate_type_scope.call target_node.receiver
+          receiver_type = receiver_type.nonnillable if op == '&.'
+          [op == '::' ? :call_or_const : :call, receiver_type, name, self_call]
+        when Prism::LocalVariableReadNode, Prism::LocalVariableTargetNode
+          [:lvar_or_method, name, calculate_scope.call]
+        when Prism::ConstantReadNode, Prism::ConstantTargetNode
+          if parents.last.is_a? Prism::ConstantPathNode
+            path_node = parents.last
+            if path_node.parent # A::B
+              receiver, scope = calculate_type_scope.call(path_node.parent)
+              [:const, receiver, name, scope]
+            else # ::A
+              scope = calculate_scope.call
+              [:const, Types::SingletonType.new(Object), name, scope]
+            end
+          else
+            [:const, nil, name, calculate_scope.call]
+          end
+        when Prism::GlobalVariableReadNode, Prism::GlobalVariableTargetNode
+          [:gvar, name, calculate_scope.call]
+        when Prism::InstanceVariableReadNode, Prism::InstanceVariableTargetNode
+          [:ivar, name, calculate_scope.call]
+        when Prism::ClassVariableReadNode, Prism::ClassVariableTargetNode
+          [:cvar, name, calculate_scope.call]
+        end
+      end
+
+      def find_target(node, position)
+        location = (
+          case node
+          when Prism::CallNode
+            node.message_loc
+          when Prism::SymbolNode
+            node.value_loc
+          when Prism::StringNode
+            node.content_loc
+          when Prism::InterpolatedStringNode
+            node.closing_loc if node.parts.empty?
+          end
+        )
+        return [node] if location&.start_offset == position
+
+        node.compact_child_nodes.each do |n|
+          match = find_target(n, position)
+          next unless match
+          match.unshift node
+          return match
+        end
+
+        [node] if node.location.start_offset == position
+      end
+
+      def handle_error(e)
+      end
+    end
+  end
+end

data/lib/irb/type_completion/methods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IRB
+  module TypeCompletion
+    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
+end

data/lib/irb/type_completion/scope.rb

@@ -0,0 +1,412 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative 'types'
+
+module IRB
+  module TypeCompletion
+
+    class RootScope
+      attr_reader :module_nesting, :self_object
+
+      def initialize(binding, self_object, local_variables)
+        @binding = binding
+        @self_object = self_object
+        @cache = {}
+        modules = [*binding.eval('::Module.nesting'), Object]
+        @module_nesting = modules.map { [_1, []] }
+        binding_local_variables = binding.local_variables
+        uninitialized_locals = local_variables - binding_local_variables
+        uninitialized_locals.each { @cache[_1] = Types::NIL }
+        @local_variables = (local_variables | binding_local_variables).map(&:to_s).to_set
+        @global_variables = Kernel.global_variables.map(&:to_s).to_set
+        @owned_constants_cache = {}
+      end
+
+      def level() = 0
+
+      def level_of(_name, _var_type) = 0
+
+      def mutable?() = false
+
+      def module_own_constant?(mod, name)
+        set = (@owned_constants_cache[mod] ||= Set.new(mod.constants.map(&:to_s)))
+        set.include? name
+      end
+
+      def get_const(nesting, path, _key = nil)
+        return unless nesting
+
+        result = path.reduce nesting do |mod, name|
+          return nil unless mod.is_a?(Module) && module_own_constant?(mod, name)
+          mod.const_get name
+        end
+        Types.type_from_object result
+      end
+
+      def get_cvar(nesting, path, name, _key = nil)
+        return Types::NIL unless nesting
+
+        result = path.reduce nesting do |mod, n|
+          return Types::NIL unless mod.is_a?(Module) && module_own_constant?(mod, n)
+          mod.const_get n
+        end
+        value = result.class_variable_get name if result.is_a?(Module) && name.size >= 3 && result.class_variable_defined?(name)
+        Types.type_from_object value
+      end
+
+      def [](name)
+        @cache[name] ||= (
+          value = case RootScope.type_by_name name
+          when :ivar
+            begin
+              Methods::OBJECT_INSTANCE_VARIABLE_GET_METHOD.bind_call(@self_object, name)
+            rescue NameError
+            end
+          when :lvar
+            begin
+              @binding.local_variable_get(name)
+            rescue NameError
+            end
+          when :gvar
+            @binding.eval name if @global_variables.include? name
+          end
+          Types.type_from_object(value)
+        )
+      end
+
+      def self_type
+        Types.type_from_object @self_object
+      end
+
+      def local_variables() = @local_variables.to_a
+
+      def global_variables() = @global_variables.to_a
+
+      def self.type_by_name(name)
+        if name.start_with? '@@'
+          # "@@cvar" or "@@cvar::[module_id]::[module_path]"
+          :cvar
+        elsif name.start_with? '@'
+          :ivar
+        elsif name.start_with? '$'
+          :gvar
+        elsif name.start_with? '%'
+          :internal
+        elsif name[0].downcase != name[0] || name[0].match?(/\d/)
+          # "ConstName" or "[module_id]::[const_path]"
+          :const
+        else
+          :lvar
+        end
+      end
+    end
+
+    class Scope
+      BREAK_RESULT = '%break'
+      NEXT_RESULT = '%next'
+      RETURN_RESULT = '%return'
+      PATTERNMATCH_BREAK = '%match'
+
+      attr_reader :parent, :mergeable_changes, :level, :module_nesting
+
+      def self.from_binding(binding, locals) = new(RootScope.new(binding, binding.receiver, locals))
+
+      def initialize(parent, table = {}, trace_ivar: true, trace_lvar: true, self_type: nil, nesting: nil)
+        @parent = parent
+        @level = parent.level + 1
+        @trace_ivar = trace_ivar
+        @trace_lvar = trace_lvar
+        @module_nesting = nesting ? [nesting, *parent.module_nesting] : parent.module_nesting
+        @self_type = self_type
+        @terminated = false
+        @jump_branches = []
+        @mergeable_changes = @table = table.transform_values { [level, _1] }
+      end
+
+      def mutable? = true
+
+      def terminated?
+        @terminated
+      end
+
+      def terminate_with(type, value)
+        return if terminated?
+        store_jump type, value, @mergeable_changes
+        terminate
+      end
+
+      def store_jump(type, value, changes)
+        return if terminated?
+        if has_own?(type)
+          changes[type] = [level, value]
+          @jump_branches << changes
+        elsif @parent.mutable?
+          @parent.store_jump(type, value, changes)
+        end
+      end
+
+      def terminate
+        return if terminated?
+        @terminated = true
+        @table = @mergeable_changes.dup
+      end
+
+      def trace?(name)
+        return false unless @parent
+        type = RootScope.type_by_name(name)
+        type == :ivar ? @trace_ivar : type == :lvar ? @trace_lvar : true
+      end
+
+      def level_of(name, var_type)
+        case var_type
+        when :ivar
+          return level unless @trace_ivar
+        when :gvar
+          return 0
+        end
+        variable_level, = @table[name]
+        variable_level || parent.level_of(name, var_type)
+      end
+
+      def get_const(nesting, path, key = nil)
+        key ||= [nesting.__id__, path].join('::')
+        _l, value = @table[key]
+        value || @parent.get_const(nesting, path, key)
+      end
+
+      def get_cvar(nesting, path, name, key = nil)
+        key ||= [name, nesting.__id__, path].join('::')
+        _l, value = @table[key]
+        value || @parent.get_cvar(nesting, path, name, key)
+      end
+
+      def [](name)
+        type = RootScope.type_by_name(name)
+        if type == :const
+          return get_const(nil, nil, name) || Types::NIL if name.include?('::')
+
+          module_nesting.each do |(nesting, path)|
+            value = get_const nesting, [*path, name]
+            return value if value
+          end
+          return Types::NIL
+        elsif type == :cvar
+          return get_cvar(nil, nil, nil, name) if name.include?('::')
+
+          nesting, path = module_nesting.first
+          return get_cvar(nesting, path, name)
+        end
+        level, value = @table[name]
+        if level
+          value
+        elsif trace? name
+          @parent[name]
+        elsif type == :ivar
+          self_instance_variable_get name
+        end
+      end
+
+      def set_const(nesting, path, value)
+        key = [nesting.__id__, path].join('::')
+        @table[key] = [0, value]
+      end
+
+      def set_cvar(nesting, path, name, value)
+        key = [name, nesting.__id__, path].join('::')
+        @table[key] = [0, value]
+      end
+
+      def []=(name, value)
+        type = RootScope.type_by_name(name)
+        if type == :const
+          if name.include?('::')
+            @table[name] = [0, value]
+          else
+            parent_module, parent_path = module_nesting.first
+            set_const parent_module, [*parent_path, name], value
+          end
+          return
+        elsif type == :cvar
+          if name.include?('::')
+            @table[name] = [0, value]
+          else
+            parent_module, parent_path = module_nesting.first
+            set_cvar parent_module, parent_path, name, value
+          end
+          return
+        end
+        variable_level = level_of name, type
+        @table[name] = [variable_level, value] if variable_level
+      end
+
+      def self_type
+        @self_type || @parent.self_type
+      end
+
+      def global_variables
+        gvar_keys = @table.keys.select do |name|
+          RootScope.type_by_name(name) == :gvar
+        end
+        gvar_keys | @parent.global_variables
+      end
+
+      def local_variables
+        lvar_keys = @table.keys.select do |name|
+          RootScope.type_by_name(name) == :lvar
+        end
+        lvar_keys |= @parent.local_variables if @trace_lvar
+        lvar_keys
+      end
+
+      def table_constants
+        constants = module_nesting.flat_map do |mod, path|
+          prefix = [mod.__id__, *path].join('::') + '::'
+          @table.keys.select { _1.start_with? prefix }.map { _1.delete_prefix(prefix).split('::').first }
+        end.uniq
+        constants |= @parent.table_constants if @parent.mutable?
+        constants
+      end
+
+      def table_module_constants(mod)
+        prefix = "#{mod.__id__}::"
+        constants = @table.keys.select { _1.start_with? prefix }.map { _1.delete_prefix(prefix).split('::').first }
+        constants |= @parent.table_constants if @parent.mutable?
+        constants
+      end
+
+      def base_scope
+        @parent.mutable? ? @parent.base_scope : @parent
+      end
+
+      def table_instance_variables
+        ivars = @table.keys.select { RootScope.type_by_name(_1) == :ivar }
+        ivars |= @parent.table_instance_variables if @parent.mutable? && @trace_ivar
+        ivars
+      end
+
+      def instance_variables
+        self_singleton_types = self_type.types.grep(Types::SingletonType)
+        singleton_classes = self_type.types.grep(Types::InstanceType).map(&:klass).select(&:singleton_class?)
+        base_self = base_scope.self_object
+        self_instance_variables = singleton_classes.flat_map do |singleton_class|
+          if singleton_class.respond_to? :attached_object
+            Methods::OBJECT_INSTANCE_VARIABLES_METHOD.bind_call(singleton_class.attached_object).map(&:to_s)
+          elsif singleton_class == Methods::OBJECT_SINGLETON_CLASS_METHOD.bind_call(base_self)
+            Methods::OBJECT_INSTANCE_VARIABLES_METHOD.bind_call(base_self).map(&:to_s)
+          else
+            []
+          end
+        end
+        [
+          self_singleton_types.flat_map { _1.module_or_class.instance_variables.map(&:to_s) },
+          self_instance_variables || [],
+          table_instance_variables
+        ].inject(:|)
+      end
+
+      def self_instance_variable_get(name)
+        self_objects = self_type.types.grep(Types::SingletonType).map(&:module_or_class)
+        singleton_classes = self_type.types.grep(Types::InstanceType).map(&:klass).select(&:singleton_class?)
+        base_self = base_scope.self_object
+        singleton_classes.each do |singleton_class|
+          if singleton_class.respond_to? :attached_object
+            self_objects << singleton_class.attached_object
+          elsif singleton_class == base_self.singleton_class
+            self_objects << base_self
+          end
+        end
+        types = self_objects.map do |object|
+          value = begin
+            Methods::OBJECT_INSTANCE_VARIABLE_GET_METHOD.bind_call(object, name)
+          rescue NameError
+          end
+          Types.type_from_object value
+        end
+        Types::UnionType[*types]
+      end
+
+      def table_class_variables
+        cvars = @table.keys.filter_map { _1.split('::', 2).first if RootScope.type_by_name(_1) == :cvar }
+        cvars |= @parent.table_class_variables if @parent.mutable?
+        cvars
+      end
+
+      def class_variables
+        cvars = table_class_variables
+        m, = module_nesting.first
+        cvars |= m.class_variables.map(&:to_s) if m.is_a? Module
+        cvars
+      end
+
+      def constants
+        module_nesting.flat_map do |nest,|
+          nest.constants
+        end.map(&:to_s) | table_constants
+      end
+
+      def merge_jumps
+        if terminated?
+          @terminated = false
+          @table = @mergeable_changes
+          merge @jump_branches
+          @terminated = true
+        else
+          merge [*@jump_branches, {}]
+        end
+      end
+
+      def conditional(&block)
+        run_branches(block, ->(_s) {}).first || Types::NIL
+      end
+
+      def never(&block)
+        block.call Scope.new(self, { BREAK_RESULT => nil, NEXT_RESULT => nil, PATTERNMATCH_BREAK => nil, RETURN_RESULT => nil })
+      end
+
+      def run_branches(*blocks)
+        results = []
+        branches = []
+        blocks.each do |block|
+          scope = Scope.new self
+          result = block.call scope
+          next if scope.terminated?
+          results << result
+          branches << scope.mergeable_changes
+        end
+        terminate if branches.empty?
+        merge branches
+        results
+      end
+
+      def has_own?(name)
+        @table.key? name
+      end
+
+      def update(child_scope)
+        current_level = level
+        child_scope.mergeable_changes.each do |name, (level, value)|
+          self[name] = value if level <= current_level
+        end
+      end
+
+      protected
+
+      def merge(branches)
+        current_level = level
+        merge = {}
+        branches.each do |changes|
+          changes.each do |name, (level, value)|
+            next if current_level < level
+            (merge[name] ||= []) << value
+          end
+        end
+        merge.each do |name, values|
+          values << self[name] unless values.size == branches.size
+          values.compact!
+          self[name] = Types::UnionType[*values.compact] unless values.empty?
+        end
+      end
+    end
+  end
+end