solargraph 0.27.1 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d239e2f354c236745db64f55ecd2f4c31de560aa8502a61713c185f455eca5a1
-  data.tar.gz: 468155f7ea49d42a1998bee42b0645af7ba3bbf533b14b20f42ada78ab5161a0
+  metadata.gz: 68af7d3f5b6fca0126629ca8ed363004b4c12d2d8ef50a0fc01a571c6459d4cc
+  data.tar.gz: 366bbc31b39be7794af1de27a6d63ee88771b22134622dbc6c4ffb146a227712
 SHA512:
-  metadata.gz: 56975c593fac1fb79cfdf9461c144e905858e7984aefa16996cba78afff282676f2102bf76ddf3909d89b37fbdf69605eac8d5a27305c0a519678e2000a52589
-  data.tar.gz: ed3d2636a8e52bfdc61ac804eedc8252a382f674b5cfd43c5da934e1d7e4a7ff268a5291af511309d4c35581458530ff6d26560ad8ab7f8ba81395d9274d77a8
+  metadata.gz: 6ffc365f1e42f0a9d17aa40f4721d5f753e94e6b24c0b8c72f43abfc583e740b6e289d7d1ec88b7388c837406e60d2cd1f0376c8c12f477eb3a7ea4de28d579d
+  data.tar.gz: d999e3ef14ca1ee00beec4c5eac3906f4c86faccfa9742e1451e85aada0a969d818393b22dbe2be887a9d0346f0ca26810243a49cb6b3b694cead4e81b91cc5c

data/lib/solargraph.rb

@@ -3,26 +3,16 @@ require 'solargraph/version'
 require 'rubygems/package'
 require 'yard-solargraph'
 
+# The top-level namespace for the Solargraph code mapping, documentation,
+# static analysis, and language server libraries.
+#
 module Solargraph
   class InvalidOffsetError <      RangeError;    end
   class DiagnosticsError <        RuntimeError;  end
   class FileNotFoundError <       RuntimeError;  end
   class SourceNotAvailableError < StandardError; end
   class ComplexTypeError        < StandardError; end
-  class WorkspaceTooLargeError <  RuntimeError
-    # @return [Integer]
-    attr_reader :size
-
-    # @return [Integer]
-    attr_reader :max
-
-    # @param size [Integer] The number of files included in the workspace
-    # @param max [Integer] The maximum number of files allowed
-    def initialize size, max
-      @size = size
-      @max = max
-    end
-  end
+  class WorkspaceTooLargeError <  RuntimeError;  end
 
   autoload :Position,         'solargraph/position'
   autoload :Range,            'solargraph/range'
@@ -45,9 +35,10 @@ module Solargraph
   autoload :ComplexType,      'solargraph/complex_type'
   autoload :Bundle,           'solargraph/bundle'
 
-  YARDOC_PATH = File.join(File.realpath(File.dirname(__FILE__)), '..', 'yardoc')
-  YARD_EXTENSION_FILE = File.join(File.realpath(File.dirname(__FILE__)), 'yard-solargraph.rb')
-  VIEWS_PATH = File.join(File.realpath(File.dirname(__FILE__)), 'solargraph', 'views')
+  dir = File.dirname(__FILE__)
+  YARDOC_PATH = File.realpath(File.join(dir, '..', 'yardoc'))
+  YARD_EXTENSION_FILE = File.join(dir, 'yard-solargraph.rb')
+  VIEWS_PATH = File.join(dir, 'solargraph', 'views')
 end
 
 Solargraph::YardMap::CoreDocs.require_minimum

data/lib/solargraph/api_map.rb

@@ -21,7 +21,6 @@ module Solargraph
     attr_reader :unresolved_requires
 
     # @param pins [Array<Solargraph::Pin::Base>]
-    # @param yard_map [YardMap]
     # def initialize workspace = Solargraph::Workspace.new(nil)
     def initialize pins: []
       # @todo Extensions don't work yet
@@ -297,6 +296,7 @@ module Solargraph
     #
     # @param type [Solargraph::ComplexType]
     # @param context [String]
+    # @param internal [Boolean] True to include private methods
     # @return [Array<Solargraph::Pin::Base>]
     def get_complex_type_methods type, context = '', internal = false
       return [] if type.undefined? || type.void?
@@ -305,6 +305,7 @@ module Solargraph
         type.select(&:duck_type?).each do |t|
           result.push Pin::DuckMethod.new(nil, t.tag[1..-1])
         end
+        result.concat get_methods('Object')
       else
         unless type.nil? || type.name == 'void'
           namespace = qualify(type.namespace, context)
@@ -480,7 +481,7 @@ module Solargraph
       return [] if skip.include?(reqstr)
       skip.push reqstr
       result = []
-      result.concat store.get_methods(fqns, scope: scope, visibility: visibility)
+      result.concat store.get_methods(fqns, scope: scope, visibility: visibility).sort{ |a, b| a.name <=> b.name }
       if deep
         sc = store.get_superclass(fqns)
         unless sc.nil?
@@ -520,7 +521,7 @@ module Solargraph
       return [] if skip.include?(fqns)
       skip.push fqns
       result = []
-      result.concat store.get_constants(fqns, visibility)
+      result.concat store.get_constants(fqns, visibility).sort{ |a, b| a.name <=> b.name }
       store.get_includes(fqns).each do |is|
         fqis = qualify(is, fqns)
         result.concat inner_get_constants(fqis, [:public], skip) unless fqis.nil?

data/lib/solargraph/api_map/cache.rb

@@ -74,11 +74,11 @@ module Solargraph
 
       # @return [Boolean]
       def empty?
-        @signature_types.empty? and
-          @assignment_node_types.empty? and
-          @methods.empty? and
-          @method_stacks.empty? and
-          @constants.empty? amd
+        @signature_types.empty? &&
+          @assignment_node_types.empty? &&
+          @methods.empty? &&
+          @method_stacks.empty? &&
+          @constants.empty? &&
           @qualified_namespaces.empty?
       end
     end

data/lib/solargraph/api_map/source_to_yard.rb

@@ -28,8 +28,9 @@ module Solargraph
             code_object_map[pin.path].files.push pin.location.filename unless pin.location.nil?
           end
           store.namespace_pins.each do |pin|
-            pin.include_references.each do |ref|
-              code_object_map[pin.path].instance_mixins.push code_object_map[ref.name] unless code_object_map[ref.name].nil? or code_object_map[pin.path].nil?
+            # pin.include_references.each do |ref|
+            store.get_includes(pin.path).each do |ref|
+              code_object_map[pin.path].instance_mixins.push code_object_map[ref] unless code_object_map[ref].nil? or code_object_map[pin.path].nil?
             end
           end
           store.method_pins.each do |pin|

data/lib/solargraph/api_map/store.rb

@@ -34,30 +34,20 @@ module Solargraph
       # @param fqns [String]
       # @return [String]
       def get_superclass fqns
-        fqns_pins(fqns).each do |pin|
-          return pin.superclass_reference.name unless pin.superclass_reference.nil?
-        end
+        return superclass_references[fqns].first if superclass_references.has_key?(fqns)
         nil
       end
 
       # @param fqns [String]
       # @return [Array<String>]
       def get_includes fqns
-        result = []
-        fqns_pins(fqns).each do |pin|
-          result.concat pin.include_references.map(&:name)
-        end
-        result
+        include_references[fqns] || []
       end
 
       # @param fqns [String]
       # @return [Array<String>]
       def get_extends fqns
-        result = []
-        fqns_pins(fqns).each do |pin|
-          result.concat pin.extend_references.map(&:name)
-        end
-        result
+        extend_references[fqns] || []
       end
 
       # @param path [String]
@@ -141,6 +131,18 @@ module Solargraph
         @symbols ||= []
       end
 
+      def superclass_references
+        @superclass_references ||= {}
+      end
+
+      def include_references
+        @include_references ||= {}
+      end
+
+      def extend_references
+        @extend_references ||= {}
+      end
+
       # @param name [String]
       # @return [Array<Solargraph::Pin::Namespace>]
       def namespace_children name
@@ -163,6 +165,16 @@ module Solargraph
           namespace_map[pin.namespace].push pin
           namespaces.add pin.path if pin.kind == Pin::NAMESPACE and !pin.path.empty?
           symbols.push pin if pin.kind == Pin::SYMBOL
+          if pin.kind == Pin::INCLUDE_REFERENCE
+            include_references[pin.namespace] ||= []
+            include_references[pin.namespace].push pin.name
+          elsif pin.kind == Pin::EXTEND_REFERENCE
+            extend_references[pin.namespace] ||= []
+            extend_references[pin.namespace].push pin.name
+          elsif pin.kind == Pin::SUPERCLASS_REFERENCE
+            superclass_references[pin.namespace] ||= []
+            superclass_references[pin.namespace].push pin.name
+          end
         end
         @namespace_pins = nil
         @method_pins = nil

data/lib/solargraph/complex_type.rb

@@ -9,11 +9,14 @@ module Solargraph
     autoload :TypeMethods, 'solargraph/complex_type/type_methods'
     autoload :UniqueType,  'solargraph/complex_type/unique_type'
   
+    # @param types [Array<ComplexType>]
     def initialize types = [ComplexType::UNDEFINED]
       super()
       concat types
     end
 
+    # @param api_map [ApiMap]
+    # @param context [String]
     def qualify api_map, context = ''
       types = map do |t|
         t.qualify api_map, context

data/lib/solargraph/diagnostics/update_errors.rb

@@ -3,7 +3,7 @@ module Solargraph
     class UpdateErrors < Base
       def diagnose source, api_map
         result = []
-        source.error_ranges.each do |range|
+        combine_ranges(source.code, source.error_ranges).each do |range|
           result.push(
             range: range.to_hash,
             severity: Diagnostics::Severities::ERROR,
@@ -13,6 +13,26 @@ module Solargraph
         end
         result
       end
+
+      private
+
+      # Combine an array of ranges by their starting lines.
+      #
+      # @param ranges [Array<Range>]
+      # @return [Array<Range>]
+      def combine_ranges code, ranges
+        result = []
+        lines = []
+        ranges.sort{|a, b| a.start.line <=> b.start.line}.each do |rng|
+          next if rng.nil? || lines.include?(rng.start.line)
+          lines.push rng.start.line
+          next if rng.start.line >= code.lines.length
+          scol = code.lines[rng.start.line].index(/[^\s]/) || 0
+          ecol = code.lines[rng.start.line].length
+          result.push Range.from_to(rng.start.line, scol, rng.start.line, ecol)
+        end
+        result
+      end
     end
   end
 end

data/lib/solargraph/language_server/host.rb

@@ -186,7 +186,7 @@ module Solargraph
         rescue WorkspaceTooLargeError => e
           send_notification 'window/showMessage', {
             'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
-            'message' => "The workspace is too large to index (#{e.size} files, max #{e.max})"
+            'message' => e.message
           }
           @library = Solargraph::Library.load(nil)
         end
@@ -372,9 +372,10 @@ module Solargraph
       # @param filename [String]
       # @param line [Integer]
       # @param column [Integer]
+      # @param strip [Boolean] Strip special characters from variable names
       # @return [Array<Solargraph::Range>]
-      def references_from filename, line, column
-        result = library.references_from(filename, line, column)
+      def references_from filename, line, column, strip: true
+        result = library.references_from(filename, line, column, strip: strip)
       end
 
       # @param query [String]

data/lib/solargraph/language_server/message/text_document/rename.rb

@@ -1,7 +1,7 @@
 module Solargraph::LanguageServer::Message::TextDocument
   class Rename < Base
     def process
-      locs = host.references_from(uri_to_file(params['textDocument']['uri']), params['position']['line'], params['position']['character'])
+      locs = host.references_from(uri_to_file(params['textDocument']['uri']), params['position']['line'], params['position']['character'], strip: true)
       changes = {}
       locs.each do |loc|
         uri = file_to_uri(loc.filename)

data/lib/solargraph/library.rb

@@ -175,19 +175,27 @@ module Solargraph
     # @param filename [String]
     # @param line [Integer]
     # @param column [Integer]
+    # @param strip [Boolean] Strip special characters from variable names
     # @return [Array<Solargraph::Range>]
     # @todo Take a Location instead of filename/line/column
-    def references_from filename, line, column
-      clip = api_map.clip_at(filename, Position.new(line, column))
+    def references_from filename, line, column, strip: false
+      cursor = api_map.cursor_at(filename, Position.new(line, column))
+      clip = api_map.clip(cursor)
       pins = clip.define
       return [] if pins.empty?
       result = []
       pins.uniq.each do |pin|
         (workspace.sources + open_file_hash.values).uniq.each do |source|
           found = source.references(pin.name)
-          found.select do |loc|
+          found.select! do |loc|
             referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)
