solargraph 0.33.2 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32fec2551136daaa8c608f7fe94fec4ef24e08ba03723b2ece3e4c8b66342c5b
-  data.tar.gz: edaa58070c532e97dd1b0ac2e43b7917e08ceb972d19c43f26eba7b9fc62cf5a
+  metadata.gz: 0d4c15dc7c4e82dfcfb3b763c111980c3faa3da66857658e5fd8124e08ef999e
+  data.tar.gz: 64f641fd49afbcee69e014e65a77f8f0f8649e854d0da67371c11aa48692f257
 SHA512:
-  metadata.gz: 46b6981ae2a47c4676a78fdb50ac01f46d70cc37b3f762b9c35936dd13b2cd529fca0ed6d9057bd3106164145967560f50d1836848c395d4d90b953facb48f27
-  data.tar.gz: c6f70f39fded5af0e588f6792c9dba1872c421fc62993e16e1f734fe828d36e5f287309368fb09b1a7130d9bd7f0aa87a9ac7e9bef8e0de9309247985bc67c9f
+  metadata.gz: 9b9442c9027fd4eb15a4958302db194e9ed9031458c34d7554a514969b5415c495bcb633b78ebcd8ba14747268be2ea78ce6117216240b1bca302fe8892bf6ee
+  data.tar.gz: 46f1c0eb34c0830dbbda766c6be52730592136e777df71bc9953bb8e391bfd161f31e08db971107d3862f815423174a51fa0334b22de67193272b3ffb9e0a560

data/.gitignore

@@ -7,4 +7,3 @@ Gemfile.lock
 doc
 coverage
 /tmp/
-guides

data/README.md

@@ -44,7 +44,7 @@ When editing code, a `require` call that references a gem will pull the document
 
 ### More Information
 
