solargraph 0.32.5 → 0.33.0

data/lib/solargraph/yard_map.rb

@@ -8,6 +8,7 @@ module Solargraph
     autoload :Cache,    'solargraph/yard_map/cache'
     autoload :CoreDocs, 'solargraph/yard_map/core_docs'
     autoload :CoreGen,  'solargraph/yard_map/core_gen'
+    autoload :Mapper,   'solargraph/yard_map/mapper'
 
     CoreDocs.require_minimum
     @@stdlib_yardoc = CoreDocs.yardoc_stdlib_file
@@ -88,12 +89,8 @@ module Solargraph
     # @return [Array<Solargraph::Pin::Base>]
     def core_pins
       @@core_pins ||= begin
-        result = []
         load_yardoc CoreDocs.yardoc_file
-        YARD::Registry.each do |o|
-          result.concat generate_pins(o)
-        end
-        result
+        Mapper.new(YARD::Registry.all).map
       end
     end
 
@@ -103,6 +100,23 @@ module Solargraph
       pins.select{ |p| p.path == path }.first
     end
 
+    # Get the location of a file referenced by a require path.
+    #
+    # @param path [String]
+    # @return [Location]
+    def require_reference path
+      # @type [Gem::Specification]
+      spec = Gem::Specification.find_by_path(path) || Gem::Specification.find_by_name(path.split('/').first)
+      spec.full_require_paths.each do |rp|
+        file = File.join(rp, "#{path}.rb")
+        next unless File.file?(file)
+        return Solargraph::Location.new(file, Solargraph::Range.from_to(0, 0, 0, 0))
+      end
+      nil
+    rescue Gem::LoadError
+      nil
+    end
+
     private
 
     # @return [YardMap::Cache]
@@ -111,54 +125,16 @@ module Solargraph
     end
 
     # @param ns [YARD::CodeObjects::Namespace]
-    # @return [Array<Solargraph::Pin::Base>]
+    # @return [Array<YARD::CodeObjects::Base>]
     def recurse_namespace_object ns
       result = []
       ns.children.each do |c|
-        result.concat generate_pins(c)
+        result.push c
         result.concat recurse_namespace_object(c) if c.respond_to?(:children)
       end
       result
     end
 
-    # @param code_object [YARD::CodeObjects::Base]
-    # @return [Solargraph::Pin::Base]
-    def generate_pins code_object, spec = nil
-      result = []
-      location = object_location(code_object, spec)
-      if code_object.is_a?(YARD::CodeObjects::NamespaceObject)
-        result.push Solargraph::Pin::YardPin::Namespace.new(code_object, location)
-        if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
-          # @todo This method of superclass detection is a bit of a hack. If
-          #   the superclass is a Proxy, it is assumed to be undefined in its
-          #   yardoc and converted to a fully qualified namespace.
-          if code_object.superclass.is_a?(YARD::CodeObjects::Proxy)
-            superclass = "::#{code_object.superclass}"
-          else
-            superclass = code_object.superclass.to_s
-          end
-          result.push Solargraph::Pin::Reference::Superclass.new(location, code_object.path, superclass)
-        end
-        code_object.class_mixins.each do |m|
-          result.push Solargraph::Pin::Reference::Extend.new(location, code_object.path, m.path)
-        end
-        code_object.instance_mixins.each do |m|
-          result.push Solargraph::Pin::Reference::Include.new(location, code_object.path, m.path)
-        end
-      elsif code_object.is_a?(YARD::CodeObjects::MethodObject)
-        if code_object.name == :initialize && code_object.scope == :instance
-          # @todo Check the visibility of <Class>.new
-          result.push Solargraph::Pin::YardPin::Method.new(code_object, location, 'new', :class, :public)
-          result.push Solargraph::Pin::YardPin::Method.new(code_object, location, 'initialize', :instance, :private)
-        else
-          result.push Solargraph::Pin::YardPin::Method.new(code_object, location)
-        end
-      elsif code_object.is_a?(YARD::CodeObjects::ConstantObject)
-        result.push Solargraph::Pin::YardPin::Constant.new(code_object, location)
-      end
-      result
-    end
-
     # @return [void]
     def process_requires
       pins.clear
