solargraph 0.30.2 → 0.31.0

data/lib/solargraph/source/encoding_fixes.rb

@@ -12,7 +12,7 @@ module Solargraph
           string.dup.force_encoding('UTF-8')
         rescue ::Encoding::CompatibilityError, ::Encoding::UndefinedConversionError, ::Encoding::InvalidByteSequenceError => e
           # @todo Improve error handling
-          STDERR.puts "Normalize error: #{e.message}"
+          Solargraph::Logging.logger.warn "Normalize error: #{e.message}"
           string
         end
       end

data/lib/solargraph/source/source_chainer.rb

@@ -15,7 +15,7 @@ module Solargraph
         # @param position [Position]
         # @return [Source::Chain]
         def chain source, position
-          raise "Not a source" unless source.is_a?(Source)
+          # raise "Not a source" unless source.is_a?(Source)
           new(source, position).chain
         end
       end
@@ -33,19 +33,23 @@ module Solargraph
         return Chain.new([Chain::Literal.new('Symbol')]) if phrase.start_with?(':') && !phrase.start_with?('::')
         begin
           return Chain.new([]) if phrase.end_with?('..')
-          if !source.repaired? && source.parsed?
-            node = source.node_at(position.line, position.column)
+          if source.synchronized?
+            if !source.repaired? && source.parsed?
+              node = source.node_at(position.line, position.column)
+            else
+              node = nil
+              node = source.node_at(fixed_position.line, fixed_position.column) unless source.error_ranges.any?{|r| r.nil? || r.include?(fixed_position)}
+              node = Source.parse(fixed_phrase) if node.nil?
+            end
           else
-            node = nil
-            node = source.node_at(fixed_position.line, fixed_position.column) unless source.error_ranges.any?{|r| r.nil? || r.include?(fixed_position)}
-            node = Source.parse(fixed_phrase) if node.nil?
+            node = Source.parse(fixed_phrase)
           end
         rescue Parser::SyntaxError
           return Chain.new([Chain::UNDEFINED_CALL])
         end
         return Chain.new([Chain::UNDEFINED_CALL]) if node.nil? || (node.type == :sym && !phrase.start_with?(':'))
         chain = NodeChainer.chain(node, source.filename)
-        if source.repaired? || !source.parsed?
+        if source.repaired? || !source.parsed? || !source.synchronized?
           if end_of_phrase.strip == '.'
             chain.links.push Chain::UNDEFINED_CALL
           elsif end_of_phrase.strip == '::'
@@ -158,7 +162,11 @@ module Solargraph
                 signature = char + signature if char.match(/[a-z0-9:\._@\$\?\!]/i) and @source.code[index - 1] != '%'
                 break if char == '$'
                 if char == '@'
-                  signature = "@#{signature}" if @source.code[index-1, 1] == '@'
+                  index -= 1
+                  if @source.code[index, 1] == '@'
+                    index -= 1
+                    signature = "@#{signature}"
+                  end
                   break
                 end
               elsif parens == 1 || brackets == 1 || squares == 1

data/lib/solargraph/source_map.rb

@@ -1,3 +1,5 @@
+require 'jaro_winkler'
+
 module Solargraph
   # An index of pins and other ApiMap-related data for a Source.
   #
@@ -66,7 +68,7 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
-      document_symbols.select{|pin| pin.path.include?(query)}
+      document_symbols.select{ |pin| fuzzy_string_match(pin.path, query) || fuzzy_string_match(pin.name, query) }
     end
 
     # @param position [Position]
@@ -85,7 +87,7 @@ module Solargraph
     # @return [Solargraph::Pin::Base]
     def locate_pin location
       # return nil unless location.start_with?("#{filename}:")
-      pins.select{|pin| pin.location == location}.first
+      pins.select { |pin| pin.location == location }.first
     end
 
     def locate_named_path_pin line, character
