solargraph 0.34.1 → 0.34.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb4c1116693acd8fdccf9caf8d077a14ab577566285871238dd57ac382f9c5b
-  data.tar.gz: f7379357d36bb6cb0b90364aa5f8a1e2936d9f86c4d597da30cc15f301f74992
+  metadata.gz: e432b35fd7f9c1466edf9d2f3ae54bcf210ebfaaa79473458b33ba700c6bf902
+  data.tar.gz: a4bb6dbe4b7e6ce15bf1177c75ecce9fe13fc10a499527622b5675893bdb0053
 SHA512:
-  metadata.gz: 6431b185d1e23f3e6d1d667e3c3622284420e77fc0575e6ca2664b5c83af2f69316b062c4589cf595b4aadf452db19a37ecef6ccc2802967758b0f5f60492c0c
-  data.tar.gz: 6396d5d67d5ee605b445b3e1b3ffd881f789caa5c3d11edf49c516948c2db58515808e29f928b22fdf1346906cf26885fc3f97c48679da29cd5e06753f119b0d
+  metadata.gz: d05491b24576660461f939eb763d10b6247ec47140ecceef8e0c4f1387074a427850c0d25c0a3624641b42e66e4964782e369c89738aec2ee067d9d2c9aafdb4
+  data.tar.gz: b0f8d060d9f19810789f1b4190758afe45b608cc4da25e92eed3797550f096f9fa2352723a9c3954e2b3b3bcc3368ca505903476cb36991c337b654fd1fd2ce4

data/.travis.yml

@@ -4,14 +4,12 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
-  - 2.5.1
-  - 2.5.3
-  - 2.6.0
-  - 2.6.1
+  - 2.5
+  - 2.6
   - jruby-9.2
 matrix:
   include:
-    - rvm: 2.4
+    - rvm: 2.5
       os: osx
 # Update RubyGems and Bundler due to error with Bundler 1.16.1 and RubyGems 2.7.3
 # See https://github.com/travis-ci/travis-ci/issues/8978

data/README.md