@@ -222,8 +198,9 @@ module Solargraph
           objects.each do |ns|
             next if done.include?(ns.path)
             done.push ns.path
-            result.concat generate_pins(ns)
-            result.concat recurse_namespace_object(ns)
+            all = [ns]
+            all.concat recurse_namespace_object(ns)
+            result.concat Mapper.new(all).map
           end
           result.delete_if(&:nil?)
           cache.set_path_pins(r, result) unless result.empty?
@@ -270,29 +247,8 @@ module Solargraph
         Solargraph::Logging.logger.warn "Yardoc at #{y} is too large to process (#{size} bytes)"
         return []
       end
-      result = []
       load_yardoc y
-      YARD::Registry.each do |o|
-        result.concat generate_pins(o, spec)
-      end
-      result
-    end
-
-    # @param obj [YARD::CodeObjects::Base]
-    # @return [Solargraph::Location]
-    def object_location obj, spec = nil
-      @object_file_cache ||= {}
-      return nil if spec.nil? || obj.file.nil? || obj.line.nil?
-      file = nil
-      if @object_file_cache.key?(obj.file)
-        file = @object_file_cache[obj.file]
-      else
-        tmp = File.join(spec.full_gem_path, obj.file)
-        file = tmp if File.exist?(tmp)
-        @object_file_cache[obj.file] = file
-      end
-      return nil if file.nil?
-      Solargraph::Location.new(file, Solargraph::Range.from_to(obj.line - 1, 0, obj.line - 1, 0))
+      Mapper.new(YARD::Registry.all, spec).map
     end
   end
 end

data/lib/solargraph/yard_map/core_docs.rb

@@ -122,10 +122,15 @@ module Solargraph
         def download version
           FileUtils.mkdir_p cache_dir
           uri = URI.parse("#{SOURCE}/#{version}.tar.gz")
+          # @type [Net::HTTPResponse]
           response = Net::HTTP.get_response(uri)
-          zipfile = File.join(cache_dir, "#{version}.tar.gz")
-          File.binwrite zipfile, response.body
-          install_archive zipfile
+          if response.code == '404'
+            raise ArgumentError, "Version #{version} is not available from #{SOURCE}"
+          else
+            zipfile = File.join(cache_dir, "#{version}.tar.gz")
+            File.binwrite zipfile, response.body
+            install_archive zipfile
+          end
         end
 
         # Reset the core documentation cache to the minimum requirement.

data/lib/solargraph/yard_map/core_gen.rb

@@ -19,12 +19,10 @@ module Solargraph
           path_name = Pathname.new(Dir.pwd).join(dest_dir).to_s
           FileUtils.mkdir_p path_name
           Dir.chdir(ruby_dir) do
-            `yardoc --plugin coregen -b "#{File.join(path_name, 'yardoc')}" -n *.c`
+            `yardoc -b "#{File.join(path_name, 'yardoc')}" -n *.c`
             raise 'An error occurred generating the core yardoc.' unless $?.success?
-            # YARD::CLI::Yardoc.run('--plugin', 'coregen', '-b', "#{File.join(path_name, 'yardoc')}", '-n', File.join(ruby_dir, '*.c'))
             `yardoc -b "#{File.join(path_name, 'yardoc-stdlib')}" -n lib ext`
             raise 'An error occurred generating the stdlib yardoc.' unless $?.success?
-            # YARD::CLI::Yardoc.run('-b', "#{File.join(path_name, 'yardoc-stdlib')}", '-n', File.join(ruby_dir, 'lib', '**', '*.rb'), File.join(ruby_dir, 'ext', '**', '*.c'), File.join(ruby_dir, 'ext', '**', '*.rb'))
           end
         end
 

data/lib/solargraph/yard_map/mapper.rb

