solargraph 0.34.0 → 0.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4c15dc7c4e82dfcfb3b763c111980c3faa3da66857658e5fd8124e08ef999e
-  data.tar.gz: 64f641fd49afbcee69e014e65a77f8f0f8649e854d0da67371c11aa48692f257
+  metadata.gz: 4eb4c1116693acd8fdccf9caf8d077a14ab577566285871238dd57ac382f9c5b
+  data.tar.gz: f7379357d36bb6cb0b90364aa5f8a1e2936d9f86c4d597da30cc15f301f74992
 SHA512:
-  metadata.gz: 9b9442c9027fd4eb15a4958302db194e9ed9031458c34d7554a514969b5415c495bcb633b78ebcd8ba14747268be2ea78ce6117216240b1bca302fe8892bf6ee
-  data.tar.gz: 46f1c0eb34c0830dbbda766c6be52730592136e777df71bc9953bb8e391bfd161f31e08db971107d3862f815423174a51fa0334b22de67193272b3ffb9e0a560
+  metadata.gz: 6431b185d1e23f3e6d1d667e3c3622284420e77fc0575e6ca2664b5c83af2f69316b062c4589cf595b4aadf452db19a37ecef6ccc2802967758b0f5f60492c0c
+  data.tar.gz: 6396d5d67d5ee605b445b3e1b3ffd881f789caa5c3d11edf49c516948c2db58515808e29f928b22fdf1346906cf26885fc3f97c48679da29cd5e06753f119b0d

data/.gitignore

@@ -1,4 +1,4 @@
-Gemfile.lock
+/Gemfile.lock
 
 .idea
 .vscode

data/.travis.yml

@@ -8,7 +8,6 @@ rvm:
   - 2.5.3
   - 2.6.0
   - 2.6.1
-  - jruby-9.1.16.0
   - jruby-9.2
 matrix:
   include:
@@ -19,7 +18,5 @@ matrix:
 before_install:
 - ruby ./travis-bundler.rb
 - bundle install
-before_script: bundle exec yard gems
-script: bundle exec rspec
-# cache:
-#   - bundler
+before_script: yard gems
+script: rspec

data/README.md

@@ -1,19 +1,23 @@
 # Solargraph
 
-IDE tools for the Ruby language.
+## A Ruby Language Server
 
-Solargraph is a set of tools to integrate Ruby code completion and inline documentation into IDEs.
+Solargraph provides a comprehensive suite of tools for Ruby programming: intellisense, diagnostics, inline documentation, and type checking.
 
 ## Online Demo
 
-A web-based demonstration of Solargraph is available at http://solargraph.org/demo.
+A web-based demonstration of Solargraph's autocomplete is available at https://solargraph.org/demo.
 
 ## Installation
 
-Solargraph is available as a Ruby gem:
+Install the gem from the command line:
 
     gem install solargraph
 
+Or add it to your Gemfile:
+
+    gem 'solargraph', group: :development
+
 ## Using Solargraph
 
 Plug-ins and extensions are available for the following editors:
@@ -38,39 +42,28 @@ Plug-ins and extensions are available for the following editors:
 
 ### Gem Support
 
