solargraph 0.33.2 → 0.34.0

data/lib/solargraph/convention/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Base
+      EMPTY_ENVIRON = Environ.new
+
+      # True if the source qualifies for this convention.
+      # Subclasses should override this method.
+      def match? source
+        false
+      end
+
+      # @return [Environ]
+      def process
+        match? ? EMPTY_ENVIRON : environ
+      end
+
+      # The Environ for this convention.
+      # Subclasses should override this method.
+      #
+      # @return [Environ]
+      def environ
+        EMPTY_ENVIRON
+      end
+    end
+  end
+end

data/lib/solargraph/convention/gemfile.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Gemfile < Base
+      def match? source
+        File.basename(source.filename) == 'Gemfile'
+      end
+
+      def environ
+        @environ ||= Environ.new(
+          requires: ['bundler'],
+          domains: ['Bundler::Dsl']
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/convention/gemspec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Gemspec < Base
+      def match? source
+        File.basename(source.filename).end_with?('.gemspec')
+      end
+
+      def environ
+        @environ ||= Environ.new(
+          requires: ['rubygems'],
+          overrides: [
+            Solargraph::Pin::Reference::Override.from_comment(
+              'Gem::Specification.new',
+              %(
+@yieldparam [self]
+              )
+            )
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/convention/rspec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Rspec < Base
+      def match? source
+        File.basename(source.filename) =~ /_spec\.rb$/
+      end
+
+      def environ
+        @environ ||= Environ.new(
+          requires: ['rspec'],
+          domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
+          # This override is necessary due to an erroneous @return tag in
+          # rspec's YARD documentation.
+          overrides: [
+            Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/core_fills.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Solargraph
   module CoreFills
+    Override = Pin::Reference::Override
+
     KEYWORDS = [
       '__ENCODING__', '__LINE__', '__FILE__', 'BEGIN', 'END', 'alias', 'and',
       'begin', 'break', 'case', 'class', 'def', 'defined?', 'do', 'else',
@@ -8,58 +12,78 @@ module Solargraph
       'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
     ].freeze
 
-    METHODS_RETURNING_SUBTYPES = %w[
-      Array#[] Array#first Array#last
-    ].freeze
-
-    METHODS_RETURNING_VALUE_TYPES = %w[
-      Hash#[]
-    ].freeze
-
-    METHODS_WITH_YIELDPARAM_SELF = %w[
-      Object#tap
-    ].freeze
-
-    METHODS_WITH_YIELDPARAM_SUBTYPES = %w[
+    methods_with_yieldparam_subtypes = %w[
       Array#each Array#map Array#any? Array#all? Array#index Array#keep_if
       Array#delete_if
       Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?
       Enumerable#select Enumerable#reject
       Set#each
-    ].freeze
-
-    class << self
-      private
-
-      def override path, *tags
-        Solargraph::Pin::Reference::Override.new(nil, path, [YARD::Tags::Tag.new('return', nil, tags)])
-      end
-    end
+    ]
 
     OVERRIDES = [
-      override('Array#select', 'self'),
-      override('Array#reject', 'self'),
-      override('Array#keep_if', 'self'),
-      override('Array#delete_if', 'self'),
+      Override.method_return('Array#select', 'self'),
+      Override.method_return('Array#reject', 'self'),
+      Override.method_return('Array#keep_if', 'self'),
+      Override.method_return('Array#delete_if', 'self'),
+      Override.from_comment('Array#[]', %(
+@overload [](range)
+  @param range [Range]
+  @return [self]
+@overload [](num1, num2)
+  @param num1 [Integer]
+  @param num2 [Integer]
+  @return [self]
+@overload [](num)
+  @param num [Integer]
+  @return_single_parameter
+@return_single_parameter
+      )),
+      Override.from_comment('Array#first', %(
+@overload first(num)
+  @param num [Integer]
+  @return [self]
+@return_single_parameter
+      )),
+      Override.from_comment('Array#last', %(
+@overload last(num)
+  @param num [Integer]
+  @return [self]
+@return_single_parameter
+      )),
+                
+      Override.method_return('Class#new', 'self'),
+      Override.method_return('Class.new', 'Class<Object>'),
+      Override.method_return('Class#allocate', 'self'),
+      Override.method_return('Class.allocate', 'Class<Object>'),
 
-      override('Class#new', 'self'),
-      override('Class.new', 'Class<Object>'),
-      override('Class#allocate', 'self'),
-      override('Class.allocate', 'Class<Object>'),
+      Override.method_return('Enumerable#select', 'self'),
 
-      override('Enumerable#select', 'self'),
+      Override.method_return('File.dirname', 'String'),
 
-      override('Object#!', 'Boolean'),
-      override('Object#clone', 'self'),
-      override('Object#dup', 'self'),
-      override('Object#freeze', 'self'),
-      override('Object#taint', 'self'),
-      override('Object#untaint', 'self'),
-      override('Object#tap', 'self'),
+      Override.from_comment('Hash#[]', %(
+@return_value_parameter
+      )),
+        
+      Override.method_return('Object#!', 'Boolean'),
+      Override.method_return('Object#clone', 'self', delete: [:overload]),
+      Override.method_return('Object#dup', 'self'),
+      Override.method_return('Object#freeze', 'self'),
+      Override.method_return('Object#taint', 'self'),
+      Override.method_return('Object#untaint', 'self'),
+      Override.from_comment('Object#tap', %(
+@return [self]
+@yieldparam [self]
+      )),
 
-      override('String#freeze', 'self'),
-      override('String#split', 'Array<String>'),
-      override('String#lines', 'Array<String>')
-    ]
+      Override.method_return('String#freeze', 'self'),
+      Override.method_return('String#split', 'Array<String>'),
+      Override.method_return('String#lines', 'Array<String>')
+      ].concat(
+        methods_with_yieldparam_subtypes.map do |path|
+          Override.from_comment(path, %(
+@yieldparam_single_parameter
+          ))
+        end
+      )
   end
 end

data/lib/solargraph/diagnostics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # The Diagnostics library provides reporters for analyzing problems in code
   # and providing the results to language server clients.

data/lib/solargraph/diagnostics/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Diagnostics
     # The base class for diagnostics reporters.

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Diagnostics
     # RequireNotFound reports required paths that could not be resolved to

data/lib/solargraph/diagnostics/rubocop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 require 'stringio'
 

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Diagnostics
     # Utility methods for the RuboCop diagnostics reporter.

data/lib/solargraph/diagnostics/severities.rb

@@ -1,13 +1,15 @@
-module Solargraph
-  module Diagnostics
-    # These severity constants match the DiagnosticSeverity constants in the
-    # language server protocol.
-    #
-    module Severities
-      ERROR = 1
-      WARNING = 2
-      INFORMATION = 3
-      HINT = 4
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    # These severity constants match the DiagnosticSeverity constants in the
+    # language server protocol.
+    #
+    module Severities
+      ERROR = 1
+      WARNING = 2
+      INFORMATION = 3
+      HINT = 4
+    end
+  end
+end

data/lib/solargraph/diagnostics/type_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Diagnostics
     # TypeCheck reports methods with undefined return types, untagged

data/lib/solargraph/diagnostics/update_errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Diagnostics
     class UpdateErrors < Base

data/lib/solargraph/documentor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Solargraph
+  class Documentor
+    RDOC_GEMS = %w[
+      actioncable actionmailbox actionmailer actionpack actiontext actionview
+      activejob activemodel activerecord activestorage activesupport railties
+    ]
+
+    def initialize directory, rebuild: false
+      @directory = directory
+      @rebuild = rebuild
+    end
+
+    def document
+      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)
+            if !yd || @rebuild
+              puts "Documenting #{spec.name} #{spec.version}"
+              `yard gems #{spec.name} #{spec.version} #{@rebuild ? '--rebuild' : ''}`
+            end
+            if RDOC_GEMS.include?(spec.name)
+              cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}", 'yardoc')
+              next if File.exist?(cache) && !@rebuild
+              puts "Caching custom documentation for #{spec.name} #{spec.version}"
+              Solargraph::YardMap::RdocToYard.run(spec)
+            end
+          end
+        end
+      end
+      Bundler.reset!
+    end
+  end
+end

data/lib/solargraph/environ.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class Environ
+    # @return [Array<String>]
+    attr_reader :requires
+
+    # @return [Array<String>]
+    attr_reader :domains
+
+    # @return [Array<Pin::Reference::Override>]
+    attr_reader :overrides
+
+    # @param requires [Array<String>]
+    # @param domains [Array<String>]
+    # @param overrides [Array<Pin::Reference::Override>]
+    def initialize requires: [], domains: [], overrides: []
+      @requires = requires
+      @domains = domains
+      @overrides = overrides
+    end
+
+    # @return [self]
+    def clear
+      domains.clear
+      requires.clear
+      overrides.clear
+      self
+    end
+
+    # @param other [Environ]
+    # @return [self]
+    def merge other
+      domains.concat other.domains
+      requires.concat other.requires
+      overrides.concat other.overrides
+      self
+    end
+  end
+end

data/lib/solargraph/language_server.rb

@@ -1,17 +1,19 @@
-require 'solargraph/language_server/error_codes'
-require 'solargraph/language_server/completion_item_kinds'
-require 'solargraph/language_server/symbol_kinds'
-
-module Solargraph
-  # The LanguageServer namespace contains the classes and modules that compose
-  # concrete implementations of language servers.
-  #
-  module LanguageServer
-    autoload :Host,         'solargraph/language_server/host'
-    autoload :Message,      'solargraph/language_server/message'
-    autoload :UriHelpers,   'solargraph/language_server/uri_helpers'
-    autoload :MessageTypes, 'solargraph/language_server/message_types'
-    autoload :Request,      'solargraph/language_server/request'
-    autoload :Transport,    'solargraph/language_server/transport'
-  end
-end
+# frozen_string_literal: true
+
+require 'solargraph/language_server/error_codes'
+require 'solargraph/language_server/completion_item_kinds'
+require 'solargraph/language_server/symbol_kinds'
+
+module Solargraph
+  # The LanguageServer namespace contains the classes and modules that compose
+  # concrete implementations of language servers.
+  #
+  module LanguageServer
+    autoload :Host,         'solargraph/language_server/host'
+    autoload :Message,      'solargraph/language_server/message'
+    autoload :UriHelpers,   'solargraph/language_server/uri_helpers'
+    autoload :MessageTypes, 'solargraph/language_server/message_types'
+    autoload :Request,      'solargraph/language_server/request'
+    autoload :Transport,    'solargraph/language_server/transport'
+  end
+end

data/lib/solargraph/language_server/completion_item_kinds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module LanguageServer
     # The CompletionItemKind constants for the language server protocol.

data/lib/solargraph/language_server/error_codes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   module LanguageServer
     # The ErrorCode constants for the language server protocol.