-            referenced.any?{|r| r.path == pin.path}
+            referenced.any?{|r| r == pin}
+          end
+          # HACK for language clients that exclude special characters from the start of variable names
+          if strip && match = cursor.word.match(/^[^a-z0-9_]+/)
+            found.map! do |loc|
+              Solargraph::Location.new(loc.filename, Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line, loc.range.ending.column))
+            end
           end
           result.concat(found.sort{ |a, b|
             a.range.start.line <=> b.range.start.line

data/lib/solargraph/pin.rb

@@ -36,7 +36,11 @@ module Solargraph
     SYMBOL = 10
     BLOCK = 11
     BLOCK_PARAMETER = 12
+    REQUIRE_REFERENCE = 13
+    SUPERCLASS_REFERENCE = 14
+    INCLUDE_REFERENCE = 15
+    EXTEND_REFERENCE = 16
 
-    ROOT_PIN = Pin::Namespace.new(nil, '', '', '', :class, :public, nil)
+    ROOT_PIN = Pin::Namespace.new(nil, '', '', '', :class, :public)
   end
 end

data/lib/solargraph/pin/base.rb

@@ -60,21 +60,11 @@ module Solargraph
         name.to_s
       end
 
-      # @return [String]
-      def identifier
-        @identifier ||= "#{path}|#{name}"
-      end
-
       # @return [Boolean]
       def variable?
         false
       end
 
-      # @return [Boolean]
-      def yard_pin?
-        false
-      end
-
       # @return [ComplexType]
       def context
         @context ||= ComplexType.parse(namespace || '')

data/lib/solargraph/pin/conversions.rb

@@ -44,7 +44,7 @@ module Solargraph
         if @detail.nil?
           @detail = ''
           @detail += "(#{parameters.join(', ')}) " unless kind != Pin::METHOD or parameters.empty?
-          @detail += "=> #{return_complex_type.tag}" unless return_complex_type.undefined?
+          @detail += "=> #{return_complex_type}" unless return_complex_type.undefined?
           @detail.strip!
         end
         return nil if @detail.empty?

data/lib/solargraph/pin/documenting.rb

@@ -10,15 +10,6 @@ module Solargraph
         @documentation
       end
 
-      # True if the suggestion has documentation.
-      # Useful for determining whether a client should resolve a suggestion's
-      # path to retrieve more information about it.
-      #
-      # @return [Boolean]
-      def has_doc?
-        !docstring.all.empty?
-      end
-
       def helper
         @helper ||= Solargraph::Pin::Helper.new
       end

data/lib/solargraph/pin/duck_method.rb

@@ -7,7 +7,7 @@ module Solargraph
       # @param location [Solargraph::Location]
       # @param name [String]
       def initialize location, name
-        super(location, 'Object', name, nil, :instance, :public, [])
+        super(location, '', name, nil, :instance, :public, [])
       end
     end
   end

data/lib/solargraph/pin/keyword.rb

@@ -16,11 +16,6 @@ module Solargraph
       def completion_item_kind
         Solargraph::LanguageServer::CompletionItemKinds::KEYWORD
       end
-
-      def identifier
-        # HACK: A cheap way to make keyword identifiers unique
-        object_id
-      end
     end
   end
 end

data/lib/solargraph/pin/namespace.rb

@@ -1,29 +1,16 @@
 module Solargraph
   module Pin
     class Namespace < Pin::Base
+      # @return [Symbol] :public or :private
       attr_reader :visibility
 
+      # @return [Symbol] :class or :module
       attr_reader :type
 
-      # @return [Pin::Reference]
-      attr_reader :superclass_reference
-
-      def initialize location, namespace, name, comments, type, visibility, superclass
+      def initialize location, namespace, name, comments, type, visibility
         super(location, namespace, name, comments)
         @type = type
         @visibility = visibility
-        # @superclass_reference = Reference.new(self, superclass) unless superclass.nil?
-        @superclass_reference = Pin::Reference.new(location, namespace, superclass) unless superclass.nil?
-      end
-
-      # @return [Array<Pin::Reference>]
-      def include_references
-        @include_references ||= []
-      end
-
-      # @return [Array<String>]
-      def extend_references
-        @extend_references ||= []
       end
 
       def kind

data/lib/solargraph/pin/reference.rb

@@ -1,35 +1,22 @@
 module Solargraph
   module Pin
-    class Reference
-      # @return [Location]
-      attr_reader :location
+    class Reference < Base
+      autoload :Require,    'solargraph/pin/reference/require'
+      autoload :Superclass, 'solargraph/pin/reference/superclass'
+      autoload :Include,    'solargraph/pin/reference/include'
+      autoload :Extend,     'solargraph/pin/reference/extend'
 
-      # @return [String]
-      attr_reader :namespace
-
-      # @return [String]
-      attr_reader :name
-
-      # @param location [Location]
-      # @param namespace [String]
-      # @param name [String]
       def initialize location, namespace, name
-        @location = location
-        @namespace = namespace
-        @name = name
+        super(location, namespace, name, '')
       end
 
-      # @return [String]
-      def filename
-        location.filename
-      end
-
-      def == other
-        return false unless self.class == other.class
-        location == other.location and
-          namespace = other.namespace and
-          name == other.name
-      end
+      # @todo Should Reference.new be protected?
+      # class << self
+      #   protected
+      #   def new *args
+      #     super
+      #   end
+      # end
     end
   end
 end