solargraph 0.21.0 → 0.22.0

data/lib/solargraph/source/position.rb

@@ -16,6 +16,7 @@ module Solargraph
       # Get a hash of the position. This representation is suitable for use in
       # the language server protocol.
       #
+      # @return [Hash]
       def to_hash
         {
           line: line,
@@ -23,6 +24,11 @@ module Solargraph
         }
       end
 
+      # Get a numeric offset for the specified text and position.
+      #
+      # @param text [String]
+      # @param position [Position]
+      # @return [Integer]
       def self.to_offset text, position
         result = 0
         feed = 0
@@ -41,10 +47,22 @@ module Solargraph
         result
       end
 
+      # Get a numeric offset for the specified text and a position identified
+      # by its line and character.
+      #
+      # @param text [String]
+      # @param line [Integer]
+      # @param character [Integer]
+      # @return [Integer]
       def self.line_char_to_offset text, line, character
         to_offset(text, Position.new(line, character))
       end
 
+      # Get a position for the specified text and offset.
+      #
+      # @param text [String]
+      # @param offset [Integer]
+      # @return [Position]
       def self.from_offset text, offset
         cursor = 0
         line = 0

data/lib/solargraph/source/range.rb

@@ -17,6 +17,7 @@ module Solargraph
       # Get a hash of the range. This representation is suitable for use in
       # the language server protocol.
       #
+      # @return [Hash<Symbol, Position>]
       def to_hash
         {
           start: start.to_hash,
@@ -24,6 +25,9 @@ module Solargraph
         }
       end
 
+      # True if the specified position is inside the range.
+      #
+      # @return [Boolean]
       def contain? position
         return false if position.line < start.line
         return false if position.line == start.line and position.character < start.character
@@ -38,7 +42,7 @@ module Solargraph
       # @param c1 [Integer] Starting character
       # @param l2 [Integer] Ending line
       # @param c2 [Integer] Ending character
-      # @return [Position]
+      # @return [Range]
       def self.from_to l1, c1, l2, c2
         Range.new(Position.new(l1, c1), Position.new(l2, c2))
       end

data/lib/solargraph/source.rb

@@ -11,6 +11,7 @@ module Solargraph
     autoload :Updater,       'solargraph/source/updater'
     autoload :Change,        'solargraph/source/change'
     autoload :Mapper,        'solargraph/source/mapper'
+    autoload :NodeMethods,   'solargraph/source/node_methods'
 
     # @return [String]
     attr_reader :code
@@ -40,6 +41,7 @@ module Solargraph
     # @return [Time]
     attr_reader :stime
 
+    # @return [Array<Solargraph::Pin::Base>]
     attr_reader :pins
 
     attr_reader :requires
@@ -132,6 +134,22 @@ module Solargraph
       symbol_pins
     end
 
+    # @return [Array<Source::Location>]
+    def references name
+      inner_node_references(name, node).map do |n|
+        offset = Position.to_offset(code, get_node_start_position(n))
+        soff = code.index(name, offset)
+        eoff = soff + name.length
+        Location.new(
+          filename,
+          Solargraph::Source::Range.new(
+            Position.from_offset(code, soff),
+            Position.from_offset(code, eoff)
+          )
+        )
+      end
+    end
+
     def locate_named_path_pin line, character
       _locate_pin line, character, Pin::NAMESPACE, Pin::METHOD
     end
@@ -157,7 +175,8 @@ module Solargraph
 
     # Get the nearest node that contains the specified index.
     #
-    # @param index [Integer]
+    # @param line [Integer]
+    # @param column [Integer]
     # @return [AST::Node]
     def node_at(line, column)
       tree_at(line, column).first
@@ -246,6 +265,17 @@ module Solargraph
 
     private
 
+    def inner_node_references name, top
+      result = []
+      if top.kind_of?(AST::Node)
+        if (top.type == :const and top.children[1].to_s == name) or (top.type == :send and top.children[1].to_s == name)
+          result.push top
+        end
+        top.children.each { |c| result.concat inner_node_references(name, c) }
+      end
+      result
+    end
+
     def parse
       node, comments = inner_parse(@fixed, filename)
       @node = node

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.21.0'
+  VERSION = '0.22.0'
 end

data/lib/solargraph/workspace/config.rb

@@ -13,7 +13,7 @@ module Solargraph
       def initialize workspace = nil
         @workspace = workspace
         include_globs = ['**/*.rb']
-        exclude_globs = ['spec/**/*', 'test/**/*', 'vendor/**/*']
+        exclude_globs = ['spec/**/*', 'test/**/*', 'vendor/**/*', '.bundle/**/*']
         unless @workspace.nil?
           sfile = File.join(@workspace, '.solargraph.yml')
           if File.file?(sfile)
@@ -44,7 +44,7 @@ module Solargraph
       end
 
       # An array of files excluded from the workspace.
-      # 
+      #
       # @return [Array<String>]
       def excluded
         return [] if workspace.nil?
@@ -67,6 +67,10 @@ module Solargraph
         raw_data['require']
       end
 
+      def require_paths
+        raw_data['require_paths'] || []
+      end
+
       def plugins
         raw_data['plugins']
       end

data/lib/solargraph/workspace.rb

@@ -132,15 +132,21 @@ module Solargraph
 
     def generate_require_paths
       return [] if directory.nil?
-      return [File.join(directory, 'lib')] unless gemspec?
+      return configured_require_paths unless gemspec?
       result = []
       gemspecs.each do |file|
         spec = Gem::Specification.load(file)
         base = File.dirname(file)
         result.concat spec.require_paths.map{ |path| File.join(base, path) } unless spec.nil?
       end
+      result.concat config.require_paths
       result.push File.join(directory, 'lib') if result.empty?
       result
     end
+
+    def configured_require_paths
+      return [File.join(directory, 'lib')] if config.require_paths.empty?
+      config.require_paths.map{|p| File.join(directory, p)}
+    end
   end
 end

data/lib/solargraph/yard_map/core_docs.rb

@@ -77,7 +77,7 @@ module Solargraph
 
         def download version
           FileUtils.mkdir_p cache_dir
-          uri = URI.parse("http://solargraph.org/download/#{version}.tar.gz")
+          uri = URI.parse("#{SOURCE}/#{version}.tar.gz")
           response = Net::HTTP.get_response(uri)
           zipfile = File.join(cache_dir, "#{version}.tar.gz")
           File.binwrite zipfile, response.body

data/lib/solargraph/yard_map.rb

@@ -1,16 +1,23 @@
 require 'yard'
 
 module Solargraph
+  # The YardMap provides access to YARD documentation for the Ruby core, the
+  # stdlib, and gems.
+  #
   class YardMap
     autoload :Cache, 'solargraph/yard_map/cache'
     autoload :CoreDocs, 'solargraph/yard_map/core_docs'
 
     CoreDocs.require_minimum
     @@stdlib_yardoc = CoreDocs.yard_stdlib_file
-    @@stdlib_namespaces = []
+    @@stdlib_paths = {}
     YARD::Registry.load! @@stdlib_yardoc
     YARD::Registry.all(:class, :module).each do |ns|