@@ -156,5 +158,12 @@ module Solargraph
       # @todo Assuming the root pin is always valid
       found || pins.first
     end
+
+    # @param str1 [String]
+    # @param str2 [String]
+    # @return [Boolean]
+    def fuzzy_string_match str1, str2
+      JaroWinkler.distance(str1, str2) > 0.6
+    end
   end
 end

data/lib/solargraph/source_map/clip.rb

@@ -15,7 +15,7 @@ module Solargraph
       def define
         return [] if cursor.comment? || cursor.chain.literal?
         result = cursor.chain.define(api_map, context_pin, locals)
-        result.concat(source_map.pins.select{ |p| p.location.range.start.line == cursor.position.line }) if result.empty?
+        result.concat((source_map.pins + source_map.locals).select{ |p| p.name == cursor.word && p.location.range.contain?(cursor.position) }) if result.empty?
         result
       end
 

data/lib/solargraph/source_map/mapper.rb

@@ -12,6 +12,7 @@ module Solargraph
 
       # Generate the data.
       #
+      # @param source [Source]
       # @return [Array]
       def map source
         @source = source
@@ -57,8 +58,8 @@ module Solargraph
       end
 
       def process_comment position, comment
+        return unless comment =~ /(@\!method|@\!attribute|@\!domain|@\!macro|@\!parse)/
         cmnt = remove_inline_comment_hashes(comment)
-        return unless cmnt =~ /(@\!method|@\!attribute|@\!domain|@\!macro|@\!parse)/
         parse = YARD::Docstring.parser.parse(cmnt)
         parse.directives.each { |d| process_directive(position, d) }
       end
@@ -72,7 +73,8 @@ module Solargraph
         when 'method'
           namespace = namespace_at(position)
           gen_src = Solargraph::SourceMap.load_string("def #{directive.tag.name};end")
-          gen_pin = gen_src.pins.last # Method is last pin after root namespace
+          gen_pin = gen_src.pins.select{ |p| p.kind == Pin::METHOD }.first
+          return if gen_pin.nil?
           @pins.push Solargraph::Pin::Method.new(location, namespace.path, gen_pin.name, docstring.all, :instance, :public, gen_pin.parameters, nil)
         when 'attribute'
           namespace = namespace_at(position)
@@ -96,7 +98,7 @@ module Solargraph
           end
         when 'domain'
           namespace = namespace_at(position)
-          namespace.domains.push directive.tag.text
+          namespace.domains.concat directive.tag.types unless directive.tag.types.nil?
         end
       end
 