@@ -85,7 +85,7 @@ See [https://solargraph.org/guides](https://solargraph.org/guides) for more tips
 
 ### Bug Reports and Feature Requests
 
-[https://github.com/castwide/solargraph/issues](GitHub Issues) are the best place to ask questions, report problems, and suggest improvements.
+[GitHub Issues](https://github.com/castwide/solargraph/issues) are the best place to ask questions, report problems, and suggest improvements.
 
 ### Development
 

data/lib/solargraph.rb

@@ -15,6 +15,7 @@ module Solargraph
   class SourceNotAvailableError < StandardError; end
   class ComplexTypeError        < StandardError; end
   class WorkspaceTooLargeError <  RuntimeError;  end
+  class BundleNotFoundError <     StandardError; end
 
   autoload :Position,         'solargraph/position'
   autoload :Range,            'solargraph/range'

data/lib/solargraph/api_map.rb

@@ -116,8 +116,9 @@ 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)
+      br = reqs.include?('bundler/require') ? require_from_bundle(bundle.workspace.directory) : {}
+      reqs.concat br.keys
+      yard_map.change(reqs, br)
       new_store = Store.new(pins + yard_map.pins)
       @mutex.synchronize {
         @cache.clear

data/lib/solargraph/api_map/bundler_methods.rb

@@ -9,14 +9,10 @@ module Solargraph
       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
+          Documentor.specs_from_bundle(directory)
+        rescue BundleNotFoundError => e
+          Solargraph.logger.warn e.message
+          {}
         end
       end
 

data/lib/solargraph/api_map/source_to_yard.rb

@@ -20,6 +20,7 @@ module Solargraph
       # @param store [ApiMap::Store] ApiMap pin store
       # @return [void]
       def rake_yard store
+        YARD::Registry.clear
         code_object_map.clear
         store.namespace_pins.each do |pin|
           next if pin.path.nil? || pin.path.empty?

data/lib/solargraph/convention/rspec.rb

@@ -13,6 +13,7 @@ module Solargraph
           domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
           # This override is necessary due to an erroneous @return tag in
           # rspec's YARD documentation.
+          # @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
           overrides: [
             Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
           ]

data/lib/solargraph/documentor.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require 'bundler'
+require 'json'
+require 'open3'
+require 'shellwords'
+require 'yard'
 
 module Solargraph
   class Documentor
@@ -9,45 +13,61 @@ module Solargraph
       activejob activemodel activerecord activestorage activesupport railties
     ]
 
-    def initialize directory, rebuild: false
+    def initialize directory, rebuild: false, out: File.new(File::NULL, 'w')
       @directory = directory
       @rebuild = rebuild
+      @out = out
     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|
-            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 #{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', "#{real.name}-#{real.version}", 'yardoc')
-              next if File.exist?(cache) && !@rebuild
-              puts "Caching custom documentation for #{real.name} #{real.version}"
-              Solargraph::YardMap::RdocToYard.run(real)
-            end
+      Documentor.specs_from_bundle(@directory).each_pair do |name, version|
+        yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
+        if !yd || @rebuild
+          @out.puts "Documenting #{name} #{version}"
+          `yard gems #{name} #{version} #{@rebuild ? '--rebuild' : ''}`
+          yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
+          if !yd
+            @out.puts "#{name} #{version} YARD documentation failed"
+            failures += 1
+          end
+        end
+        if yd && RDOC_GEMS.include?(name)
+          cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}", 'yardoc')
+          if !File.exist?(cache) || @rebuild
+            @out.puts "Caching custom documentation for #{name} #{version}"
+            spec = Gem::Specification.find_by_name(name, "= #{version}")
+            Solargraph::YardMap::RdocToYard.run(spec)
           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."
+        @out.puts "#{failures} gem#{failures == 1 ? '' : 's'} could not be documented. You might need to run `bundle install`."
       end
       failures == 0
+    rescue Solargraph::BundleNotFoundError => e
+      @out.puts "[#{e.class}] #{e.message}"
+      @out.puts "No bundled gems are available in #{@directory}"
+      false
+    end
+
+    def self.specs_from_bundle directory
+      Bundler.with_clean_env do
+        Dir.chdir directory do
+          cmd = [
+            'bundle', 'exec', 'ruby', '-e',
+            "require 'bundler'; require 'json'; puts Bundler.definition.specs_for([:default]).map { |spec| [spec.name, spec.version] }.to_h.to_json"
+          ]
+          o, e, s = Open3.capture3(*cmd)
+          if s.success?
+            o && !o.empty? ? JSON.parse(o) : {}
+          else
+            Solargraph.logger.warn e
+            raise BundleNotFoundError, "Failed to load gems from bundle at #{directory}"
+          end
+        end
+      end
     end
   end
 end

data/lib/solargraph/shell.rb

@@ -183,7 +183,7 @@ module Solargraph
     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
+      Documentor.new(options[:directory], rebuild: options[:rebuild], out: STDOUT).document
     end
 
     desc 'rdoc GEM [VERSION]', 'Use RDoc to cache documentation'

data/lib/solargraph/version.rb

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

data/lib/solargraph/workspace.rb

@@ -159,15 +159,18 @@ module Solargraph
         # HACK: Evaluating gemspec files violates the goal of not running
         #   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) })
-        rescue Exception => e
-          # 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')
+        Dir.chdir base do
+          begin
+            # @type [Gem::Specification]
+            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.
+            Solargraph.logger.warn "Error reading #{file}: [#{e.class}] #{e.message}"
+            result.push File.join(base, 'lib')
+          end
         end
       end
       result.concat config.require_paths

data/lib/solargraph/yard_map.rb

@@ -30,14 +30,18 @@ module Solargraph
 
     attr_writer :with_dependencies
 
+    attr_reader :gemset
+
     # @param required [Array<String>]
+    # @param gemset [Hash{String => String}]
     # @param with_dependencies [Boolean]
-    def initialize(required: [], with_dependencies: true)
+    def initialize(required: [], gemset: {}, with_dependencies: true)
       # HACK: YardMap needs its own copy of this array
       @required = required.clone
       @with_dependencies = with_dependencies
       @gem_paths = {}
       @stdlib_namespaces = []
+      @gemset = gemset
       process_requires
       yardocs.uniq!
     end
@@ -54,12 +58,13 @@ module Solargraph
 
     # @param new_requires [Array<String>]
     # @return [Boolean]
-    def change new_requires
-      if new_requires.uniq.sort == required.uniq.sort
+    def change new_requires, new_gemset
+      if new_requires.uniq.sort == required.uniq.sort && new_gemset == gemset
         false
       else
         required.clear
         required.concat new_requires
+        @gemset = new_gemset
         process_requires
         true
       end
@@ -120,7 +125,7 @@ module Solargraph
     # @return [Location]
     def require_reference path
       # @type [Gem::Specification]
-      spec = Gem::Specification.find_by_path(path) || Gem::Specification.find_by_name(path.split('/').first)
+      spec = spec_for_require(path)
       spec.full_require_paths.each do |rp|
         file = File.join(rp, "#{path}.rb")
         next unless File.file?(file)
@@ -165,7 +170,7 @@ module Solargraph
         end
         result = []
         begin
-          spec = Gem::Specification.find_by_path(r) || Gem::Specification.find_by_name(r.split('/').first)
+          spec = spec_for_require(r)
           ver = spec.version.to_s
           ver = ">= 0" if ver.empty?
           yd = yardoc_file_for_spec(spec)
@@ -271,24 +276,20 @@ module Solargraph
         Solargraph.logger.info "Using cached documentation for #{spec.name} at #{cache_dir}"
         cache_dir
       else
-        YARD::Registry.yardoc_file_for_gem(spec.name, spec.version)
+        YARD::Registry.yardoc_file_for_gem(spec.name, "= #{spec.version}")
       end
     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])
+
+    def spec_for_require path
+      spec = Gem::Specification.find_by_path(path) || Gem::Specification.find_by_name(path.split('/').first)
+      if @gemset[spec.name]
+        begin
+          return Gem::Specification.find_by_name(spec.name, "= #{@gemset[spec.name]}")
+        rescue Gem::LoadError
+          Solargraph.logger.warn "Unable to load #{spec.name} #{@gemset[spec.name]} specified by workspace, using #{spec.version} instead"
+        end
+      end
+      spec
     end
-    specs.map(&:name)
   end
-  Bundler.reset!
-  result
-rescue Bundler::GemfileNotFound => e
-  Solargraph.logger.info "Ignoring bundler/require: #{e.message}"
-  []
 end

data/travis-bundler.rb

@@ -4,7 +4,8 @@
 # each job.
 
 if RUBY_VERSION =~ /^2\.(1|2)\./
-  exec "gem install bundler -v '< 2'"
+  `gem install bundler -v '< 2'`
 else
-  exec "gem install bundler"
+  `gem update --system`
+  `gem install bundler`
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.34.1
+  version: 0.34.2
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport