solargraph 0.33.2 → 0.34.0

data/lib/solargraph/pin/yard_pin/method.rb

@@ -1,35 +1,37 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Pin
     module YardPin
       class Method < Pin::Method
         include YardMixin
 
-        def initialize code_object, location, name = nil, scope = nil, visibility = nil, closure = nil
+        def initialize code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
           @code_object = code_object
-          comments = (code_object.docstring ? code_object.docstring.all : nil)
+          @spec = spec
           closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s
+            name: code_object.namespace.to_s,
+            gates: [code_object.namespace.to_s]
           )
           super(
             location: location,
             closure: closure,
             name: name || code_object.name.to_s,
-            comments: comments,
+            comments: nil,
             scope: scope || code_object.scope,
             visibility: visibility || code_object.visibility,
-            args: get_parameters(code_object)
+            args: nil
           )
         end
 
-        # def return_type
-        #   @return_type ||= Solargraph::ComplexType.try_parse(Solargraph::CoreFills::CUSTOM_RETURN_TYPES[path]) if Solargraph::CoreFills::CUSTOM_RETURN_TYPES.has_key?(path)
-        #   super
-        # end
+        def parameters
+          @parameters ||= get_parameters(code_object)
+        end
 
         private
 
         def get_parameters code_object
-          return [] unless code_object.kind_of?(YARD::CodeObjects::MethodObject)
+          return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
           args = []
           code_object.parameters.each do |a|
             p = a[0]

data/lib/solargraph/pin/yard_pin/namespace.rb

@@ -1,22 +1,27 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Pin
     module YardPin
       class Namespace < Pin::Namespace
         include YardMixin
 
-        def initialize code_object, location
+        def initialize code_object, spec
           @code_object = code_object
+          @spec = spec
           closure = Solargraph::Pin::Namespace.new(
             name: code_object.namespace.to_s,
-            closure: Pin::ROOT_PIN
+            closure: Pin::ROOT_PIN,
+            gates: [code_object.namespace.to_s]
           )
           super(
             location: location,
             name: code_object.name.to_s,
-            comments: comments_from(code_object),
+            comments: nil,
             type: namespace_type(code_object),
             visibility: code_object.visibility,
-            closure: closure
+            closure: closure,
+            gates: split_to_gates(code_object.path)
           )
         end
 

data/lib/solargraph/pin/yard_pin/yard_mixin.rb

@@ -1,12 +1,39 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Pin
     module YardPin
       module YardMixin
+        attr_reader :code_object
+
+        attr_reader :spec
+
+        @@gate_cache ||= {}
+
+        def comments
+          @comments ||= code_object.docstring ? code_object.docstring.all : ''
+        end
+
+        def location
+          return @location if @located
+          @located = true
+          @location = Solargraph::YardMap::Mapper.object_location(code_object, spec)
+        end
+
         private
 
-        def comments_from code_object
-          return nil if code_object.docstring.nil?
-          code_object.docstring.all
+        def split_to_gates namespace
+          @@gate_cache[namespace] || begin
+            parts = namespace.split('::')
+            result = []
+            until parts.empty?
+              result.push parts.join('::')
+              parts.pop
+            end
+            result.push ''
+            @@gate_cache[namespace] = result.freeze
+            result
+          end
         end
       end
     end

data/lib/solargraph/position.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # The zero-based line and column numbers of a position in a string.
   #

data/lib/solargraph/range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # A pair of positions that compose a section of text.
   #

data/lib/solargraph/server_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 
 module Solargraph

data/lib/solargraph/shell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'backport'
 require 'benchmark'
@@ -14,6 +16,7 @@ module Solargraph
     end
 
     desc 'socket', 'Run a Solargraph socket server'
+    
     option :host, type: :string, aliases: :h, desc: 'The server host', default: '127.0.0.1'
     option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7658
     def socket
@@ -90,10 +93,24 @@ module Solargraph
       puts Solargraph::YardMap::CoreDocs.available.join("\n")
     end
 
-    desc 'clear-cores', 'Clear the cached core documentation'
-    def clear_cores
+    desc 'clear', 'Delete the cached documentation'
+    def clear
+      puts "Deleting the cached documentation"
       Solargraph::YardMap::CoreDocs.clear
     end
+    map 'clear-cache' => :clear
+    map 'clear-cores' => :clear
+
+    desc 'uncache GEM [...GEM]', "Delete cached gem documentation"
+    def uncache *gems
+      raise ArgumentError, 'No gems specified.' if gems.empty?
+      gems.each do |gem|
+        Dir[File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{gem}-*")].each do |dir|
+          puts "Deleting cache: #{dir}"
+          FileUtils.remove_entry_secure dir
+        end
+      end
+    end
 
     desc 'reporters', 'Get a list of diagnostics reporters'
     def reporters
@@ -162,6 +179,20 @@ module Solargraph
       puts "Scanned #{directory} (#{api_map.pins.length} pins) in #{time.real} seconds."
     end
 
+    desc 'bundle', 'Generate documentation for bundled gems'
+    option :directory, type: :string, aliases: :d, desc: 'The workspace directory', default: '.'
+    option :rebuild, type: :boolean, aliases: :r, desc: 'Rebuild existing documentation', default: false
+    def bundle
+      Documentor.new(options[:directory]).document
+    end
+
+    desc 'rdoc GEM [VERSION]', 'Use RDoc to cache documentation'
+    def rdoc gem, version = '>= 0'
+      spec = Gem::Specification.find_by_name(gem, version)
+      puts "Caching #{spec.name} #{spec.version} from RDoc"
+      Solargraph::YardMap::RdocToYard.run(spec)
+    end
+
     private
 
     # @param pin [Solargraph::Pin::Base]

data/lib/solargraph/source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parser/current'
 require 'yard'
 

data/lib/solargraph/source/chain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # HACK: Fix autoload issue
 require 'solargraph/source/chain/link'
 

data/lib/solargraph/source/chain/call.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain
@@ -28,33 +30,61 @@ module Solargraph
 
         private
 
+        # @param pins [Array<Pin::Base>]
+        # @param api_map [ApiMap]
+        # @param context [ComplexType]
+        # @param locals [Pin::LocalVariable]
+        # @return [Array<Pin::Base>]
         def inferred_pins pins, api_map, context, locals
           result = pins.map do |p|
-            if CoreFills::METHODS_RETURNING_SUBTYPES.include?(p.path) && !context.subtypes.empty?
-              next Solargraph::Pin::Method.new(
-                location: p.location,
-                closure: p.closure,
-                name: p.name,
-                comments: "@return [#{context.subtypes.first.tag}]",
-                scope: p.scope,
-                visibility: p.visibility,
-                args: p.parameters,
-                node: p.node
-              )
+            overloads = p.docstring.tags(:overload)
+            # next p if overloads.empty?
+            type = ComplexType::UNDEFINED
+            # @param [YARD::Tags::OverloadTag]
+            overloads.each do |ol|
+              next if arguments.length < ol.parameters.length &&
+                !(arguments.length == ol.parameters.length - 1 && ol.parameters.last.first.start_with?('*'))
+              match = true
+              arguments.each_with_index do |arg, idx|
+                achain = arguments[idx]
+                next if achain.nil?
+                param = ol.parameters[idx]
+                if param.nil?
+                  match = false unless ol.parameters.last && ol.parameters.last.first.start_with?('*')
+                  break
+                end
+                par = ol.tags(:param).select { |pp| pp.name == param.first }.first
+                next if par.nil? || par.types.nil? || par.types.empty?
+                atype = achain.infer(api_map, Pin::ProxyType.anonymous(context), locals)
+                other = ComplexType.try_parse(*par.types)
+                # @todo Weak type comparison
+                unless atype.tag == other.tag || api_map.super_and_sub?(other.tag, atype.tag)
+                  match = false
+                  break
+                end
+              end
+              if match
+                type = extra_return_type(ol, context)
+                type = ComplexType.try_parse(*ol.tag(:return).types).self_to(context.to_s).qualify(api_map, context.namespace) if ol.has_tag?(:return) && ol.tag(:return).types && !ol.tag(:return).types.empty? && (type.nil? || type.undefined?)
+                type ||= ComplexType::UNDEFINED
+              end
+              break if type.defined?
             end
-            if CoreFills::METHODS_RETURNING_VALUE_TYPES.include?(p.path) && !context.value_types.empty?
+            next p.proxy(type) if type.defined?
+            type = extra_return_type(p.docstring, context)
+            if type
               next Solargraph::Pin::Method.new(
                 location: p.location,
                 closure: p.closure,
                 name: p.name,
-                comments: "@return [#{context.value_types.first.tag}]",
+                comments: "@return [#{context.subtypes.first.to_s}]",
                 scope: p.scope,
                 visibility: p.visibility,
                 args: p.parameters,
                 node: p.node
               )
             end
-            if p.kind == Pin::METHOD && !p.macros.empty?
+            if p.is_a?(Pin::Method) && !p.macros.empty?
               result = process_macro(p, api_map, context, locals)
               next result unless result.return_type.undefined?
             elsif !p.directives.empty?
@@ -92,9 +122,15 @@ module Solargraph
           Pin::ProxyType.anonymous ComplexType::UNDEFINED
         end
 
+        # @param api_map [ApiMap]
+        # @param macro [YARD::Tags::MacroDirective]
         def inner_process_macro pin, macro, api_map, context, locals
           vals = arguments.map{ |c| Pin::ProxyType.anonymous(c.infer(api_map, pin, locals)) }
           txt = macro.tag.text.clone
+          if txt.empty? && macro.tag.name
+            named = api_map.named_macro(macro.tag.name)
+            txt = named.tag.text.clone if named
+          end
           i = 1
           vals.each do |v|
             txt.gsub!(/\$#{i}/, v.context.namespace)
@@ -107,6 +143,19 @@ module Solargraph
           end
           Pin::ProxyType.anonymous(ComplexType::UNDEFINED)
         end
+
+        # @param docstring [YARD::Docstring]
+        # @param context [ComplexType]
+        def extra_return_type docstring, context
+          if docstring.has_tag?(:return_single_parameter) && context.subtypes.one?
+            return context.subtypes.first
+          elsif docstring.has_tag?(:return_value_parameter) && context.value_types.one?
+            return context.value_types.first
+          # elsif docstring.has_tag?(:return) && docstring.tag(:return).types && !docstring.tag(:return).types.empty?
+          #   return ComplexType.try_parse(*docstring.tag(:return).types)
+          end
+          nil
+        end
       end
     end
   end

data/lib/solargraph/source/chain/class_variable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/constant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain
@@ -9,20 +11,25 @@ module Solargraph
         def resolve api_map, name_pin, locals
           return [Pin::ROOT_PIN] if word.empty?
           if word.start_with?('::')
-            context = ''
-            bottom = word[2..-1]
+            bottom = ''
+            gates = [word[2..-1].split('::')[0..-2].join('::')]
           else
-            context = name_pin.full_context.namespace
-            bottom = word
+            bottom = word.split('::')[0..-2].join('::')
+            gates = crawl_gates(name_pin)
           end
-          if bottom.include?('::')
-            ns = bottom.split('::')[0..-2].join('::')
-          else
-            ns = ''
+          result = api_map.get_constants(bottom, *gates)
+          result.select{ |p| p.path == word || "::#{p.path}" == word || p.path.end_with?("::#{word}") }
+        end
+
+        private
+
+        def crawl_gates pin
+          clos = pin
+          until clos.nil?
+            return clos.gates if clos.is_a?(Pin::Namespace)
+            clos = clos.closure
           end
-          result = api_map.get_constants(ns, context)
-          last_name = bottom.split('::').last
-          result.select{ |p| p.name == last_name }
+          ['']
         end
       end
     end

data/lib/solargraph/source/chain/global_variable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/head.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/instance_variable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/literal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/or.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/chain/variable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     class Chain

data/lib/solargraph/source/change.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class Source
     # A change to be applied to text.