@@ -0,0 +1,85 @@
+module Solargraph
+  class YardMap
+    class Mapper
+      # @param code_objects [Array<YARD::CodeObject::Base>]
+      # @param spec [Gem::Specification]
+      def initialize code_objects, spec = nil
+        @code_objects = code_objects
+        @spec = spec
+        @pins = []
+        @namespace_pins = {}
+      end
+
+      # @return [Array<Pin::Base>]
+      def map
+        @code_objects.each do |co|
+          @pins.concat generate_pins co
+        end
+        @pins
+      end
+
+      # @param code_object [YARD::CodeObjects::Base]
+      # @return [Array<Pin::Base>]
+      def generate_pins code_object
+        result = []
+        location = object_location(code_object, @spec)
+        if code_object.is_a?(YARD::CodeObjects::NamespaceObject)
+          nspin = Solargraph::Pin::YardPin::Namespace.new(code_object, location)
+          @namespace_pins[code_object.path] = nspin
+          result.push nspin
+          if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
+            # This method of superclass detection is a bit of a hack. If
+            # the superclass is a Proxy, it is assumed to be undefined in its
+            # yardoc and converted to a fully qualified namespace.
+            if code_object.superclass.is_a?(YARD::CodeObjects::Proxy)
+              superclass = "::#{code_object.superclass}"
+            else
+              superclass = code_object.superclass.to_s
+            end
+            result.push Solargraph::Pin::Reference::Superclass.new(location: location, name: superclass, closure: nspin)
+          end
+          code_object.class_mixins.each do |m|
+            result.push Solargraph::Pin::Reference::Extend.new(location: location, closure: nspin, name: m.path)
+          end
+          code_object.instance_mixins.each do |m|
+            result.push Solargraph::Pin::Reference::Include.new(
+              location: location,
+              closure: nspin, # @todo Fix this
+              name: m.path
+            )
+          end
+        elsif code_object.is_a?(YARD::CodeObjects::MethodObject)
+          closure = @namespace_pins[code_object.namespace.to_s]
+          if code_object.name == :initialize && code_object.scope == :instance
+            # @todo Check the visibility of <Class>.new
+            result.push Solargraph::Pin::YardPin::Method.new(code_object, location, 'new', :class, :public, closure)
+            result.push Solargraph::Pin::YardPin::Method.new(code_object, location, 'initialize', :instance, :private, closure)
+          else
+            result.push Solargraph::Pin::YardPin::Method.new(code_object, location, nil, nil, nil, closure)
+          end
+        elsif code_object.is_a?(YARD::CodeObjects::ConstantObject)
+          closure = @namespace_pins[code_object.namespace]
+          result.push Solargraph::Pin::YardPin::Constant.new(code_object, location, closure)
+        end
+        result
+      end
+
+      # @param obj [YARD::CodeObjects::Base]
+      # @return [Solargraph::Location, nil]
+      def object_location obj, spec = nil
+        @object_file_cache ||= {}
+        return nil if spec.nil? || obj.file.nil? || obj.line.nil?
+        file = nil
+        if @object_file_cache.key?(obj.file)
+          file = @object_file_cache[obj.file]
+        else
+          tmp = File.join(spec.full_gem_path, obj.file)
+          file = tmp if File.exist?(tmp)
+          @object_file_cache[obj.file] = file
+        end
+        return nil if file.nil?
+        Solargraph::Location.new(file, Solargraph::Range.from_to(obj.line - 1, 0, obj.line - 1, 0))
+      end
+    end
+  end
+end

data/lib/yard-solargraph.rb

@@ -16,3 +16,5 @@ YARD::Tags::Library.define_tag("Yieldself", :yieldself, :with_types)
 YARD::Tags::Library.define_tag("Yieldpublic", :yieldpublic, :with_types)
 # Define a @!domain directive for documenting DSLs
 YARD::Tags::Library.define_directive("domain", :with_types, Solargraph::DomainDirective)
+# Define an @!override directive for overriding method tags
+YARD::Tags::Library.define_directive("override", :with_name, Solargraph::DomainDirective)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.32.5
+  version: 0.33.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-31 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -269,7 +269,7 @@ files:
 - lib/solargraph/diagnostics/rubocop.rb
 - lib/solargraph/diagnostics/rubocop_helpers.rb
 - lib/solargraph/diagnostics/severities.rb