-      @@stdlib_namespaces.push ns.path
+      next if ns.file.nil?
+      path = ns.file.sub(/^(ext|lib)\//, '').sub(/\.(rb|c)$/, '')
+      next if path.start_with?('-')
+      @@stdlib_paths[path] ||= []
+      @@stdlib_paths[path].push ns
     end
 
     # @return [Solargraph::Workspace]
@@ -25,6 +32,7 @@ module Solargraph
       @required = required.clone
       @namespace_yardocs = {}
       @gem_paths = {}
+      @stdlib_namespaces = []
       process_requires
       yardocs.push CoreDocs.yardoc_file
       yardocs.uniq!
@@ -99,12 +107,16 @@ module Solargraph
       result = []
       combined_namespaces(namespace, scope).each do |ns|
         yardocs_documenting(ns).each do |y|
+          # @todo Getting constants from the stdlib works slightly differently
+          #   from methods
+          next if y == @@stdlib_yardoc
           yard = load_yardoc(y)
           unless yard.nil?
             found = yard.at(ns)
             consts.concat found.children unless found.nil?
           end
         end
+        consts.concat @stdlib_namespaces.select{|ns| ns.namespace.path == namespace}
       end
       consts.each { |c|
         detail = nil
@@ -140,9 +152,20 @@ module Solargraph
             ns = nil
             ns = find_first_resolved_object(yard, namespace, scope)
             unless ns.nil?
+              has_new = false
               ns.meths(scope: :class, visibility: visibility).each { |m|
+                has_new = true if m.name == 'new'
                 meths.push Pin::YardObject.new(m, object_location(m))
               }
+              # HACK: Convert #initialize to .new
+              if visibility.include?(:public) and !has_new
+                init = ns.meths(scope: :instance).select{|m| m.to_s.split(/[\.#]/).last == 'initialize'}.first
+                unless init.nil?
+                  ip = Solargraph::Pin::YardObject.new(init, object_location(init))
+                  np = Solargraph::Pin::Method.new(ip.location, ip.namespace, 'new', ip.docstring, :class, :public, ip.parameters)
+                  meths.push np
+                end
+              end
               # Collect superclass methods
               if ns.kind_of?(YARD::CodeObjects::ClassObject) and !ns.superclass.nil?
                 meths += get_methods ns.superclass.to_s, '', visibility: [:public, :protected] unless ['Object', 'BasicObject', ''].include?(ns.superclass.to_s)
@@ -170,6 +193,8 @@ module Solargraph
             unless ns.nil?
               ns.meths(scope: :instance, visibility: visibility).each do |m|
                 n = m.to_s.split(/[\.#]/).last
+                # HACK: Exception for Module#module_function in Class
+                next if ns.name == :Class and m.path == 'Module#module_function'
                 # HACK: Special treatment for #initialize
                 next if n == 'initialize' and !visibility.include?(:private)
                 if (namespace == 'Kernel' or !m.to_s.start_with?('Kernel#')) and !m.docstring.to_s.include?(':nodoc:')
@@ -203,10 +228,12 @@ module Solargraph
         while parts.length > 0
           here = "#{parts.join('::')}::#{namespace}"
           return here unless yardocs_documenting(here).empty?
+          return here if @stdlib_namespaces.any?{|ns| ns.path == here}
           parts.pop
         end
       end
       return namespace unless yardocs_documenting(namespace).empty?
+      return namespace if @stdlib_namespaces.any?{|ns| ns.path == namespace}
       nil
     end
 
@@ -221,6 +248,9 @@ module Solargraph
           end
         end
       }
+      @stdlib_namespaces.each do |ns|
+        result.push Pin::YardObject.new(ns, object_location(ns)) if ns.path == path
+      end
       result
     end
 
@@ -266,19 +296,25 @@ module Solargraph
       tried = []
       unresolved_requires.clear
       required.each do |r|
+        next if r.nil?
+        next if !workspace.nil? and workspace.would_require?(r)
         begin
           spec = Gem::Specification.find_by_path(r) || Gem::Specification.find_by_name(r.split('/').first)
           ver = spec.version.to_s
           ver = ">= 0" if ver.empty?
           add_gem_dependencies spec
-          next if !workspace.nil? and workspace.would_require?(r)
           yd = YARD::Registry.yardoc_file_for_gem(spec.name, ver)
           @gem_paths[spec.name] = spec.full_gem_path
           unresolved_requires.push r if yd.nil?
           yardocs.unshift yd unless yd.nil? or yardocs.include?(yd)
         rescue Gem::LoadError => e
           next if !workspace.nil? and workspace.would_require?(r)
-          unresolved_requires.push r
+          stdnames = []
+          @@stdlib_paths.each_pair do |path, objects|
+            stdnames.concat objects if path == r or path.start_with?("#{r}/")
+          end
+          @stdlib_namespaces.concat stdnames
+          unresolved_requires.push r if stdnames.empty?
         end
       end
     end
@@ -315,7 +351,9 @@ module Solargraph
       else
         result.concat @namespace_yardocs[namespace] unless @namespace_yardocs[namespace].nil?
       end
-      result.push @@stdlib_yardoc if result.empty? and @@stdlib_namespaces.include?(namespace)
+      if @stdlib_namespaces.map(&:path).include?(namespace)
+        result.push @@stdlib_yardoc
+      end
       result
     end
 

data/lib/solargraph.rb

@@ -20,7 +20,6 @@ module Solargraph
   autoload :Shell,          'solargraph/shell'
   autoload :Source,         'solargraph/source'
   autoload :ApiMap,         'solargraph/api_map'
-  autoload :NodeMethods,    'solargraph/node_methods'
   autoload :YardMap,        'solargraph/yard_map'
   autoload :Pin,            'solargraph/pin'
   autoload :LiveMap,        'solargraph/live_map'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -102,16 +102,16 @@ dependencies:
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +208,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 description: IDE tools for code completion and inline documentation
 email: admin@castwide.com
 executables:
@@ -226,6 +240,7 @@ files:
 - lib/solargraph/api_map/probe.rb
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb
+- lib/solargraph/api_map/type_methods.rb
 - lib/solargraph/core_fills.rb
 - lib/solargraph/diagnostics.rb
 - lib/solargraph/diagnostics/base.rb
@@ -248,6 +263,7 @@ files:
 - lib/solargraph/language_server/message/extended/check_gem_version.rb
 - lib/solargraph/language_server/message/extended/document.rb
 - lib/solargraph/language_server/message/extended/document_gems.rb
+- lib/solargraph/language_server/message/extended/download_core.rb
 - lib/solargraph/language_server/message/extended/search.rb
 - lib/solargraph/language_server/message/initialize.rb
 - lib/solargraph/language_server/message/initialized.rb
@@ -266,6 +282,8 @@ files:
 - lib/solargraph/language_server/message/text_document/formatting.rb
 - lib/solargraph/language_server/message/text_document/hover.rb
 - lib/solargraph/language_server/message/text_document/on_type_formatting.rb
+- lib/solargraph/language_server/message/text_document/references.rb
+- lib/solargraph/language_server/message/text_document/rename.rb
 - lib/solargraph/language_server/message/text_document/signature_help.rb
 - lib/solargraph/language_server/message/workspace.rb
 - lib/solargraph/language_server/message/workspace/did_change_configuration.rb
@@ -281,7 +299,6 @@ files:
 - lib/solargraph/library.rb
 - lib/solargraph/live_map.rb
 - lib/solargraph/live_map/cache.rb
-- lib/solargraph/node_methods.rb
 - lib/solargraph/page.rb
 - lib/solargraph/pin.rb
 - lib/solargraph/pin/attribute.rb
@@ -303,6 +320,7 @@ files:
 - lib/solargraph/pin/method_parameter.rb
 - lib/solargraph/pin/namespace.rb
 - lib/solargraph/pin/plugin/method.rb
+- lib/solargraph/pin/proxy_method.rb
 - lib/solargraph/pin/reference.rb
 - lib/solargraph/pin/symbol.rb
 - lib/solargraph/pin/yard_object.rb
@@ -319,6 +337,7 @@ files:
 - lib/solargraph/source/fragment.rb
 - lib/solargraph/source/location.rb
 - lib/solargraph/source/mapper.rb
+- lib/solargraph/source/node_methods.rb
 - lib/solargraph/source/position.rb
 - lib/solargraph/source/range.rb
 - lib/solargraph/source/updater.rb
@@ -356,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Solargraph for Ruby

data/lib/solargraph/node_methods.rb

@@ -1,101 +0,0 @@
-module Solargraph
-  module NodeMethods
-    # @return [String]
-    def unpack_name(node)
-      pack_name(node).join("::")
-    end
-
-    # @return [Array<String>]
-    def pack_name(node)
-      parts = []
-      if node.kind_of?(AST::Node)
-        node.children.each { |n|
-          if n.kind_of?(AST::Node)
-            if n.type == :cbase
-              parts = pack_name(n)
-            else
-              parts += pack_name(n)
-            end
-          else
-            parts.push n unless n.nil?
-          end
-        }
-      end
-      parts
-    end
-
-    # @return [String]
-    def const_from node
-      if node.kind_of?(AST::Node) and node.type == :const
-        result = ''
-        unless node.children[0].nil?
-          result = const_from(node.children[0])
-        end
-        if result == ''
-          result = node.children[1].to_s
-        else
-          result = result + '::' + node.children[1].to_s
-        end
-        result
-      else
-        nil
-      end
-    end
-
-    # @return [String]
-    def infer_literal_node_type node
-      return nil unless node.kind_of?(AST::Node)
-      if node.type == :str or node.type == :dstr
-        return 'String'
-      elsif node.type == :array
-        return 'Array'
-      elsif node.type == :hash
-        return 'Hash'
-      elsif node.type == :int
-        return 'Integer'
-      elsif node.type == :float
-        return 'Float'
-      elsif node.type == :sym
-        return 'Symbol'
-      # @todo Maybe ignore nils
-      # elsif node.type == :nil
-      #   return 'NilClass'
-      end
-      nil
-    end
-
-    # Get a call signature from a node.
-    # The result should be a string in the form of a method path, e.g.,
-    # String.new or variable.method.
-    #
-    # @return [String]
-    def resolve_node_signature node
-      result = drill_signature node, ''
-      return nil if result.empty?
-      result
-    end
-
-    private
-
-    def drill_signature node, signature
-      return signature unless node.kind_of?(AST::Node)
-      if node.type == :const or node.type == :cbase
-        unless node.children[0].nil?
-          signature += drill_signature(node.children[0], signature)
-        end
-        signature += '::' unless signature.empty?
-        signature += node.children[1].to_s
-      elsif node.type == :lvar or node.type == :ivar or node.type == :cvar
-        signature += '.' unless signature.empty?
-        signature += node.children[0].to_s
-      elsif node.type == :send
-        unless node.children[0].nil?
-          signature += drill_signature(node.children[0], signature)
-        end
-        signature += '.' unless signature.empty?
-        signature += node.children[1].to_s
-      end
-      signature
-    end
-  end
-end