-See [http://solargraph.org/tips](http://solargraph.org/tips) for more tips on using Solargraph with an editor.
+See [http://solargraph.org/guides](http://solargraph.org/guides) for more tips and tutorials for using Solargraph.
 
 ## How It Works
 

data/lib/solargraph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard'
 require 'solargraph/version'
 require 'rubygems/package'
@@ -34,6 +36,9 @@ module Solargraph
   autoload :Bundle,           'solargraph/bundle'
   autoload :Logging,          'solargraph/logging'
   autoload :TypeChecker,      'solargraph/type_checker'
+  autoload :Environ,          'solargraph/environ'
+  autoload :Convention,       'solargraph/convention'
+  autoload :Documentor,       'solargraph/documentor'
 
   dir = File.dirname(__FILE__)
   YARDOC_PATH = File.realpath(File.join(dir, '..', 'yardoc'))

data/lib/solargraph/api_map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'set'
 require 'pathname'
@@ -47,6 +49,8 @@ module Solargraph
       self
     end
 
+    # @param name [String]
+    # @return [YARD::Tags::MacroDirective, nil]
     def named_macro name
       store.named_macros[name]
     end
@@ -83,10 +87,12 @@ module Solargraph
         end
       end
       return self if merged
+      implicit.clear
       pins = []
       reqs = []
       # @param map [SourceMap]
       new_map_hash.values.each do |map|
+        implicit.merge map.environ
         pins.concat map.pins
         reqs.concat map.requires.map(&:name)
       end
@@ -106,6 +112,8 @@ module Solargraph
           result
         end
       end
+      reqs.concat implicit.requires
+      pins.concat implicit.overrides
       yard_map.change(reqs)
       new_store = Store.new(pins + yard_map.pins)
       @mutex.synchronize {
@@ -119,6 +127,12 @@ module Solargraph
       self
     end
 
+    # @return [Environ]
+    def implicit
+      @implicit ||= Environ.new
+    end
+
+    # @return [Hash]
     def local_path_hash
       @local_paths ||= {}
     end
@@ -187,28 +201,26 @@ module Solargraph
     # may contain both constant and namespace pins.
     #
     # @param namespace [String] The namespace
-    # @param context [String] The context
+    # @param contexts [Array<String>] The contexts
     # @return [Array<Solargraph::Pin::Base>]
-    def get_constants namespace, context = ''
+    def get_constants namespace, *contexts
       namespace ||= ''
-      cached = cache.get_constants(namespace, context)
+      contexts.push '' if contexts.empty?
+      cached = cache.get_constants(namespace, contexts)
       return cached.clone unless cached.nil?
       skip = []
       result = []
-      bases = context.split('::')
-      while bases.length > 0
-        built = bases.join('::')
-        fqns = qualify(namespace, built)
+      contexts.each do |context|
+        fqns = qualify(namespace, context)
+        visibility = [:public]
+        visibility.push :private if fqns == context
+        result.concat inner_get_constants(fqns, visibility, skip)
+        fqns = qualify(namespace, '')
         visibility = [:public]
         visibility.push :private if fqns == context
         result.concat inner_get_constants(fqns, visibility, skip)
-        bases.pop
       end
-      fqns = qualify(namespace, '')
-      visibility = [:public]
-      visibility.push :private if fqns == context
-      result.concat inner_get_constants(fqns, visibility, skip)
-      cache.set_constants(namespace, context, result)
+      cache.set_constants(namespace, contexts, result)
       result
     end
 
@@ -266,7 +278,7 @@ module Solargraph
     # @return [Array<Solargraph::Pin::GlobalVariable>]
     def get_global_variable_pins
       # @todo Slow version
-      pins.select{|p| p.kind == Pin::GLOBAL_VARIABLE}
+      pins.select{ |p| p.is_a?(Pin::GlobalVariable) }
     end
 
     # Get an array of methods available in a particular context.
@@ -283,10 +295,11 @@ module Solargraph
       skip = []
       if fqns == ''
         # @todo Implement domains
-        # domains.each do |domain|
-        #   type = ComplexType.parse(domain).first
-        #   result.concat inner_get_methods(type.name, type.scope, [:public], deep, skip)
-        # end
+        implicit.domains.each do |domain|
+          type = ComplexType.try_parse(domain)
+          next if type.undefined?
+          result.concat inner_get_methods(type.name, type.scope, [:public], deep, skip)
+        end
         result.concat inner_get_methods(fqns, :class, visibility, deep, skip)
         result.concat inner_get_methods(fqns, :instance, visibility, deep, skip)
         result.concat inner_get_methods('Kernel', :instance, visibility, deep, skip)
@@ -466,11 +479,15 @@ module Solargraph
       source_map_hash.keys.include?(filename)
     end
 
+    # True if the specified file is included in the workspace.
+    #
+    # @param filename [String]
     def workspaced? filename
       workspace_filenames.include?(filename)
     end
 
     # @param location [Location]
+    # @return [Location]
     def require_reference_at location
       map = source_map(location.filename)
       pin = map.requires.select { |pin| pin.location.range.contain?(location.range.start) }.first
@@ -500,6 +517,7 @@ module Solargraph
 
     private
 
+    # @return [Array<String>]
     def workspace_filenames
       @workspace_filenames ||= []
     end

data/lib/solargraph/api_map/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class ApiMap
     class Cache

data/lib/solargraph/api_map/source_to_yard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class ApiMap
     module SourceToYard
@@ -26,12 +28,17 @@ module Solargraph
             next
           end
           if pin.type == :class
-            code_object_map[pin.path] ||= YARD::CodeObjects::ClassObject.new(root_code_object, pin.path)
+            code_object_map[pin.path] ||= YARD::CodeObjects::ClassObject.new(root_code_object, pin.path) { |obj|
+              next if pin.location.nil? || pin.location.filename.nil?
+              obj.add_file(pin.location.filename, pin.location.range.start.line, !pin.comments.empty?)
+            }
           else
-            code_object_map[pin.path] ||= YARD::CodeObjects::ModuleObject.new(root_code_object, pin.path)
+            code_object_map[pin.path] ||= YARD::CodeObjects::ModuleObject.new(root_code_object, pin.path) { |obj|
+              next if pin.location.nil? || pin.location.filename.nil?
+              obj.add_file(pin.location.filename, pin.location.range.start.line, !pin.comments.empty?)
+            }
           end
           code_object_map[pin.path].docstring = pin.docstring
-          code_object_map[pin.path].files.push pin.location.filename unless pin.location.nil? || code_object_map[pin.path].files.include?(pin.location.filename)
           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
@@ -45,10 +52,12 @@ module Solargraph
             code_object_map[pin.path] ||= pin.code_object
             next
           end
-          code_object_map[pin.path] ||= YARD::CodeObjects::MethodObject.new(code_object_at(pin.namespace), pin.name, pin.scope)
+          code_object_map[pin.path] ||= YARD::CodeObjects::MethodObject.new(code_object_at(pin.namespace), pin.name, pin.scope) { |obj|
+            next if pin.location.nil? || pin.location.filename.nil?
+            obj.add_file pin.location.filename, pin.location.range.start.line
+          }
           code_object_map[pin.path].docstring = pin.docstring
           code_object_map[pin.path].visibility = pin.visibility || :public
-          code_object_map[pin.path].files.push pin.location.filename unless pin.location.nil? || code_object_map[pin.path].files.include?(pin.location.filename)
           code_object_map[pin.path].parameters = pin.parameters.map do |p|
             n = p.match(/^[a-z0-9_]*:?/i)[0]
             v = nil

data/lib/solargraph/api_map/store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Solargraph
@@ -17,7 +19,7 @@ module Solargraph
       # @return [Array<Solargraph::Pin::Base>]
       def get_constants fqns, visibility = [:public]
         namespace_children(fqns).select { |pin|
-          !pin.name.empty? and (pin.kind == Pin::NAMESPACE or pin.kind == Pin::CONSTANT) and visibility.include?(pin.visibility)
+          !pin.name.empty? and (pin.is_a?(Pin::Namespace) || pin.is_a?(Pin::Constant)) && visibility.include?(pin.visibility)
         }
       end
 
@@ -26,9 +28,8 @@ module Solargraph
       # @param visibility [Array<Symbol>]
       # @return [Array<Solargraph::Pin::Base>]
       def get_methods fqns, scope: :instance, visibility: [:public]
-        kinds = [Pin::METHOD, Pin::ATTRIBUTE, Pin::METHOD_ALIAS]
         namespace_children(fqns).select do |pin|
-          kinds.include?(pin.kind) && pin.scope == scope && visibility.include?(pin.visibility)
+          pin.is_a?(Pin::BaseMethod) && pin.scope == scope && visibility.include?(pin.visibility)
         end
       end
 
@@ -61,7 +62,6 @@ module Solargraph
       # @param scope [Symbol] :class or :instance
       # @return [Array<Solargraph::Pin::Base>]
       def get_instance_variables(fqns, scope = :instance)
-        # namespace_children(fqns).select{|pin| pin.kind == Pin::INSTANCE_VARIABLE and pin.context.scope == scope}
         all_instance_variables.select { |pin|
           pin.binder.namespace == fqns && pin.binder.scope == scope
         }
@@ -70,7 +70,7 @@ module Solargraph
       # @param fqns [String]
       # @return [Array<Solargraph::Pin::Base>]
       def get_class_variables(fqns)
-        namespace_children(fqns).select{|pin| pin.kind == Pin::CLASS_VARIABLE}
+        namespace_children(fqns).select{|pin| pin.is_a?(Pin::ClassVariable)}
       end
 
       # @return [Array<Solargraph::Pin::Base>]
@@ -91,13 +91,11 @@ module Solargraph
 
       # @return [Array<Solargraph::Pin::Base>]
       def namespace_pins
-        # @namespace_pins ||= pins.select{|p| p.kind == Pin::NAMESPACE}
         @namespace_pins ||= []
       end
 
       # @return [Array<Solargraph::Pin::Base>]
       def method_pins
-        # @method_pins ||= pins.select{|p| p.kind == Pin::METHOD or p.kind == Pin::ATTRIBUTE}
         @method_pins ||= []
       end
 
@@ -116,7 +114,7 @@ module Solargraph
         @named_macros ||= begin
           result = {}
           pins.each do |pin|
-            pin.macros.select{|m| m.tag.tag_name == 'macro'}.each do |macro|
+            pin.macros.select{|m| m.tag.tag_name == 'macro' && !m.tag.text.empty? }.each do |macro|
               next if macro.tag.name.nil? || macro.tag.name.empty?
               result[macro.tag.name] = macro
             end
@@ -149,7 +147,7 @@ module Solargraph
           base = ''
           name = fqns
         end
-        namespace_children(base).select{|pin| pin.name == name and pin.kind == Pin::NAMESPACE}
+        namespace_children(base).select{|pin| pin.name == name && pin.is_a?(Pin::Namespace)}
       end
 
       # @return [Array<Solargraph::Pin::Symbol>]
@@ -203,17 +201,17 @@ module Solargraph
         pins.each do |pin|
           namespace_map[pin.namespace] ||= []
           namespace_map[pin.namespace].push pin
-          namespaces.add pin.path if pin.kind == Pin::NAMESPACE and !pin.path.empty?
-          namespace_pins.push pin if pin.kind == Pin::NAMESPACE
-          method_pins.push pin if pin.kind == Pin::METHOD || pin.kind == Pin::ATTRIBUTE
-          symbols.push pin if pin.kind == Pin::SYMBOL
-          if pin.kind == Pin::INCLUDE_REFERENCE
+          namespaces.add pin.path if pin.is_a?(Pin::Namespace) and !pin.path.empty?
+          namespace_pins.push pin if pin.is_a?(Pin::Namespace)
+          method_pins.push pin if pin.is_a?(Pin::BaseMethod)
+          symbols.push pin if pin.is_a?(Pin::Symbol)
+          if pin.is_a?(Pin::Reference::Include)
             include_references[pin.namespace] ||= []
             include_references[pin.namespace].push pin.name
-          elsif pin.kind == Pin::EXTEND_REFERENCE
+          elsif pin.is_a?(Pin::Reference::Extend)
             extend_references[pin.namespace] ||= []
             extend_references[pin.namespace].push pin.name
-          elsif pin.kind == Pin::SUPERCLASS_REFERENCE
+          elsif pin.is_a?(Pin::Reference::Superclass)
             superclass_references[pin.namespace] ||= []
             superclass_references[pin.namespace].push pin.name
           elsif pin.is_a?(Pin::Block)
@@ -228,12 +226,12 @@ module Solargraph
             path_pin_hash[pin.path].push pin
           end
         end
-        override_pins.concat CoreFills::OVERRIDES
         override_pins.each do |ovr|
           pin = get_path_pins(ovr.name).first
           next if pin.nil?
-          pin.docstring.delete_tags(:overload)
-          pin.docstring.delete_tags(:return)
+          (ovr.tags.map(&:tag_name) + ovr.delete).uniq.each do |tag|
+            pin.docstring.delete_tags tag.to_sym
+          end
           ovr.tags.each do |tag|
             pin.docstring.add_tag(tag)
           end

data/lib/solargraph/bundle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # An aggregation of a workspace and additional sources to be cataloged in an
   # ApiMap.

data/lib/solargraph/complex_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # A container for type data based on YARD type tags.
   #
@@ -73,10 +75,24 @@ module Solargraph
 
     def self_to dst
       return self unless selfy?
-      result = @items.map { |i| i.self_to dst }
+      red = reduce_class(dst)
+      result = @items.map { |i| i.self_to red }
       ComplexType.parse(*result.map(&:tag))
     end
 
+    private
+
+    # @todo This is a quick and dirty hack that forces `self` keywords
+    #   to reference an instance of their class and never the class itself.
+    #   This behavior may change depending on which result is expected
+    #   from YARD conventions. See https://github.com/lsegal/yard/issues/1257
+    def reduce_class dst
+      while dst =~ /^(Class|Module)\<(.*?)\>$/
+        dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
+      end
+      dst
+    end
+
     class << self
       # Parse type strings into a ComplexType.
       #
@@ -157,11 +173,9 @@ module Solargraph
               subtype_string += char
             end
           end
-          base.strip!
-          subtype_string.strip!
           raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 || curly_stack != 0 || paren_stack != 0
           # types.push ComplexType.new([UniqueType.new(base, subtype_string)])
-          types.push UniqueType.new(base, subtype_string)
+          types.push UniqueType.new(base.strip, subtype_string.strip)
         end
         unless key_types.nil?
           raise ComplexTypeError, "Invalid use of key/value parameters" unless partial

data/lib/solargraph/complex_type/type_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class ComplexType
     # Methods for accessing type data.

data/lib/solargraph/complex_type/unique_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class ComplexType
     # An individual type signature. A complex type can consist of multiple

data/lib/solargraph/convention.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Solargraph
+  # Conventions provide a way to modify an ApiMap based on expectations about
+  # one of its sources.
+  #
+  module Convention
+    autoload :Base,    'solargraph/convention/base'
+    autoload :Gemfile, 'solargraph/convention/gemfile'
+    autoload :Rspec,   'solargraph/convention/rspec'
+    autoload :Gemspec, 'solargraph/convention/gemspec'
+
+    @@conventions = Set.new
+
+    # @param convention [Class<Convention::Base>]
+    # @return [Convention::Base]
+    def self.register convention
+      @@conventions.add convention.new
+    end
+
+    # @param source [Source]
+    # @return [Environ]
+    def self.for(source)
+      result = Environ.new
+      return result if source.filename.nil? || source.filename.empty?
+      @@conventions.each do |conv|
+        result.merge conv.environ if conv.match?(source)
+      end
+      result
+    end
+
+    register Gemfile
+    register Gemspec
+    register Rspec
+  end
+end