-- lib/solargraph/diagnostics/type_not_defined.rb
+- lib/solargraph/diagnostics/type_check.rb
 - lib/solargraph/diagnostics/update_errors.rb
 - lib/solargraph/language_server.rb
 - lib/solargraph/language_server/completion_item_kinds.rb
@@ -301,6 +301,7 @@ files:
 - lib/solargraph/language_server/message/shutdown.rb
 - lib/solargraph/language_server/message/text_document.rb
 - lib/solargraph/language_server/message/text_document/base.rb
+- lib/solargraph/language_server/message/text_document/code_action.rb
 - lib/solargraph/language_server/message/text_document/completion.rb
 - lib/solargraph/language_server/message/text_document/definition.rb
 - lib/solargraph/language_server/message/text_document/did_change.rb
@@ -329,8 +330,6 @@ files:
 - lib/solargraph/language_server/transport/data_reader.rb
 - lib/solargraph/language_server/uri_helpers.rb
 - lib/solargraph/library.rb
-- lib/solargraph/live_map.rb
-- lib/solargraph/live_map/cache.rb
 - lib/solargraph/location.rb
 - lib/solargraph/logging.rb
 - lib/solargraph/page.rb
@@ -340,8 +339,9 @@ files:
 - lib/solargraph/pin/base_method.rb
 - lib/solargraph/pin/base_variable.rb
 - lib/solargraph/pin/block.rb
-- lib/solargraph/pin/block_parameter.rb
 - lib/solargraph/pin/class_variable.rb
+- lib/solargraph/pin/closure.rb
+- lib/solargraph/pin/common.rb
 - lib/solargraph/pin/constant.rb
 - lib/solargraph/pin/conversions.rb
 - lib/solargraph/pin/documenting.rb
@@ -353,26 +353,22 @@ files:
 - lib/solargraph/pin/localized.rb
 - lib/solargraph/pin/method.rb
 - lib/solargraph/pin/method_alias.rb
-- lib/solargraph/pin/method_parameter.rb
 - lib/solargraph/pin/namespace.rb
-- lib/solargraph/pin/plugin/method.rb
+- lib/solargraph/pin/parameter.rb
 - lib/solargraph/pin/proxy_type.rb
 - lib/solargraph/pin/reference.rb
 - lib/solargraph/pin/reference/extend.rb
 - lib/solargraph/pin/reference/include.rb
+- lib/solargraph/pin/reference/override.rb
 - lib/solargraph/pin/reference/require.rb
 - lib/solargraph/pin/reference/superclass.rb
+- lib/solargraph/pin/singleton.rb
 - lib/solargraph/pin/symbol.rb
 - lib/solargraph/pin/yard_pin.rb
 - lib/solargraph/pin/yard_pin/constant.rb
 - lib/solargraph/pin/yard_pin/method.rb
 - lib/solargraph/pin/yard_pin/namespace.rb
 - lib/solargraph/pin/yard_pin/yard_mixin.rb
-- lib/solargraph/plugin.rb
-- lib/solargraph/plugin/base.rb
-- lib/solargraph/plugin/canceler.rb
-- lib/solargraph/plugin/process.rb
-- lib/solargraph/plugin/runtime.rb
 - lib/solargraph/position.rb
 - lib/solargraph/range.rb
 - lib/solargraph/server_methods.rb
@@ -415,10 +411,14 @@ files:
 - lib/solargraph/source_map/node_processor/lvasgn_node.rb
 - lib/solargraph/source_map/node_processor/namespace_node.rb
 - lib/solargraph/source_map/node_processor/orasgn_node.rb
+- lib/solargraph/source_map/node_processor/resbody_node.rb
 - lib/solargraph/source_map/node_processor/sclass_node.rb
 - lib/solargraph/source_map/node_processor/send_node.rb
 - lib/solargraph/source_map/node_processor/sym_node.rb
 - lib/solargraph/source_map/region.rb
+- lib/solargraph/type_checker.rb
+- lib/solargraph/type_checker/param_def.rb
+- lib/solargraph/type_checker/problem.rb
 - lib/solargraph/version.rb
 - lib/solargraph/views/_method.erb
 - lib/solargraph/views/_name_type_tag.erb