@@ -107,10 +109,10 @@ module Solargraph
         comment.lines.each { |l|
           # Trim the comment and minimum leading whitespace
           p = l.gsub(/^#/, '')
-          if num.nil? and !p.strip.empty?
+          if num.nil? && !p.strip.empty?
             num = p.index(/[^ ]/)
             started = true
-          elsif started and !p.strip.empty?
+          elsif started && !p.strip.empty?
             cur = p.index(/[^ ]/)
             num = cur if cur < num
           end
@@ -120,6 +122,7 @@ module Solargraph
       end
 
       def process_comment_directives
+        return unless @code =~ /(@\!method|@\!attribute|@\!domain|@\!macro|@\!parse)/
         current = []
         last_line = nil
         @comments.each do |cmnt|

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.30.2'
+  VERSION = '0.31.0'
 end

data/lib/solargraph/views/environment.erb

@@ -29,6 +29,9 @@
     <li>
       Core Documentation Version: <%= Solargraph::YardMap::CoreDocs.best_match %>
     </li>
+    <li>
+      Core Cache Directory: <%= Solargraph::YardMap::CoreDocs.cache_dir %>
+    </li>
     <li>
       Parser Target Version: <%= Solargraph::Source.parser.version %>
     </li>

data/lib/solargraph/workspace.rb

@@ -10,6 +10,7 @@ module Solargraph
     attr_reader :directory
 
     # @param directory [String]
+    # @param config [Config, nil]
     def initialize directory = '', config = nil
       @directory = directory
       @config = config
@@ -28,7 +29,7 @@ module Solargraph
     # @param source [Solargraph::Source]
     # @return [Boolean] True if the source was added to the workspace
     def merge source
-      unless directory == '*' || source_hash.has_key?(source.filename)
+      unless directory == '*' || source_hash.key?(source.filename)
         # Reload the config to determine if a new source should be included
         @config = Solargraph::Workspace::Config.new(directory)
         return false unless config.calculated.include?(source.filename)
@@ -53,7 +54,7 @@ module Solargraph
     # @param filename [String]
     # @return [Boolean] True if the source was removed from the workspace
     def remove filename
-      return false unless source_hash.has_key?(filename)
+      return false unless source_hash.key?(filename)
       source_hash.delete filename
       true
     end
@@ -68,13 +69,15 @@ module Solargraph
       source_hash.values
     end
 
+    # @param filename [String]
     # @return [Boolean]
     def has_file? filename
-      source_hash.has_key?(filename)
+      source_hash.key?(filename)
     end
 
     # Get a source by its filename.
     #
+    # @param filename [String]
     # @return [Solargraph::Source]
     def source filename
       source_hash[filename]
@@ -109,13 +112,13 @@ module Solargraph
     #
     # @return [Array<String>]
     def gemspecs
-      return [] if directory.empty?
+      return [] if directory.empty? || directory == '*'
       @gemspecs ||= Dir[File.join(directory, '**/*.gemspec')]
     end
 
     # Synchronize the workspace from the provided updater.
     #
-    # @param [Source::Updater]
+    # @param updater [Source::Updater]
     # @return [void]
     def synchronize! updater
       source_hash[updater.filename] = source_hash[updater.filename].synchronize(updater)
@@ -128,6 +131,7 @@ module Solargraph
       @source_hash ||= {}
     end
 
+    # @return [void]
     def load_sources
       source_hash.clear
       unless directory.empty? || directory == '*'
@@ -144,7 +148,7 @@ module Solargraph
     #
     # @return [Array<String>]
     def generate_require_paths
-      return configured_require_paths if directory.empty? || !gemspec?
+      return configured_require_paths unless gemspec?
       result = []
       gemspecs.each do |file|
         base = File.dirname(file)
@@ -152,15 +156,14 @@ module Solargraph
         #   workspace code, but this is how Gem::Specification.load does it
         #   anyway.
         begin
-           spec = eval(File.read(file), binding, file)
-           next unless Gem::Specification === spec
-           result.concat spec.require_paths.map{ |path| File.join(base, path) } unless spec.nil?
+          spec = eval(File.read(file), binding, file)
+          next unless Gem::Specification === spec
+          result.concat(spec.require_paths.map { |path| File.join(base, path) })
         rescue Exception => e
-           # Don't die if we have an error during eval-ing a gem spec.
-           # Concat the default lib directory instead.
-           # @todo Should the client be informed of the error through
-           #   diagnostics or some other mechanism?
-           result.push File.join(base, 'lib')
+          # Don't die if we have an error during eval-ing a gem spec.
+          # Concat the default lib directory instead.
+          Solargraph.logger.warn "Error reading #{file}: [#{e.class}] #{e.message}"
+          result.push File.join(base, 'lib')
         end
       end
       result.concat config.require_paths

data/lib/solargraph/workspace/config.rb

@@ -15,7 +15,7 @@ module Solargraph
       # @return [Hash]
       attr_reader :raw_data
 
-      # @param workspace [String]
+      # @param directory [String]
       def initialize directory = ''
         @directory = directory
         include_globs = ['**/*.rb']

data/lib/solargraph/yard_map.rb

@@ -7,9 +7,10 @@ module Solargraph
   class YardMap
     autoload :Cache,    'solargraph/yard_map/cache'
     autoload :CoreDocs, 'solargraph/yard_map/core_docs'
+    autoload :CoreGen,  'solargraph/yard_map/core_gen'
 
     CoreDocs.require_minimum
-    @@stdlib_yardoc = CoreDocs.yard_stdlib_file
+    @@stdlib_yardoc = CoreDocs.yardoc_stdlib_file
     @@stdlib_paths = {}
     YARD::Registry.load! @@stdlib_yardoc
     YARD::Registry.all(:class, :module).each do |ns|
@@ -26,7 +27,7 @@ module Solargraph
     attr_writer :with_dependencies
 
     # @param required [Array<String>]
-    # @param skip_dependencies [Boolean]
+    # @param with_dependencies [Boolean]
     def initialize(required: [], with_dependencies: true)
       # HACK: YardMap needs its own copy of this array
       @required = required.clone
@@ -79,7 +80,7 @@ module Solargraph
         YARD::Registry.load! y
       end
     rescue Exception => e
-      STDERR.puts "Error loading yardoc '#{y}' #{e.class} #{e.message}"
+      Solargraph::Logging.logger.warn "Error loading yardoc '#{y}' #{e.class} #{e.message}"
       yardocs.delete y
       nil
     end
@@ -252,7 +253,7 @@ module Solargraph
           end
         rescue Gem::LoadError
           # This error probably indicates a bug in an installed gem
-          STDERR.puts "Warning: failed to resolve #{dep.name} gem dependency for #{spec.name}"
+          Solargraph::Logging.logger.warn "Failed to resolve #{dep.name} gem dependency for #{spec.name}"
         end
       end
       result
@@ -266,7 +267,7 @@ module Solargraph
         .map{ |f| File.size(f) }
         .inject(:+)
       if !size.nil? && size > 20_000_000
-        STDERR.puts "Warning: yardoc at #{y} is too large to process (#{size} bytes)"
+        Solargraph::Logging.logger.warn "Yardoc at #{y} is too large to process (#{size} bytes)"
         return []
       end
       result = []

data/lib/solargraph/yard_map/core_docs.rb

@@ -8,25 +8,37 @@ module Solargraph
     # Tools for managing core documentation.
     #
     module CoreDocs
+      # The URL for downloading core documentation
       SOURCE = 'https://solargraph.org/download'
 
+      # The default core documentation version
+      DEFAULT = '2.2.2'
+
       class << self
+        # The directory where core documentation is installed.
+        #
+        # @return [String]
         def cache_dir
-          @cache_dir ||= ENV["SOLARGRAPH_CACHE"] || File.join(Dir.home, '.solargraph', 'cache')
+          # The directory is not stored in a variable so it can be overridden
+          # in specs.
+          ENV['SOLARGRAPH_CACHE'] || File.join(Dir.home, '.solargraph', 'cache')
         end
 
         # Ensure installation of minimum documentation.
         #
+        # @return [void]
         def require_minimum
           return unless best_match.nil?
           FileUtils.mkdir_p cache_dir
-          version_dir = File.join(cache_dir, '2.2.2')
-          unless File.exist?(version_dir)
-            FileUtils.cp File.join(Solargraph::YARDOC_PATH, '2.2.2.tar.gz'), cache_dir
-            install_archive File.join(cache_dir, '2.2.2.tar.gz')
-          end
+          FileUtils.cp File.join(Solargraph::YARDOC_PATH, "#{DEFAULT}.tar.gz"), cache_dir
+          install_archive File.join(cache_dir, "#{DEFAULT}.tar.gz")
         end
 
+        # True if core documentation is installed for the specified version
+        # number.
+        #
+        # @param ver [String] The version number to check
+        # @return [Boolean]
         def valid?(ver)
           dir = File.join(cache_dir, ver)
           return false unless File.directory?(dir)
@@ -35,6 +47,10 @@ module Solargraph
           true
         end
 
+        # Get a list of version numbers for currently installed core
+        # documentation.
+        #
+        # @return [Array<String>] The installed version numbers
         def versions
           dirs = Dir[File.join(cache_dir, '*')].map{|d| File.basename(d)}
           dirs.keep_if{|d| valid?(d)}
@@ -42,40 +58,67 @@ module Solargraph
           dirs
         end
 
+        # Get the version number of the installed core documentation that is
+        # the closest match for the current Ruby version.
+        #
+        # @return [String] The closest match
         def best_match
-          available = versions
-          available.each do |v|
-            return v if Gem::Version.new(v) <= Gem::Version.new(RUBY_VERSION)
+          avail = versions
+          cur = Gem::Version.new(RUBY_VERSION)
+          avail.each do |v|
+            return v if Gem::Version.new(v) <= cur
           end
-          return available.last
+          avail.last
         end
 
+        # Get a list of core documentation versions that are available for
+        # download.
+        #
+        # @return [Array<String>] The version numbers
         def available
           uri = URI.parse("#{SOURCE}/versions.json")
           response = Net::HTTP.get_response(uri)
           obj = JSON.parse(response.body)
-          raise SourceNotAvailableError.new("Error connecting to #{SOURCE}") unless obj['status'] == 'ok'
+          raise SourceNotAvailableError, "Error connecting to #{SOURCE}" unless obj['status'] == 'ok'
           obj['cores']
         end
 
-        def best_download
-          rv = Gem::Version.new(RUBY_VERSION)
-          available.each do |ver|
+        # Get the version number of core documentation available for download
+        # that is the closest match for the current Ruby version.
+        #
+        # @param current [String] The version to compare
+        # @return [String] The version number of the best match
+        def best_download current = RUBY_VERSION
+          rv = Gem::Version.new(current)
+          found = available
+          found.each do |ver|
             return ver if Gem::Version.new(ver) <= rv
           end
-          obj['cores'].last
+          found.last
         end
 
+        # Get the path to a yardoc file for Ruby core documentation.
+        #
+        # @param ver [String] The version number (best match is default)
+        # @return [String] The path to the yardoc
         def yardoc_file(ver = best_match)
-          raise ArgumentError.new("Invalid core yardoc version #{ver}") unless valid?(ver)
+          raise ArgumentError, "Invalid core yardoc version #{ver}" unless valid?(ver)
           File.join(cache_dir, ver, 'yardoc')
         end
 
-        def yard_stdlib_file(ver = best_match)
-          raise ArgumentError.new("Invalid core yardoc version #{ver}") unless valid?(ver)
+        # Get the path to a yardoc file for Ruby stdlib documentation.
+        #
+        # @param ver [String] The version number (best match is default)
+        # @return [String] The path to the yardoc
+        def yardoc_stdlib_file(ver = best_match)
+          raise ArgumentError, "Invalid core yardoc version #{ver}" unless valid?(ver)
           File.join(cache_dir, ver, 'yardoc-stdlib')
         end
 
+        # Download the specified version of core documentation.
+        #
+        # @param version [String]
+        # @return [void]
         def download version
           FileUtils.mkdir_p cache_dir
           uri = URI.parse("#{SOURCE}/#{version}.tar.gz")
@@ -85,6 +128,9 @@ module Solargraph
           install_archive zipfile
         end
 
+        # Reset the core documentation cache to the minimum requirement.
+        #
+        # @return [void]
         def clear
           FileUtils.rm_rf cache_dir, secure: true
           require_minimum
@@ -92,6 +138,10 @@ module Solargraph
 
         private
 
+        # Extract the specified archive to the core cache directory.
+        #
+        # @param filename [String]
+        # @return [void]
         def install_archive filename
           tar_extract = Gem::Package::TarReader.new(Zlib::GzipReader.open(filename))
           tar_extract.rewind