-Solargraph is capable of providing code completion and documentation for gems that have YARD documentation. You can make sure your gems are documented by running `yard gems` from the command line. (The first time you run it might take a while if you have a lot of gems installed).
+Solargraph is capable of providing code completion and documentation for gems that have YARD documentation. You can make sure your gems are documented by running `yard gems` from the command line. (YARD is included as one of Solargraph's gem dependencies. The first time you run it might take a while if you have a lot of gems installed).
 
 When editing code, a `require` call that references a gem will pull the documentation into the code maps and include the gem's API in code completion and intellisense.
 
-### More Information
-
-See [http://solargraph.org/guides](http://solargraph.org/guides) for more tips and tutorials for using Solargraph.
-
-## How It Works
-
-Solargraph uses [parser](https://github.com/whitequark/parser) for code analysis and [YARD](https://github.com/lsegal/yard) for API documentation.
+If your project automatically requires bundled gems (e.g., `require 'bundler/require'`), Solargraph will add all of the Gemfile's default dependecies to the map.
 
-## Using the `solargraph` Executable
+### Type Checking
 
-The gem includes an executable that provides access to the library's features. For code completion, IDEs will typically integrate using `solargraph stdio` or `solargraph socket`.
+As of version 0.33.0, Solargraph includes a [type checker](https://github.com/castwide/solargraph/issues/192) that uses a combination of YARD tags and code analysis to report missing type definitions. In strict mode, it performs type inference to determine whether the tags match the types it detects from code.
 
-### Language Server Protocol
+### Updating Core Documentation
 
-The language server protocol is the recommended way for integrating Solargraph into editors and IDEs. Clients can connect using either stdio or TCP.
-See [LANGUAGE_SERVER.md](LANGUAGE_SERVER.md) for more information.
-
-## Updating Core Documentation
-
-The Solargraph gem ships with documentation for Ruby 2.2.2. As of gem version 0.15.0, there's an option to download additional documentation for other Ruby versions from the command line.
+The Solargraph gem ships with documentation for Ruby 2.2.2. You can download documentation for other Ruby versions from the command line.
 
     $ solargraph list-cores      # List the installed documentation versions
     $ solargraph available-cores # List the versions available for download
     $ solargraph download-core   # Install the best match for your Ruby version
-    $ solargraph clear-cores     # Clear the documentation cache
+    $ solargraph clear           # Reset the documentation cache
 
-## Solargraph and Bundler
+### Solargraph and Bundler
 
-If you're using the Solargraph language server with a project that uses Bundler, the most comprehensive way to use your bundled gems is to bundle Solargraph.
+If you're using the language server with a project that uses Bundler, the most comprehensive way to use your bundled gems is to bundle Solargraph.
 
 In the Gemfile:
 
@@ -78,13 +71,21 @@ In the Gemfile:
 
 Run `bundle install` and use `bundle exec yard gems` to generate the documentation. This process documents cached or vendored gems, or even gems that are installed from a local path.
 
-In order to access the gems in your project, you'll need to start the language server with Bundler. In VS Code, there's a `solargraph.useBundler` option. Other clients will vary, but the command you probably want to run is `bundle exec solargraph socket` or `bundle exec solargraph stdio`.
+In order to make sure you're using the correct dependencies, you can start the language server with Bundler. In VS Code, there's a `solargraph.useBundler` option. Other clients will vary, but the command you probably want to run is `bundle exec solargraph socket` or `bundle exec solargraph stdio`.
+
+### Integrating Other Editors
+
+The [language server protocol](https://microsoft.github.io/language-server-protocol/specification) is the recommended way for integrating Solargraph into editors and IDEs. Clients can connect using either stdio or TCP. Language client developers should refer to [https://solargraph.org/guides/language-server](https://solargraph.org/guides/language-server).
+
+### More Information
+
+See [https://solargraph.org/guides](https://solargraph.org/guides) for more tips and tutorials about Solargraph.
 
 ## Contributing to Solargraph
 
 ### Bug Reports and Feature Requests
 
-GitHub Issues are the best place to ask questions, report problems, and suggest improvements.
+[https://github.com/castwide/solargraph/issues](GitHub Issues) are the best place to ask questions, report problems, and suggest improvements.
 
 ### Development
 

data/lib/solargraph/api_map.rb

@@ -9,11 +9,13 @@ module Solargraph
   # the Ruby core.
   #
   class ApiMap
-    autoload :Cache,        'solargraph/api_map/cache'
-    autoload :SourceToYard, 'solargraph/api_map/source_to_yard'
-    autoload :Store,        'solargraph/api_map/store'
+    autoload :Cache,          'solargraph/api_map/cache'
+    autoload :SourceToYard,   'solargraph/api_map/source_to_yard'
+    autoload :Store,          'solargraph/api_map/store'
+    autoload :BundlerMethods, 'solargraph/api_map/bundler_methods'
 
     include SourceToYard
+    include BundlerMethods
 
     # @return [Array<String>]
     attr_reader :unresolved_requires
@@ -114,6 +116,7 @@ module Solargraph
       end
       reqs.concat implicit.requires
       pins.concat implicit.overrides
+      reqs.concat require_from_bundle(bundle.workspace.directory) if reqs.include?('bundler/require')
       yard_map.change(reqs)
       new_store = Store.new(pins + yard_map.pins)
       @mutex.synchronize {

data/lib/solargraph/api_map/bundler_methods.rb

@@ -0,0 +1,28 @@
+require 'bundler'
+require 'shellwords'
+
+module Solargraph
+  class ApiMap
+    module BundlerMethods
+      module_function
+
+      def require_from_bundle directory
+        @require_from_bundle ||= begin
+          Solargraph.logger.info "Loading gems for bundler/require"
+          Bundler.with_clean_env do
+            specs = `cd #{Shellwords.escape(directory)} && bundle exec ruby -e "require 'bundler'; puts Bundler.definition.specs_for([:default]).map(&:name)"`
+            if specs
+              specs.lines.map(&:strip).reject(&:nil?)
+            else
+              []
+            end
+          end
+        end
+      end
+
+      def reset_require_from_bundle
+        @require_from_bundle = nil
+      end
+    end
+  end
+end

data/lib/solargraph/api_map/source_to_yard.rb

@@ -22,7 +22,7 @@ module Solargraph
       def rake_yard store
         code_object_map.clear
         store.namespace_pins.each do |pin|
-          next if pin.path.nil? or pin.path.empty?
+          next if pin.path.nil? || pin.path.empty?
           if pin.code_object
             code_object_map[pin.path] ||= pin.code_object
             next

data/lib/solargraph/documentor.rb

@@ -14,29 +14,40 @@ module Solargraph
       @rebuild = rebuild
     end
 
+    # @return [Boolean] True if all specs were found and documented.
     def document
+      failures = 0
       Dir.chdir @directory do
         Bundler.with_clean_env do
           Bundler.reset!
           lockfile = Bundler::LockfileParser.new(Bundler.read_file(Bundler.default_lockfile))
           # @param spec [Gem::Specification]
           lockfile.specs.each do |spec|
-            spec = spec.__materialize__
-            yd = YARD::Registry.yardoc_file_for_gem(spec.name, spec.version)
+            real = spec.__materialize__
+            if real.nil?
+              puts "WARNING: #{spec.name} #{spec.version} not found"
+              failures += 1
+              next
+            end
+            yd = YARD::Registry.yardoc_file_for_gem(real.name, real.version)
             if !yd || @rebuild
-              puts "Documenting #{spec.name} #{spec.version}"
-              `yard gems #{spec.name} #{spec.version} #{@rebuild ? '--rebuild' : ''}`
+              puts "Documenting #{real.name} #{real.version}"
+              `yard gems #{real.name} #{real.version} #{@rebuild ? '--rebuild' : ''}`
             end
             if RDOC_GEMS.include?(spec.name)
-              cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}", 'yardoc')
+              cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{real.name}-#{real.version}", 'yardoc')
               next if File.exist?(cache) && !@rebuild
-              puts "Caching custom documentation for #{spec.name} #{spec.version}"
-              Solargraph::YardMap::RdocToYard.run(spec)
+              puts "Caching custom documentation for #{real.name} #{real.version}"
+              Solargraph::YardMap::RdocToYard.run(real)
             end
           end
         end
       end
       Bundler.reset!
+      if failures > 0
+        puts "#{failures} spec#{failures == 1 ? '' : 's'} could not be found. You might need to run `bundle install` first."
+      end
+      failures == 0
     end
   end
 end

data/lib/solargraph/source/source_chainer.rb

@@ -37,6 +37,8 @@ module Solargraph
           return Chain.new([]) if phrase.end_with?('..')
           if !source.repaired? && source.parsed? && source.synchronized?
             node = source.node_at(position.line, position.column)
+          elsif source.parsed? && source.repaired? && end_of_phrase == '.'
+            node = source.node_at(fixed_position.line, fixed_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)}

data/lib/solargraph/source_map/node_processor/base.rb

@@ -62,7 +62,7 @@ module Solargraph
         end
 
         def named_path_pin position
-          pins.select{|pin| pin.is_a?(Pin::Closure) && !pin.path.empty? && pin.location.range.contain?(position)}.last
+          pins.select{|pin| pin.is_a?(Pin::Closure) && pin.path && !pin.path.empty? && pin.location.range.contain?(position)}.last
         end
 
         # @todo Candidate for deprecation

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.34.0'
+  VERSION = '0.34.1'
 end

data/lib/solargraph/yard_map.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'yard'
-require 'bundler'
 
 module Solargraph
   # The YardMap provides access to YARD documentation for the Ruby core, the
@@ -33,8 +32,7 @@ module Solargraph
 
     # @param required [Array<String>]
     # @param with_dependencies [Boolean]
-    def initialize(directory: '.', required: [], with_dependencies: true)
-      @directory = directory
+    def initialize(required: [], with_dependencies: true)
       # HACK: YardMap needs its own copy of this array
       @required = required.clone
       @with_dependencies = with_dependencies
@@ -157,7 +155,6 @@ module Solargraph
       unresolved_requires.clear
       stdnames = {}
       done = []
-      pins.concat(bundler_require) if required.include?('bundler/require')
       required.each do |r|
         next if r.nil? || r.empty? || done.include?(r)
         done.push r
@@ -268,38 +265,6 @@ module Solargraph
       Mapper.new(YARD::Registry.all, spec).map
     end
 
-    def bundler_require
-      Solargraph.logger.debug "Using bundler/require"
-      result = []
-      Dir.chdir @directory do
-        # @type [Array<Gem::Specification>]
-        specs = Bundler.with_original_env do
-          Bundler.reset!
-          Bundler.definition.specs_for([:default])
-        end
-        specs.each do |spec|
-          ver = spec.version.to_s
-          ver = ">= 0" if ver.empty?
-          yd = yardoc_file_for_spec(spec)
-          # YARD detects gems for certain libraries that do not have a yardoc
-          # but exist in the stdlib. `fileutils` is an example. Treat those
-          # cases as errors and check the stdlib yardoc.
-          if yd.nil?
-            Solargraph.logger.warn "Failed to load gem #{spec.name} #{ver} via bundler/require"
-            next
-          end
-          @gem_paths[spec.name] = spec.full_gem_path
-          unless yardocs.include?(yd)
-            yardocs.unshift yd
-            result.concat process_yardoc yd, spec
-            result.concat add_gem_dependencies(spec) if with_dependencies?
-          end
-        end
-      end
-      Bundler.reset!
-      result.reject(&:nil?)
-    end
-
     def yardoc_file_for_spec spec
       cache_dir = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}", 'yardoc')
       if File.exist?(cache_dir)
@@ -311,3 +276,19 @@ module Solargraph
     end
   end
 end
+def bundler_require directory
+  Solargraph.logger.info "Using bundler/require"
+  result = Dir.chdir directory do
+    # @type [Array<Gem::Specification>]
+    specs = Bundler.with_original_env do
+      Bundler.reset!
+      Bundler.definition.specs_for([:default])
+    end
+    specs.map(&:name)
+  end
+  Bundler.reset!
+  result
+rescue Bundler::GemfileNotFound => e
+  Solargraph.logger.info "Ignoring bundler/require: #{e.message}"
+  []
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.34.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -243,18 +243,16 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
-- EXAMPLES.md
 - Gemfile
-- LANGUAGE_SERVER.md
 - LICENSE
 - OVERVIEW.md
 - README.md
 - Rakefile
-- SERVER.md
 - bin/solargraph
 - bin/solargraph-runtime
 - lib/solargraph.rb
 - lib/solargraph/api_map.rb
+- lib/solargraph/api_map/bundler_methods.rb
 - lib/solargraph/api_map/cache.rb
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb

data/EXAMPLES.md

@@ -1,76 +0,0 @@
-# Code Examples
-
-This document provides simple examples of how to use the Solargraph library. The examples are intended as a starting point for developers who want to modify or extend the library, or integrate its tools into other software.
-
-Language client implementors who want to connect to Solargraph language servers should refer to [LANGUAGE_SERVER.md](LANGUAGE_SERVER.md).
-
-## Querying Ruby Core Methods
-
-```Ruby
-api_map = Solargraph::ApiMap.new
-pins = api_map.get_methods('String') # Get public instance methods of the String class
-```
-
-## Adding a File to an ApiMap
-
-```Ruby
-api_map = Solargraph::ApiMap.new
-source = Solargraph::Source.load_string('class MyClass; end', 'my_class.rb')
-api_map.map source # Add the source to the map
-pins = api_map.get_constants('') # The constants in the global namespace will include `MyClass`
-```
-
-## Adding a Workspace to an ApiMap
-
-```Ruby
-api_map = Solargraph::ApiMap.load('/path/to/workspace')
-pins = api_map.get_constants('') # Results will include constants defined in the project's code
-```
-
-## Querying Definitions from a Location in Source Code
-
-```Ruby
-api_map = Solargraph::ApiMap.new
-source = Solargraph::Source.load_string("var = 'a string'; puts var", 'example.rb')
-api_map.virtualize source
-clip = api_map.clip_at('example.rb', Solargraph::Position.new(0, 23))
-pins = clip.define # `var` is recognized as a local variable containing a String
-```
-
-## Querying Completion Suggestions
-```Ruby
-api_map = Solargraph::ApiMap.new
-source = Solargraph::Source.load_string("String.", 'example.rb')
-api_map.map source
-clip = api_map.clip_at('example.rb', Solargraph::Position.new(0, 7))
-completion = clip.complete # Suggestions will include String class methods
-```
-
-## Adding a Message to the Language Server Protocol
-
-```Ruby
-class MyMessage < Solargraph::LanguageServer::Message::Base
-  def process
-    STDERR.puts "Server received MyMessage with the following parameters: #{params}"
-  end
-end
-
-Solargraph::LanguageServer::Message.register '$/myMessage', MyMessage
-```
-
-## Adding a Diagnostics Reporter to the Language Server
-
-```Ruby
-class MyReporter < Solargraph::Diagnostics::Base
-  def diagnose source, api_map
-    # Return an array of hash objects that conform to the LSP's Diagnostic specification
-    []
-  end
-end
-
-Solargraph::Diagnostics.register 'my_reporter', MyReporter
-```
-
-## More Examples
-
-Developers are encouraged to refer to the specs for more examples of how to use Solargraph.

data/LANGUAGE_SERVER.md

@@ -1,51 +0,0 @@
-# Language Server Protocol
-
-Solargraph supports the language server protocol as of gem version 0.18.0. The VSCode extension uses LSP as of extension version 0.14.0.
-
-## Using the Language Server
-
-Run `solargraph stdio` to use the language server via stdio.
-
-Run `solargraph socket` to use the language server via TCP socket. The default port is 7658.
-
-## Supported Capabilities
-
-* Hover
-* Completion
-* Signature help
-* Definition
-* Document symbols
-* Workspace symbols
-* Rename symbols
-* References
-* Formatting
-* Diagnostics (linting)
-
-## Work in Progress
-
-* On type formatting
-
-## Custom Features
-
-Solargraph's language server extends the protocol with additional methods for inline document pages.
-
-## Linting and Formatting
-
-Solargraph uses RuboCop for linting and formatting.
-
-## Diagnostics Reporters
-
-A .solargraph.yml file can be used to select which diagnostics reporters Solargraph should use. Example:
-
-```
-reporters:
-- rubocop
-- require_not_found
-```
-
-`rubocop` enables RuboCop linting. Its rules can be configured in a .rubocop.yml file.
-
-`require_not_found` highlights `require` calls where Solargraph could not resolve a required path. Note that this error does not
-necessarily mean that the path is incorrect; only that Solargraph was unable to recognize it.
-
-Run `solargraph reporters` for a list of available reporters.

data/SERVER.md

@@ -1,95 +0,0 @@
-# Solargraph Server Documentation
-
-**NOTE: The legacy web server is deprecated and no longer available as of gem version 0.21.0. This document is archived for the benefit of extensions and plugins that still use it. Client implementors should use the [language server protocol](LANGUAGE_SERVER.md) instead.**
-
-## Running the Server
-
-Use the following command to start the server:
-
-```
-solargraph server
-```
-
-The command accepts an optional `--port` setting. The default port is 7657. If you set the port to 0, the server will select the first available port.
-
-## API Endpoints
-
-### POST /suggest
-
-Get an array of suggestions to complete the code at the specified line and column of a file.
-
-**Parameters:**
-- `text` - the contents of the file
-- `filename` - the absolute path to the file
-- `line` - the zero-based line position of the cursor
-- `column` - the zero-based column position of the cursor
-- `workspace` - (optional) the root directory of the project
-- `with_all` - (optional) request verbose suggestions
-
-If `with_all` is set to 1, the suggestions will include documentation. The default is 0.
-
-### POST /define
-
-Get an array of suggestions that point to definitions for the symbol at the
-specified location in the file. This method supports classes, modules, method
-definitions, and variable assignments. The suggestions have a `location`
-property that identifies the definition's file, line, and column.
-
-**Parameters:**
-- `text` - the contents of the file
-- `filename` - the absolute path to the file
-- `line` - the zero-based line position of the cursor
-- `column` - the zero-based column position of the cursor
-- `workspace` - (optional) the root directory of the project
-
-### POST /resolve
-
-**Parameters:**
-- `filename` - the absolute path to the file
-- `path` - the code path to find (e.g., `String#upcase`)
-- `workspace` - (optional) the root directory of the project
-
-### POST /signify
-
-**Parameters:**
-- `text` - the contents of the file
-- `filename` - the absolute path to the file
-- `line` - the zero-based line position of the cursor
-- `column` - the zero-based column position of the cursor
-- `workspace` - (optional) the root directory of the project
-
-### GET /search
-
-Request an HTML page containing search results for the specified text.
-A search for "str" will include the String class in the results.
-
-**Parameters:**
-- `query` - the text to find
-- `workspace` - (optional) the root directory of the project
-
-### GET /document
-
-Request an HTML page containing documentation for the specified path. A path
-can be a class or module name, a class method (e.g., `Object.superclass`), or
-an instance method (e.g., `String#upcase`). Documentation will also be
-generated for the current workspace.
-
-**Parameters:**
-- `path` - the code path to find
-- `workspace` - (optional) the root directory of the project
-
-### POST /prepare
-
-Initialize an ApiMap for the specified workspace. This method can make
-subsequent requests for suggestions significantly faster.
-
-**Parameters:**
-- `workspace` - the root directory of the project
-
-### POST /update
-
-Update a file in the ApiMap for the specified workspace.
-
-**Parameters:**
-- `filename` - the absolute path to the file
-- `workspace` - the root directory of the project