@@ -433,7 +433,7 @@ files:
 - lib/solargraph/yard_map/cache.rb
 - lib/solargraph/yard_map/core_docs.rb
 - lib/solargraph/yard_map/core_gen.rb
-- lib/yard-coregen.rb
+- lib/solargraph/yard_map/mapper.rb
 - lib/yard-solargraph.rb
 - solargraph.gemspec
 - travis-bundler.rb

data/lib/solargraph/diagnostics/type_not_defined.rb

@@ -1,108 +0,0 @@
-module Solargraph
-  module Diagnostics
-    # TypeNotDefined reports methods with undefined return types, untagged
-    # parameters, and invalid param tags.
-    #
-    class TypeNotDefined < Base
-      def diagnose source, api_map
-        result = []
-        api_map.document_symbols(source.filename).each do |pin|
-          next unless pin.kind == Pin::METHOD or pin.kind == Pin::ATTRIBUTE
-          result.concat check_return_type(pin, api_map, source)
-          result.concat check_param_types(pin, api_map, source)
-          result.concat check_param_tags(pin, api_map, source)
-        end
-        result
-      end
-
-      private
-
-      def check_return_type pin, api_map, source
-        return [] if (pin.name == 'initialize' && pin.scope == :instance) || (pin.name == 'new' && pin.scope == :class)
-        result = []
-        unless defined_return_type?(pin, api_map)
-          result.push(
-            range: extract_first_line(pin, source),
-            severity: Diagnostics::Severities::WARNING,
-            source: 'Solargraph',
-            message: "Method `#{pin.name}` has undefined return type."
-          )
-        end
-        result
-      end
-
-      def check_param_types pin, api_map, source
-        return [] if pin.name == 'new' and pin.scope == :class
-        result = []
-        pin.parameter_names.each do |par|
-          next if defined_param_type?(pin, par, api_map)
-          result.push(
-            range: extract_first_line(pin, source),
-            severity: Diagnostics::Severities::WARNING,
-            source: 'Solargraph',
-            message: "Method `#{pin.name}` has undefined param `#{par}`."
-          )
-        end
-        result
-      end
-
-      def check_param_tags pin, api_map, source
-        result = []
-        pin.docstring.tags(:param).each do |par|
-          next if pin.parameter_names.include?(par.name)
-          result.push(
-            range: extract_first_line(pin, source),
-            severity: Diagnostics::Severities::WARNING,
-            source: 'Solargraph',
-            message: "Method `#{pin.name}` has mistagged param `#{par.name}`."
-          )
-        end
-        result
-      end
-
-      def extract_first_line pin, source
-        {
-          start: {
-            line: pin.location.range.start.line,
-            character: pin.location.range.start.character
-          },
-          end: {
-            line: pin.location.range.start.line,
-            character: last_character(pin.location.range.start, source)
-          }
-        }
-      end
-
-      def defined_return_type? pin, api_map
-        return true unless pin.return_complex_type.undefined?
-        matches = api_map.get_method_stack(pin.namespace, pin.name, scope: pin.scope)
-        matches.shift
-        matches.any?{|m| !m.return_complex_type.undefined?}
-      end
-
-      def defined_param_type? pin, param, api_map
-        return true if param_in_docstring?(param, pin.docstring)
-        matches = api_map.get_method_stack(pin.namespace, pin.name, scope: pin.scope)
-        matches.shift
-        matches.each do |m|
-          next unless pin.parameter_names == m.parameter_names
-          return true if param_in_docstring?(param, m.docstring)
-        end
-        false
-      end
-
-      def param_in_docstring? param, docstring
-        tags = docstring.tags(:param)
-        tags.any?{|t| t.name == param}
-      end
-
-      # @param position [Solargraph::Position]
-      # @param source [Solargraph::Source]
-      # @return [Integer]
-      def last_character position, source
-        cursor = Position.to_offset(source.code, position)
-        source.code.index(/[\r\n]/, cursor) || source.code.length
-      end
-    end
-  end
-end